openapi: 3.1.0
info:
  title: Mist API
  description: >-
    > Version: **2607.1.1**

    >

    > Date: **August 17, 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/)


    ---
  contact:
    name: Thomas Munzer
    email: tmunzer@juniper.net
  version: '2607.1.1'
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
servers:
- url: https://api.mist.com
  variables: {}
- url: https://api.gc1.mist.com
  variables: {}
- url: https://api.ac2.mist.com
  variables: {}
- url: https://api.gc2.mist.com
  variables: {}
- url: https://api.gc4.mist.com
  variables: {}
- url: https://api.eu.mist.com
  variables: {}
- url: https://api.gc3.mist.com
  variables: {}
- url: https://api.ac6.mist.com
  variables: {}
- url: https://api.gc6.mist.com
  variables: {}
- url: https://api.ac5.mist.com
  variables: {}
- url: https://api.gc5.mist.com
  variables: {}
- url: https://api.gc7.mist.com
  variables: {}
paths:
  /api/v1/invite/verify/{token}:
    post:
      tags:
      - Admins
      summary: verifyAdminInvite
      description: Accept an administrator invite using the invite verification token from the invite email. This public endpoint does not require authentication. After a successful verification, call [Get Self]($e/Self%20Account/getSelf) to refresh the authenticated admin profile and retrieve the newly granted privileges.
      operationId: verifyAdminInvite
      parameters:
      - name: token
        in: path
        description: ''
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_detail_string'
                - description: Response containing a human-readable detail message
                  examples:
                  - '{"detail":"invalid secret"}'
                  - '{"detail":"invite created by self"}'
                contentMediaType: application/json
              examples:
                Invalid Secret:
                  value:
                    detail: invalid secret
                Invite Created By Self:
                  value:
                    detail: invite created by self
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_detail_string'
                - description: Response containing a human-readable detail message
                  examples:
                  - '{"detail":"invalid secret"}'
                  - '{"detail":"invite created by self"}'
                contentMediaType: application/vnd.api+json
              examples:
                Invalid Secret:
                  value:
                    detail: invalid secret
                Invite Created By Self:
                  value:
                    detail: invite created by self
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
      security: []
    parameters: []
  /api/v1/register:
    post:
      tags:
      - Admins
      summary: registerNewAdmin
      description: >-
        Register a new administrator account and initial organization. This public endpoint does not require authentication. Mist sends a verification email containing a link such as `/verify/register?token={token}`; use [Verify Registration]($e/Admins/verifyRegistration) to complete registration with that token.


        Use [Get Registration Information]($e/Admins/getAdminRegistrationInfo) before submitting this request to determine whether CAPTCHA is required, which CAPTCHA provider to render, and which public site key to use. If CAPTCHA is required, include the provider response token in `recaptcha` and the provider name in `recaptcha_flavor`.
      operationId: registerNewAdmin
      parameters: []
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/admin_invite'
              - description: Request Body
                examples:
                - account_only: false
                  allow_mist: false
                  city: Cupertino
                  country: United States
                  email: test@mistsys.com
                  first_name: John
                  invite_code: MISTROCKS
                  last_name: Smith
                  org_name: Smith LLC
                  password: foryoureyesonly
                  recaptcha: string
                  recaptcha_flavor: hcaptcha
                  referer_invite_token: Dm2gtT8dwMeM4Bc2E8FLIaA96VHOjPat
                  return_to: https://mist.zendesk.com/hc/quickstart.pdf
                  state: California
                  street_address: 1601 S De Anza Blvd Ste 248
                  street_address 2: 1601 S De Anza Blvd Ste 248
                  zipcode: '95014'
              contentMediaType: application/json
            examples:
              Example:
                value:
                  account_only: false
                  allow_mist: false
                  city: Cupertino
                  country: United States
                  email: test@mistsys.com
                  first_name: John
                  invite_code: MISTROCKS
                  last_name: Smith
                  org_name: Smith LLC
                  password: foryoureyesonly
                  recaptcha: string
                  recaptcha_flavor: hcaptcha
                  referer_invite_token: Dm2gtT8dwMeM4Bc2E8FLIaA96VHOjPat
                  return_to: https://mist.zendesk.com/hc/quickstart.pdf
                  state: California
                  street_address: 1601 S De Anza Blvd Ste 248
                  street_address 2: 1601 S De Anza Blvd Ste 248
                  zipcode: '95014'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
      security: []
    parameters: []
  /api/v1/register/recaptcha:
    get:
      tags:
      - Admins
      summary: getAdminRegistrationInfo
      description: Return the public CAPTCHA settings required for administrator registration. This public endpoint does not require authentication. Use the returned `flavor`, `required`, and `sitekey` values to render the correct CAPTCHA challenge before calling [Register New Admin]($e/Admins/registerNewAdmin).
      operationId: getAdminRegistrationInfo
      parameters:
      - name: recaptcha_flavor
        in: query
        description: 'Filter login settings by reCAPTCHA flavor. enum: `google`, `hcaptcha`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/recaptcha_flavor'
          - description: 'Filter login settings by reCAPTCHA flavor. enum: `google`, `hcaptcha`'
            examples:
            - hcaptcha
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/recaptcha'
                - description: CAPTCHA settings returned for admin registration
                  examples:
                  - '{"flavor":"google","required":true,"sitekey":"6LdAewsTAAAAAE25XKQhPEQ2FiMTft-WrZXQ5NUd"}'
                  - '{"flavor":"hcaptcha","required":true,"sitekey":"6LdAewsTAAAAAE25XKQhPEQ2FiMTft-WrZXQ5NUd"}'
                contentMediaType: application/json
              examples:
                Google:
                  value:
                    flavor: google
                    required: true
                    sitekey: '6LdAewsTAAAAAE25XKQhPEQ2FiMTft-WrZXQ5NUd'
                Hcaptcha:
                  value:
                    flavor: hcaptcha
                    required: true
                    sitekey: '6LdAewsTAAAAAE25XKQhPEQ2FiMTft-WrZXQ5NUd'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/recaptcha'
                - description: CAPTCHA settings returned for admin registration
                  examples:
                  - '{"flavor":"google","required":true,"sitekey":"6LdAewsTAAAAAE25XKQhPEQ2FiMTft-WrZXQ5NUd"}'
                  - '{"flavor":"hcaptcha","required":true,"sitekey":"6LdAewsTAAAAAE25XKQhPEQ2FiMTft-WrZXQ5NUd"}'
                contentMediaType: application/vnd.api+json
              examples:
                Google:
                  value:
                    flavor: google
                    required: true
                    sitekey: '6LdAewsTAAAAAE25XKQhPEQ2FiMTft-WrZXQ5NUd'
                Hcaptcha:
                  value:
                    flavor: hcaptcha
                    required: true
                    sitekey: '6LdAewsTAAAAAE25XKQhPEQ2FiMTft-WrZXQ5NUd'
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
      security: []
    parameters: []
  /api/v1/register/verify/{token}:
    post:
      tags:
      - Admins
      summary: verifyRegistration
      description: Verify a new administrator registration using the token from the registration email. This public endpoint does not require authentication. A successful verification creates a login session and may also apply a pending invitation; the response indicates whether an invitation could not be applied automatically.
      operationId: verifyRegistration
      parameters:
      - name: token
        in: path
        description: ''
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers:
            Set-Cookie:
              content:
                text/plain:
                  schema:
                    type: string
                    examples:
                    - csrftoken=vwvBuq9qkqaKh7lu8tNc0gkvBfEaLAmx; expires=Tue, 15-Mar-2016 19:47:20 GMT; Max-Age=31449600; Path=/
                    contentMediaType: text/plain
                  example: csrftoken=vwvBuq9qkqaKh7lu8tNc0gkvBfEaLAmx; expires=Tue, 15-Mar-2016 19:47:20 GMT; Max-Age=31449600; Path=/
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_verify_token_success'
                - description: Successful registration token verification response
                  examples:
                  - '{"return_to":"https://mist.zendesk.com/hc/quickstart.pdf"}'
                  - '{"detail":"password policy not met","invite_not_applied":true,"min_length":8}'
                contentMediaType: application/json
              examples:
                Success:
                  value:
                    return_to: https://mist.zendesk.com/hc/quickstart.pdf
                success-but-failed-to-apply_the-invitation-automatically:
                  value:
                    detail: password policy not met
                    invite_not_applied: true
                    min_length: 8
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_verify_token_success'
                - description: Successful registration token verification response
                  examples:
                  - '{"return_to":"https://mist.zendesk.com/hc/quickstart.pdf"}'
                  - '{"detail":"password policy not met","invite_not_applied":true,"min_length":8}'
                contentMediaType: application/vnd.api+json
              examples:
                Success:
                  value:
                    return_to: https://mist.zendesk.com/hc/quickstart.pdf
                success-but-failed-to-apply_the-invitation-automatically:
                  value:
                    detail: password policy not met
                    invite_not_applied: true
                    min_length: 8
        '400':
          description: Response if verification expired or already registered
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_detail_string'
                - description: Response containing a human-readable detail message
                  examples:
                  - '{"detail":"already registered"}'
                  - '{"detail":"expired"}'
                contentMediaType: application/json
              examples:
                Already Registered:
                  value:
                    detail: already registered
                Verification Expired:
                  value:
                    detail: expired
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_detail_string'
                - description: Response containing a human-readable detail message
                  examples:
                  - '{"detail":"already registered"}'
                  - '{"detail":"expired"}'
                contentMediaType: application/vnd.api+json
              examples:
                Already Registered:
                  value:
                    detail: already registered
                Verification Expired:
                  value:
                    detail: expired
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Response if secret is invalid
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_detail_string'
                - description: Response containing a human-readable detail message
                  examples:
                  - detail: Not found.
                contentMediaType: application/json
              examples:
                Not Found:
                  value:
                    detail: Not found.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_detail_string'
                - description: Response containing a human-readable detail message
                  examples:
                  - detail: Not found.
                contentMediaType: application/vnd.api+json
              examples:
                Not Found:
                  value:
                    detail: Not found.
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
      security: []
    parameters: []
  /api/v1/login:
    post:
      tags:
      - Admins Login
      summary: login
      description: >-
        Authenticate an administrator with email and password. A successful login creates the browser session cookies, including the `csrftoken` value used with the `X-CSRFToken` header on later API requests.


        When 2FA is enabled, either include the `two_factor` code in this request or submit the first factor here and complete the login with [Two Factor]($e/Admins%20Login/twoFactor).
      operationId: login
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/login'
              - examples:
                - '{"email":"test@mistsys.com","password":"foryoureyesonly","two_factor":"123456"}'
                - '{"email":"test@mistsys.com","password":"foryoureyesonly"}'
              contentMediaType: application/json
            examples:
              with-2FA:
                value:
                  email: test@mistsys.com
                  password: foryoureyesonly
                  two_factor: '123456'
              without-2FA:
                value:
                  email: test@mistsys.com
                  password: foryoureyesonly
        required: false
      responses:
        '200':
          description: Login Success
          headers:
            Set-Cookie:
              description: Session Cookie if login/password authentication is successful
              content:
                text/plain:
                  schema:
                    type: string
                    description: Session Cookie if login/password authentication is successful
                    examples:
                    - csrftoken=vwvBuq9qkqaKh7lu8tNc0gkvBfEaLAmx; expires=Tue, 15-Mar-2016 19:47:20 GMT; Max-Age=31449600; Path=/
                    contentMediaType: text/plain
                  example: csrftoken=vwvBuq9qkqaKh7lu8tNc0gkvBfEaLAmx; expires=Tue, 15-Mar-2016 19:47:20 GMT; Max-Age=31449600; Path=/
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_login_success'
                - description: Login response body, empty on normal success or populated with two-factor state
                  examples:
                  - '{"email":"test@mistsys.com","two_factor_passed":false,"two_factor_required":true}'
                  - '{}'
                contentMediaType: application/json
              examples:
                2FA-required:
                  value:
                    email: test@mistsys.com
                    two_factor_passed: false
                    two_factor_required: true
                OK:
                  value: {}
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_login_success'
                - description: Login response body, empty on normal success or populated with two-factor state
                  examples:
                  - '{"email":"test@mistsys.com","two_factor_passed":false,"two_factor_required":true}'
                  - '{}'
                contentMediaType: application/vnd.api+json
              examples:
                2FA-required:
                  value:
                    email: test@mistsys.com
                    two_factor_passed: false
                    two_factor_required: true
                OK:
                  value: {}
        '400':
          description: Login Failed
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_login_failure'
                - description: Login failure response returned when authentication cannot continue locally
                  examples:
                  - detail: sso admin login needs to be initiated by IdP
                    forward_url: https://my.sso/idp_sso_url
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: sso admin login needs to be initiated by IdP
                    forward_url: https://my.sso/idp_sso_url
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_login_failure'
                - description: Login failure response returned when authentication cannot continue locally
                  examples:
                  - detail: sso admin login needs to be initiated by IdP
                    forward_url: https://my.sso/idp_sso_url
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: sso admin login needs to be initiated by IdP
                    forward_url: https://my.sso/idp_sso_url
      deprecated: false
      security: []
    parameters: []
  /api/v1/login/two_factor:
    post:
      tags:
      - Admins Login
      summary: twoFactor
      description: Complete a two-factor login by submitting the 2FA code after the initial email/password step has created a pending login session.
      operationId: twoFactor
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/two_factor_string'
              - examples:
                - two_factor: '123456'
              contentMediaType: application/json
            examples:
              Example:
                value:
                  two_factor: '123456'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: two_factor code is incorrect or the user hasn't login yet
          headers: {}
          content: {}
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: The user doesn't have 2FA enabled
          headers: {}
          content: {}
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
      security: []
    parameters: []
  /api/v1/logout:
    post:
      tags:
      - Admins Logout
      summary: logout
      description: End the current authenticated administrator session and invalidate the related login cookies.
      operationId: logout
      parameters: []
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_logout'
                - description: Logout response with optional SSO forwarding URL
                  examples:
                  - forward_url: https://my.sso/custom_logout_url
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    forward_url: https://my.sso/custom_logout_url
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_logout'
                - description: Logout response with optional SSO forwarding URL
                  examples:
                  - forward_url: https://my.sso/custom_logout_url
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    forward_url: https://my.sso/custom_logout_url
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/recover:
    post:
      tags:
      - Admins Recover Password
      summary: recoverPassword
      description: Start password recovery for an administrator account. This public endpoint does not require authentication. When the request is accepted, Mist sends an email containing a recovery link such as `https://manage.mist.com/verify/recover?token=:token`. If CAPTCHA is required, include the CAPTCHA response token and provider flavor in the request body.
      operationId: recoverPassword
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/recover'
              - examples:
                - email: test@mistsys.com
                  recaptcha: string
                  recaptcha_flavor: hcaptcha
              contentMediaType: application/json
            examples:
              Example:
                value:
                  email: test@mistsys.com
                  recaptcha: string
                  recaptcha_flavor: hcaptcha
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
      security: []
    parameters: []
  /api/v1/recover/verify/{token}:
    post:
      tags:
      - Admins Recover Password
      summary: verifyRecoverPassword
      description: Verify a password recovery token from the recovery email. This public endpoint does not require authentication. When the token is valid, the user is authenticated for the recovery flow so the client can prompt for and submit a new password.
      operationId: verifyRecoverPassword
      parameters:
      - name: token
        in: path
        description: ''
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
      security: []
    parameters: []
  /api/v1/login/lookup:
    post:
      tags:
      - Admins Lookup
      summary: lookup
      description: Check the login method for an administrator email address. This public lookup is mainly used by UI clients to determine whether the user should continue with local login or be redirected to SSO.
      operationId: lookup
      parameters: []
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/email_string'
              - description: Request Body
                examples:
                - email: test@mistsys.com
              contentMediaType: application/json
            examples:
              Example:
                value:
                  email: test@mistsys.com
        required: false
      responses:
        '200':
          description: Account exists
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_login_lookup'
                - description: Login lookup response indicating whether SSO is available for the account
                  examples:
                  - '{"sso_url":"https://my.sso/idp_sso_url"}'
                  - '{}'
                contentMediaType: application/json
              examples:
                SSO_user_exists:
                  value:
                    sso_url: https://my.sso/idp_sso_url
                local_user_exists:
                  value: {}
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_login_lookup'
                - description: Login lookup response indicating whether SSO is available for the account
                  examples:
                  - '{"sso_url":"https://my.sso/idp_sso_url"}'
                  - '{}'
                contentMediaType: application/vnd.api+json
              examples:
                SSO_user_exists:
                  value:
                    sso_url: https://my.sso/idp_sso_url
                local_user_exists:
                  value: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: User does not exist
          headers: {}
          content: {}
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
      security: []
    parameters: []
  /api/v1/login/oauth/{provider}:
    delete:
      tags:
      - Admins Login - OAuth2
      summary: unlinkOauth2Provider
      description: Unlink the specified OAuth2 provider from the authenticated administrator account so it can no longer be used for that account's OAuth login.
      operationId: unlinkOauth2Provider
      parameters:
      - name: provider
        in: path
        description: Oauth2 provider name
        required: true
        schema:
          type: string
          examples:
          - google
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Admins Login - OAuth2
      summary: getOauth2AuthorizationUrlForLogin
      description: Return the provider authorization URL used to start an OAuth2 login or account-linking flow. When `forward` is provided, the provider redirects back to that callback URL after authorization.
      operationId: getOauth2AuthorizationUrlForLogin
      parameters:
      - name: provider
        in: path
        description: Oauth2 provider name
        required: true
        schema:
          type: string
          examples:
          - google
      - name: forward
        in: query
        description: Callback URL used after completing the OAuth login flow
        style: form
        explode: true
        schema:
          type: string
          examples:
          - https://manage.mist.com/oauth/callback.html
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_login_oauth_url'
                - description: OAuth2 authorization URL response for login
                  examples:
                  - authorization_url: https://accounts.google.com/o/oauth2/v2/auth?.....
                    client_id: 173131512-mpbnju32.apps.googleusercontent.com
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    authorization_url: https://accounts.google.com/o/oauth2/v2/auth?.....
                    client_id: 173131512-mpbnju32.apps.googleusercontent.com
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_login_oauth_url'
                - description: OAuth2 authorization URL response for login
                  examples:
                  - authorization_url: https://accounts.google.com/o/oauth2/v2/auth?.....
                    client_id: 173131512-mpbnju32.apps.googleusercontent.com
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    authorization_url: https://accounts.google.com/o/oauth2/v2/auth?.....
                    client_id: 173131512-mpbnju32.apps.googleusercontent.com
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
      security: []
    post:
      tags:
      - Admins Login - OAuth2
      summary: loginOauth2
      description: Complete an OAuth2 login by exchanging the provider authorization code for a Mist administrator session.
      operationId: loginOauth2
      parameters:
      - name: provider
        in: path
        description: Oauth2 provider name
        required: true
        schema:
          type: string
          examples:
          - google
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/code_string'
              - description: Request Body
                examples:
                - code: 4/S9tegDeLkrYg0L9pWNXV4cgMVbbr3SR9t693A2kSHzw
              contentMediaType: application/json
            examples:
              Example:
                value:
                  code: 4/S9tegDeLkrYg0L9pWNXV4cgMVbbr3SR9t693A2kSHzw
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
      security: []
    parameters: []
  /api/v1/installer/orgs/{org_id}/alarmtemplates:
    get:
      tags:
      - Installer
      summary: listInstallerAlarmTemplates
      description: Return alarm templates available to installer workflows in the organization.
      operationId: listInstallerAlarmTemplates
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Installer List of Alarm Templates
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/installers_item'
                description: Installer access entries returned by list responses
                examples:
                - - id: 684dfc5c-fe77-2290-eb1d-ef3d677fe168
                    name: AlarmTemplate 1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - id: 684dfc5c-fe77-2290-eb1d-ef3d677fe168
                    name: AlarmTemplate 1
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/installers_item'
                description: Installer access entries returned by list responses
                examples:
                - - id: 684dfc5c-fe77-2290-eb1d-ef3d677fe168
                    name: AlarmTemplate 1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - id: 684dfc5c-fe77-2290-eb1d-ef3d677fe168
                    name: AlarmTemplate 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/installer/orgs/{org_id}/deviceprofiles:
    get:
      tags:
      - Installer
      summary: listInstallerDeviceProfiles
      description: Return device profiles that installers can use when provisioning recently claimed devices, optionally filtered by device type.
      operationId: listInstallerDeviceProfiles
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: type
        in: query
        description: 'Filter results by type. enum: `ap`, `gateway`, `switch`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/device_type_default_ap'
          - description: 'Filter results by type. enum: `ap`, `gateway`, `switch`'
      responses:
        '200':
          description: Installer List of Device Profiles
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/installers_item'
                description: Installer access entries returned by list responses
                examples:
                - - id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                    name: DeviceProfile 1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                    name: DeviceProfile 1
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/installers_item'
                description: Installer access entries returned by list responses
                examples:
                - - id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                    name: DeviceProfile 1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                    name: DeviceProfile 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/installer/orgs/{org_id}/devices:
    get:
      tags:
      - Installer
      summary: listInstallerListOfRecentlyClaimedDevices
      description: Return recently claimed devices visible to installer workflows, with optional filters for model, site name, or site identifier.
      operationId: listInstallerListOfRecentlyClaimedDevices
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: model
        in: query
        description: Filter results by device model
        style: form
        explode: true
        schema:
          type: string
          examples:
          - AP43
      - name: site_name
        in: query
        description: Filter results by site name
        style: form
        explode: true
        schema:
          type: string
          examples:
          - SJ1
      - name: site_id
        in: query
        description: Filter results by site identifier
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 72771e6a-6f5e-4de4-a5b9-1266c4197811
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: List of Devices Recently Claimed
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/installer_device'
                description: Recently claimed devices available to installer workflows
                examples:
                - - connected: true
                    deviceprofile_name: SJ1
                    height: 2.7
                    mac: 5c5b35000018
                    map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                    model: AP41
                    name: hallway
                    orientation: 90
                    serial: FXLH2015150025
                    site_name: SJ1
                    x: 150
                    y: 300
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - connected: true
                    deviceprofile_name: SJ1
                    height: 2.7
                    mac: 5c5b35000018
                    map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                    model: AP41
                    name: hallway
                    orientation: 90
                    serial: FXLH2015150025
                    site_name: SJ1
                    x: 150
                    y: 300
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/installer_device'
                description: Recently claimed devices available to installer workflows
                examples:
                - - connected: true
                    deviceprofile_name: SJ1
                    height: 2.7
                    mac: 5c5b35000018
                    map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                    model: AP41
                    name: hallway
                    orientation: 90
                    serial: FXLH2015150025
                    site_name: SJ1
                    x: 150
                    y: 300
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - connected: true
                    deviceprofile_name: SJ1
                    height: 2.7
                    mac: 5c5b35000018
                    map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                    model: AP41
                    name: hallway
                    orientation: 90
                    serial: FXLH2015150025
                    site_name: SJ1
                    x: 150
                    y: 300
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Installer
      summary: claimInstallerDevices
      description: Claim devices into the organization inventory by activation code through the installer workflow.
      operationId: claimInstallerDevices
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              uniqueItems: true
              type: array
              items:
                type: string
              description: Request Body
              examples:
              - - 6JG8E-PTFV2-A9Z2N
                - DVH4V-SNMSZ-PDXBR
              contentMediaType: application/json
            examples:
              Example:
                value:
                - 6JG8E-PTFV2-A9Z2N
                - DVH4V-SNMSZ-PDXBR
        required: false
      responses:
        '200':
          description: OK - if any of entries are valid or there’s no errors
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_inventory'
                - description: Result of adding device claim codes to organization inventory
                  examples:
                  - added:
                    - 6JG8E-PTFV2-A9Z2N
                    duplicated:
                    - DVH4V-SNMSZ-PDXBR
                    error:
                    - PO1025335ohoh
                    inventory_added:
                    - mac: 5c5b35000018
                      magic: 6JG8EPTFV2A9Z2N
                      model: AP41
                      serial: FXLH2015150025
                      type: ap
                    inventory_duplicated:
                    - mac: 5c5b35000012
                      magic: DVH4VSNMSZPDXBR
                      model: AP41
                      serial: FXLH2015150027
                      type: ap
                    reason:
                    - belongs to another org ('e2f543f7-d6e1-409f-a565-e77a1f098d3b' (other) != '0de5d6fc-219a-414d-a840-67d6b919ad8f' (you))
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    added:
                    - 6JG8E-PTFV2-A9Z2N
                    duplicated:
                    - DVH4V-SNMSZ-PDXBR
                    error:
                    - PO1025335ohoh
                    inventory_added:
                    - mac: 5c5b35000018
                      magic: 6JG8EPTFV2A9Z2N
                      model: AP41
                      serial: FXLH2015150025
                      type: ap
                    inventory_duplicated:
                    - mac: 5c5b35000012
                      magic: DVH4VSNMSZPDXBR
                      model: AP41
                      serial: FXLH2015150027
                      type: ap
                    reason:
                    - belongs to another org ('e2f543f7-d6e1-409f-a565-e77a1f098d3b' (other) != '0de5d6fc-219a-414d-a840-67d6b919ad8f' (you))
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_inventory'
                - description: Result of adding device claim codes to organization inventory
                  examples:
                  - added:
                    - 6JG8E-PTFV2-A9Z2N
                    duplicated:
                    - DVH4V-SNMSZ-PDXBR
                    error:
                    - PO1025335ohoh
                    inventory_added:
                    - mac: 5c5b35000018
                      magic: 6JG8EPTFV2A9Z2N
                      model: AP41
                      serial: FXLH2015150025
                      type: ap
                    inventory_duplicated:
                    - mac: 5c5b35000012
                      magic: DVH4VSNMSZPDXBR
                      model: AP41
                      serial: FXLH2015150027
                      type: ap
                    reason:
                    - belongs to another org ('e2f543f7-d6e1-409f-a565-e77a1f098d3b' (other) != '0de5d6fc-219a-414d-a840-67d6b919ad8f' (you))
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    added:
                    - 6JG8E-PTFV2-A9Z2N
                    duplicated:
                    - DVH4V-SNMSZ-PDXBR
                    error:
                    - PO1025335ohoh
                    inventory_added:
                    - mac: 5c5b35000018
                      magic: 6JG8EPTFV2A9Z2N
                      model: AP41
                      serial: FXLH2015150025
                      type: ap
                    inventory_duplicated:
                    - mac: 5c5b35000012
                      magic: DVH4VSNMSZPDXBR
                      model: AP41
                      serial: FXLH2015150027
                      type: ap
                    reason:
                    - belongs to another org ('e2f543f7-d6e1-409f-a565-e77a1f098d3b' (other) != '0de5d6fc-219a-414d-a840-67d6b919ad8f' (you))
        '400':
          description: OK - if any of entries are valid or there’s no errors
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_inventory'
                - description: Result of adding device claim codes to organization inventory
                  examples:
                  - added:
                    - 6JG8E-PTFV2-A9Z2N
                    duplicated:
                    - DVH4V-SNMSZ-PDXBR
                    error:
                    - PO1025335ohoh
                    inventory_added:
                    - mac: 5c5b35000018
                      magic: 6JG8EPTFV2A9Z2N
                      model: AP41
                      serial: FXLH2015150025
                      type: ap
                    inventory_duplicated:
                    - mac: 5c5b35000012
                      magic: DVH4VSNMSZPDXBR
                      model: AP41
                      serial: FXLH2015150027
                      type: ap
                    reason:
                    - belongs to another org ('e2f543f7-d6e1-409f-a565-e77a1f098d3b' (other) != '0de5d6fc-219a-414d-a840-67d6b919ad8f' (you))
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    added:
                    - 6JG8E-PTFV2-A9Z2N
                    duplicated:
                    - DVH4V-SNMSZ-PDXBR
                    error:
                    - PO1025335ohoh
                    inventory_added:
                    - mac: 5c5b35000018
                      magic: 6JG8EPTFV2A9Z2N
                      model: AP41
                      serial: FXLH2015150025
                      type: ap
                    inventory_duplicated:
                    - mac: 5c5b35000012
                      magic: DVH4VSNMSZPDXBR
                      model: AP41
                      serial: FXLH2015150027
                      type: ap
                    reason:
                    - belongs to another org ('e2f543f7-d6e1-409f-a565-e77a1f098d3b' (other) != '0de5d6fc-219a-414d-a840-67d6b919ad8f' (you))
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_inventory'
                - description: Result of adding device claim codes to organization inventory
                  examples:
                  - added:
                    - 6JG8E-PTFV2-A9Z2N
                    duplicated:
                    - DVH4V-SNMSZ-PDXBR
                    error:
                    - PO1025335ohoh
                    inventory_added:
                    - mac: 5c5b35000018
                      magic: 6JG8EPTFV2A9Z2N
                      model: AP41
                      serial: FXLH2015150025
                      type: ap
                    inventory_duplicated:
                    - mac: 5c5b35000012
                      magic: DVH4VSNMSZPDXBR
                      model: AP41
                      serial: FXLH2015150027
                      type: ap
                    reason:
                    - belongs to another org ('e2f543f7-d6e1-409f-a565-e77a1f098d3b' (other) != '0de5d6fc-219a-414d-a840-67d6b919ad8f' (you))
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    added:
                    - 6JG8E-PTFV2-A9Z2N
                    duplicated:
                    - DVH4V-SNMSZ-PDXBR
                    error:
                    - PO1025335ohoh
                    inventory_added:
                    - mac: 5c5b35000018
                      magic: 6JG8EPTFV2A9Z2N
                      model: AP41
                      serial: FXLH2015150025
                      type: ap
                    inventory_duplicated:
                    - mac: 5c5b35000012
                      magic: DVH4VSNMSZPDXBR
                      model: AP41
                      serial: FXLH2015150027
                      type: ap
                    reason:
                    - belongs to another org ('e2f543f7-d6e1-409f-a565-e77a1f098d3b' (other) != '0de5d6fc-219a-414d-a840-67d6b919ad8f' (you))
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/installer/orgs/{org_id}/devices/{device_mac}:
    delete:
      tags:
      - Installer
      summary: unassignInstallerRecentlyClaimedDevice
      description: Unassign a recently claimed device from its current site so it can be provisioned again through the installer workflow.
      operationId: unassignInstallerRecentlyClaimedDevice
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Installer
      summary: provisionInstallerDevices
      description: "Provision or replace an installer-managed device. \n\nIf replacing_mac is in the request payload, other attributes are ignored, we attempt to replace existing device (with MAC address `replacing_mac`) with the inventory device being configured. The replacement device must be in the inventory but not assigned, and the replacing_mac device must be assigned to a site, and satisfy grace period requirements. The Device replaced will become unassigned."
      operationId: provisionInstallerDevices
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/installer_provision_device'
              - description: Request Body
                examples:
                - deviceprofile_name: SJ1
                  height: 2.7
                  name: SJ1-AP1
                  orientation: 90
                  site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                  site_name: SJ1
                  x: 150
                  y: 300
              contentMediaType: application/json
            examples:
              Example:
                value:
                  deviceprofile_name: SJ1
                  height: 2.7
                  name: SJ1-AP1
                  orientation: 90
                  site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                  site_name: SJ1
                  x: 150
                  y: 300
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_detail_string'
                - description: Response containing a human-readable detail message
                  examples:
                  - '{"detail":"invalid replacing_mac"}'
                  - '{"detail":"device already assigned"}'
                  - '{"detail":"outside of grace period"}'
                  - '{"detail":"replacing_mac device is unassigned"}'
                  - '{"detail":"replacing_mac device outside of grace period"}'
                contentMediaType: application/json
              examples:
                Invalid Mac Given For Replacing Mac:
                  value:
                    detail: invalid replacing_mac
                Inventory Device Is Already Assigned:
                  value:
                    detail: device already assigned
                Outside Of Grace Period:
                  value:
                    detail: outside of grace period
                Replacing Mac Device Is Not Assigned To A Site:
                  value:
                    detail: replacing_mac device is unassigned
                Replacing Mac Device Last Modified Outside Of Grace Period:
                  value:
                    detail: replacing_mac device outside of grace period
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_detail_string'
                - description: Response containing a human-readable detail message
                  examples:
                  - '{"detail":"invalid replacing_mac"}'
                  - '{"detail":"device already assigned"}'
                  - '{"detail":"outside of grace period"}'
                  - '{"detail":"replacing_mac device is unassigned"}'
                  - '{"detail":"replacing_mac device outside of grace period"}'
                contentMediaType: application/vnd.api+json
              examples:
                Invalid Mac Given For Replacing Mac:
                  value:
                    detail: invalid replacing_mac
                Inventory Device Is Already Assigned:
                  value:
                    detail: device already assigned
                Outside Of Grace Period:
                  value:
                    detail: outside of grace period
                Replacing Mac Device Is Not Assigned To A Site:
                  value:
                    detail: replacing_mac device is unassigned
                Replacing Mac Device Last Modified Outside Of Grace Period:
                  value:
                    detail: replacing_mac device outside of grace period
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_detail_string'
                - description: Response containing a human-readable detail message
                  examples:
                  - '{"detail":"replacing_mac inventory not found"}'
                  - '{"detail":"replacing_mac device not found"}'
                contentMediaType: application/json
              examples:
                Replacing Mac Device Is Not In Org Inventory:
                  value:
                    detail: replacing_mac inventory not found
                Replacing Mac Device Not Found:
                  value:
                    detail: replacing_mac device not found
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_detail_string'
                - description: Response containing a human-readable detail message
                  examples:
                  - '{"detail":"replacing_mac inventory not found"}'
                  - '{"detail":"replacing_mac device not found"}'
                contentMediaType: application/vnd.api+json
              examples:
                Replacing Mac Device Is Not In Org Inventory:
                  value:
                    detail: replacing_mac inventory not found
                Replacing Mac Device Not Found:
                  value:
                    detail: replacing_mac device not found
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/installer/orgs/{org_id}/devices/{device_mac}/locate:
    post:
      tags:
      - Installer
      summary: startInstallerLocateDevice
      description: Start locating an installer-managed device by blinking its LED. The locate state persists until [Stop Locating Installer Device]($e/Installer/stopInstallerLocateDevice) is called.
      operationId: startInstallerLocateDevice
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/installer/orgs/{org_id}/devices/{device_mac}/unlocate:
    post:
      tags:
      - Installer
      summary: stopInstallerLocateDevice
      description: Stop the locate LED state for an installer-managed device.
      operationId: stopInstallerLocateDevice
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/installer/orgs/{org_id}/devices/{device_mac}/{image_name}:
    delete:
      tags:
      - Installer
      summary: deleteInstallerDeviceImage
      description: Remove a previously uploaded image associated with an installer-managed device, such as an installation photo or device placement image.
      operationId: deleteInstallerDeviceImage
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: image_name
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: device_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Installer
      summary: addInstallerDeviceImage
      description: Upload an image associated with an installer-managed device using `multipart/form-data`.
      operationId: addInstallerDeviceImage
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: image_name
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: device_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              type: object
              properties:
                auto_deviceprofile_assignment:
                  type: boolean
                  description: Whether to auto assign device to deviceprofile by name
                  examples:
                  - true
                csv:
                  type: string
                  description: Optional AP name-mapping CSV file
                  contentEncoding: base64
                file:
                  type: string
                  description: Ekahau or iBwave floorplan file to import
                  contentEncoding: base64
                json:
                  allOf:
                  - $ref: '#/components/schemas/map_import_json1'
                  - description: Import options for the site map file
              contentMediaType: multipart/form-data
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/installer/orgs/{org_id}/devices/{fpc0_mac}/vc:
    get:
      tags:
      - Installer
      summary: getInstallerDeviceVirtualChassis
      description: >-
        Return Virtual Chassis status for an installer-managed switch, including topology and member statistics.


        The response is a combined view of the Virtual Chassis state.
      operationId: getInstallerDeviceVirtualChassis
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: fpc0_mac
        in: path
        description: FPC0 MAC address
        required: true
        schema:
          type: string
          examples:
          - aff827549235
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_virtual_chassis_config'
                - description: Combined virtual chassis status, topology, and member statistics
                  examples:
                  - config_type: nonprovisioned
                    id: 00000000-0000-0000-1000-52d9107af289
                    mac: 52d9107af289
                    members:
                    - boot_partition: junos
                      cpld_version: '6'
                      cpu_stat:
                        idle: 69
                        interrupt: 1
                        load_avg:
                        - 0.8
                        - 1.09
                        - 1.07
                        system: 11
                        user: 19
                      fans:
                      - airflow: out
                        name: Fan Tray 0 Fan 0
                        rpm: 0
                        status: ok
                      - airflow: out
                        name: Fan Tray 1 Fan 0
                        rpm: 0
                        status: ok
                      fpc_idx: 0
                      mac: 52d9107af289
                      memory_stat:
                        usage: 42
                      model: EX2300-48P
                      pics:
                      - index: 0
                        model_number: EX2300-48P
                        port_groups:
                        - count: 48
                          type: GE
                      - index: 1
                        model_number: EX2300-48P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      poe:
                        max_power: 750
                        power_draw: 40.4
                        status: AT_MODE
                      poe_version: 2.1.1.19.3 (type1)
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.4R3-S4.18
                      serial: JW0000000000
                      temperatures:
                      - celsius: 33
                        name: CPU Sensor
                        status: ok
                      - celsius: 29
                        name: PSU Sensor
                        status: ok
                      type: fpc
                      uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800)  1.3.2
                      uptime: 27636720
                      vc_links:
                      - neighbor_module_idx: 1
                        neighbor_port_id: vcp-1/1/0
                        port_id: vcp-0/1/0
                      vc_mode: HiGiG
                      vc_role: master
                      vc_state: present
                      version: 21.4R3-S4.18
                    - boot_partition: junos
                      cpld_version: '6'
                      cpu_stat:
                        idle: 76
                        interrupt: 0
                        load_avg:
                        - 0.96
                        - 0.87
                        - 0.76
                        system: 6
                        user: 17
                      fans:
                      - airflow: out
                        name: Fan Tray 0 Fan 0
                        rpm: 0
                        status: ok
                      - airflow: out
                        name: Fan Tray 1 Fan 0
                        rpm: 0
                        status: ok
                      fpc_idx: 1
                      mac: d0dd4991652d
                      memory_stat:
                        usage: 18
                      model: EX2300-48P
                      pics:
                      - index: 0
                        model_number: EX2300-48P
                        port_groups:
                        - count: 48
                          type: GE
                      - index: 1
                        model_number: EX2300-48P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      poe:
                        max_power: 750
                        power_draw: 21.2
                        status: AT_MODE
                      poe_version: 2.1.1.19.3 (type1)
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.4R3-S4.18
                      serial: JW3619300922
                      temperatures:
                      - celsius: 32
                        name: CPU Sensor
                        status: ok
                      - celsius: 29
                        name: PSU Sensor
                        status: ok
                      type: fpc
                      uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800)  1.3.2
                      uptime: 27636720
                      vc_links:
                      - neighbor_module_idx: 0
                        neighbor_port_id: vcp-0/1/0
                        port_id: vcp-1/1/0
                      vc_mode: HiGiG
                      vc_role: backup
                      vc_state: present
                      version: 21.4R3-S4.18
                    model: EX2300-48P
                    num_routing_engines: 1
                    org_id: 1e9a61a9-bc42-42ca-bf67-1ad87443d9b8
                    serial: JW3619300157
                    site_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b
                    status: connected
                    type: switch
                    vc_mac: 52d9107af289
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    config_type: nonprovisioned
                    id: 00000000-0000-0000-1000-52d9107af289
                    mac: 52d9107af289
                    members:
                    - boot_partition: junos
                      cpld_version: '6'
                      cpu_stat:
                        idle: 69
                        interrupt: 1
                        load_avg:
                        - 0.8
                        - 1.09
                        - 1.07
                        system: 11
                        user: 19
                      fans:
                      - airflow: out
                        name: Fan Tray 0 Fan 0
                        rpm: 0
                        status: ok
                      - airflow: out
                        name: Fan Tray 1 Fan 0
                        rpm: 0
                        status: ok
                      fpc_idx: 0
                      mac: 52d9107af289
                      memory_stat:
                        usage: 42
                      model: EX2300-48P
                      pics:
                      - index: 0
                        model_number: EX2300-48P
                        port_groups:
                        - count: 48
                          type: GE
                      - index: 1
                        model_number: EX2300-48P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      poe:
                        max_power: 750
                        power_draw: 40.4
                        status: AT_MODE
                      poe_version: 2.1.1.19.3 (type1)
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.4R3-S4.18
                      serial: JW0000000000
                      temperatures:
                      - celsius: 33
                        name: CPU Sensor
                        status: ok
                      - celsius: 29
                        name: PSU Sensor
                        status: ok
                      type: fpc
                      uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800)  1.3.2
                      uptime: 27636720
                      vc_links:
                      - neighbor_module_idx: 1
                        neighbor_port_id: vcp-1/1/0
                        port_id: vcp-0/1/0
                      vc_mode: HiGiG
                      vc_role: master
                      vc_state: present
                      version: 21.4R3-S4.18
                    - boot_partition: junos
                      cpld_version: '6'
                      cpu_stat:
                        idle: 76
                        interrupt: 0
                        load_avg:
                        - 0.96
                        - 0.87
                        - 0.76
                        system: 6
                        user: 17
                      fans:
                      - airflow: out
                        name: Fan Tray 0 Fan 0
                        rpm: 0
                        status: ok
                      - airflow: out
                        name: Fan Tray 1 Fan 0
                        rpm: 0
                        status: ok
                      fpc_idx: 1
                      mac: d0dd4991652d
                      memory_stat:
                        usage: 18
                      model: EX2300-48P
                      pics:
                      - index: 0
                        model_number: EX2300-48P
                        port_groups:
                        - count: 48
                          type: GE
                      - index: 1
                        model_number: EX2300-48P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      poe:
                        max_power: 750
                        power_draw: 21.2
                        status: AT_MODE
                      poe_version: 2.1.1.19.3 (type1)
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.4R3-S4.18
                      serial: JW3619300922
                      temperatures:
                      - celsius: 32
                        name: CPU Sensor
                        status: ok
                      - celsius: 29
                        name: PSU Sensor
                        status: ok
                      type: fpc
                      uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800)  1.3.2
                      uptime: 27636720
                      vc_links:
                      - neighbor_module_idx: 0
                        neighbor_port_id: vcp-0/1/0
                        port_id: vcp-1/1/0
                      vc_mode: HiGiG
                      vc_role: backup
                      vc_state: present
                      version: 21.4R3-S4.18
                    model: EX2300-48P
                    num_routing_engines: 1
                    org_id: 1e9a61a9-bc42-42ca-bf67-1ad87443d9b8
                    serial: JW3619300157
                    site_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b
                    status: connected
                    type: switch
                    vc_mac: 52d9107af289
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_virtual_chassis_config'
                - description: Combined virtual chassis status, topology, and member statistics
                  examples:
                  - config_type: nonprovisioned
                    id: 00000000-0000-0000-1000-52d9107af289
                    mac: 52d9107af289
                    members:
                    - boot_partition: junos
                      cpld_version: '6'
                      cpu_stat:
                        idle: 69
                        interrupt: 1
                        load_avg:
                        - 0.8
                        - 1.09
                        - 1.07
                        system: 11
                        user: 19
                      fans:
                      - airflow: out
                        name: Fan Tray 0 Fan 0
                        rpm: 0
                        status: ok
                      - airflow: out
                        name: Fan Tray 1 Fan 0
                        rpm: 0
                        status: ok
                      fpc_idx: 0
                      mac: 52d9107af289
                      memory_stat:
                        usage: 42
                      model: EX2300-48P
                      pics:
                      - index: 0
                        model_number: EX2300-48P
                        port_groups:
                        - count: 48
                          type: GE
                      - index: 1
                        model_number: EX2300-48P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      poe:
                        max_power: 750
                        power_draw: 40.4
                        status: AT_MODE
                      poe_version: 2.1.1.19.3 (type1)
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.4R3-S4.18
                      serial: JW0000000000
                      temperatures:
                      - celsius: 33
                        name: CPU Sensor
                        status: ok
                      - celsius: 29
                        name: PSU Sensor
                        status: ok
                      type: fpc
                      uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800)  1.3.2
                      uptime: 27636720
                      vc_links:
                      - neighbor_module_idx: 1
                        neighbor_port_id: vcp-1/1/0
                        port_id: vcp-0/1/0
                      vc_mode: HiGiG
                      vc_role: master
                      vc_state: present
                      version: 21.4R3-S4.18
                    - boot_partition: junos
                      cpld_version: '6'
                      cpu_stat:
                        idle: 76
                        interrupt: 0
                        load_avg:
                        - 0.96
                        - 0.87
                        - 0.76
                        system: 6
                        user: 17
                      fans:
                      - airflow: out
                        name: Fan Tray 0 Fan 0
                        rpm: 0
                        status: ok
                      - airflow: out
                        name: Fan Tray 1 Fan 0
                        rpm: 0
                        status: ok
                      fpc_idx: 1
                      mac: d0dd4991652d
                      memory_stat:
                        usage: 18
                      model: EX2300-48P
                      pics:
                      - index: 0
                        model_number: EX2300-48P
                        port_groups:
                        - count: 48
                          type: GE
                      - index: 1
                        model_number: EX2300-48P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      poe:
                        max_power: 750
                        power_draw: 21.2
                        status: AT_MODE
                      poe_version: 2.1.1.19.3 (type1)
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.4R3-S4.18
                      serial: JW3619300922
                      temperatures:
                      - celsius: 32
                        name: CPU Sensor
                        status: ok
                      - celsius: 29
                        name: PSU Sensor
                        status: ok
                      type: fpc
                      uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800)  1.3.2
                      uptime: 27636720
                      vc_links:
                      - neighbor_module_idx: 0
                        neighbor_port_id: vcp-0/1/0
                        port_id: vcp-1/1/0
                      vc_mode: HiGiG
                      vc_role: backup
                      vc_state: present
                      version: 21.4R3-S4.18
                    model: EX2300-48P
                    num_routing_engines: 1
                    org_id: 1e9a61a9-bc42-42ca-bf67-1ad87443d9b8
                    serial: JW3619300157
                    site_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b
                    status: connected
                    type: switch
                    vc_mac: 52d9107af289
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    config_type: nonprovisioned
                    id: 00000000-0000-0000-1000-52d9107af289
                    mac: 52d9107af289
                    members:
                    - boot_partition: junos
                      cpld_version: '6'
                      cpu_stat:
                        idle: 69
                        interrupt: 1
                        load_avg:
                        - 0.8
                        - 1.09
                        - 1.07
                        system: 11
                        user: 19
                      fans:
                      - airflow: out
                        name: Fan Tray 0 Fan 0
                        rpm: 0
                        status: ok
                      - airflow: out
                        name: Fan Tray 1 Fan 0
                        rpm: 0
                        status: ok
                      fpc_idx: 0
                      mac: 52d9107af289
                      memory_stat:
                        usage: 42
                      model: EX2300-48P
                      pics:
                      - index: 0
                        model_number: EX2300-48P
                        port_groups:
                        - count: 48
                          type: GE
                      - index: 1
                        model_number: EX2300-48P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      poe:
                        max_power: 750
                        power_draw: 40.4
                        status: AT_MODE
                      poe_version: 2.1.1.19.3 (type1)
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.4R3-S4.18
                      serial: JW0000000000
                      temperatures:
                      - celsius: 33
                        name: CPU Sensor
                        status: ok
                      - celsius: 29
                        name: PSU Sensor
                        status: ok
                      type: fpc
                      uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800)  1.3.2
                      uptime: 27636720
                      vc_links:
                      - neighbor_module_idx: 1
                        neighbor_port_id: vcp-1/1/0
                        port_id: vcp-0/1/0
                      vc_mode: HiGiG
                      vc_role: master
                      vc_state: present
                      version: 21.4R3-S4.18
                    - boot_partition: junos
                      cpld_version: '6'
                      cpu_stat:
                        idle: 76
                        interrupt: 0
                        load_avg:
                        - 0.96
                        - 0.87
                        - 0.76
                        system: 6
                        user: 17
                      fans:
                      - airflow: out
                        name: Fan Tray 0 Fan 0
                        rpm: 0
                        status: ok
                      - airflow: out
                        name: Fan Tray 1 Fan 0
                        rpm: 0
                        status: ok
                      fpc_idx: 1
                      mac: d0dd4991652d
                      memory_stat:
                        usage: 18
                      model: EX2300-48P
                      pics:
                      - index: 0
                        model_number: EX2300-48P
                        port_groups:
                        - count: 48
                          type: GE
                      - index: 1
                        model_number: EX2300-48P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      poe:
                        max_power: 750
                        power_draw: 21.2
                        status: AT_MODE
                      poe_version: 2.1.1.19.3 (type1)
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.4R3-S4.18
                      serial: JW3619300922
                      temperatures:
                      - celsius: 32
                        name: CPU Sensor
                        status: ok
                      - celsius: 29
                        name: PSU Sensor
                        status: ok
                      type: fpc
                      uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800)  1.3.2
                      uptime: 27636720
                      vc_links:
                      - neighbor_module_idx: 0
                        neighbor_port_id: vcp-0/1/0
                        port_id: vcp-1/1/0
                      vc_mode: HiGiG
                      vc_role: backup
                      vc_state: present
                      version: 21.4R3-S4.18
                    model: EX2300-48P
                    num_routing_engines: 1
                    org_id: 1e9a61a9-bc42-42ca-bf67-1ad87443d9b8
                    serial: JW3619300157
                    site_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b
                    status: connected
                    type: switch
                    vc_mac: 52d9107af289
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Installer
      summary: createInstallerVirtualChassis
      description: >-
        For models (e.g. EX3400 and up) having dedicated VC ports, it is easier to form a VC by just connecting cables with the dedicated VC ports. Cloud will detect the new VC and update the inventory.


        In case that the user would like to choose the dedicated switch as a VC master or for EX2300-C-12P and EX2300-C-12T which doesn't have dedicated VC ports, below are procedures to automate the VC creation:


        1. Power on the switch that is chosen as the VC master first. And then powering on the other member switches.

        2. Claim or adopt all these switches under the same organization’s Inventory

        3. Assign these switches into the same Site

        4. Invoke vc command on the switch chosen to be the VC master. For EX2300-C-12P, VC ports will be created automatically.

        5. Connect the cables to the VC ports for these switches

        6. Wait for the VC to be formed. The Org’s inventory will be updated for the new VC.
      operationId: createInstallerVirtualChassis
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: fpc0_mac
        in: path
        description: FPC0 MAC address
        required: true
        schema:
          type: string
          examples:
          - aff827549235
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/virtual_chassis_config'
              - description: Request Body
                examples:
                - '{"members":[{"mac":"aff827549235","vc_ports":["xe-0/1/0","xe-0/1/1"],"vc_role":"master"},{"mac":"8396cd006c8c","vc_ports":["xe-0/1/0","xe-0/1/1"],"vc_role":"backup"},{"mac":"8396cd00888c","vc_ports":["xe-0/1/0","xe-0/1/1"],"vc_role":"linecard"}]}'
                - '{"members":[{"mac":"aff827549235","member_id":0,"vc_ports":["xe-0/1/0","xe-0/1/1"],"vc_role":"master"},{"mac":"8396cd006c8c","member_id":1,"vc_ports":["xe-0/1/0","xe-0/1/1"],"vc_role":"linecard"},{"mac":"8396cd00888c","member_id":2,"vc_ports":["xe-0/1/0","xe-0/1/1"],"vc_role":"backup"}],"preprovisioned":true}'
              contentMediaType: application/json
            examples:
              create-a-VC-with-three-members:
                value:
                  members:
                  - mac: aff827549235
                    vc_ports:
                    - xe-0/1/0
                    - xe-0/1/1
                    vc_role: master
                  - mac: 8396cd006c8c
                    vc_ports:
                    - xe-0/1/0
                    - xe-0/1/1
                    vc_role: backup
                  - mac: 8396cd00888c
                    vc_ports:
                    - xe-0/1/0
                    - xe-0/1/1
                    vc_role: linecard
              create-a-pre-provisioned-VC-with-three-members:
                value:
                  members:
                  - mac: aff827549235
                    member_id: 0
                    vc_ports:
                    - xe-0/1/0
                    - xe-0/1/1
                    vc_role: master
                  - mac: 8396cd006c8c
                    member_id: 1
                    vc_ports:
                    - xe-0/1/0
                    - xe-0/1/1
                    vc_role: linecard
                  - mac: 8396cd00888c
                    member_id: 2
                    vc_ports:
                    - xe-0/1/0
                    - xe-0/1/1
                    vc_role: backup
                  preprovisioned: true
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_virtual_chassis_config'
                - description: Combined virtual chassis status, topology, and member statistics
                  examples:
                  - config_type: nonprovisioned
                    id: 00000000-0000-0000-1000-52d9107af289
                    mac: 52d9107af289
                    members:
                    - boot_partition: junos
                      cpld_version: '6'
                      cpu_stat:
                        idle: 69
                        interrupt: 1
                        load_avg:
                        - 0.8
                        - 1.09
                        - 1.07
                        system: 11
                        user: 19
                      fans:
                      - airflow: out
                        name: Fan Tray 0 Fan 0
                        rpm: 0
                        status: ok
                      - airflow: out
                        name: Fan Tray 1 Fan 0
                        rpm: 0
                        status: ok
                      fpc_idx: 0
                      mac: 52d9107af289
                      memory_stat:
                        usage: 42
                      model: EX2300-48P
                      pics:
                      - index: 0
                        model_number: EX2300-48P
                        port_groups:
                        - count: 48
                          type: GE
                      - index: 1
                        model_number: EX2300-48P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      poe:
                        max_power: 750
                        power_draw: 40.4
                        status: AT_MODE
                      poe_version: 2.1.1.19.3 (type1)
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.4R3-S4.18
                      serial: JW0000000000
                      temperatures:
                      - celsius: 33
                        name: CPU Sensor
                        status: ok
                      - celsius: 29
                        name: PSU Sensor
                        status: ok
                      type: fpc
                      uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800)  1.3.2
                      uptime: 27636720
                      vc_links:
                      - neighbor_module_idx: 1
                        neighbor_port_id: vcp-1/1/0
                        port_id: vcp-0/1/0
                      vc_mode: HiGiG
                      vc_role: master
                      vc_state: present
                      version: 21.4R3-S4.18
                    - boot_partition: junos
                      cpld_version: '6'
                      cpu_stat:
                        idle: 76
                        interrupt: 0
                        load_avg:
                        - 0.96
                        - 0.87
                        - 0.76
                        system: 6
                        user: 17
                      fans:
                      - airflow: out
                        name: Fan Tray 0 Fan 0
                        rpm: 0
                        status: ok
                      - airflow: out
                        name: Fan Tray 1 Fan 0
                        rpm: 0
                        status: ok
                      fpc_idx: 1
                      mac: d0dd4991652d
                      memory_stat:
                        usage: 18
                      model: EX2300-48P
                      pics:
                      - index: 0
                        model_number: EX2300-48P
                        port_groups:
                        - count: 48
                          type: GE
                      - index: 1
                        model_number: EX2300-48P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      poe:
                        max_power: 750
                        power_draw: 21.2
                        status: AT_MODE
                      poe_version: 2.1.1.19.3 (type1)
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.4R3-S4.18
                      serial: JW3619300922
                      temperatures:
                      - celsius: 32
                        name: CPU Sensor
                        status: ok
                      - celsius: 29
                        name: PSU Sensor
                        status: ok
                      type: fpc
                      uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800)  1.3.2
                      uptime: 27636720
                      vc_links:
                      - neighbor_module_idx: 0
                        neighbor_port_id: vcp-0/1/0
                        port_id: vcp-1/1/0
                      vc_mode: HiGiG
                      vc_role: backup
                      vc_state: present
                      version: 21.4R3-S4.18
                    model: EX2300-48P
                    num_routing_engines: 1
                    org_id: 1e9a61a9-bc42-42ca-bf67-1ad87443d9b8
                    serial: JW3619300157
                    site_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b
                    status: connected
                    type: switch
                    vc_mac: 52d9107af289
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    config_type: nonprovisioned
                    id: 00000000-0000-0000-1000-52d9107af289
                    mac: 52d9107af289
                    members:
                    - boot_partition: junos
                      cpld_version: '6'
                      cpu_stat:
                        idle: 69
                        interrupt: 1
                        load_avg:
                        - 0.8
                        - 1.09
                        - 1.07
                        system: 11
                        user: 19
                      fans:
                      - airflow: out
                        name: Fan Tray 0 Fan 0
                        rpm: 0
                        status: ok
                      - airflow: out
                        name: Fan Tray 1 Fan 0
                        rpm: 0
                        status: ok
                      fpc_idx: 0
                      mac: 52d9107af289
                      memory_stat:
                        usage: 42
                      model: EX2300-48P
                      pics:
                      - index: 0
                        model_number: EX2300-48P
                        port_groups:
                        - count: 48
                          type: GE
                      - index: 1
                        model_number: EX2300-48P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      poe:
                        max_power: 750
                        power_draw: 40.4
                        status: AT_MODE
                      poe_version: 2.1.1.19.3 (type1)
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.4R3-S4.18
                      serial: JW0000000000
                      temperatures:
                      - celsius: 33
                        name: CPU Sensor
                        status: ok
                      - celsius: 29
                        name: PSU Sensor
                        status: ok
                      type: fpc
                      uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800)  1.3.2
                      uptime: 27636720
                      vc_links:
                      - neighbor_module_idx: 1
                        neighbor_port_id: vcp-1/1/0
                        port_id: vcp-0/1/0
                      vc_mode: HiGiG
                      vc_role: master
                      vc_state: present
                      version: 21.4R3-S4.18
                    - boot_partition: junos
                      cpld_version: '6'
                      cpu_stat:
                        idle: 76
                        interrupt: 0
                        load_avg:
                        - 0.96
                        - 0.87
                        - 0.76
                        system: 6
                        user: 17
                      fans:
                      - airflow: out
                        name: Fan Tray 0 Fan 0
                        rpm: 0
                        status: ok
                      - airflow: out
                        name: Fan Tray 1 Fan 0
                        rpm: 0
                        status: ok
                      fpc_idx: 1
                      mac: d0dd4991652d
                      memory_stat:
                        usage: 18
                      model: EX2300-48P
                      pics:
                      - index: 0
                        model_number: EX2300-48P
                        port_groups:
                        - count: 48
                          type: GE
                      - index: 1
                        model_number: EX2300-48P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      poe:
                        max_power: 750
                        power_draw: 21.2
                        status: AT_MODE
                      poe_version: 2.1.1.19.3 (type1)
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.4R3-S4.18
                      serial: JW3619300922
                      temperatures:
                      - celsius: 32
                        name: CPU Sensor
                        status: ok
                      - celsius: 29
                        name: PSU Sensor
                        status: ok
                      type: fpc
                      uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800)  1.3.2
                      uptime: 27636720
                      vc_links:
                      - neighbor_module_idx: 0
                        neighbor_port_id: vcp-0/1/0
                        port_id: vcp-1/1/0
                      vc_mode: HiGiG
                      vc_role: backup
                      vc_state: present
                      version: 21.4R3-S4.18
                    model: EX2300-48P
                    num_routing_engines: 1
                    org_id: 1e9a61a9-bc42-42ca-bf67-1ad87443d9b8
                    serial: JW3619300157
                    site_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b
                    status: connected
                    type: switch
                    vc_mac: 52d9107af289
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_virtual_chassis_config'
                - description: Combined virtual chassis status, topology, and member statistics
                  examples:
                  - config_type: nonprovisioned
                    id: 00000000-0000-0000-1000-52d9107af289
                    mac: 52d9107af289
                    members:
                    - boot_partition: junos
                      cpld_version: '6'
                      cpu_stat:
                        idle: 69
                        interrupt: 1
                        load_avg:
                        - 0.8
                        - 1.09
                        - 1.07
                        system: 11
                        user: 19
                      fans:
                      - airflow: out
                        name: Fan Tray 0 Fan 0
                        rpm: 0
                        status: ok
                      - airflow: out
                        name: Fan Tray 1 Fan 0
                        rpm: 0
                        status: ok
                      fpc_idx: 0
                      mac: 52d9107af289
                      memory_stat:
                        usage: 42
                      model: EX2300-48P
                      pics:
                      - index: 0
                        model_number: EX2300-48P
                        port_groups:
                        - count: 48
                          type: GE
                      - index: 1
                        model_number: EX2300-48P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      poe:
                        max_power: 750
                        power_draw: 40.4
                        status: AT_MODE
                      poe_version: 2.1.1.19.3 (type1)
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.4R3-S4.18
                      serial: JW0000000000
                      temperatures:
                      - celsius: 33
                        name: CPU Sensor
                        status: ok
                      - celsius: 29
                        name: PSU Sensor
                        status: ok
                      type: fpc
                      uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800)  1.3.2
                      uptime: 27636720
                      vc_links:
                      - neighbor_module_idx: 1
                        neighbor_port_id: vcp-1/1/0
                        port_id: vcp-0/1/0
                      vc_mode: HiGiG
                      vc_role: master
                      vc_state: present
                      version: 21.4R3-S4.18
                    - boot_partition: junos
                      cpld_version: '6'
                      cpu_stat:
                        idle: 76
                        interrupt: 0
                        load_avg:
                        - 0.96
                        - 0.87
                        - 0.76
                        system: 6
                        user: 17
                      fans:
                      - airflow: out
                        name: Fan Tray 0 Fan 0
                        rpm: 0
                        status: ok
                      - airflow: out
                        name: Fan Tray 1 Fan 0
                        rpm: 0
                        status: ok
                      fpc_idx: 1
                      mac: d0dd4991652d
                      memory_stat:
                        usage: 18
                      model: EX2300-48P
                      pics:
                      - index: 0
                        model_number: EX2300-48P
                        port_groups:
                        - count: 48
                          type: GE
                      - index: 1
                        model_number: EX2300-48P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      poe:
                        max_power: 750
                        power_draw: 21.2
                        status: AT_MODE
                      poe_version: 2.1.1.19.3 (type1)
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.4R3-S4.18
                      serial: JW3619300922
                      temperatures:
                      - celsius: 32
                        name: CPU Sensor
                        status: ok
                      - celsius: 29
                        name: PSU Sensor
                        status: ok
                      type: fpc
                      uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800)  1.3.2
                      uptime: 27636720
                      vc_links:
                      - neighbor_module_idx: 0
                        neighbor_port_id: vcp-0/1/0
                        port_id: vcp-1/1/0
                      vc_mode: HiGiG
                      vc_role: backup
                      vc_state: present
                      version: 21.4R3-S4.18
                    model: EX2300-48P
                    num_routing_engines: 1
                    org_id: 1e9a61a9-bc42-42ca-bf67-1ad87443d9b8
                    serial: JW3619300157
                    site_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b
                    status: connected
                    type: switch
                    vc_mac: 52d9107af289
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    config_type: nonprovisioned
                    id: 00000000-0000-0000-1000-52d9107af289
                    mac: 52d9107af289
                    members:
                    - boot_partition: junos
                      cpld_version: '6'
                      cpu_stat:
                        idle: 69
                        interrupt: 1
                        load_avg:
                        - 0.8
                        - 1.09
                        - 1.07
                        system: 11
                        user: 19
                      fans:
                      - airflow: out
                        name: Fan Tray 0 Fan 0
                        rpm: 0
                        status: ok
                      - airflow: out
                        name: Fan Tray 1 Fan 0
                        rpm: 0
                        status: ok
                      fpc_idx: 0
                      mac: 52d9107af289
                      memory_stat:
                        usage: 42
                      model: EX2300-48P
                      pics:
                      - index: 0
                        model_number: EX2300-48P
                        port_groups:
                        - count: 48
                          type: GE
                      - index: 1
                        model_number: EX2300-48P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      poe:
                        max_power: 750
                        power_draw: 40.4
                        status: AT_MODE
                      poe_version: 2.1.1.19.3 (type1)
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.4R3-S4.18
                      serial: JW0000000000
                      temperatures:
                      - celsius: 33
                        name: CPU Sensor
                        status: ok
                      - celsius: 29
                        name: PSU Sensor
                        status: ok
                      type: fpc
                      uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800)  1.3.2
                      uptime: 27636720
                      vc_links:
                      - neighbor_module_idx: 1
                        neighbor_port_id: vcp-1/1/0
                        port_id: vcp-0/1/0
                      vc_mode: HiGiG
                      vc_role: master
                      vc_state: present
                      version: 21.4R3-S4.18
                    - boot_partition: junos
                      cpld_version: '6'
                      cpu_stat:
                        idle: 76
                        interrupt: 0
                        load_avg:
                        - 0.96
                        - 0.87
                        - 0.76
                        system: 6
                        user: 17
                      fans:
                      - airflow: out
                        name: Fan Tray 0 Fan 0
                        rpm: 0
                        status: ok
                      - airflow: out
                        name: Fan Tray 1 Fan 0
                        rpm: 0
                        status: ok
                      fpc_idx: 1
                      mac: d0dd4991652d
                      memory_stat:
                        usage: 18
                      model: EX2300-48P
                      pics:
                      - index: 0
                        model_number: EX2300-48P
                        port_groups:
                        - count: 48
                          type: GE
                      - index: 1
                        model_number: EX2300-48P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      poe:
                        max_power: 750
                        power_draw: 21.2
                        status: AT_MODE
                      poe_version: 2.1.1.19.3 (type1)
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.4R3-S4.18
                      serial: JW3619300922
                      temperatures:
                      - celsius: 32
                        name: CPU Sensor
                        status: ok
                      - celsius: 29
                        name: PSU Sensor
                        status: ok
                      type: fpc
                      uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800)  1.3.2
                      uptime: 27636720
                      vc_links:
                      - neighbor_module_idx: 0
                        neighbor_port_id: vcp-0/1/0
                        port_id: vcp-1/1/0
                      vc_mode: HiGiG
                      vc_role: backup
                      vc_state: present
                      version: 21.4R3-S4.18
                    model: EX2300-48P
                    num_routing_engines: 1
                    org_id: 1e9a61a9-bc42-42ca-bf67-1ad87443d9b8
                    serial: JW3619300157
                    site_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b
                    status: connected
                    type: switch
                    vc_mac: 52d9107af289
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Installer
      summary: updateInstallerVirtualChassisMember
      description: "The VC creation and adding member switch API will update the device’ s virtual chassis config which is applied after VC is formed to create JUNOS pre-provisioned virtual chassis configuration.\n\n## Change to use preprovisioned VC\nTo switch the VC to use preprovisioned VC, enable preprovisioned in virtual_chassis config. Both vc_role master and backup will be matched to routing-engine role in Junos preprovisioned VC config.\n\nIn this config, fpc0 has to be the same as the mac of device_id. Use renumber if you want to replace fpc0 which involves device_id change.\n\nNotice: to configure preprovisioned VC, every member of the VC must be in the inventory.\n\n## Add new members\nFor models (e.g. EX4300 and up) having dedicated VC ports, it is easier to add new member switches into a VC by just connecting cables with the dedicated VC ports. Cloud will detect the new members and update the inventory.\n\nFor EX2300 VC, adding new members requires to follow the procedures below:\n1. Powering on the new member switches and ensuring cables are not connected to any VC ports.\n2. Claim or adopt all new member switches under the VC’s organization Inventory\n3. Assign all new member switches to the same Site as the VC\n4. Invoke vc command to add switches to the VC.\n5. Connect the cables to the VC ports for these switches\n6. After a while, the Org’s Inventory shows this new switches has been added into the VC.\n\n## Removing member switch\nTo remove a member switch from the VC, following the procedures below:\n\n1. Ensuring the VC is connected to the cloud first\n2. Unplug the cable from the VC port of the switch\n3. Waiting for the VC state (vc_state) of this switch is changed to not-present\n4. Invoke update_vc with remove to remove this switch from the VC\n5. The Org’s Inventory shows the switch is removed.\n\nPlease notice that member ID 0 (fpc0) cannot be removed. When a VC has two switches left, unplugging the cable may result in the situation that fpc0 becomes a line card (LC). When this situation is happening, please re-plug in the cable, wait for both switches becoming present (show virtual-chassis) and then removing the cable again.\n\n## Renumber a member switch\nWhen a member switch doesn't' work properly and needed to be replaced, the renumber API could be used. The following two types of renumber are supported:\n\n1. Replace a non-fpc0 member switch\n2. Replace fpc0. When fpc0 is replaced, PAPI device config and JUNOS config will be both updated.\n\nFor renumber to work, the following procedures are needed: \n1. Ensuring the VC is connected to the cloud and the state of the member switch to be replaced must be non present. \n2. Adding the new member switch to the VC \n3. Waiting for the VC state (vc_state) of this VC to be updated to API server \n4. Invoke vc with renumber to replace the new member switch from fpc X to\n\n## Perprovision VC members\nBy specifying \"preprovision\" op, you can convert the current VC to pre-provisioned mode, update VC members as well as specify vc_ports when adding new members for device models without dedicated vc ports. Use renumber for fpc0 replacement which involves device_id change.\n\nNote: \n1. vc_ports is used for adding new members and not needed if * the device model has dedicated vc ports, or * no new member is added \n2. New VC members to be added should exist in the same Site as the VC\n\nUpdate Device’s VC config can achieve similar purpose by directly modifying current virtual_chassis config. However, it cannot fulfill requests to enabling vc_ports on new members that are yet to belong to current VC."
      operationId: updateInstallerVirtualChassisMember
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: fpc0_mac
        in: path
        description: FPC0 MAC address
        required: true
        schema:
          type: string
          examples:
          - aff827549235
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/virtual_chassis_update'
              - description: Request Body
                examples:
                - '{"members":[{"mac":"aff827549235","member_id":2,"vc_ports":["xe-0/1/0","xe-0/1/1"],"vc_role":"linecard"},{"mac":"8396cd00777c","member_id":3,"vc_ports":["xe-0/1/0","xe-0/1/1"],"vc_role":"linecard"}],"op":"add"}'
                - '{"member":0,"members":[{"mac":"string","member_id":0,"vc_ports":["xe-0/1/0","xe-0/1/1"],"vc_role":"master"}],"new-member":0,"op":"add"}'
                - '{"members":[{"member":2},{"member":3}],"op":"remove"}'
                - '{"member":3,"new-member":2,"op":"renumber"}'
              contentMediaType: application/json
            examples:
              adding-two-new-switches-as-line-cards-into-the-VC:
                value:
                  members:
                  - mac: aff827549235
                    member_id: 2
                    vc_ports:
                    - xe-0/1/0
                    - xe-0/1/1
                    vc_role: linecard
                  - mac: 8396cd00777c
                    member_id: 3
                    vc_ports:
                    - xe-0/1/0
                    - xe-0/1/1
                    vc_role: linecard
                  op: add
              convert-to-pre-provisioned-VC:
                value:
                  member: 0
                  members:
                  - mac: string
                    member_id: 0
                    vc_ports:
                    - xe-0/1/0
                    - xe-0/1/1
                    vc_role: master
                  new-member: 0
                  op: add
              removing-two-switches-from-VC:
                value:
                  members:
                  - member: 2
                  - member: 3
                  op: remove
              renumber-member-ID-3-to-member-ID-2:
                value:
                  member: 3
                  new-member: 2
                  op: renumber
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_virtual_chassis_config'
                - description: Combined virtual chassis status, topology, and member statistics
                  examples:
                  - config_type: nonprovisioned
                    id: 00000000-0000-0000-1000-52d9107af289
                    mac: 52d9107af289
                    members:
                    - boot_partition: junos
                      cpld_version: '6'
                      cpu_stat:
                        idle: 69
                        interrupt: 1
                        load_avg:
                        - 0.8
                        - 1.09
                        - 1.07
                        system: 11
                        user: 19
                      fans:
                      - airflow: out
                        name: Fan Tray 0 Fan 0
                        rpm: 0
                        status: ok
                      - airflow: out
                        name: Fan Tray 1 Fan 0
                        rpm: 0
                        status: ok
                      fpc_idx: 0
                      mac: 52d9107af289
                      memory_stat:
                        usage: 42
                      model: EX2300-48P
                      pics:
                      - index: 0
                        model_number: EX2300-48P
                        port_groups:
                        - count: 48
                          type: GE
                      - index: 1
                        model_number: EX2300-48P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      poe:
                        max_power: 750
                        power_draw: 40.4
                        status: AT_MODE
                      poe_version: 2.1.1.19.3 (type1)
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.4R3-S4.18
                      serial: JW0000000000
                      temperatures:
                      - celsius: 33
                        name: CPU Sensor
                        status: ok
                      - celsius: 29
                        name: PSU Sensor
                        status: ok
                      type: fpc
                      uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800)  1.3.2
                      uptime: 27636720
                      vc_links:
                      - neighbor_module_idx: 1
                        neighbor_port_id: vcp-1/1/0
                        port_id: vcp-0/1/0
                      vc_mode: HiGiG
                      vc_role: master
                      vc_state: present
                      version: 21.4R3-S4.18
                    - boot_partition: junos
                      cpld_version: '6'
                      cpu_stat:
                        idle: 76
                        interrupt: 0
                        load_avg:
                        - 0.96
                        - 0.87
                        - 0.76
                        system: 6
                        user: 17
                      fans:
                      - airflow: out
                        name: Fan Tray 0 Fan 0
                        rpm: 0
                        status: ok
                      - airflow: out
                        name: Fan Tray 1 Fan 0
                        rpm: 0
                        status: ok
                      fpc_idx: 1
                      mac: d0dd4991652d
                      memory_stat:
                        usage: 18
                      model: EX2300-48P
                      pics:
                      - index: 0
                        model_number: EX2300-48P
                        port_groups:
                        - count: 48
                          type: GE
                      - index: 1
                        model_number: EX2300-48P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      poe:
                        max_power: 750
                        power_draw: 21.2
                        status: AT_MODE
                      poe_version: 2.1.1.19.3 (type1)
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.4R3-S4.18
                      serial: JW3619300922
                      temperatures:
                      - celsius: 32
                        name: CPU Sensor
                        status: ok
                      - celsius: 29
                        name: PSU Sensor
                        status: ok
                      type: fpc
                      uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800)  1.3.2
                      uptime: 27636720
                      vc_links:
                      - neighbor_module_idx: 0
                        neighbor_port_id: vcp-0/1/0
                        port_id: vcp-1/1/0
                      vc_mode: HiGiG
                      vc_role: backup
                      vc_state: present
                      version: 21.4R3-S4.18
                    model: EX2300-48P
                    num_routing_engines: 1
                    org_id: 1e9a61a9-bc42-42ca-bf67-1ad87443d9b8
                    serial: JW3619300157
                    site_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b
                    status: connected
                    type: switch
                    vc_mac: 52d9107af289
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    config_type: nonprovisioned
                    id: 00000000-0000-0000-1000-52d9107af289
                    mac: 52d9107af289
                    members:
                    - boot_partition: junos
                      cpld_version: '6'
                      cpu_stat:
                        idle: 69
                        interrupt: 1
                        load_avg:
                        - 0.8
                        - 1.09
                        - 1.07
                        system: 11
                        user: 19
                      fans:
                      - airflow: out
                        name: Fan Tray 0 Fan 0
                        rpm: 0
                        status: ok
                      - airflow: out
                        name: Fan Tray 1 Fan 0
                        rpm: 0
                        status: ok
                      fpc_idx: 0
                      mac: 52d9107af289
                      memory_stat:
                        usage: 42
                      model: EX2300-48P
                      pics:
                      - index: 0
                        model_number: EX2300-48P
                        port_groups:
                        - count: 48
                          type: GE
                      - index: 1
                        model_number: EX2300-48P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      poe:
                        max_power: 750
                        power_draw: 40.4
                        status: AT_MODE
                      poe_version: 2.1.1.19.3 (type1)
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.4R3-S4.18
                      serial: JW0000000000
                      temperatures:
                      - celsius: 33
                        name: CPU Sensor
                        status: ok
                      - celsius: 29
                        name: PSU Sensor
                        status: ok
                      type: fpc
                      uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800)  1.3.2
                      uptime: 27636720
                      vc_links:
                      - neighbor_module_idx: 1
                        neighbor_port_id: vcp-1/1/0
                        port_id: vcp-0/1/0
                      vc_mode: HiGiG
                      vc_role: master
                      vc_state: present
                      version: 21.4R3-S4.18
                    - boot_partition: junos
                      cpld_version: '6'
                      cpu_stat:
                        idle: 76
                        interrupt: 0
                        load_avg:
                        - 0.96
                        - 0.87
                        - 0.76
                        system: 6
                        user: 17
                      fans:
                      - airflow: out
                        name: Fan Tray 0 Fan 0
                        rpm: 0
                        status: ok
                      - airflow: out
                        name: Fan Tray 1 Fan 0
                        rpm: 0
                        status: ok
                      fpc_idx: 1
                      mac: d0dd4991652d
                      memory_stat:
                        usage: 18
                      model: EX2300-48P
                      pics:
                      - index: 0
                        model_number: EX2300-48P
                        port_groups:
                        - count: 48
                          type: GE
                      - index: 1
                        model_number: EX2300-48P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      poe:
                        max_power: 750
                        power_draw: 21.2
                        status: AT_MODE
                      poe_version: 2.1.1.19.3 (type1)
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.4R3-S4.18
                      serial: JW3619300922
                      temperatures:
                      - celsius: 32
                        name: CPU Sensor
                        status: ok
                      - celsius: 29
                        name: PSU Sensor
                        status: ok
                      type: fpc
                      uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800)  1.3.2
                      uptime: 27636720
                      vc_links:
                      - neighbor_module_idx: 0
                        neighbor_port_id: vcp-0/1/0
                        port_id: vcp-1/1/0
                      vc_mode: HiGiG
                      vc_role: backup
                      vc_state: present
                      version: 21.4R3-S4.18
                    model: EX2300-48P
                    num_routing_engines: 1
                    org_id: 1e9a61a9-bc42-42ca-bf67-1ad87443d9b8
                    serial: JW3619300157
                    site_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b
                    status: connected
                    type: switch
                    vc_mac: 52d9107af289
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_virtual_chassis_config'
                - description: Combined virtual chassis status, topology, and member statistics
                  examples:
                  - config_type: nonprovisioned
                    id: 00000000-0000-0000-1000-52d9107af289
                    mac: 52d9107af289
                    members:
                    - boot_partition: junos
                      cpld_version: '6'
                      cpu_stat:
                        idle: 69
                        interrupt: 1
                        load_avg:
                        - 0.8
                        - 1.09
                        - 1.07
                        system: 11
                        user: 19
                      fans:
                      - airflow: out
                        name: Fan Tray 0 Fan 0
                        rpm: 0
                        status: ok
                      - airflow: out
                        name: Fan Tray 1 Fan 0
                        rpm: 0
                        status: ok
                      fpc_idx: 0
                      mac: 52d9107af289
                      memory_stat:
                        usage: 42
                      model: EX2300-48P
                      pics:
                      - index: 0
                        model_number: EX2300-48P
                        port_groups:
                        - count: 48
                          type: GE
                      - index: 1
                        model_number: EX2300-48P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      poe:
                        max_power: 750
                        power_draw: 40.4
                        status: AT_MODE
                      poe_version: 2.1.1.19.3 (type1)
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.4R3-S4.18
                      serial: JW0000000000
                      temperatures:
                      - celsius: 33
                        name: CPU Sensor
                        status: ok
                      - celsius: 29
                        name: PSU Sensor
                        status: ok
                      type: fpc
                      uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800)  1.3.2
                      uptime: 27636720
                      vc_links:
                      - neighbor_module_idx: 1
                        neighbor_port_id: vcp-1/1/0
                        port_id: vcp-0/1/0
                      vc_mode: HiGiG
                      vc_role: master
                      vc_state: present
                      version: 21.4R3-S4.18
                    - boot_partition: junos
                      cpld_version: '6'
                      cpu_stat:
                        idle: 76
                        interrupt: 0
                        load_avg:
                        - 0.96
                        - 0.87
                        - 0.76
                        system: 6
                        user: 17
                      fans:
                      - airflow: out
                        name: Fan Tray 0 Fan 0
                        rpm: 0
                        status: ok
                      - airflow: out
                        name: Fan Tray 1 Fan 0
                        rpm: 0
                        status: ok
                      fpc_idx: 1
                      mac: d0dd4991652d
                      memory_stat:
                        usage: 18
                      model: EX2300-48P
                      pics:
                      - index: 0
                        model_number: EX2300-48P
                        port_groups:
                        - count: 48
                          type: GE
                      - index: 1
                        model_number: EX2300-48P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      poe:
                        max_power: 750
                        power_draw: 21.2
                        status: AT_MODE
                      poe_version: 2.1.1.19.3 (type1)
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.4R3-S4.18
                      serial: JW3619300922
                      temperatures:
                      - celsius: 32
                        name: CPU Sensor
                        status: ok
                      - celsius: 29
                        name: PSU Sensor
                        status: ok
                      type: fpc
                      uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800)  1.3.2
                      uptime: 27636720
                      vc_links:
                      - neighbor_module_idx: 0
                        neighbor_port_id: vcp-0/1/0
                        port_id: vcp-1/1/0
                      vc_mode: HiGiG
                      vc_role: backup
                      vc_state: present
                      version: 21.4R3-S4.18
                    model: EX2300-48P
                    num_routing_engines: 1
                    org_id: 1e9a61a9-bc42-42ca-bf67-1ad87443d9b8
                    serial: JW3619300157
                    site_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b
                    status: connected
                    type: switch
                    vc_mac: 52d9107af289
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    config_type: nonprovisioned
                    id: 00000000-0000-0000-1000-52d9107af289
                    mac: 52d9107af289
                    members:
                    - boot_partition: junos
                      cpld_version: '6'
                      cpu_stat:
                        idle: 69
                        interrupt: 1
                        load_avg:
                        - 0.8
                        - 1.09
                        - 1.07
                        system: 11
                        user: 19
                      fans:
                      - airflow: out
                        name: Fan Tray 0 Fan 0
                        rpm: 0
                        status: ok
                      - airflow: out
                        name: Fan Tray 1 Fan 0
                        rpm: 0
                        status: ok
                      fpc_idx: 0
                      mac: 52d9107af289
                      memory_stat:
                        usage: 42
                      model: EX2300-48P
                      pics:
                      - index: 0
                        model_number: EX2300-48P
                        port_groups:
                        - count: 48
                          type: GE
                      - index: 1
                        model_number: EX2300-48P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      poe:
                        max_power: 750
                        power_draw: 40.4
                        status: AT_MODE
                      poe_version: 2.1.1.19.3 (type1)
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.4R3-S4.18
                      serial: JW0000000000
                      temperatures:
                      - celsius: 33
                        name: CPU Sensor
                        status: ok
                      - celsius: 29
                        name: PSU Sensor
                        status: ok
                      type: fpc
                      uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800)  1.3.2
                      uptime: 27636720
                      vc_links:
                      - neighbor_module_idx: 1
                        neighbor_port_id: vcp-1/1/0
                        port_id: vcp-0/1/0
                      vc_mode: HiGiG
                      vc_role: master
                      vc_state: present
                      version: 21.4R3-S4.18
                    - boot_partition: junos
                      cpld_version: '6'
                      cpu_stat:
                        idle: 76
                        interrupt: 0
                        load_avg:
                        - 0.96
                        - 0.87
                        - 0.76
                        system: 6
                        user: 17
                      fans:
                      - airflow: out
                        name: Fan Tray 0 Fan 0
                        rpm: 0
                        status: ok
                      - airflow: out
                        name: Fan Tray 1 Fan 0
                        rpm: 0
                        status: ok
                      fpc_idx: 1
                      mac: d0dd4991652d
                      memory_stat:
                        usage: 18
                      model: EX2300-48P
                      pics:
                      - index: 0
                        model_number: EX2300-48P
                        port_groups:
                        - count: 48
                          type: GE
                      - index: 1
                        model_number: EX2300-48P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      poe:
                        max_power: 750
                        power_draw: 21.2
                        status: AT_MODE
                      poe_version: 2.1.1.19.3 (type1)
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.4R3-S4.18
                      serial: JW3619300922
                      temperatures:
                      - celsius: 32
                        name: CPU Sensor
                        status: ok
                      - celsius: 29
                        name: PSU Sensor
                        status: ok
                      type: fpc
                      uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800)  1.3.2
                      uptime: 27636720
                      vc_links:
                      - neighbor_module_idx: 0
                        neighbor_port_id: vcp-0/1/0
                        port_id: vcp-1/1/0
                      vc_mode: HiGiG
                      vc_role: backup
                      vc_state: present
                      version: 21.4R3-S4.18
                    model: EX2300-48P
                    num_routing_engines: 1
                    org_id: 1e9a61a9-bc42-42ca-bf67-1ad87443d9b8
                    serial: JW3619300157
                    site_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b
                    status: connected
                    type: switch
                    vc_mac: 52d9107af289
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/installer/orgs/{org_id}/rftemplates:
    get:
      tags:
      - Installer
      summary: listInstallerRfTemplatesNames
      description: Return RF template names available to installer workflows for site creation or updates.
      operationId: listInstallerRfTemplatesNames
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Installer List of RF Templates
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/installers_item'
                description: Installer access entries returned by list responses
                examples:
                - - id: bb8a9017-1e36-5d6c-6f2b-551abe8a76a2
                    name: RFTemplate 1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - id: bb8a9017-1e36-5d6c-6f2b-551abe8a76a2
                    name: RFTemplate 1
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/installers_item'
                description: Installer access entries returned by list responses
                examples:
                - - id: bb8a9017-1e36-5d6c-6f2b-551abe8a76a2
                    name: RFTemplate 1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - id: bb8a9017-1e36-5d6c-6f2b-551abe8a76a2
                    name: RFTemplate 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/installer/orgs/{org_id}/sitegroups:
    get:
      tags:
      - Installer
      summary: listInstallerSiteGroups
      description: Return site groups that installers can assign when creating or updating sites.
      operationId: listInstallerSiteGroups
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Installer List of Site Groups
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/installers_item'
                description: Installer access entries returned by list responses
                examples:
                - - id: 581328b6-e382-f54e-c9dc-999983183a34
                    name: SiteGroup 1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - id: 581328b6-e382-f54e-c9dc-999983183a34
                    name: SiteGroup 1
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/installers_item'
                description: Installer access entries returned by list responses
                examples:
                - - id: 581328b6-e382-f54e-c9dc-999983183a34
                    name: SiteGroup 1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - id: 581328b6-e382-f54e-c9dc-999983183a34
                    name: SiteGroup 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/installer/orgs/{org_id}/sites:
    get:
      tags:
      - Installer
      summary: listInstallerSites
      description: Return sites visible to installer workflows for device assignment and map operations.
      operationId: listInstallerSites
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: List of Sites
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/installer_site'
                description: Sites available to installer workflows
                examples:
                - - address: 1601 S. Deanza Blvd., Cupertino, CA, 95014
                    country_code: US
                    id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    latlng:
                      lat: 37.295833
                      lng: -122.032946
                    name: Mist Office
                    rftemplate_name: rftemplate1
                    sitegroup_names:
                    - sg1
                    - sg2
                    timezone: America/Los_Angeles
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - address: 1601 S. Deanza Blvd., Cupertino, CA, 95014
                    country_code: US
                    id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    latlng:
                      lat: 37.295833
                      lng: -122.032946
                    name: Mist Office
                    rftemplate_name: rftemplate1
                    sitegroup_names:
                    - sg1
                    - sg2
                    timezone: America/Los_Angeles
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/installer_site'
                description: Sites available to installer workflows
                examples:
                - - address: 1601 S. Deanza Blvd., Cupertino, CA, 95014
                    country_code: US
                    id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    latlng:
                      lat: 37.295833
                      lng: -122.032946
                    name: Mist Office
                    rftemplate_name: rftemplate1
                    sitegroup_names:
                    - sg1
                    - sg2
                    timezone: America/Los_Angeles
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - address: 1601 S. Deanza Blvd., Cupertino, CA, 95014
                    country_code: US
                    id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    latlng:
                      lat: 37.295833
                      lng: -122.032946
                    name: Mist Office
                    rftemplate_name: rftemplate1
                    sitegroup_names:
                    - sg1
                    - sg2
                    timezone: America/Los_Angeles
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/installer/orgs/{org_id}/sites/{site_name}:
    put:
      tags:
      - Installer
      summary: createOrUpdateInstallerSites
      description: Use `site_name` to create a site when it does not exist, or to update installer-editable fields on an existing site. Installers use these sites for device assignment, and grace-period rules also apply when updating an existing site.
      operationId: createOrUpdateInstallerSites
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: site_name
        in: path
        description: ''
        required: true
        schema:
          type: string
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/installer_site'
              - description: Request Body
                examples:
                - address: 1601 S. Deanza Blvd., Cupertino, CA, 95014
                  country_code: US
                  latlng:
                    lat: 37.295833
                    lng: -122.032946
                  name: string
                  rftemplate_name: rftemplate1
                  sitegroup_names:
                  - sg1
                  - sg2
                  timezone: America/Los_Angeles
              contentMediaType: application/json
            examples:
              Example:
                value:
                  address: 1601 S. Deanza Blvd., Cupertino, CA, 95014
                  country_code: US
                  latlng:
                    lat: 37.295833
                    lng: -122.032946
                  name: string
                  rftemplate_name: rftemplate1
                  sitegroup_names:
                  - sg1
                  - sg2
                  timezone: America/Los_Angeles
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/installer/orgs/{org_id}/sites/{site_name}/maps:
    get:
      tags:
      - Installer
      summary: listInstallerMaps
      description: Return maps for an installer-managed site, used for floorplan selection and AP placement during provisioning.
      operationId: listInstallerMaps
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: site_name
        in: path
        description: ''
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/map'
                description: Maps or floorplans returned by the API
                examples:
                - - created_time: 0
                    flags: {}
                    group_idx: 1
                    group_name: East Wing
                    height: 0
                    height_m: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    latlng_br:
                      lat: string
                      lng: string
                    latlng_tl:
                      lat: string
                      lng: string
                    locked: true
                    modified_time: 0
                    name: string
                    occupancy_limit: 0
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    orientation: 0
                    origin_x: 0
                    origin_y: 0
                    ppm: 0
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    sitesurvey_path:
                    - coordinate: string
                      id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      name: string
                      nodes:
                      - edges:
                          N2: string
                        name: string
                        position:
                          x: 0
                          y: 0
                    thumbnail_url: string
                    type: image
                    url: string
                    view: roadmap
                    wall_path:
                      coordinate: string
                      nodes:
                      - edges:
                          N2: string
                        name: string
                        position:
                          x: 0
                          y: 0
                    wayfinding:
                      micello:
                        account_key: string
                        default_level_id: 0
                        map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      snap_to_path: true
                    wayfinding_path:
                      coordinate: string
                      nodes:
                      - edges:
                          N2: string
                        name: string
                        position:
                          x: 0
                          y: 0
                    width: 0
                    width_m: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 0
                    flags: {}
                    group_idx: 1
                    group_name: East Wing
                    height: 0
                    height_m: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    latlng_br:
                      lat: string
                      lng: string
                    latlng_tl:
                      lat: string
                      lng: string
                    locked: true
                    modified_time: 0
                    name: string
                    occupancy_limit: 0
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    orientation: 0
                    origin_x: 0
                    origin_y: 0
                    ppm: 0
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    sitesurvey_path:
                    - coordinate: string
                      id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      name: string
                      nodes:
                      - edges:
                          N2: string
                        name: string
                        position:
                          x: 0
                          y: 0
                    thumbnail_url: string
                    type: image
                    url: string
                    view: roadmap
                    wall_path:
                      coordinate: string
                      nodes:
                      - edges:
                          N2: string
                        name: string
                        position:
                          x: 0
                          y: 0
                    wayfinding:
                      micello:
                        account_key: string
                        default_level_id: 0
                        map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      snap_to_path: true
                    wayfinding_path:
                      coordinate: string
                      nodes:
                      - edges:
                          N2: string
                        name: string
                        position:
                          x: 0
                          y: 0
                    width: 0
                    width_m: 0
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/map'
                description: Maps or floorplans returned by the API
                examples:
                - - created_time: 0
                    flags: {}
                    group_idx: 1
                    group_name: East Wing
                    height: 0
                    height_m: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    latlng_br:
                      lat: string
                      lng: string
                    latlng_tl:
                      lat: string
                      lng: string
                    locked: true
                    modified_time: 0
                    name: string
                    occupancy_limit: 0
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    orientation: 0
                    origin_x: 0
                    origin_y: 0
                    ppm: 0
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    sitesurvey_path:
                    - coordinate: string
                      id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      name: string
                      nodes:
                      - edges:
                          N2: string
                        name: string
                        position:
                          x: 0
                          y: 0
                    thumbnail_url: string
                    type: image
                    url: string
                    view: roadmap
                    wall_path:
                      coordinate: string
                      nodes:
                      - edges:
                          N2: string
                        name: string
                        position:
                          x: 0
                          y: 0
                    wayfinding:
                      micello:
                        account_key: string
                        default_level_id: 0
                        map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      snap_to_path: true
                    wayfinding_path:
                      coordinate: string
                      nodes:
                      - edges:
                          N2: string
                        name: string
                        position:
                          x: 0
                          y: 0
                    width: 0
                    width_m: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 0
                    flags: {}
                    group_idx: 1
                    group_name: East Wing
                    height: 0
                    height_m: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    latlng_br:
                      lat: string
                      lng: string
                    latlng_tl:
                      lat: string
                      lng: string
                    locked: true
                    modified_time: 0
                    name: string
                    occupancy_limit: 0
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    orientation: 0
                    origin_x: 0
                    origin_y: 0
                    ppm: 0
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    sitesurvey_path:
                    - coordinate: string
                      id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      name: string
                      nodes:
                      - edges:
                          N2: string
                        name: string
                        position:
                          x: 0
                          y: 0
                    thumbnail_url: string
                    type: image
                    url: string
                    view: roadmap
                    wall_path:
                      coordinate: string
                      nodes:
                      - edges:
                          N2: string
                        name: string
                        position:
                          x: 0
                          y: 0
                    wayfinding:
                      micello:
                        account_key: string
                        default_level_id: 0
                        map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      snap_to_path: true
                    wayfinding_path:
                      coordinate: string
                      nodes:
                      - edges:
                          N2: string
                        name: string
                        position:
                          x: 0
                          y: 0
                    width: 0
                    width_m: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/installer/orgs/{org_id}/sites/{site_name}/maps/import:
    post:
      tags:
      - Installer
      summary: importInstallerMap
      description: Import a site floorplan and optional placement data from multipart files. The request can include an image file, optional JSON, and optional CSV data to create the map and assign or place APs when names or MAC addresses match.
      operationId: importInstallerMap
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: site_name
        in: path
        description: ''
        required: true
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              type: object
              properties:
                auto_deviceprofile_assignment:
                  type: boolean
                  description: Whether to auto assign device to deviceprofile by name
                  examples:
                  - true
                csv:
                  type: string
                  description: Optional AP name-mapping CSV file
                  contentEncoding: base64
                file:
                  type: string
                  description: Ekahau or iBwave floorplan file to import
                  contentEncoding: base64
                json:
                  allOf:
                  - $ref: '#/components/schemas/map_import_json1'
                  - description: Import options for the site map file
              contentMediaType: multipart/form-data
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_map_import'
                - description: Result of importing map files and matching AP placements
                  examples:
                  - '{"aps":[{"action":"assigned-placed","floorplan_id":"6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9","height":3,"mac":"5c5b35000001","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","orientation":45}],"floorplans":[{"action":"imported","id":"cbdb7f0b-3be0-4872-88f9-58790b509c23","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","name":"map1"}],"site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","summary":{"num_ap_assigned":1,"num_inv_assigned":1,"num_map_assigned":1}}'
                  - '{"aps":[{"action":"assigned-named-placed","floorplan_id":"6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9","mac":"5c5b35000001","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","orientation":45}],"floorplans":[{"action":"imported","id":"cbdb7f0b-3be0-4872-88f9-58790b509c23","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","name":"map1"}],"site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","summary":{"num_ap_assigned":1,"num_inv_assigned":1,"num_map_assigned":1}}'
                  - '{"aps":[{"action":"placed","floorplan_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","height":3,"mac":"5c5b35000001","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","orientation":45}],"floorplans":[{"action":"imported","id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","name":"map1"}],"site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","summary":{"num_ap_assigned":1,"num_inv_assigned":1,"num_map_assigned":1}}'
                contentMediaType: application/json
              examples:
                Assigned And Placed:
                  value:
                    aps:
                    - action: assigned-placed
                      floorplan_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                      height: 3
                      mac: 5c5b35000001
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      orientation: 45
                    floorplans:
                    - action: imported
                      id: cbdb7f0b-3be0-4872-88f9-58790b509c23
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      name: map1
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    summary:
                      num_ap_assigned: 1
                      num_inv_assigned: 1
                      num_map_assigned: 1
                Assigned Named And Placed:
                  value:
                    aps:
                    - action: assigned-named-placed
                      floorplan_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                      mac: 5c5b35000001
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      orientation: 45
                    floorplans:
                    - action: imported
                      id: cbdb7f0b-3be0-4872-88f9-58790b509c23
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      name: map1
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    summary:
                      num_ap_assigned: 1
                      num_inv_assigned: 1
                      num_map_assigned: 1
                Placed:
                  value:
                    aps:
                    - action: placed
                      floorplan_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      height: 3
                      mac: 5c5b35000001
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      orientation: 45
                    floorplans:
                    - action: imported
                      id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      name: map1
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    summary:
                      num_ap_assigned: 1
                      num_inv_assigned: 1
                      num_map_assigned: 1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_map_import'
                - description: Result of importing map files and matching AP placements
                  examples:
                  - '{"aps":[{"action":"assigned-placed","floorplan_id":"6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9","height":3,"mac":"5c5b35000001","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","orientation":45}],"floorplans":[{"action":"imported","id":"cbdb7f0b-3be0-4872-88f9-58790b509c23","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","name":"map1"}],"site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","summary":{"num_ap_assigned":1,"num_inv_assigned":1,"num_map_assigned":1}}'
                  - '{"aps":[{"action":"assigned-named-placed","floorplan_id":"6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9","mac":"5c5b35000001","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","orientation":45}],"floorplans":[{"action":"imported","id":"cbdb7f0b-3be0-4872-88f9-58790b509c23","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","name":"map1"}],"site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","summary":{"num_ap_assigned":1,"num_inv_assigned":1,"num_map_assigned":1}}'
                  - '{"aps":[{"action":"placed","floorplan_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","height":3,"mac":"5c5b35000001","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","orientation":45}],"floorplans":[{"action":"imported","id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","name":"map1"}],"site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","summary":{"num_ap_assigned":1,"num_inv_assigned":1,"num_map_assigned":1}}'
                contentMediaType: application/vnd.api+json
              examples:
                Assigned And Placed:
                  value:
                    aps:
                    - action: assigned-placed
                      floorplan_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                      height: 3
                      mac: 5c5b35000001
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      orientation: 45
                    floorplans:
                    - action: imported
                      id: cbdb7f0b-3be0-4872-88f9-58790b509c23
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      name: map1
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    summary:
                      num_ap_assigned: 1
                      num_inv_assigned: 1
                      num_map_assigned: 1
                Assigned Named And Placed:
                  value:
                    aps:
                    - action: assigned-named-placed
                      floorplan_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                      mac: 5c5b35000001
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      orientation: 45
                    floorplans:
                    - action: imported
                      id: cbdb7f0b-3be0-4872-88f9-58790b509c23
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      name: map1
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    summary:
                      num_ap_assigned: 1
                      num_inv_assigned: 1
                      num_map_assigned: 1
                Placed:
                  value:
                    aps:
                    - action: placed
                      floorplan_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      height: 3
                      mac: 5c5b35000001
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      orientation: 45
                    floorplans:
                    - action: imported
                      id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      name: map1
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    summary:
                      num_ap_assigned: 1
                      num_inv_assigned: 1
                      num_map_assigned: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/installer/orgs/{org_id}/sites/{site_name}/maps/{map_id}:
    delete:
      tags:
      - Installer
      summary: deleteInstallerMap
      description: Remove a map or floorplan from an installer-managed site. This removes the map used for AP placement, but does not delete the site.
      operationId: deleteInstallerMap
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: site_name
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: map_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Installer
      summary: createInstallerMap
      description: Define a map or floorplan for an installer-managed site, including metadata used for AP placement and site visualization.
      operationId: createInstallerMap
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: site_name
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: map_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/map'
              - description: Request Body
                examples:
                - height: 0
                  latlng_br:
                    lat: string
                    lng: string
                  latlng_tl:
                    lat: string
                    lng: string
                  locked: true
                  name: string
                  orientation: 0
                  origin_x: 0
                  origin_y: 0
                  ppm: 0
                  sitesurvey_path:
                  - coordinate: string
                    name: string
                    nodes:
                    - edges:
                        N2: string
                      name: string
                      position:
                        x: 0
                        y: 0
                  type: image
                  view: roadmap
                  wall_path:
                    coordinate: string
                    nodes:
                    - edges:
                        N2: string
                      name: string
                      position:
                        x: 0
                        y: 0
                  wayfinding:
                    micello:
                      account_key: string
                      default_level_id: 0
                    snap_to_path: true
                  wayfinding_path:
                    coordinate: string
                    nodes:
                    - edges:
                        N2: string
                      name: string
                      position:
                        x: 0
                        y: 0
                  width: 0
              contentMediaType: application/json
            examples:
              Example:
                value:
                  height: 0
                  latlng_br:
                    lat: string
                    lng: string
                  latlng_tl:
                    lat: string
                    lng: string
                  locked: true
                  name: string
                  orientation: 0
                  origin_x: 0
                  origin_y: 0
                  ppm: 0
                  sitesurvey_path:
                  - coordinate: string
                    name: string
                    nodes:
                    - edges:
                        N2: string
                      name: string
                      position:
                        x: 0
                        y: 0
                  type: image
                  view: roadmap
                  wall_path:
                    coordinate: string
                    nodes:
                    - edges:
                        N2: string
                      name: string
                      position:
                        x: 0
                        y: 0
                  wayfinding:
                    micello:
                      account_key: string
                      default_level_id: 0
                    snap_to_path: true
                  wayfinding_path:
                    coordinate: string
                    nodes:
                    - edges:
                        N2: string
                      name: string
                      position:
                        x: 0
                        y: 0
                  width: 0
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/map'
                - description: Map or floorplan metadata for a site or organization
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/map'
                - description: Map or floorplan metadata for a site or organization
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Installer
      summary: updateInstallerMap
      description: Modify map or floorplan metadata for an installer-managed site, including dimensions, orientation, and placement-related settings.
      operationId: updateInstallerMap
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: site_name
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: map_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/map'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/map'
                - description: Map or floorplan metadata for a site or organization
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/map'
                - description: Map or floorplan metadata for a site or organization
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/installer/sites/{site_name}/optimize:
    get:
      tags:
      - Installer
      summary: optimizeInstallerRrm
      description: Trigger RF optimization after installation is complete, such as after APs have been placed on maps and powered on. This starts RRM before the next automatic optimization schedule.
      operationId: optimizeInstallerRrm
      parameters:
      - name: site_name
        in: path
        description: ''
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/msps:
    post:
      tags:
      - MSPs
      summary: createMsp
      description: Create a managed service provider account that can own organizations, organization groups, admins, licenses, and MSP-level settings.
      operationId: createMsp
      parameters: []
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/msp'
              - description: Request Body
                examples:
                - name: MSP
              contentMediaType: application/json
            examples:
              Example:
                value:
                  name: MSP
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/msp'
                - description: Managed service provider account
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/msp'
                - description: Managed service provider account
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/msps/{msp_id}:
    delete:
      tags:
      - MSPs
      summary: deleteMsp
      description: Delete the MSP account and its MSP-level organization groups and privileges. This does not delete any organizations or administrator accounts.
      operationId: deleteMsp
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - MSPs
      summary: getMspDetails
      description: Return MSP account details, including the display name, service tier, support-access setting, logo URL, custom URL, and timestamps.
      operationId: getMspDetails
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/msp'
                - description: Managed service provider account
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/msp'
                - description: Managed service provider account
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - MSPs
      summary: updateMsp
      description: Update editable MSP account settings such as the display name, support-access setting, logo URL, or custom URL.
      operationId: updateMsp
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/msp'
              - description: Request Body
                examples:
                - name: MSP
              contentMediaType: application/json
            examples:
              Example:
                value:
                  name: MSP
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/msp'
                - description: Managed service provider account
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/msp'
                - description: Managed service provider account
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/msps/{msp_id}/search:
    get:
      tags:
      - MSPs
      summary: searchMspOrgGroup
      description: Search MSP resources by query string. Currently `type=orgs` returns matching organizations in this MSP.
      operationId: searchMspOrgGroup
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: type
        in: query
        description: 'MSP search result type to return. enum: `orgs`'
        required: true
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/msp_search_type'
          - description: 'MSP search result type to return. enum: `orgs`'
            examples:
            - orgs
      - name: q
        in: query
        description: Filter results by search string
        required: true
        style: form
        explode: true
        schema:
          type: string
          examples:
          - live
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_search'
                - description: Paginated response for MSP organization search results
                  examples:
                  - limit: 0
                    page: 0
                    results:
                    - id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      text: string
                      type: string
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    limit: 0
                    page: 0
                    results:
                    - id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      text: string
                      type: string
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_search'
                - description: Paginated response for MSP organization search results
                  examples:
                  - limit: 0
                    page: 0
                    results:
                    - id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      text: string
                      type: string
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    limit: 0
                    page: 0
                    results:
                    - id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      text: string
                      type: string
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/msps/{msp_id}/admins:
    get:
      tags:
      - MSPs Admins
      summary: listMspAdmins
      description: List administrators that have privileges in this MSP hierarchy, including MSP, organization, organization group, site, or site group scopes.
      operationId: listMspAdmins
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                uniqueItems: true
                type: array
                items:
                  $ref: '#/components/schemas/admin'
                description: List of Mist administrator accounts
                examples:
                - '[{"admin_id":"456b7016-a916-a4b1-78dd-72b947c152b7","email":"jsmith@mycorp.org","first_name":"Joe","last_name":"Smith","privileges":[{"role":"admin","scope":"msp"},{"org_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","role":"admin","scope":"org"},{"orggroup_ids":["507f1bab-13ba-73e2-f291-2bcb8d1362b0"],"role":"read","scope":"orggroup"}]}]'
                - '[{"admin_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","email":"user@example.com","first_name":"string","last_name":"string","privileges":[{"msp_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","msp_name":"string","name":"string","org_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","org_name":"string","orggroup_ids":["b069b358-4c97-5319-1f8c-7c5ca64d6ab1"],"role":"admin","scope":"org","site_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","sitegroup_ids":["6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9"]}]}]'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - admin_id: 456b7016-a916-a4b1-78dd-72b947c152b7
                    email: jsmith@mycorp.org
                    first_name: Joe
                    last_name: Smith
                    privileges:
                    - role: admin
                      scope: msp
                    - org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                    - orggroup_ids:
                      - 507f1bab-13ba-73e2-f291-2bcb8d1362b0
                      role: read
                      scope: orggroup
                Example2:
                  value:
                  - admin_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    email: user@example.com
                    first_name: string
                    last_name: string
                    privileges:
                    - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      msp_name: string
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      org_name: string
                      orggroup_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sitegroup_ids:
                      - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
            application/vnd.api+json:
              schema:
                uniqueItems: true
                type: array
                items:
                  $ref: '#/components/schemas/admin'
                description: List of Mist administrator accounts
                examples:
                - '[{"admin_id":"456b7016-a916-a4b1-78dd-72b947c152b7","email":"jsmith@mycorp.org","first_name":"Joe","last_name":"Smith","privileges":[{"role":"admin","scope":"msp"},{"org_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","role":"admin","scope":"org"},{"orggroup_ids":["507f1bab-13ba-73e2-f291-2bcb8d1362b0"],"role":"read","scope":"orggroup"}]}]'
                - '[{"admin_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","email":"user@example.com","first_name":"string","last_name":"string","privileges":[{"msp_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","msp_name":"string","name":"string","org_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","org_name":"string","orggroup_ids":["b069b358-4c97-5319-1f8c-7c5ca64d6ab1"],"role":"admin","scope":"org","site_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","sitegroup_ids":["6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9"]}]}]'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - admin_id: 456b7016-a916-a4b1-78dd-72b947c152b7
                    email: jsmith@mycorp.org
                    first_name: Joe
                    last_name: Smith
                    privileges:
                    - role: admin
                      scope: msp
                    - org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                    - orggroup_ids:
                      - 507f1bab-13ba-73e2-f291-2bcb8d1362b0
                      role: read
                      scope: orggroup
                Example2:
                  value:
                  - admin_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    email: user@example.com
                    first_name: string
                    last_name: string
                    privileges:
                    - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      msp_name: string
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      org_name: string
                      orggroup_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sitegroup_ids:
                      - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/msps/{msp_id}/admins/{admin_id}:
    delete:
      tags:
      - MSPs Admins
      summary: revokeMspAdmin
      description: Remove all privileges this administrator has through the MSP hierarchy, including inherited organization and site access. This does not delete the administrator account.
      operationId: revokeMspAdmin
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: admin_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - MSPs Admins
      summary: getMspAdmin
      description: Return administrator details and privilege assignments for one administrator under this MSP.
      operationId: getMspAdmin
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: admin_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/admin'
                - description: Mist administrator account or organization API token details
                  examples:
                  - admin_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    email: user@example.com
                    first_name: string
                    last_name: string
                    password_modified_time: 1656353525
                    privileges:
                    - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      msp_name: string
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      org_name: string
                      orggroup_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sitegroup_ids:
                      - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    admin_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    email: user@example.com
                    first_name: string
                    last_name: string
                    password_modified_time: 1656353525
                    privileges:
                    - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      msp_name: string
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      org_name: string
                      orggroup_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sitegroup_ids:
                      - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/admin'
                - description: Mist administrator account or organization API token details
                  examples:
                  - admin_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    email: user@example.com
                    first_name: string
                    last_name: string
                    password_modified_time: 1656353525
                    privileges:
                    - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      msp_name: string
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      org_name: string
                      orggroup_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sitegroup_ids:
                      - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    admin_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    email: user@example.com
                    first_name: string
                    last_name: string
                    password_modified_time: 1656353525
                    privileges:
                    - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      msp_name: string
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      org_name: string
                      orggroup_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sitegroup_ids:
                      - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - MSPs Admins
      summary: updateMspAdmin
      description: Update identity fields and privilege assignments for an existing administrator under this MSP.
      operationId: updateMspAdmin
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: admin_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/admin'
              - description: Request Body
                examples:
                - email: jsnow@abc.com
                  first_name: string
                  last_name: string
                  privileges:
                  - org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    role: admin
                    scope: org
                    sitegroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  - role: admin
                    scope: site
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
              contentMediaType: application/json
            examples:
              Example:
                value:
                  email: jsnow@abc.com
                  first_name: string
                  last_name: string
                  privileges:
                  - org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    role: admin
                    scope: org
                    sitegroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  - role: admin
                    scope: site
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/admin'
                - description: Mist administrator account or organization API token details
                  examples:
                  - admin_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    email: user@example.com
                    first_name: string
                    last_name: string
                    password_modified_time: 1656353525
                    privileges:
                    - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      msp_name: string
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      org_name: string
                      orggroup_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sitegroup_ids:
                      - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    admin_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    email: user@example.com
                    first_name: string
                    last_name: string
                    password_modified_time: 1656353525
                    privileges:
                    - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      msp_name: string
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      org_name: string
                      orggroup_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sitegroup_ids:
                      - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/admin'
                - description: Mist administrator account or organization API token details
                  examples:
                  - admin_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    email: user@example.com
                    first_name: string
                    last_name: string
                    password_modified_time: 1656353525
                    privileges:
                    - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      msp_name: string
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      org_name: string
                      orggroup_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sitegroup_ids:
                      - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    admin_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    email: user@example.com
                    first_name: string
                    last_name: string
                    password_modified_time: 1656353525
                    privileges:
                    - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      msp_name: string
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      org_name: string
                      orggroup_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sitegroup_ids:
                      - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/msps/{msp_id}/invites:
    post:
      tags:
      - MSPs Admins
      summary: inviteMspAdmin
      description: >-
        Send an MSP administrator invitation with the requested identity fields and privilege assignments.


        **Note**: An email will also be sent to the user with a link to https://manage.mist.com/verify/invite?token=:token
      operationId: inviteMspAdmin
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/admin'
              - description: Request Body
                examples:
                - '{"email":"user@example.com","first_name":"string","last_name":"string","privileges":[{"msp_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","msp_name":"string","name":"string","org_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","org_name":"string","orggroup_ids":["b069b358-4c97-5319-1f8c-7c5ca64d6ab1"],"role":"admin","scope":"org","site_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","sitegroup_ids":["b069b358-4c97-5319-1f8c-7c5ca64d6ab1"]}]}'
              contentMediaType: application/json
            examples:
              Example:
                value:
                  email: user@example.com
                  first_name: string
                  last_name: string
                  privileges:
                  - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    msp_name: string
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    org_name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    role: admin
                    scope: org
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    sitegroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/admin'
                - description: Mist administrator account or organization API token details
                  examples:
                  - admin_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    email: user@example.com
                    first_name: string
                    last_name: string
                    password_modified_time: 1656353525
                    privileges:
                    - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      msp_name: string
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      org_name: string
                      orggroup_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sitegroup_ids:
                      - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    admin_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    email: user@example.com
                    first_name: string
                    last_name: string
                    password_modified_time: 1656353525
                    privileges:
                    - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      msp_name: string
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      org_name: string
                      orggroup_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sitegroup_ids:
                      - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/admin'
                - description: Mist administrator account or organization API token details
                  examples:
                  - admin_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    email: user@example.com
                    first_name: string
                    last_name: string
                    password_modified_time: 1656353525
                    privileges:
                    - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      msp_name: string
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      org_name: string
                      orggroup_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sitegroup_ids:
                      - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    admin_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    email: user@example.com
                    first_name: string
                    last_name: string
                    password_modified_time: 1656353525
                    privileges:
                    - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      msp_name: string
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      org_name: string
                      orggroup_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sitegroup_ids:
                      - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/msps/{msp_id}/invites/{invite_id}:
    delete:
      tags:
      - MSPs Admins
      summary: uninviteMspAdmin
      description: Cancel a pending MSP administrator invitation before the invitee accepts it.
      operationId: uninviteMspAdmin
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: invite_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - MSPs Admins
      summary: updateMspAdminInvite
      description: Update the identity fields or privilege assignments on a pending MSP administrator invitation.
      operationId: updateMspAdminInvite
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: invite_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/admin'
              - description: Request Body
                examples:
                - '{"email":"user@example.com","first_name":"string","last_name":"string","privileges":[{"msp_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","msp_name":"string","name":"string","org_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","org_name":"string","orggroup_ids":["b069b358-4c97-5319-1f8c-7c5ca64d6ab1"],"role":"admin","scope":"org","site_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","sitegroup_ids":["b069b358-4c97-5319-1f8c-7c5ca64d6ab1"]}]}'
              contentMediaType: application/json
            examples:
              Example:
                value:
                  email: user@example.com
                  first_name: string
                  last_name: string
                  privileges:
                  - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    msp_name: string
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    org_name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    role: admin
                    scope: org
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    sitegroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/admin'
                - description: Mist administrator account or organization API token details
                  examples:
                  - admin_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    email: user@example.com
                    first_name: string
                    last_name: string
                    password_modified_time: 1656353525
                    privileges:
                    - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      msp_name: string
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      org_name: string
                      orggroup_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sitegroup_ids:
                      - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    admin_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    email: user@example.com
                    first_name: string
                    last_name: string
                    password_modified_time: 1656353525
                    privileges:
                    - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      msp_name: string
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      org_name: string
                      orggroup_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sitegroup_ids:
                      - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/admin'
                - description: Mist administrator account or organization API token details
                  examples:
                  - admin_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    email: user@example.com
                    first_name: string
                    last_name: string
                    password_modified_time: 1656353525
                    privileges:
                    - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      msp_name: string
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      org_name: string
                      orggroup_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sitegroup_ids:
                      - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    admin_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    email: user@example.com
                    first_name: string
                    last_name: string
                    password_modified_time: 1656353525
                    privileges:
                    - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      msp_name: string
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      org_name: string
                      orggroup_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sitegroup_ids:
                      - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/secintelprofiles:
    get:
      tags:
      - Orgs SecIntel Profiles
      summary: listOrgSecIntelProfiles
      description: List organization SecIntel profiles. These profiles define protection levels for SecIntel feed categories such as command-and-control, infected host, and DNS.
      operationId: listOrgSecIntelProfiles
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/secintel_profile'
                description: SecIntel profiles returned by list operations
                examples:
                - - name: secintel-custom
                    profiles:
                    - action: default
                      category: CC
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - name: secintel-custom
                    profiles:
                    - action: default
                      category: CC
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/secintel_profile'
                description: SecIntel profiles returned by list operations
                examples:
                - - name: secintel-custom
                    profiles:
                    - action: default
                      category: CC
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - name: secintel-custom
                    profiles:
                    - action: default
                      category: CC
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs SecIntel Profiles
      summary: createOrgSecIntelProfile
      description: Create an organization SecIntel profile with category-specific protection levels for threat intelligence feeds.
      operationId: createOrgSecIntelProfile
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/secintel_profile'
              - description: Request Body
                examples:
                - name: secintel-custom
                  profiles:
                  - action: default
                    category: CC
              contentMediaType: application/json
            examples:
              Example:
                value:
                  name: secintel-custom
                  profiles:
                  - action: default
                    category: CC
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secintel_profile'
                - description: SecIntel profile containing category-specific threat intelligence actions
                  examples:
                  - name: secintel-custom
                    profiles:
                    - action: default
                      category: CC
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    name: secintel-custom
                    profiles:
                    - action: default
                      category: CC
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secintel_profile'
                - description: SecIntel profile containing category-specific threat intelligence actions
                  examples:
                  - name: secintel-custom
                    profiles:
                    - action: default
                      category: CC
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    name: secintel-custom
                    profiles:
                    - action: default
                      category: CC
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/secintelprofiles/{secintelprofile_id}:
    delete:
      tags:
      - Orgs SecIntel Profiles
      summary: deleteOrgSecIntelProfile
      description: Remove an organization SecIntel profile from the organization's available threat intelligence profile set.
      operationId: deleteOrgSecIntelProfile
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: secintelprofile_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs SecIntel Profiles
      summary: getOrgSecIntelProfile
      description: Return an organization SecIntel profile, including the protection level configured for each SecIntel feed category.
      operationId: getOrgSecIntelProfile
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: secintelprofile_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secintel_profile'
                - description: SecIntel profile containing category-specific threat intelligence actions
                  examples:
                  - name: secintel-custom
                    profiles:
                    - action: default
                      category: CC
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    name: secintel-custom
                    profiles:
                    - action: default
                      category: CC
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secintel_profile'
                - description: SecIntel profile containing category-specific threat intelligence actions
                  examples:
                  - name: secintel-custom
                    profiles:
                    - action: default
                      category: CC
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    name: secintel-custom
                    profiles:
                    - action: default
                      category: CC
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs SecIntel Profiles
      summary: updateOrgSecIntelProfile
      description: Update an organization SecIntel profile, including its display name and category-specific threat intelligence protection levels.
      operationId: updateOrgSecIntelProfile
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: secintelprofile_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/secintel_profile'
              - description: Request Body
                examples:
                - name: secintel-custom
                  profiles:
                  - action: default
                    category: CC
              contentMediaType: application/json
            examples:
              Example:
                value:
                  name: secintel-custom
                  profiles:
                  - action: default
                    category: CC
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secintel_profile'
                - description: SecIntel profile containing category-specific threat intelligence actions
                  examples:
                  - name: secintel-custom
                    profiles:
                    - action: default
                      category: CC
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    name: secintel-custom
                    profiles:
                    - action: default
                      category: CC
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secintel_profile'
                - description: SecIntel profile containing category-specific threat intelligence actions
                  examples:
                  - name: secintel-custom
                    profiles:
                    - action: default
                      category: CC
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    name: secintel-custom
                    profiles:
                    - action: default
                      category: CC
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/secintelprofiles/derived:
    get:
      tags:
      - Sites SecIntel Profiles
      summary: listSiteSecIntelProfilesDerived
      description: Get the list of derived Sky-ATP secintel profiles a Site
      operationId: listSiteSecIntelProfilesDerived
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: resolve
        in: query
        description: Whether resolve the site variables
        style: form
        explode: true
        schema:
          type: boolean
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/secintel_profile'
                description: SecIntel profiles returned by list operations
                examples:
                - - name: secintel-custom
                    profiles:
                    - action: default
                      category: CC
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - name: secintel-custom
                    profiles:
                    - action: default
                      category: CC
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/secintel_profile'
                description: SecIntel profiles returned by list operations
                examples:
                - - name: secintel-custom
                    profiles:
                    - action: default
                      category: CC
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - name: secintel-custom
                    profiles:
                    - action: default
                      category: CC
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/msps/{msp_id}/inventory/{device_mac}:
    get:
      tags:
      - MSPs Inventory
      summary: getMspInventoryByMac
      description: Return the inventory record for a device MAC address owned by an organization under this MSP, including the owning organization and site when available.
      operationId: getMspInventoryByMac
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_msp_inventory_device'
                - description: Inventory device record returned by MSP device MAC lookup
                  examples:
                  - mac: 5c5b35000018
                    model: AP200
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    serial: FXLH2015150025
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    type: ap
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    mac: 5c5b35000018
                    model: AP200
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    serial: FXLH2015150025
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    type: ap
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_msp_inventory_device'
                - description: Inventory device record returned by MSP device MAC lookup
                  examples:
                  - mac: 5c5b35000018
                    model: AP200
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    serial: FXLH2015150025
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    type: ap
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    mac: 5c5b35000018
                    model: AP200
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    serial: FXLH2015150025
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    type: ap
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/msps/{msp_id}/logo:
    delete:
      tags:
      - MSPs Logo
      summary: deleteMspLogo
      description: Remove the logo configured for an advanced-tier MSP account.
      operationId: deleteMspLogo
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - MSPs Logo
      summary: postMspLogo
      description: Upload or update the public logo URL for an advanced-tier MSP account.
      operationId: postMspLogo
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/msp_logo'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/msps/{msp_id}/logs:
    get:
      tags:
      - MSPs Logs
      summary: listMspAuditLogs
      description: List audit log entries for configuration and administrative changes within this MSP, with optional filters by site, administrator, message text, and time range.
      operationId: listMspAuditLogs
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: site_id
        in: query
        description: Filter results by site identifier
        style: form
        explode: true
        schema:
          type: string
          examples:
          - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
      - name: admin_name
        in: query
        description: Admin name or email
        style: form
        explode: true
        schema:
          type: string
          examples:
          - jsnow
      - name: message
        in: query
        description: Filter results by message text
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Added new site
      - name: sort
        in: query
        description: 'Field used to sort results; a leading `-` indicates descending order. enum: `-timestamp`, `admin_id`, `site_id`, `timestamp`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/list_msp_logs_sort'
          - description: 'Field used to sort results; a leading `-` indicates descending order. enum: `-timestamp`, `admin_id`, `site_id`, `timestamp`'
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_log_search'
                - description: Paginated response for audit log search results
                  examples:
                  - end: 1428954000
                    limit: 100
                    results:
                    - admin_id: 72bfa2bd-e58a-4670-9d20-a1468f7a6f58
                      admin_name: test@mistsys.com
                      id: c6f9347b-b0a4-4a23-b927-fa9249f2ffb2
                      message: TEST AUDIT
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      timestamp: 1431382121
                    start: 1428939600
                    total: 135
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1428954000
                    limit: 100
                    results:
                    - admin_id: 72bfa2bd-e58a-4670-9d20-a1468f7a6f58
                      admin_name: test@mistsys.com
                      id: c6f9347b-b0a4-4a23-b927-fa9249f2ffb2
                      message: TEST AUDIT
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      timestamp: 1431382121
                    start: 1428939600
                    total: 135
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_log_search'
                - description: Paginated response for audit log search results
                  examples:
                  - end: 1428954000
                    limit: 100
                    results:
                    - admin_id: 72bfa2bd-e58a-4670-9d20-a1468f7a6f58
                      admin_name: test@mistsys.com
                      id: c6f9347b-b0a4-4a23-b927-fa9249f2ffb2
                      message: TEST AUDIT
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      timestamp: 1431382121
                    start: 1428939600
                    total: 135
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1428954000
                    limit: 100
                    results:
                    - admin_id: 72bfa2bd-e58a-4670-9d20-a1468f7a6f58
                      admin_name: test@mistsys.com
                      id: c6f9347b-b0a4-4a23-b927-fa9249f2ffb2
                      message: TEST AUDIT
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      timestamp: 1431382121
                    start: 1428939600
                    total: 135
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/msps/{msp_id}/logs/count:
    get:
      tags:
      - MSPs Logs
      summary: countMspAuditLogs
      description: Return distinct counts of MSP audit log entries grouped by the requested field, such as administrator, message, or organization.
      operationId: countMspAuditLogs
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `admin_id`, `admin_name`, `message`, `org_id`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/msp_logs_count_distinct'
          - description: 'Field used to group this count response. enum: `admin_id`, `admin_name`, `message`, `org_id`'
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/msps/{msp_id}/claim:
    post:
      tags:
      - MSPs Licenses
      summary: claimMspLicense
      description: Claim a license order for this MSP by submitting the activation code from the order.
      operationId: claimMspLicense
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/code_string'
              - examples:
                - code: ZHT3K-H36DT-MG85D-M61AC
              contentMediaType: application/json
            examples:
              Example:
                value:
                  code: ZHT3K-H36DT-MG85D-M61AC
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_claim_license'
                - description: Result of claiming licenses or activation codes
                  examples:
                  - inventory_added:
                    - mac: 5c5b35000018
                      magic: 6JG8EPTFV2A9Z2N
                      model: AP41
                      serial: FXLH2015150025
                      type: ap
                    inventory_duplicated:
                    - mac: 5c5b35000012
                      magic: DVH4VSNMSZPDXBR
                      model: AP41
                      serial: FXLH2015150027
                      type: ap
                    inventory_pending:
                    - mac: 5c5b35000012
                    license_added:
                    - end: 1520380800
                      quantity: 180
                      start: 1504828800
                      type: SUB-MAN
                    - end: 1520380800
                      quantity: 120
                      start: 1504828800
                      type: SUB-LOC
                    license_duplicated:
                    - end: 1520380800
                      quantity: 180
                      start: 1504828800
                      type: SUB-MAN
                    license_error:
                    - order: '00000464'
                      reason: ''
                contentMediaType: application/json
              examples:
                Licenses Successfully Claimed And Applied:
                  value:
                    inventory_added:
                    - mac: 5c5b35000018
                      magic: 6JG8EPTFV2A9Z2N
                      model: AP41
                      serial: FXLH2015150025
                      type: ap
                    inventory_duplicated:
                    - mac: 5c5b35000012
                      magic: DVH4VSNMSZPDXBR
                      model: AP41
                      serial: FXLH2015150027
                      type: ap
                    inventory_pending:
                    - mac: 5c5b35000012
                    license_added:
                    - end: 1520380800
                      quantity: 180
                      start: 1504828800
                      type: SUB-MAN
                    - end: 1520380800
                      quantity: 120
                      start: 1504828800
                      type: SUB-LOC
                    license_duplicated:
                    - end: 1520380800
                      quantity: 180
                      start: 1504828800
                      type: SUB-MAN
                    license_error:
                    - order: '00000464'
                      reason: ''
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_claim_license'
                - description: Result of claiming licenses or activation codes
                  examples:
                  - inventory_added:
                    - mac: 5c5b35000018
                      magic: 6JG8EPTFV2A9Z2N
                      model: AP41
                      serial: FXLH2015150025
                      type: ap
                    inventory_duplicated:
                    - mac: 5c5b35000012
                      magic: DVH4VSNMSZPDXBR
                      model: AP41
                      serial: FXLH2015150027
                      type: ap
                    inventory_pending:
                    - mac: 5c5b35000012
                    license_added:
                    - end: 1520380800
                      quantity: 180
                      start: 1504828800
                      type: SUB-MAN
                    - end: 1520380800
                      quantity: 120
                      start: 1504828800
                      type: SUB-LOC
                    license_duplicated:
                    - end: 1520380800
                      quantity: 180
                      start: 1504828800
                      type: SUB-MAN
                    license_error:
                    - order: '00000464'
                      reason: ''
                contentMediaType: application/vnd.api+json
              examples:
                Licenses Successfully Claimed And Applied:
                  value:
                    inventory_added:
                    - mac: 5c5b35000018
                      magic: 6JG8EPTFV2A9Z2N
                      model: AP41
                      serial: FXLH2015150025
                      type: ap
                    inventory_duplicated:
                    - mac: 5c5b35000012
                      magic: DVH4VSNMSZPDXBR
                      model: AP41
                      serial: FXLH2015150027
                      type: ap
                    inventory_pending:
                    - mac: 5c5b35000012
                    license_added:
                    - end: 1520380800
                      quantity: 180
                      start: 1504828800
                      type: SUB-MAN
                    - end: 1520380800
                      quantity: 120
                      start: 1504828800
                      type: SUB-LOC
                    license_duplicated:
                    - end: 1520380800
                      quantity: 180
                      start: 1504828800
                      type: SUB-MAN
                    license_error:
                    - order: '00000464'
                      reason: ''
        '400':
          description: Response when the key is invalid (or already used)
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/msps/{msp_id}/licenses:
    get:
      tags:
      - MSPs Licenses
      summary: listMspLicenses
      description: Return MSP license entitlement, subscription, amendment, and usage summary information.
      operationId: listMspLicenses
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/license'
                - description: Organization license entitlement, subscription, and usage summary
                  examples:
                  - amendments:
                    - created_time: 1644684842
                      end_time: 1744156799
                      id: ff0a14f6-1234-5678-90ab-c8e64d4bc6c6
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1632873600
                      subscription_id: VNA-000000af
                      type: SUB-VNA
                    - created_time: 1644684842
                      end_time: 1744156799
                      id: c1c28812-1234-5678-90ab-dc95680da61e
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1632873600
                      subscription_id: MAN-000008be
                      type: SUB-MAN
                    - created_time: 1644684842
                      end_time: 1744243199
                      id: 96c0a41f-1234-5678-90ab-afe74817e9fd
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1586476800
                      subscription_id: EX24-000000bc
                      type: SUB-EX24
                    entitled:
                      SUB-ENG: 26
                      SUB-EX24: 9
                      SUB-MAN: 26
                      SUB-VNA: 26
                    licenses:
                    - created_time: 1555353534
                      end_time: 1586822399
                      id: 693a41a6-1234-5678-90ab-f53dbd3a31c0
                      modified_time: 1555353534
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 0
                      start_time: 1555286400
                      subscription_id: VNA-000000aa
                      type: SUB-VNA
                    - created_time: 1576132516
                      end_time: 1586822399
                      id: 656607cf-1234-5678-90ab-fc9035614ea5
                      modified_time: 1576132516
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 8
                      remaining_quantity: 0
                      start_time: 1576022400
                      subscription_id: VNA-000000ab
                      type: SUB-VNA
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: db50d0bc-1234-5678-90ab-e439958cb06b
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: MAN-000000ac
                      type: SUB-MAN
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: 2ff9e84a-1234-5678-90ab-fb9ec0726e01
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: ENG-000000ad
                      type: SUB-ENG
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: 16df7ea6-1234-5678-90ab-78018cd4024d
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: VNA-000000ae
                      type: SUB-VNA
                    - created_time: 1586237081
                      end_time: 1744243199
                      id: 1b6f68d5-1234-5678-90ab-70d3e6d18c73
                      modified_time: 1586237081
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: VNA-000000af
                      type: SUB-VNA
                    - created_time: 1586237097
                      end_time: 1744243199
                      id: 1375c9bf-1234-5678-90ab-9c636708c89e
                      modified_time: 1586237097
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: MAN-000000ba
                      type: SUB-MAN
                    - created_time: 1586237137
                      end_time: 1744243199
                      id: 5974e979-1234-5678-90ab-438f833ec1c9
                      modified_time: 1586237137
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: ENG-000000bb
                      type: SUB-ENG
                    - created_time: 1629947267
                      end_time: 1744243199
                      id: 340a9cb3-1234-5678-90ab-b009344dbf3c
                      modified_time: 1629947267
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 10
                      remaining_quantity: 9
                      start_time: 1586476800
                      subscription_id: EX24-000000bc
                      type: SUB-EX24
                    - created_time: 1632941870
                      end_time: 1744156799
                      id: 9b599b0f-1234-5678-90ab-406081b58e7f
                      modified_time: 1632941870
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 10
                      remaining_quantity: 10
                      start_time: 1632873600
                      subscription_id: ENG-000000bd
                      type: SUB-ENG
                    - created_time: 1632941882
                      end_time: 1744156799
                      id: d6d8ead3-1234-5678-90ab-98badeac7287
                      modified_time: 1632941882
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 11
                      remaining_quantity: 9
                      start_time: 1632873600
                      subscription_id: MAN-000008be
                      type: SUB-MAN
                    summary:
                      SUB-ENG: 18
                      SUB-EX24: 3
                      SUB-MAN: 22
                      SUB-VNA: 20
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    amendments:
                    - created_time: 1644684842
                      end_time: 1744156799
                      id: ff0a14f6-1234-5678-90ab-c8e64d4bc6c6
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1632873600
                      subscription_id: VNA-000000af
                      type: SUB-VNA
                    - created_time: 1644684842
                      end_time: 1744156799
                      id: c1c28812-1234-5678-90ab-dc95680da61e
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1632873600
                      subscription_id: MAN-000008be
                      type: SUB-MAN
                    - created_time: 1644684842
                      end_time: 1744243199
                      id: 96c0a41f-1234-5678-90ab-afe74817e9fd
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1586476800
                      subscription_id: EX24-000000bc
                      type: SUB-EX24
                    entitled:
                      SUB-ENG: 26
                      SUB-EX24: 9
                      SUB-MAN: 26
                      SUB-VNA: 26
                    licenses:
                    - created_time: 1555353534
                      end_time: 1586822399
                      id: 693a41a6-1234-5678-90ab-f53dbd3a31c0
                      modified_time: 1555353534
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 0
                      start_time: 1555286400
                      subscription_id: VNA-000000aa
                      type: SUB-VNA
                    - created_time: 1576132516
                      end_time: 1586822399
                      id: 656607cf-1234-5678-90ab-fc9035614ea5
                      modified_time: 1576132516
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 8
                      remaining_quantity: 0
                      start_time: 1576022400
                      subscription_id: VNA-000000ab
                      type: SUB-VNA
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: db50d0bc-1234-5678-90ab-e439958cb06b
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: MAN-000000ac
                      type: SUB-MAN
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: 2ff9e84a-1234-5678-90ab-fb9ec0726e01
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: ENG-000000ad
                      type: SUB-ENG
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: 16df7ea6-1234-5678-90ab-78018cd4024d
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: VNA-000000ae
                      type: SUB-VNA
                    - created_time: 1586237081
                      end_time: 1744243199
                      id: 1b6f68d5-1234-5678-90ab-70d3e6d18c73
                      modified_time: 1586237081
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: VNA-000000af
                      type: SUB-VNA
                    - created_time: 1586237097
                      end_time: 1744243199
                      id: 1375c9bf-1234-5678-90ab-9c636708c89e
                      modified_time: 1586237097
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: MAN-000000ba
                      type: SUB-MAN
                    - created_time: 1586237137
                      end_time: 1744243199
                      id: 5974e979-1234-5678-90ab-438f833ec1c9
                      modified_time: 1586237137
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: ENG-000000bb
                      type: SUB-ENG
                    - created_time: 1629947267
                      end_time: 1744243199
                      id: 340a9cb3-1234-5678-90ab-b009344dbf3c
                      modified_time: 1629947267
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 10
                      remaining_quantity: 9
                      start_time: 1586476800
                      subscription_id: EX24-000000bc
                      type: SUB-EX24
                    - created_time: 1632941870
                      end_time: 1744156799
                      id: 9b599b0f-1234-5678-90ab-406081b58e7f
                      modified_time: 1632941870
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 10
                      remaining_quantity: 10
                      start_time: 1632873600
                      subscription_id: ENG-000000bd
                      type: SUB-ENG
                    - created_time: 1632941882
                      end_time: 1744156799
                      id: d6d8ead3-1234-5678-90ab-98badeac7287
                      modified_time: 1632941882
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 11
                      remaining_quantity: 9
                      start_time: 1632873600
                      subscription_id: MAN-000008be
                      type: SUB-MAN
                    summary:
                      SUB-ENG: 18
                      SUB-EX24: 3
                      SUB-MAN: 22
                      SUB-VNA: 20
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/license'
                - description: Organization license entitlement, subscription, and usage summary
                  examples:
                  - amendments:
                    - created_time: 1644684842
                      end_time: 1744156799
                      id: ff0a14f6-1234-5678-90ab-c8e64d4bc6c6
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1632873600
                      subscription_id: VNA-000000af
                      type: SUB-VNA
                    - created_time: 1644684842
                      end_time: 1744156799
                      id: c1c28812-1234-5678-90ab-dc95680da61e
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1632873600
                      subscription_id: MAN-000008be
                      type: SUB-MAN
                    - created_time: 1644684842
                      end_time: 1744243199
                      id: 96c0a41f-1234-5678-90ab-afe74817e9fd
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1586476800
                      subscription_id: EX24-000000bc
                      type: SUB-EX24
                    entitled:
                      SUB-ENG: 26
                      SUB-EX24: 9
                      SUB-MAN: 26
                      SUB-VNA: 26
                    licenses:
                    - created_time: 1555353534
                      end_time: 1586822399
                      id: 693a41a6-1234-5678-90ab-f53dbd3a31c0
                      modified_time: 1555353534
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 0
                      start_time: 1555286400
                      subscription_id: VNA-000000aa
                      type: SUB-VNA
                    - created_time: 1576132516
                      end_time: 1586822399
                      id: 656607cf-1234-5678-90ab-fc9035614ea5
                      modified_time: 1576132516
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 8
                      remaining_quantity: 0
                      start_time: 1576022400
                      subscription_id: VNA-000000ab
                      type: SUB-VNA
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: db50d0bc-1234-5678-90ab-e439958cb06b
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: MAN-000000ac
                      type: SUB-MAN
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: 2ff9e84a-1234-5678-90ab-fb9ec0726e01
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: ENG-000000ad
                      type: SUB-ENG
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: 16df7ea6-1234-5678-90ab-78018cd4024d
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: VNA-000000ae
                      type: SUB-VNA
                    - created_time: 1586237081
                      end_time: 1744243199
                      id: 1b6f68d5-1234-5678-90ab-70d3e6d18c73
                      modified_time: 1586237081
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: VNA-000000af
                      type: SUB-VNA
                    - created_time: 1586237097
                      end_time: 1744243199
                      id: 1375c9bf-1234-5678-90ab-9c636708c89e
                      modified_time: 1586237097
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: MAN-000000ba
                      type: SUB-MAN
                    - created_time: 1586237137
                      end_time: 1744243199
                      id: 5974e979-1234-5678-90ab-438f833ec1c9
                      modified_time: 1586237137
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: ENG-000000bb
                      type: SUB-ENG
                    - created_time: 1629947267
                      end_time: 1744243199
                      id: 340a9cb3-1234-5678-90ab-b009344dbf3c
                      modified_time: 1629947267
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 10
                      remaining_quantity: 9
                      start_time: 1586476800
                      subscription_id: EX24-000000bc
                      type: SUB-EX24
                    - created_time: 1632941870
                      end_time: 1744156799
                      id: 9b599b0f-1234-5678-90ab-406081b58e7f
                      modified_time: 1632941870
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 10
                      remaining_quantity: 10
                      start_time: 1632873600
                      subscription_id: ENG-000000bd
                      type: SUB-ENG
                    - created_time: 1632941882
                      end_time: 1744156799
                      id: d6d8ead3-1234-5678-90ab-98badeac7287
                      modified_time: 1632941882
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 11
                      remaining_quantity: 9
                      start_time: 1632873600
                      subscription_id: MAN-000008be
                      type: SUB-MAN
                    summary:
                      SUB-ENG: 18
                      SUB-EX24: 3
                      SUB-MAN: 22
                      SUB-VNA: 20
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    amendments:
                    - created_time: 1644684842
                      end_time: 1744156799
                      id: ff0a14f6-1234-5678-90ab-c8e64d4bc6c6
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1632873600
                      subscription_id: VNA-000000af
                      type: SUB-VNA
                    - created_time: 1644684842
                      end_time: 1744156799
                      id: c1c28812-1234-5678-90ab-dc95680da61e
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1632873600
                      subscription_id: MAN-000008be
                      type: SUB-MAN
                    - created_time: 1644684842
                      end_time: 1744243199
                      id: 96c0a41f-1234-5678-90ab-afe74817e9fd
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1586476800
                      subscription_id: EX24-000000bc
                      type: SUB-EX24
                    entitled:
                      SUB-ENG: 26
                      SUB-EX24: 9
                      SUB-MAN: 26
                      SUB-VNA: 26
                    licenses:
                    - created_time: 1555353534
                      end_time: 1586822399
                      id: 693a41a6-1234-5678-90ab-f53dbd3a31c0
                      modified_time: 1555353534
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 0
                      start_time: 1555286400
                      subscription_id: VNA-000000aa
                      type: SUB-VNA
                    - created_time: 1576132516
                      end_time: 1586822399
                      id: 656607cf-1234-5678-90ab-fc9035614ea5
                      modified_time: 1576132516
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 8
                      remaining_quantity: 0
                      start_time: 1576022400
                      subscription_id: VNA-000000ab
                      type: SUB-VNA
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: db50d0bc-1234-5678-90ab-e439958cb06b
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: MAN-000000ac
                      type: SUB-MAN
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: 2ff9e84a-1234-5678-90ab-fb9ec0726e01
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: ENG-000000ad
                      type: SUB-ENG
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: 16df7ea6-1234-5678-90ab-78018cd4024d
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: VNA-000000ae
                      type: SUB-VNA
                    - created_time: 1586237081
                      end_time: 1744243199
                      id: 1b6f68d5-1234-5678-90ab-70d3e6d18c73
                      modified_time: 1586237081
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: VNA-000000af
                      type: SUB-VNA
                    - created_time: 1586237097
                      end_time: 1744243199
                      id: 1375c9bf-1234-5678-90ab-9c636708c89e
                      modified_time: 1586237097
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: MAN-000000ba
                      type: SUB-MAN
                    - created_time: 1586237137
                      end_time: 1744243199
                      id: 5974e979-1234-5678-90ab-438f833ec1c9
                      modified_time: 1586237137
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: ENG-000000bb
                      type: SUB-ENG
                    - created_time: 1629947267
                      end_time: 1744243199
                      id: 340a9cb3-1234-5678-90ab-b009344dbf3c
                      modified_time: 1629947267
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 10
                      remaining_quantity: 9
                      start_time: 1586476800
                      subscription_id: EX24-000000bc
                      type: SUB-EX24
                    - created_time: 1632941870
                      end_time: 1744156799
                      id: 9b599b0f-1234-5678-90ab-406081b58e7f
                      modified_time: 1632941870
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 10
                      remaining_quantity: 10
                      start_time: 1632873600
                      subscription_id: ENG-000000bd
                      type: SUB-ENG
                    - created_time: 1632941882
                      end_time: 1744156799
                      id: d6d8ead3-1234-5678-90ab-98badeac7287
                      modified_time: 1632941882
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 11
                      remaining_quantity: 9
                      start_time: 1632873600
                      subscription_id: MAN-000008be
                      type: SUB-MAN
                    summary:
                      SUB-ENG: 18
                      SUB-EX24: 3
                      SUB-MAN: 22
                      SUB-VNA: 20
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - MSPs Licenses
      summary: moveOrDeleteMspLicenseToAnotherOrg
      description: Perform an MSP license action, such as amending license quantity to an organization, deleting a subscription, undoing an amendment, or annotating a subscription.
      operationId: moveOrDeleteMspLicenseToAnotherOrg
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/msp_license_action'
              - examples:
                - '{"op":"delete","subscription_id":"SUB-0000144"}'
                - '{"dst_org_id":"3eff35f7-c218-894e-bca2-24e5325601cc","op":"amend","quantity":10,"subscription_id":"SUB-0000144"}'
                - '{"amendment_id":"2b9116ab-cd1e-e897-6e08-31fccd88e792","op":"unamend"}'
              contentMediaType: application/json
            examples:
              delete-license:
                value:
                  op: delete
                  subscription_id: SUB-0000144
              move-license:
                value:
                  dst_org_id: 3eff35f7-c218-894e-bca2-24e5325601cc
                  op: amend
                  quantity: 10
                  subscription_id: SUB-0000144
              undo-the_license_move:
                value:
                  amendment_id: 2b9116ab-cd1e-e897-6e08-31fccd88e792
                  op: unamend
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/msps/{msp_id}/stats/licenses:
    get:
      tags:
      - MSPs Licenses
      summary: listMspOrgLicenses
      description: Return license entitlement, subscription, amendment, and usage statistics for organizations managed by this MSP.
      operationId: listMspOrgLicenses
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/license'
                - description: Organization license entitlement, subscription, and usage summary
                  examples:
                  - amendments:
                    - created_time: 1644684842
                      end_time: 1744156799
                      id: ff0a14f6-1234-5678-90ab-c8e64d4bc6c6
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1632873600
                      subscription_id: VNA-000000af
                      type: SUB-VNA
                    - created_time: 1644684842
                      end_time: 1744156799
                      id: c1c28812-1234-5678-90ab-dc95680da61e
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1632873600
                      subscription_id: MAN-000008be
                      type: SUB-MAN
                    - created_time: 1644684842
                      end_time: 1744243199
                      id: 96c0a41f-1234-5678-90ab-afe74817e9fd
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1586476800
                      subscription_id: EX24-000000bc
                      type: SUB-EX24
                    entitled:
                      SUB-ENG: 26
                      SUB-EX24: 9
                      SUB-MAN: 26
                      SUB-VNA: 26
                    licenses:
                    - created_time: 1555353534
                      end_time: 1586822399
                      id: 693a41a6-1234-5678-90ab-f53dbd3a31c0
                      modified_time: 1555353534
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 0
                      start_time: 1555286400
                      subscription_id: VNA-000000aa
                      type: SUB-VNA
                    - created_time: 1576132516
                      end_time: 1586822399
                      id: 656607cf-1234-5678-90ab-fc9035614ea5
                      modified_time: 1576132516
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 8
                      remaining_quantity: 0
                      start_time: 1576022400
                      subscription_id: VNA-000000ab
                      type: SUB-VNA
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: db50d0bc-1234-5678-90ab-e439958cb06b
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: MAN-000000ac
                      type: SUB-MAN
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: 2ff9e84a-1234-5678-90ab-fb9ec0726e01
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: ENG-000000ad
                      type: SUB-ENG
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: 16df7ea6-1234-5678-90ab-78018cd4024d
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: VNA-000000ae
                      type: SUB-VNA
                    - created_time: 1586237081
                      end_time: 1744243199
                      id: 1b6f68d5-1234-5678-90ab-70d3e6d18c73
                      modified_time: 1586237081
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: VNA-000000af
                      type: SUB-VNA
                    - created_time: 1586237097
                      end_time: 1744243199
                      id: 1375c9bf-1234-5678-90ab-9c636708c89e
                      modified_time: 1586237097
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: MAN-000000ba
                      type: SUB-MAN
                    - created_time: 1586237137
                      end_time: 1744243199
                      id: 5974e979-1234-5678-90ab-438f833ec1c9
                      modified_time: 1586237137
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: ENG-000000bb
                      type: SUB-ENG
                    - created_time: 1629947267
                      end_time: 1744243199
                      id: 340a9cb3-1234-5678-90ab-b009344dbf3c
                      modified_time: 1629947267
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 10
                      remaining_quantity: 9
                      start_time: 1586476800
                      subscription_id: EX24-000000bc
                      type: SUB-EX24
                    - created_time: 1632941870
                      end_time: 1744156799
                      id: 9b599b0f-1234-5678-90ab-406081b58e7f
                      modified_time: 1632941870
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 10
                      remaining_quantity: 10
                      start_time: 1632873600
                      subscription_id: ENG-000000bd
                      type: SUB-ENG
                    - created_time: 1632941882
                      end_time: 1744156799
                      id: d6d8ead3-1234-5678-90ab-98badeac7287
                      modified_time: 1632941882
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 11
                      remaining_quantity: 9
                      start_time: 1632873600
                      subscription_id: MAN-000008be
                      type: SUB-MAN
                    summary:
                      SUB-ENG: 18
                      SUB-EX24: 3
                      SUB-MAN: 22
                      SUB-VNA: 20
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    amendments:
                    - created_time: 1644684842
                      end_time: 1744156799
                      id: ff0a14f6-1234-5678-90ab-c8e64d4bc6c6
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1632873600
                      subscription_id: VNA-000000af
                      type: SUB-VNA
                    - created_time: 1644684842
                      end_time: 1744156799
                      id: c1c28812-1234-5678-90ab-dc95680da61e
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1632873600
                      subscription_id: MAN-000008be
                      type: SUB-MAN
                    - created_time: 1644684842
                      end_time: 1744243199
                      id: 96c0a41f-1234-5678-90ab-afe74817e9fd
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1586476800
                      subscription_id: EX24-000000bc
                      type: SUB-EX24
                    entitled:
                      SUB-ENG: 26
                      SUB-EX24: 9
                      SUB-MAN: 26
                      SUB-VNA: 26
                    licenses:
                    - created_time: 1555353534
                      end_time: 1586822399
                      id: 693a41a6-1234-5678-90ab-f53dbd3a31c0
                      modified_time: 1555353534
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 0
                      start_time: 1555286400
                      subscription_id: VNA-000000aa
                      type: SUB-VNA
                    - created_time: 1576132516
                      end_time: 1586822399
                      id: 656607cf-1234-5678-90ab-fc9035614ea5
                      modified_time: 1576132516
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 8
                      remaining_quantity: 0
                      start_time: 1576022400
                      subscription_id: VNA-000000ab
                      type: SUB-VNA
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: db50d0bc-1234-5678-90ab-e439958cb06b
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: MAN-000000ac
                      type: SUB-MAN
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: 2ff9e84a-1234-5678-90ab-fb9ec0726e01
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: ENG-000000ad
                      type: SUB-ENG
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: 16df7ea6-1234-5678-90ab-78018cd4024d
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: VNA-000000ae
                      type: SUB-VNA
                    - created_time: 1586237081
                      end_time: 1744243199
                      id: 1b6f68d5-1234-5678-90ab-70d3e6d18c73
                      modified_time: 1586237081
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: VNA-000000af
                      type: SUB-VNA
                    - created_time: 1586237097
                      end_time: 1744243199
                      id: 1375c9bf-1234-5678-90ab-9c636708c89e
                      modified_time: 1586237097
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: MAN-000000ba
                      type: SUB-MAN
                    - created_time: 1586237137
                      end_time: 1744243199
                      id: 5974e979-1234-5678-90ab-438f833ec1c9
                      modified_time: 1586237137
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: ENG-000000bb
                      type: SUB-ENG
                    - created_time: 1629947267
                      end_time: 1744243199
                      id: 340a9cb3-1234-5678-90ab-b009344dbf3c
                      modified_time: 1629947267
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 10
                      remaining_quantity: 9
                      start_time: 1586476800
                      subscription_id: EX24-000000bc
                      type: SUB-EX24
                    - created_time: 1632941870
                      end_time: 1744156799
                      id: 9b599b0f-1234-5678-90ab-406081b58e7f
                      modified_time: 1632941870
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 10
                      remaining_quantity: 10
                      start_time: 1632873600
                      subscription_id: ENG-000000bd
                      type: SUB-ENG
                    - created_time: 1632941882
                      end_time: 1744156799
                      id: d6d8ead3-1234-5678-90ab-98badeac7287
                      modified_time: 1632941882
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 11
                      remaining_quantity: 9
                      start_time: 1632873600
                      subscription_id: MAN-000008be
                      type: SUB-MAN
                    summary:
                      SUB-ENG: 18
                      SUB-EX24: 3
                      SUB-MAN: 22
                      SUB-VNA: 20
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/license'
                - description: Organization license entitlement, subscription, and usage summary
                  examples:
                  - amendments:
                    - created_time: 1644684842
                      end_time: 1744156799
                      id: ff0a14f6-1234-5678-90ab-c8e64d4bc6c6
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1632873600
                      subscription_id: VNA-000000af
                      type: SUB-VNA
                    - created_time: 1644684842
                      end_time: 1744156799
                      id: c1c28812-1234-5678-90ab-dc95680da61e
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1632873600
                      subscription_id: MAN-000008be
                      type: SUB-MAN
                    - created_time: 1644684842
                      end_time: 1744243199
                      id: 96c0a41f-1234-5678-90ab-afe74817e9fd
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1586476800
                      subscription_id: EX24-000000bc
                      type: SUB-EX24
                    entitled:
                      SUB-ENG: 26
                      SUB-EX24: 9
                      SUB-MAN: 26
                      SUB-VNA: 26
                    licenses:
                    - created_time: 1555353534
                      end_time: 1586822399
                      id: 693a41a6-1234-5678-90ab-f53dbd3a31c0
                      modified_time: 1555353534
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 0
                      start_time: 1555286400
                      subscription_id: VNA-000000aa
                      type: SUB-VNA
                    - created_time: 1576132516
                      end_time: 1586822399
                      id: 656607cf-1234-5678-90ab-fc9035614ea5
                      modified_time: 1576132516
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 8
                      remaining_quantity: 0
                      start_time: 1576022400
                      subscription_id: VNA-000000ab
                      type: SUB-VNA
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: db50d0bc-1234-5678-90ab-e439958cb06b
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: MAN-000000ac
                      type: SUB-MAN
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: 2ff9e84a-1234-5678-90ab-fb9ec0726e01
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: ENG-000000ad
                      type: SUB-ENG
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: 16df7ea6-1234-5678-90ab-78018cd4024d
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: VNA-000000ae
                      type: SUB-VNA
                    - created_time: 1586237081
                      end_time: 1744243199
                      id: 1b6f68d5-1234-5678-90ab-70d3e6d18c73
                      modified_time: 1586237081
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: VNA-000000af
                      type: SUB-VNA
                    - created_time: 1586237097
                      end_time: 1744243199
                      id: 1375c9bf-1234-5678-90ab-9c636708c89e
                      modified_time: 1586237097
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: MAN-000000ba
                      type: SUB-MAN
                    - created_time: 1586237137
                      end_time: 1744243199
                      id: 5974e979-1234-5678-90ab-438f833ec1c9
                      modified_time: 1586237137
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: ENG-000000bb
                      type: SUB-ENG
                    - created_time: 1629947267
                      end_time: 1744243199
                      id: 340a9cb3-1234-5678-90ab-b009344dbf3c
                      modified_time: 1629947267
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 10
                      remaining_quantity: 9
                      start_time: 1586476800
                      subscription_id: EX24-000000bc
                      type: SUB-EX24
                    - created_time: 1632941870
                      end_time: 1744156799
                      id: 9b599b0f-1234-5678-90ab-406081b58e7f
                      modified_time: 1632941870
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 10
                      remaining_quantity: 10
                      start_time: 1632873600
                      subscription_id: ENG-000000bd
                      type: SUB-ENG
                    - created_time: 1632941882
                      end_time: 1744156799
                      id: d6d8ead3-1234-5678-90ab-98badeac7287
                      modified_time: 1632941882
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 11
                      remaining_quantity: 9
                      start_time: 1632873600
                      subscription_id: MAN-000008be
                      type: SUB-MAN
                    summary:
                      SUB-ENG: 18
                      SUB-EX24: 3
                      SUB-MAN: 22
                      SUB-VNA: 20
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    amendments:
                    - created_time: 1644684842
                      end_time: 1744156799
                      id: ff0a14f6-1234-5678-90ab-c8e64d4bc6c6
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1632873600
                      subscription_id: VNA-000000af
                      type: SUB-VNA
                    - created_time: 1644684842
                      end_time: 1744156799
                      id: c1c28812-1234-5678-90ab-dc95680da61e
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1632873600
                      subscription_id: MAN-000008be
                      type: SUB-MAN
                    - created_time: 1644684842
                      end_time: 1744243199
                      id: 96c0a41f-1234-5678-90ab-afe74817e9fd
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1586476800
                      subscription_id: EX24-000000bc
                      type: SUB-EX24
                    entitled:
                      SUB-ENG: 26
                      SUB-EX24: 9
                      SUB-MAN: 26
                      SUB-VNA: 26
                    licenses:
                    - created_time: 1555353534
                      end_time: 1586822399
                      id: 693a41a6-1234-5678-90ab-f53dbd3a31c0
                      modified_time: 1555353534
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 0
                      start_time: 1555286400
                      subscription_id: VNA-000000aa
                      type: SUB-VNA
                    - created_time: 1576132516
                      end_time: 1586822399
                      id: 656607cf-1234-5678-90ab-fc9035614ea5
                      modified_time: 1576132516
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 8
                      remaining_quantity: 0
                      start_time: 1576022400
                      subscription_id: VNA-000000ab
                      type: SUB-VNA
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: db50d0bc-1234-5678-90ab-e439958cb06b
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: MAN-000000ac
                      type: SUB-MAN
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: 2ff9e84a-1234-5678-90ab-fb9ec0726e01
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: ENG-000000ad
                      type: SUB-ENG
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: 16df7ea6-1234-5678-90ab-78018cd4024d
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: VNA-000000ae
                      type: SUB-VNA
                    - created_time: 1586237081
                      end_time: 1744243199
                      id: 1b6f68d5-1234-5678-90ab-70d3e6d18c73
                      modified_time: 1586237081
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: VNA-000000af
                      type: SUB-VNA
                    - created_time: 1586237097
                      end_time: 1744243199
                      id: 1375c9bf-1234-5678-90ab-9c636708c89e
                      modified_time: 1586237097
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: MAN-000000ba
                      type: SUB-MAN
                    - created_time: 1586237137
                      end_time: 1744243199
                      id: 5974e979-1234-5678-90ab-438f833ec1c9
                      modified_time: 1586237137
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: ENG-000000bb
                      type: SUB-ENG
                    - created_time: 1629947267
                      end_time: 1744243199
                      id: 340a9cb3-1234-5678-90ab-b009344dbf3c
                      modified_time: 1629947267
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 10
                      remaining_quantity: 9
                      start_time: 1586476800
                      subscription_id: EX24-000000bc
                      type: SUB-EX24
                    - created_time: 1632941870
                      end_time: 1744156799
                      id: 9b599b0f-1234-5678-90ab-406081b58e7f
                      modified_time: 1632941870
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 10
                      remaining_quantity: 10
                      start_time: 1632873600
                      subscription_id: ENG-000000bd
                      type: SUB-ENG
                    - created_time: 1632941882
                      end_time: 1744156799
                      id: d6d8ead3-1234-5678-90ab-98badeac7287
                      modified_time: 1632941882
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 11
                      remaining_quantity: 9
                      start_time: 1632873600
                      subscription_id: MAN-000008be
                      type: SUB-MAN
                    summary:
                      SUB-ENG: 18
                      SUB-EX24: 3
                      SUB-MAN: 22
                      SUB-VNA: 20
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/msps/{msp_id}/suggestion/count:
    get:
      tags:
      - MSPs Marvis
      summary: countMspsMarvisActions
      description: Return distinct counts of Marvis actions for this MSP grouped by the requested field, such as organization or status.
      operationId: countMspsMarvisActions
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `org_id`, `status`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/msp_marvis_suggestions_count_distinct'
          - description: 'Field used to group this count response. enum: `org_id`, `status`'
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Marvis Actions Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count_marvis_actions'
                - description: Distinct count response for Marvis action suggestions
                  examples:
                  - distinct: status
                    limit: 1000
                    results:
                    - count: 24
                      status: 002e176a-0000-000-1111-002e208b20e1
                    - count: 12
                      status: 2d3f176a-0000-000-2222-002e208f176a
                    - count: 15
                      status: 08b2176a-0000-000-3333-002e208b2d3f
                    total: 3
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: status
                    limit: 1000
                    results:
                    - count: 24
                      status: 002e176a-0000-000-1111-002e208b20e1
                    - count: 12
                      status: 2d3f176a-0000-000-2222-002e208f176a
                    - count: 15
                      status: 08b2176a-0000-000-3333-002e208b2d3f
                    total: 3
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count_marvis_actions'
                - description: Distinct count response for Marvis action suggestions
                  examples:
                  - distinct: status
                    limit: 1000
                    results:
                    - count: 24
                      status: 002e176a-0000-000-1111-002e208b20e1
                    - count: 12
                      status: 2d3f176a-0000-000-2222-002e208f176a
                    - count: 15
                      status: 08b2176a-0000-000-3333-002e208b2d3f
                    total: 3
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: status
                    limit: 1000
                    results:
                    - count: 24
                      status: 002e176a-0000-000-1111-002e208b20e1
                    - count: 12
                      status: 2d3f176a-0000-000-2222-002e208f176a
                    - count: 15
                      status: 08b2176a-0000-000-3333-002e208b2d3f
                    total: 3
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/msps/{msp_id}/orggroups:
    get:
      tags:
      - MSPs Org Groups
      summary: listMspOrgGroups
      description: List organization groups defined under this MSP. Organization groups contain related organization IDs and can be used in MSP privilege assignments.
      operationId: listMspOrgGroups
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/orggroup'
                description: List of MSP organization groups
                examples:
                - - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/orggroup'
                description: List of MSP organization groups
                examples:
                - - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - MSPs Org Groups
      summary: createMspOrgGroup
      description: Create an organization group under this MSP with a display name and optional list of member organization IDs.
      operationId: createMspOrgGroup
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/orggroup'
              - description: Request Body
                examples:
                - name: string
                  org_ids:
                  - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
              contentMediaType: application/json
            examples:
              Example:
                value:
                  name: string
                  org_ids:
                  - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orggroup'
                - description: MSP organization group containing related organizations
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orggroup'
                - description: MSP organization group containing related organizations
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/msps/{msp_id}/orggroups/{orggroup_id}:
    delete:
      tags:
      - MSPs Org Groups
      summary: deleteMspOrgGroup
      description: Delete an MSP organization group. This removes the grouping object without deleting the organizations it referenced.
      operationId: deleteMspOrgGroup
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: orggroup_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - MSPs Org Groups
      summary: getMspOrgGroup
      description: Return the organization group details, including its name and member organization IDs.
      operationId: getMspOrgGroup
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: orggroup_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orggroup'
                - description: MSP organization group containing related organizations
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orggroup'
                - description: MSP organization group containing related organizations
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - MSPs Org Groups
      summary: updateMspOrgGroup
      description: Update an MSP organization group's display name or member organization IDs.
      operationId: updateMspOrgGroup
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: orggroup_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/orggroup'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orggroup'
                - description: MSP organization group containing related organizations
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orggroup'
                - description: MSP organization group containing related organizations
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/msps/{msp_id}/orgs:
    get:
      tags:
      - MSPs Orgs
      summary: listMspOrgs
      description: List organizations managed by this MSP account, including MSP ownership and organization-group membership metadata.
      operationId: listMspOrgs
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/org'
                description: Organization records returned by a list response
                examples:
                - - alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 1440
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 1440
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/org'
                description: Organization records returned by a list response
                examples:
                - - alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 1440
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 1440
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - MSPs Orgs
      summary: createMspOrg
      description: Create an organization under this MSP, optionally assigning it to organization groups and setting organization-level defaults.
      operationId: createMspOrg
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/org'
              - description: Request Body
                examples:
                - alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  allow_mist: true
                  name: string
                  orggroup_ids:
                  - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  session_expiry: 10
              contentMediaType: application/json
            examples:
              Example:
                value:
                  alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  allow_mist: true
                  name: string
                  orggroup_ids:
                  - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  session_expiry: 10
        required: false
      responses:
        '200':
          description: Org Infos
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org'
                - description: Mist organization containing sites, devices, users, and organization-level settings
                  examples:
                  - alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 1440
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 1440
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org'
                - description: Mist organization containing sites, devices, users, and organization-level settings
                  examples:
                  - alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 1440
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 1440
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - MSPs Orgs
      summary: manageMspOrgs
      description: Assign existing organizations to this MSP account or unassign organizations from it by providing the desired operation and org IDs.
      operationId: manageMspOrgs
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/msp_org_change'
              - description: Request Body
                examples:
                - op: assign
                  org_ids:
                  - 2b069b358-4c97-5319-1f8c-7c5ca64d6ab1
              contentMediaType: application/json
            examples:
              Example:
                value:
                  op: assign
                  org_ids:
                  - 2b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/msps/{msp_id}/orgs/search:
    get:
      tags:
      - MSPs Orgs
      summary: searchMspOrgs
      description: Search organizations under this MSP using organization identifiers, names, subscription state, trial state, usage types, and time-based filters.
      operationId: searchMspOrgs
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: name
        in: query
        description: Filter results by name
        style: form
        explode: true
        schema:
          type: string
      - name: org_id
        in: query
        description: Filter results by organization identifier
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
      - name: sub_insufficient
        in: query
        description: If this org has sufficient subscription
        style: form
        explode: true
        schema:
          type: boolean
          examples:
          - false
      - name: trial_enabled
        in: query
        description: If this org is under trial period
        style: form
        explode: true
        schema:
          type: boolean
          examples:
          - false
      - name: usage_types
        in: query
        description: List of types that enabled by usage
        style: form
        explode: true
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_org_search'
                - description: Paginated response for MSP organization search results
                  examples:
                  - end: 1614383378.4365287
                    limit: 10
                    next: /api/v1/msps/43e96c5a-6ef6-11e6-9909-9596d1d1534f/orgs/search?end=1760601621&limit=1&search_after=%5B1760599794477%5D&start=1759996821
                    results:
                    - msp_id: d287e62f-0000-0000-0000-f2b9ba0a531f
                      name: Test Org
                      num_aps: 9
                      num_sites: 5
                      num_switches: 1
                      num_unassigned_aps: 1
                      org_id: bb1a8bf6-0000-0000-0000-8053a663cf65
                      sub_ana_required: 9
                      sub_ast_entitled: 5
                      sub_ast_required: 3
                      sub_eng_required: 3
                      sub_ex12_required: 1
                      sub_insufficient: true
                      sub_man_required: 9
                      sub_vna_entitled: 1
                      timestamp: 1614322563.513937
                      trial_enabled: false
                      usage_types:
                      - sub_eng
                    - msp_id: d287e62f-0000-0000-0000-f2b9ba0a531f
                      name: Rogue Test1
                      num_aps: 1
                      num_sites: 1
                      org_id: 0fb81690-0000-0000-0000-9596d1d1534f
                      sub_ana_entitled: 1
                      sub_ana_required: 1
                      sub_insufficient: false
                      sub_man_entitled: 1
                      sub_man_required: 1
                      timestamp: 1614309876.500955
                    start: 1613778578.4365668
                    total: 2
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1614383378.4365287
                    limit: 10
                    next: /api/v1/msps/43e96c5a-6ef6-11e6-9909-9596d1d1534f/orgs/search?end=1760601621&limit=1&search_after=%5B1760599794477%5D&start=1759996821
                    results:
                    - msp_id: d287e62f-0000-0000-0000-f2b9ba0a531f
                      name: Test Org
                      num_aps: 9
                      num_sites: 5
                      num_switches: 1
                      num_unassigned_aps: 1
                      org_id: bb1a8bf6-0000-0000-0000-8053a663cf65
                      sub_ana_required: 9
                      sub_ast_entitled: 5
                      sub_ast_required: 3
                      sub_eng_required: 3
                      sub_ex12_required: 1
                      sub_insufficient: true
                      sub_man_required: 9
                      sub_vna_entitled: 1
                      timestamp: 1614322563.513937
                      trial_enabled: false
                      usage_types:
                      - sub_eng
                    - msp_id: d287e62f-0000-0000-0000-f2b9ba0a531f
                      name: Rogue Test1
                      num_aps: 1
                      num_sites: 1
                      org_id: 0fb81690-0000-0000-0000-9596d1d1534f
                      sub_ana_entitled: 1
                      sub_ana_required: 1
                      sub_insufficient: false
                      sub_man_entitled: 1
                      sub_man_required: 1
                      timestamp: 1614309876.500955
                    start: 1613778578.4365668
                    total: 2
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_org_search'
                - description: Paginated response for MSP organization search results
                  examples:
                  - end: 1614383378.4365287
                    limit: 10
                    next: /api/v1/msps/43e96c5a-6ef6-11e6-9909-9596d1d1534f/orgs/search?end=1760601621&limit=1&search_after=%5B1760599794477%5D&start=1759996821
                    results:
                    - msp_id: d287e62f-0000-0000-0000-f2b9ba0a531f
                      name: Test Org
                      num_aps: 9
                      num_sites: 5
                      num_switches: 1
                      num_unassigned_aps: 1
                      org_id: bb1a8bf6-0000-0000-0000-8053a663cf65
                      sub_ana_required: 9
                      sub_ast_entitled: 5
                      sub_ast_required: 3
                      sub_eng_required: 3
                      sub_ex12_required: 1
                      sub_insufficient: true
                      sub_man_required: 9
                      sub_vna_entitled: 1
                      timestamp: 1614322563.513937
                      trial_enabled: false
                      usage_types:
                      - sub_eng
                    - msp_id: d287e62f-0000-0000-0000-f2b9ba0a531f
                      name: Rogue Test1
                      num_aps: 1
                      num_sites: 1
                      org_id: 0fb81690-0000-0000-0000-9596d1d1534f
                      sub_ana_entitled: 1
                      sub_ana_required: 1
                      sub_insufficient: false
                      sub_man_entitled: 1
                      sub_man_required: 1
                      timestamp: 1614309876.500955
                    start: 1613778578.4365668
                    total: 2
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1614383378.4365287
                    limit: 10
                    next: /api/v1/msps/43e96c5a-6ef6-11e6-9909-9596d1d1534f/orgs/search?end=1760601621&limit=1&search_after=%5B1760599794477%5D&start=1759996821
                    results:
                    - msp_id: d287e62f-0000-0000-0000-f2b9ba0a531f
                      name: Test Org
                      num_aps: 9
                      num_sites: 5
                      num_switches: 1
                      num_unassigned_aps: 1
                      org_id: bb1a8bf6-0000-0000-0000-8053a663cf65
                      sub_ana_required: 9
                      sub_ast_entitled: 5
                      sub_ast_required: 3
                      sub_eng_required: 3
                      sub_ex12_required: 1
                      sub_insufficient: true
                      sub_man_required: 9
                      sub_vna_entitled: 1
                      timestamp: 1614322563.513937
                      trial_enabled: false
                      usage_types:
                      - sub_eng
                    - msp_id: d287e62f-0000-0000-0000-f2b9ba0a531f
                      name: Rogue Test1
                      num_aps: 1
                      num_sites: 1
                      org_id: 0fb81690-0000-0000-0000-9596d1d1534f
                      sub_ana_entitled: 1
                      sub_ana_required: 1
                      sub_insufficient: false
                      sub_man_entitled: 1
                      sub_man_required: 1
                      timestamp: 1614309876.500955
                    start: 1613778578.4365668
                    total: 2
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/msps/{msp_id}/orgs/{org_id}:
    delete:
      tags:
      - MSPs Orgs
      summary: deleteMspOrg
      description: Delete an organization managed by this MSP. Use the MSP organization assignment endpoint when only assigning or unassigning organizations from the MSP account.
      operationId: deleteMspOrg
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - MSPs Orgs
      summary: getMspOrg
      description: Return details for one organization managed by this MSP, including MSP ownership, organization groups, support access, and session settings.
      operationId: getMspOrg
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Org Infos
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org'
                - description: Mist organization containing sites, devices, users, and organization-level settings
                  examples:
                  - alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 1440
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 1440
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org'
                - description: Mist organization containing sites, devices, users, and organization-level settings
                  examples:
                  - alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 1440
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 1440
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - MSPs Orgs
      summary: updateMspOrg
      description: Update organization settings for an organization managed by this MSP.
      operationId: updateMspOrg
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/org'
        required: false
      responses:
        '200':
          description: Org Infos
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org'
                - description: Mist organization containing sites, devices, users, and organization-level settings
                  examples:
                  - alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 1440
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 1440
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org'
                - description: Mist organization containing sites, devices, users, and organization-level settings
                  examples:
                  - alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 1440
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 1440
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/msps/{msp_id}/stats/orgs:
    get:
      tags:
      - MSPs Orgs
      summary: listMspOrgStats
      description: List organization statistics for organizations managed by this MSP, including device, inventory, site, and SLE summary fields.
      operationId: listMspOrgStats
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/stats_org'
                description: Organization statistics summaries returned by stats APIs
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/stats_org'
                description: Organization statistics summaries returned by stats APIs
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/msps/{msp_id}/insights/{metric}:
    get:
      tags:
      - MSPs SLEs
      summary: getMspSle
      description: Return MSP-level SLE insight metrics for the selected metric and time range. Depending on the metric, the response can include all organizations or the worst-performing organizations in the MSP.
      operationId: getMspSle
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: metric
        in: path
        description: See [List Insight Metrics]($e/Constants%20Definitions/listInsightMetrics) for available metrics
        required: true
        schema:
          type: string
      - name: sle
        in: query
        description: See [List Insight Metrics]($e/Constants%20Definitions/listInsightMetrics) for more details
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: interval
        in: query
        description: Aggregation works by giving a time range plus interval (e.g. 1d, 1h, 10m) where aggregation function would be applied to.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 10m
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/insight_metrics'
                - description: Insight metric response for a requested time range and aggregation interval
                  examples:
                  - end: 1643706000
                    interval: 3600
                    limit: 100
                    results:
                    - ap-availability: 0.9919400860511628
                      ap-health: 0.967607512909879
                      capacity: 0.7484652273070254
                      coverage: 0.91217567374857
                      num_aps: 13
                      num_clients: 12
                      org_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b
                      roaming: 0.991735537682683
                      roaming-exp: 0.991735537682683
                      successful-connect: 0.46052632135780236
                      throughput: 0.6775702123846302
                      time-to-connect: 0.9349112447196916
                    - ap-availability: 0.9990384613092129
                      ap-health: 0.48201754375507955
                      capacity: 0.9702673450306101
                      coverage: 0.8335392334930375
                      num_aps: 1
                      num_clients: 6
                      org_id: 49ff76e0-a283-4e7d-b38d-041f1e9aff3c
                      roaming: 1
                      roaming-exp: 1
                      successful-connect: 1
                      throughput: 0
                      time-to-connect: 1
                    - ap-availability: 1
                      ap-health: 0.982456140612301
                      capacity: 1
                      coverage: 0.9276041182442488
                      num_aps: 2
                      num_clients: 3
                      org_id: 9b9b48f1-15a4-459e-86cc-9cbec9005983
                      roaming: 1
                      roaming-exp: 1
                      successful-connect: 1
                      throughput: 1
                      time-to-connect: 0.8125
                    - ap-availability: 0.9981132070973234
                      ap-health: 0.9991228068084047
                      capacity: 1
                      coverage: 1
                      num_aps: 1
                      num_clients: 0
                      org_id: eb0e1671-7a6b-472b-94c3-c187dafe5274
                      roaming: 1
                      roaming-exp: 1
                      successful-connect: 1
                      throughput: 0
                      time-to-connect: 0.5
                    start: 1643670000
                contentMediaType: application/json
              examples:
                Orgs Sle:
                  value:
                    end: 1643706000
                    interval: 3600
                    limit: 100
                    results:
                    - ap-availability: 0.9919400860511628
                      ap-health: 0.967607512909879
                      capacity: 0.7484652273070254
                      coverage: 0.91217567374857
                      num_aps: 13
                      num_clients: 12
                      org_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b
                      roaming: 0.991735537682683
                      roaming-exp: 0.991735537682683
                      successful-connect: 0.46052632135780236
                      throughput: 0.6775702123846302
                      time-to-connect: 0.9349112447196916
                    - ap-availability: 0.9990384613092129
                      ap-health: 0.48201754375507955
                      capacity: 0.9702673450306101
                      coverage: 0.8335392334930375
                      num_aps: 1
                      num_clients: 6
                      org_id: 49ff76e0-a283-4e7d-b38d-041f1e9aff3c
                      roaming: 1
                      roaming-exp: 1
                      successful-connect: 1
                      throughput: 0
                      time-to-connect: 1
                    - ap-availability: 1
                      ap-health: 0.982456140612301
                      capacity: 1
                      coverage: 0.9276041182442488
                      num_aps: 2
                      num_clients: 3
                      org_id: 9b9b48f1-15a4-459e-86cc-9cbec9005983
                      roaming: 1
                      roaming-exp: 1
                      successful-connect: 1
                      throughput: 1
                      time-to-connect: 0.8125
                    - ap-availability: 0.9981132070973234
                      ap-health: 0.9991228068084047
                      capacity: 1
                      coverage: 1
                      num_aps: 1
                      num_clients: 0
                      org_id: eb0e1671-7a6b-472b-94c3-c187dafe5274
                      roaming: 1
                      roaming-exp: 1
                      successful-connect: 1
                      throughput: 0
                      time-to-connect: 0.5
                    start: 1643670000
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/insight_metrics'
                - description: Insight metric response for a requested time range and aggregation interval
                  examples:
                  - end: 1643706000
                    interval: 3600
                    limit: 100
                    results:
                    - ap-availability: 0.9919400860511628
                      ap-health: 0.967607512909879
                      capacity: 0.7484652273070254
                      coverage: 0.91217567374857
                      num_aps: 13
                      num_clients: 12
                      org_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b
                      roaming: 0.991735537682683
                      roaming-exp: 0.991735537682683
                      successful-connect: 0.46052632135780236
                      throughput: 0.6775702123846302
                      time-to-connect: 0.9349112447196916
                    - ap-availability: 0.9990384613092129
                      ap-health: 0.48201754375507955
                      capacity: 0.9702673450306101
                      coverage: 0.8335392334930375
                      num_aps: 1
                      num_clients: 6
                      org_id: 49ff76e0-a283-4e7d-b38d-041f1e9aff3c
                      roaming: 1
                      roaming-exp: 1
                      successful-connect: 1
                      throughput: 0
                      time-to-connect: 1
                    - ap-availability: 1
                      ap-health: 0.982456140612301
                      capacity: 1
                      coverage: 0.9276041182442488
                      num_aps: 2
                      num_clients: 3
                      org_id: 9b9b48f1-15a4-459e-86cc-9cbec9005983
                      roaming: 1
                      roaming-exp: 1
                      successful-connect: 1
                      throughput: 1
                      time-to-connect: 0.8125
                    - ap-availability: 0.9981132070973234
                      ap-health: 0.9991228068084047
                      capacity: 1
                      coverage: 1
                      num_aps: 1
                      num_clients: 0
                      org_id: eb0e1671-7a6b-472b-94c3-c187dafe5274
                      roaming: 1
                      roaming-exp: 1
                      successful-connect: 1
                      throughput: 0
                      time-to-connect: 0.5
                    start: 1643670000
                contentMediaType: application/vnd.api+json
              examples:
                Orgs Sle:
                  value:
                    end: 1643706000
                    interval: 3600
                    limit: 100
                    results:
                    - ap-availability: 0.9919400860511628
                      ap-health: 0.967607512909879
                      capacity: 0.7484652273070254
                      coverage: 0.91217567374857
                      num_aps: 13
                      num_clients: 12
                      org_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b
                      roaming: 0.991735537682683
                      roaming-exp: 0.991735537682683
                      successful-connect: 0.46052632135780236
                      throughput: 0.6775702123846302
                      time-to-connect: 0.9349112447196916
                    - ap-availability: 0.9990384613092129
                      ap-health: 0.48201754375507955
                      capacity: 0.9702673450306101
                      coverage: 0.8335392334930375
                      num_aps: 1
                      num_clients: 6
                      org_id: 49ff76e0-a283-4e7d-b38d-041f1e9aff3c
                      roaming: 1
                      roaming-exp: 1
                      successful-connect: 1
                      throughput: 0
                      time-to-connect: 1
                    - ap-availability: 1
                      ap-health: 0.982456140612301
                      capacity: 1
                      coverage: 0.9276041182442488
                      num_aps: 2
                      num_clients: 3
                      org_id: 9b9b48f1-15a4-459e-86cc-9cbec9005983
                      roaming: 1
                      roaming-exp: 1
                      successful-connect: 1
                      throughput: 1
                      time-to-connect: 0.8125
                    - ap-availability: 0.9981132070973234
                      ap-health: 0.9991228068084047
                      capacity: 1
                      coverage: 1
                      num_aps: 1
                      num_clients: 0
                      org_id: eb0e1671-7a6b-472b-94c3-c187dafe5274
                      roaming: 1
                      roaming-exp: 1
                      successful-connect: 1
                      throughput: 0
                      time-to-connect: 0.5
                    start: 1643670000
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/msps/{msp_id}/ssoroles:
    get:
      tags:
      - MSPs SSO Roles
      summary: listMspSsoRoles
      description: List MSP SSO role definitions that map identity-provider role assertions to MSP privilege scopes.
      operationId: listMspSsoRoles
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/sso_role_msp'
                description: MSP SSO roles returned by the request
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/sso_role_msp'
                description: MSP SSO roles returned by the request
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - MSPs SSO Roles
      summary: createMspSsoRole
      description: Create an MSP SSO role definition with a display name and the MSP privileges granted when the role is matched during SSO.
      operationId: createMspSsoRole
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/sso_role_msp'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sso_role_msp'
                - description: MSP SSO role definition
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    privileges:
                    - orggroup_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: read
                      scope: orggroup
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    privileges:
                    - orggroup_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: read
                      scope: orggroup
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sso_role_msp'
                - description: MSP SSO role definition
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    privileges:
                    - orggroup_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: read
                      scope: orggroup
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    privileges:
                    - orggroup_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: read
                      scope: orggroup
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/msps/{msp_id}/ssoroles/{ssorole_id}:
    delete:
      tags:
      - MSPs SSO Roles
      summary: deleteMspSsoRole
      description: Delete an MSP SSO role definition so it can no longer grant MSP privileges during SSO.
      operationId: deleteMspSsoRole
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: ssorole_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - MSPs SSO Roles
      summary: updateMspSsoRole
      description: Update an MSP SSO role definition, including its display name and granted MSP privileges.
      operationId: updateMspSsoRole
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: ssorole_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/sso_role_msp'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sso_role_msp'
                - description: MSP SSO role definition
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    privileges:
                    - orggroup_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: read
                      scope: orggroup
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    privileges:
                    - orggroup_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: read
                      scope: orggroup
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sso_role_msp'
                - description: MSP SSO role definition
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    privileges:
                    - orggroup_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: read
                      scope: orggroup
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    privileges:
                    - orggroup_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: read
                      scope: orggroup
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/msps/{msp_id}/ssos:
    get:
      tags:
      - MSPs SSO
      summary: listMspSsos
      description: List SSO identity provider configurations defined for this MSP.
      operationId: listMspSsos
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/sso'
                description: List of SSO configurations
                examples:
                - - created_time: 0
                    custom_logout_url: string
                    default_role: string
                    domain: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    idp_cert: string
                    idp_sign_algo: sha256
                    idp_sso_url: string
                    ignore_unmatched_roles: true
                    issuer: string
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    nameid_format: email
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 0
                    custom_logout_url: string
                    default_role: string
                    domain: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    idp_cert: string
                    idp_sign_algo: sha256
                    idp_sso_url: string
                    ignore_unmatched_roles: true
                    issuer: string
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    nameid_format: email
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: string
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/sso'
                description: List of SSO configurations
                examples:
                - - created_time: 0
                    custom_logout_url: string
                    default_role: string
                    domain: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    idp_cert: string
                    idp_sign_algo: sha256
                    idp_sso_url: string
                    ignore_unmatched_roles: true
                    issuer: string
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    nameid_format: email
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 0
                    custom_logout_url: string
                    default_role: string
                    domain: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    idp_cert: string
                    idp_sign_algo: sha256
                    idp_sso_url: string
                    ignore_unmatched_roles: true
                    issuer: string
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    nameid_format: email
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - MSPs SSO
      summary: createMspSso
      description: Create an MSP SSO identity provider configuration, including provider settings and role-handling behavior.
      operationId: createMspSso
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/sso'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sso'
                - description: Single sign-on identity provider configuration
                  examples:
                  - created_time: 0
                    custom_logout_url: string
                    default_role: string
                    domain: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    idp_cert: string
                    idp_sign_algo: sha256
                    idp_sso_url: string
                    ignore_unmatched_roles: true
                    issuer: string
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    nameid_format: email
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    custom_logout_url: string
                    default_role: string
                    domain: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    idp_cert: string
                    idp_sign_algo: sha256
                    idp_sso_url: string
                    ignore_unmatched_roles: true
                    issuer: string
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    nameid_format: email
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: string
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sso'
                - description: Single sign-on identity provider configuration
                  examples:
                  - created_time: 0
                    custom_logout_url: string
                    default_role: string
                    domain: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    idp_cert: string
                    idp_sign_algo: sha256
                    idp_sso_url: string
                    ignore_unmatched_roles: true
                    issuer: string
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    nameid_format: email
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    custom_logout_url: string
                    default_role: string
                    domain: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    idp_cert: string
                    idp_sign_algo: sha256
                    idp_sso_url: string
                    ignore_unmatched_roles: true
                    issuer: string
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    nameid_format: email
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/msps/{msp_id}/ssos/{sso_id}:
    delete:
      tags:
      - MSPs SSO
      summary: deleteMspSso
      description: Delete an MSP SSO identity provider configuration so it can no longer be used for administrator login.
      operationId: deleteMspSso
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: sso_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - MSPs SSO
      summary: getMspSso
      description: Return one MSP SSO identity provider configuration, including provider settings and generated SSO URLs.
      operationId: getMspSso
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: sso_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sso'
                - description: Single sign-on identity provider configuration
                  examples:
                  - created_time: 0
                    custom_logout_url: string
                    default_role: string
                    domain: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    idp_cert: string
                    idp_sign_algo: sha256
                    idp_sso_url: string
                    ignore_unmatched_roles: true
                    issuer: string
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    nameid_format: email
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    custom_logout_url: string
                    default_role: string
                    domain: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    idp_cert: string
                    idp_sign_algo: sha256
                    idp_sso_url: string
                    ignore_unmatched_roles: true
                    issuer: string
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    nameid_format: email
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: string
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sso'
                - description: Single sign-on identity provider configuration
                  examples:
                  - created_time: 0
                    custom_logout_url: string
                    default_role: string
                    domain: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    idp_cert: string
                    idp_sign_algo: sha256
                    idp_sso_url: string
                    ignore_unmatched_roles: true
                    issuer: string
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    nameid_format: email
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    custom_logout_url: string
                    default_role: string
                    domain: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    idp_cert: string
                    idp_sign_algo: sha256
                    idp_sso_url: string
                    ignore_unmatched_roles: true
                    issuer: string
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    nameid_format: email
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - MSPs SSO
      summary: updateMspSso
      description: Update an MSP SSO identity provider configuration, such as IdP URLs, certificates, issuer, NameID format, and unmatched-role handling.
      operationId: updateMspSso
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: sso_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/sso'
              - description: Request Body
                examples:
                - custom_logout_url: string
                  idp_cert: string
                  idp_sign_algo: sha256
                  idp_sso_url: string
                  ignore_unmatched_roles: true
                  issuer: string
                  name: string
                  nameid_format: email
              contentMediaType: application/json
            examples:
              Example:
                value:
                  custom_logout_url: string
                  idp_cert: string
                  idp_sign_algo: sha256
                  idp_sso_url: string
                  ignore_unmatched_roles: true
                  issuer: string
                  name: string
                  nameid_format: email
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sso'
                - description: Single sign-on identity provider configuration
                  examples:
                  - created_time: 0
                    custom_logout_url: string
                    default_role: string
                    domain: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    idp_cert: string
                    idp_sign_algo: sha256
                    idp_sso_url: string
                    ignore_unmatched_roles: true
                    issuer: string
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    nameid_format: email
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    custom_logout_url: string
                    default_role: string
                    domain: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    idp_cert: string
                    idp_sign_algo: sha256
                    idp_sso_url: string
                    ignore_unmatched_roles: true
                    issuer: string
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    nameid_format: email
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: string
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sso'
                - description: Single sign-on identity provider configuration
                  examples:
                  - created_time: 0
                    custom_logout_url: string
                    default_role: string
                    domain: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    idp_cert: string
                    idp_sign_algo: sha256
                    idp_sso_url: string
                    ignore_unmatched_roles: true
                    issuer: string
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    nameid_format: email
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    custom_logout_url: string
                    default_role: string
                    domain: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    idp_cert: string
                    idp_sign_algo: sha256
                    idp_sso_url: string
                    ignore_unmatched_roles: true
                    issuer: string
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    nameid_format: email
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/msps/{msp_id}/ssos/{sso_id}/delete_admins:
    post:
      tags:
      - MSPs SSO
      summary: deleteMspSsoAdmins
      description: Remove SSO-linked MSP administrator accounts by email for this SSO profile.
      operationId: deleteMspSsoAdmins
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: sso_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/sso_delete_admins'
              - description: Request Body
                examples:
                - emails:
                  - john@abc.com
                  - may@abc.com
              contentMediaType: application/json
            examples:
              Example:
                value:
                  emails:
                  - john@abc.com
                  - may@abc.com
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sso_delete_admins_response'
                - description: Result of deleting SSO admin accounts
                contentMediaType: application/json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/msps/{msp_id}/ssos/{sso_id}/failures:
    get:
      tags:
      - MSPs SSO
      summary: listMspSsoLatestFailures
      description: List recent authentication failures for this MSP SSO configuration, including failure details and captured SAML assertion data when available.
      operationId: listMspSsoLatestFailures
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: sso_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_sso_failure_search'
                - description: Response containing recent SSO authentication failure records
                  examples:
                  - results:
                    - detail: string
                      saml_assertion_xml: string
                      timestamp: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    results:
                    - detail: string
                      saml_assertion_xml: string
                      timestamp: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_sso_failure_search'
                - description: Response containing recent SSO authentication failure records
                  examples:
                  - results:
                    - detail: string
                      saml_assertion_xml: string
                      timestamp: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    results:
                    - detail: string
                      saml_assertion_xml: string
                      timestamp: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/msps/{msp_id}/ssos/{sso_id}/metadata:
    get:
      tags:
      - MSPs SSO
      summary: getMspSamlMetadata
      description: Return generated SAML service provider metadata for this MSP SSO configuration as JSON.
      operationId: getMspSamlMetadata
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: sso_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/saml_metadata'
                - description: Read-only SAML and SCIM metadata generated for an SSO configuration
                  examples:
                  - acs_url: https://api.mist.com/api/v1/saml/llDfa13f/login
                    entity_id: https://api.mist.com/api/v1/saml/llDfa13f/login
                    logout_url: https://api.mist.com/api/v1/saml/llDfa13f/logout
                    metadata: <?xml version="1.0" encoding="UTF-8"?><md:EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" entityID="https://api.mist.com/api/v1/saml/llDfa13f/login" validUntil="2027-10-12T21:59:01Z" xmlns:ds="http://www.w3.org/2000/09/xmldsig#"><md:SPSSODescriptor AuthnRequestsSigned="false" WantAssertionsSigned="true" protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol"><md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</md:NameIDFormat><md:AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://api.mist.com/api/v1/saml/llDfa13f/login" index="0" isDefault="true"/></md:SPSSODescriptor></md:EntityDescriptor>
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    acs_url: https://api.mist.com/api/v1/saml/llDfa13f/login
                    entity_id: https://api.mist.com/api/v1/saml/llDfa13f/login
                    logout_url: https://api.mist.com/api/v1/saml/llDfa13f/logout
                    metadata: <?xml version="1.0" encoding="UTF-8"?><md:EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" entityID="https://api.mist.com/api/v1/saml/llDfa13f/login" validUntil="2027-10-12T21:59:01Z" xmlns:ds="http://www.w3.org/2000/09/xmldsig#"><md:SPSSODescriptor AuthnRequestsSigned="false" WantAssertionsSigned="true" protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol"><md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</md:NameIDFormat><md:AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://api.mist.com/api/v1/saml/llDfa13f/login" index="0" isDefault="true"/></md:SPSSODescriptor></md:EntityDescriptor>
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/saml_metadata'
                - description: Read-only SAML and SCIM metadata generated for an SSO configuration
                  examples:
                  - acs_url: https://api.mist.com/api/v1/saml/llDfa13f/login
                    entity_id: https://api.mist.com/api/v1/saml/llDfa13f/login
                    logout_url: https://api.mist.com/api/v1/saml/llDfa13f/logout
                    metadata: <?xml version="1.0" encoding="UTF-8"?><md:EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" entityID="https://api.mist.com/api/v1/saml/llDfa13f/login" validUntil="2027-10-12T21:59:01Z" xmlns:ds="http://www.w3.org/2000/09/xmldsig#"><md:SPSSODescriptor AuthnRequestsSigned="false" WantAssertionsSigned="true" protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol"><md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</md:NameIDFormat><md:AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://api.mist.com/api/v1/saml/llDfa13f/login" index="0" isDefault="true"/></md:SPSSODescriptor></md:EntityDescriptor>
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    acs_url: https://api.mist.com/api/v1/saml/llDfa13f/login
                    entity_id: https://api.mist.com/api/v1/saml/llDfa13f/login
                    logout_url: https://api.mist.com/api/v1/saml/llDfa13f/logout
                    metadata: <?xml version="1.0" encoding="UTF-8"?><md:EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" entityID="https://api.mist.com/api/v1/saml/llDfa13f/login" validUntil="2027-10-12T21:59:01Z" xmlns:ds="http://www.w3.org/2000/09/xmldsig#"><md:SPSSODescriptor AuthnRequestsSigned="false" WantAssertionsSigned="true" protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol"><md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</md:NameIDFormat><md:AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://api.mist.com/api/v1/saml/llDfa13f/login" index="0" isDefault="true"/></md:SPSSODescriptor></md:EntityDescriptor>
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/msps/{msp_id}/ssos/{sso_id}/metadata.xml:
    get:
      tags:
      - MSPs SSO
      summary: downloadMspSamlMetadata
      description: >-
        Download generated SAML service provider metadata XML for this MSP SSO configuration.


        Example of metadata.xml:

        ```xml

        <?xml version="1.0" encoding="UTF-8"?><md:EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" entityID="https://api.mist.com/api/v1/saml/5hdF5g/login" validUntil="2027-10-12T21:59:01Z" xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
          <md:SPSSODescriptor AuthnRequestsSigned="false" WantAssertionsSigned="true" protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol">
              <md:SingleLogoutService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://api.mist.com/api/v1/saml/5hdF5g/logout" />
              <md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</md:NameIDFormat>
              <md:AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://api.mist.com/api/v1/saml/5hdF5g/login" index="0" isDefault="true"/>
              <md:AttributeConsumingService index="0">
                  <md:ServiceName xml:lang="en-US">Mist</md:ServiceName>
                  <md:RequestedAttribute Name="Role" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic" isRequired="true"/>
                  <md:RequestedAttribute Name="FirstName" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic" isRequired="false"/>
                  <md:RequestedAttribute Name="LastName" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic" isRequired="false"/>
              </md:AttributeConsumingService>
          </md:SPSSODescriptor>
        </md:EntityDescriptor>

        ```
      operationId: downloadMspSamlMetadata
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: sso_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: string
                description: File
                contentEncoding: base64
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                type: string
                description: File
                contentEncoding: base64
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/msps/{msp_id}/tickets:
    get:
      tags:
      - MSPs Tickets
      summary: listMspTickets
      description: List support tickets associated with this MSP for the requested time range.
      operationId: listMspTickets
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ticket'
                description: Support ticket records returned by a ticket list response
                examples:
                - - comments:
                    - attachments:
                      - content_type: string
                        content_url: string
                      author: string
                      comment: string
                      created_at: 0
                    created_at: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    requester: string
                    status: open
                    subject: string
                    type: string
                    updated_at: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - comments:
                    - attachments:
                      - content_type: string
                        content_url: string
                      author: string
                      comment: string
                      created_at: 0
                    created_at: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    requester: string
                    status: open
                    subject: string
                    type: string
                    updated_at: 0
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ticket'
                description: Support ticket records returned by a ticket list response
                examples:
                - - comments:
                    - attachments:
                      - content_type: string
                        content_url: string
                      author: string
                      comment: string
                      created_at: 0
                    created_at: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    requester: string
                    status: open
                    subject: string
                    type: string
                    updated_at: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - comments:
                    - attachments:
                      - content_type: string
                        content_url: string
                      author: string
                      comment: string
                      created_at: 0
                    created_at: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    requester: string
                    status: open
                    subject: string
                    type: string
                    updated_at: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/msps/{msp_id}/tickets/count:
    get:
      tags:
      - MSPs Tickets
      summary: countMspTickets
      description: Return distinct counts of MSP support tickets grouped by the requested field, such as organization, status, or ticket type.
      operationId: countMspTickets
      parameters:
      - name: msp_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `org_id`, `status`, `type`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/msp_tickets_count_distinct'
          - description: 'Field used to group this count response. enum: `org_id`, `status`, `type`'
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs:
    post:
      tags:
      - Orgs
      summary: createOrg
      description: Create a Mist organization with organization-level defaults such as display name, support-access setting, default alarm template, and admin session lifetime.
      operationId: createOrg
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/org'
              - examples:
                - alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  allow_mist: true
                  name: string
                  session_expiry: 1440
              contentMediaType: application/json
            examples:
              Example:
                value:
                  alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  allow_mist: true
                  name: string
                  session_expiry: 1440
        required: false
      responses:
        '200':
          description: Org Infos
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org'
                - description: Mist organization containing sites, devices, users, and organization-level settings
                  examples:
                  - alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 1440
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 1440
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org'
                - description: Mist organization containing sites, devices, users, and organization-level settings
                  examples:
                  - alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 1440
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 1440
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}:
    delete:
      tags:
      - Orgs
      summary: deleteOrg
      description: Delete an organization and its organization-level resources. Use MSP organization assignment endpoints when only changing MSP ownership or association. This action is only allowed when the Organization Inventory is empty.
      operationId: deleteOrg
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs
      summary: getOrg
      description: Return organization details, including name, MSP ownership, organization group membership, support-access setting, and session settings.
      operationId: getOrg
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Org Infos
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org'
                - description: Mist organization containing sites, devices, users, and organization-level settings
                  examples:
                  - alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 1440
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 1440
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org'
                - description: Mist organization containing sites, devices, users, and organization-level settings
                  examples:
                  - alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 1440
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 1440
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs
      summary: updateOrg
      description: Update organization-level settings such as display name, support-access setting, organization groups, default alarm template, or admin session lifetime.
      operationId: updateOrg
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/org'
              - description: Request Body
                examples:
                - alarmtemplate_id: 1984805d-2be2-4aec-a8d4-3ddf67fab0df
                  allow_mist: true
                  name: string
                  orggroup_ids: []
                  session_expiry: 1440
              contentMediaType: application/json
            examples:
              Example:
                value:
                  alarmtemplate_id: 1984805d-2be2-4aec-a8d4-3ddf67fab0df
                  allow_mist: true
                  name: string
                  orggroup_ids: []
                  session_expiry: 1440
        required: false
      responses:
        '200':
          description: Org Infos
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org'
                - description: Mist organization containing sites, devices, users, and organization-level settings
                  examples:
                  - alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 1440
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 1440
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org'
                - description: Mist organization containing sites, devices, users, and organization-level settings
                  examples:
                  - alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 1440
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 1440
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/clone:
    post:
      tags:
      - Orgs
      summary: cloneOrg
      description: Create an Org by cloning from another one. Org Settings, Templates, Wxlan Tags, Wxlan Tunnels, Wxlan Rules, Org Wlans will be copied. Sites and Site Groups will not be copied, and therefore, the copied template will not be applied to any site/sitegroups.
      operationId: cloneOrg
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/name_string'
              - description: Request Body
                examples:
                - name: New Org
              contentMediaType: application/json
            examples:
              Example:
                value:
                  name: New Org
        required: false
      responses:
        '200':
          description: Org Infos
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org'
                - description: Mist organization containing sites, devices, users, and organization-level settings
                  examples:
                  - alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 1440
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 1440
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org'
                - description: Mist organization containing sites, devices, users, and organization-level settings
                  examples:
                  - alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 1440
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 1440
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/admins:
    get:
      tags:
      - Orgs Admins
      summary: listOrgAdmins
      description: List administrators that have privileges in this organization hierarchy, including organization, site, or site group scopes.
      operationId: listOrgAdmins
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                uniqueItems: true
                type: array
                items:
                  $ref: '#/components/schemas/admin'
                description: List of Mist administrator accounts
                examples:
                - '[{"admin_id":"456b7016-a916-a4b1-78dd-72b947c152b7","email":"jsmith@mycorp.org","first_name":"Joe","last_name":"Smith","privileges":[{"role":"admin","scope":"msp"},{"org_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","role":"admin","scope":"org"},{"orggroup_ids":["507f1bab-13ba-73e2-f291-2bcb8d1362b0"],"role":"read","scope":"orggroup"}]}]'
                - '[{"admin_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","email":"user@example.com","first_name":"string","last_name":"string","privileges":[{"msp_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","msp_name":"string","name":"string","org_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","org_name":"string","orggroup_ids":["b069b358-4c97-5319-1f8c-7c5ca64d6ab1"],"role":"admin","scope":"org","site_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","sitegroup_ids":["6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9"]}]}]'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - admin_id: 456b7016-a916-a4b1-78dd-72b947c152b7
                    email: jsmith@mycorp.org
                    first_name: Joe
                    last_name: Smith
                    privileges:
                    - role: admin
                      scope: msp
                    - org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                    - orggroup_ids:
                      - 507f1bab-13ba-73e2-f291-2bcb8d1362b0
                      role: read
                      scope: orggroup
                Example2:
                  value:
                  - admin_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    email: user@example.com
                    first_name: string
                    last_name: string
                    privileges:
                    - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      msp_name: string
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      org_name: string
                      orggroup_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sitegroup_ids:
                      - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
            application/vnd.api+json:
              schema:
                uniqueItems: true
                type: array
                items:
                  $ref: '#/components/schemas/admin'
                description: List of Mist administrator accounts
                examples:
                - '[{"admin_id":"456b7016-a916-a4b1-78dd-72b947c152b7","email":"jsmith@mycorp.org","first_name":"Joe","last_name":"Smith","privileges":[{"role":"admin","scope":"msp"},{"org_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","role":"admin","scope":"org"},{"orggroup_ids":["507f1bab-13ba-73e2-f291-2bcb8d1362b0"],"role":"read","scope":"orggroup"}]}]'
                - '[{"admin_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","email":"user@example.com","first_name":"string","last_name":"string","privileges":[{"msp_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","msp_name":"string","name":"string","org_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","org_name":"string","orggroup_ids":["b069b358-4c97-5319-1f8c-7c5ca64d6ab1"],"role":"admin","scope":"org","site_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","sitegroup_ids":["6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9"]}]}]'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - admin_id: 456b7016-a916-a4b1-78dd-72b947c152b7
                    email: jsmith@mycorp.org
                    first_name: Joe
                    last_name: Smith
                    privileges:
                    - role: admin
                      scope: msp
                    - org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                    - orggroup_ids:
                      - 507f1bab-13ba-73e2-f291-2bcb8d1362b0
                      role: read
                      scope: orggroup
                Example2:
                  value:
                  - admin_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    email: user@example.com
                    first_name: string
                    last_name: string
                    privileges:
                    - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      msp_name: string
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      org_name: string
                      orggroup_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sitegroup_ids:
                      - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/admins/{admin_id}:
    delete:
      tags:
      - Orgs Admins
      summary: revokeOrgAdmin
      description: Remove all privileges this administrator has in the organization hierarchy. This does not delete the administrator account.
      operationId: revokeOrgAdmin
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: admin_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs Admins
      summary: updateOrgAdmin
      description: Update identity fields and privilege assignments for an existing administrator under this organization.
      operationId: updateOrgAdmin
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: admin_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/admin'
              - description: Request Body
                examples:
                - '{"email":"jsnow@abc.com","expire_time":0,"first_name":"John","hours":24,"last_name":"Sno","phone":"string","phone2":"string","privileges":[{"msp_id":"c0cf23fc-d82f-4219-988c-82fb61d8c875","name":"string","org_id":"a40f5d1f-d889-42e9-94ea-b9b33585fc6b","org_name":"string","orggroup_ids":["497f6eca-6276-4993-bfeb-53d5bbba6f08"],"role":"admin","scope":"org","site_id":"72771e6a-6f5e-4de4-a5b9-1266c4197811","sitegroup_ids":["497f6eca-6276-4993-bfeb-53d6bbba6f08"],"views":["switch_admin"]}]}'
              contentMediaType: application/json
            examples:
              Example:
                value:
                  email: jsnow@abc.com
                  expire_time: 0
                  first_name: John
                  hours: 24
                  last_name: Sno
                  phone: string
                  phone2: string
                  privileges:
                  - msp_id: c0cf23fc-d82f-4219-988c-82fb61d8c875
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    org_name: string
                    orggroup_ids:
                    - 497f6eca-6276-4993-bfeb-53d5bbba6f08
                    role: admin
                    scope: org
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    sitegroup_ids:
                    - 497f6eca-6276-4993-bfeb-53d6bbba6f08
                    views:
                    - switch_admin
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/admin'
                - description: Mist administrator account or organization API token details
                  examples:
                  - admin_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    email: user@example.com
                    first_name: string
                    last_name: string
                    password_modified_time: 1656353525
                    privileges:
                    - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      msp_name: string
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      org_name: string
                      orggroup_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sitegroup_ids:
                      - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    admin_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    email: user@example.com
                    first_name: string
                    last_name: string
                    password_modified_time: 1656353525
                    privileges:
                    - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      msp_name: string
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      org_name: string
                      orggroup_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sitegroup_ids:
                      - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/admin'
                - description: Mist administrator account or organization API token details
                  examples:
                  - admin_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    email: user@example.com
                    first_name: string
                    last_name: string
                    password_modified_time: 1656353525
                    privileges:
                    - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      msp_name: string
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      org_name: string
                      orggroup_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sitegroup_ids:
                      - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    admin_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    email: user@example.com
                    first_name: string
                    last_name: string
                    password_modified_time: 1656353525
                    privileges:
                    - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      msp_name: string
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      org_name: string
                      orggroup_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sitegroup_ids:
                      - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/invites:
    post:
      tags:
      - Orgs Admins
      summary: inviteOrgAdmin
      description: If the request is successful, an email will also be sent to the user with a link to ```https://manage.mist.com/verify/invite?token=:token&expire=1459632743&org=OrgName```
      operationId: inviteOrgAdmin
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/admin'
              - description: Request Body
                examples:
                - '{"email":"user@example.com","first_name":"string","last_name":"string","privileges":[{"msp_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","msp_name":"string","name":"string","org_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","org_name":"string","orggroup_ids":["b069b358-4c97-5319-1f8c-7c5ca64d6ab1"],"role":"admin","scope":"org","site_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","sitegroup_ids":["b069b358-4c97-5319-1f8c-7c5ca64d6ab1"]}]}'
              contentMediaType: application/json
            examples:
              Example:
                value:
                  email: user@example.com
                  first_name: string
                  last_name: string
                  privileges:
                  - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    msp_name: string
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    org_name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    role: admin
                    scope: org
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    sitegroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/invites/{invite_id}:
    delete:
      tags:
      - Orgs Admins
      summary: uninviteOrgAdmin
      description: Cancel a pending organization admin invite by invite ID.
      operationId: uninviteOrgAdmin
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: invite_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs Admins
      summary: updateOrgAdminInvite
      description: Update a pending organization admin invite, including invitee identity and requested privileges.
      operationId: updateOrgAdminInvite
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: invite_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/admin'
              - description: Request Body
                examples:
                - '{"email":"user@example.com","first_name":"string","last_name":"string","privileges":[{"msp_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","msp_name":"string","name":"string","org_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","org_name":"string","orggroup_ids":["b069b358-4c97-5319-1f8c-7c5ca64d6ab1"],"role":"admin","scope":"org","site_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","sitegroup_ids":["b069b358-4c97-5319-1f8c-7c5ca64d6ab1"]}]}'
              contentMediaType: application/json
            examples:
              Example:
                value:
                  email: user@example.com
                  first_name: string
                  last_name: string
                  privileges:
                  - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    msp_name: string
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    org_name: string
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    role: admin
                    scope: org
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    sitegroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/alarms/ack:
    post:
      tags:
      - Orgs Alarms
      summary: ackOrgMultipleAlarms
      description: Acknowledge multiple organization alarms by alarm ID and optionally attach a note to the acknowledgement.
      operationId: ackOrgMultipleAlarms
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/alarms'
              - description: Request Body
                examples:
                - alarm_ids:
                  - ccb8c94d-ca56-4075-932f-1f2ab444ff2c
                  - 98ff4a3d-ec9b-4138-a42e-54fc3335179d
                  note: maintenance window
              contentMediaType: application/json
            examples:
              Example:
                value:
                  alarm_ids:
                  - ccb8c94d-ca56-4075-932f-1f2ab444ff2c
                  - 98ff4a3d-ec9b-4138-a42e-54fc3335179d
                  note: maintenance window
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/alarms/ack_all:
    post:
      tags:
      - Orgs Alarms
      summary: ackOrgAllAlarms
      description: Acknowledge all alarms in the organization and optionally attach a note. For targeted bulk updates, use [Ack Org Multiple Alarms]($e/Orgs%20Alarms/ackOrgMultipleAlarms) with up to 1000 alarm IDs per request.
      operationId: ackOrgAllAlarms
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/note_string'
              - examples:
                - note: string
              contentMediaType: application/json
            examples:
              Example:
                value:
                  note: string
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/alarms/count:
    get:
      tags:
      - Orgs Alarms
      summary: countOrgAlarms
      description: Count alarms across the organization, optionally grouped by the `distinct` field and filtered by time range.
      operationId: countOrgAlarms
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: Field used to group this count response
        style: form
        explode: true
        schema:
          type: string
          examples:
          - site_id
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/alarms/search:
    get:
      tags:
      - Orgs Alarms
      summary: searchOrgAlarms
      description: Search alarms across the organization with filters for site, alarm group, severity, type, acknowledgement state, acknowledgement admin, and time range.
      operationId: searchOrgAlarms
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: site_id
        in: query
        description: Filter results by site identifier. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002
          - 72771e6a-6f5e-4de4-a5b9-1266c4197811
        examples:
          Untitled Example1:
            value: 00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002
          Untitled Example2:
            value: 72771e6a-6f5e-4de4-a5b9-1266c4197811
      - name: group
        in: query
        description: 'Alarm group used to filter alarm results. enum: `certificate_expiry`, `infrastructure`, `marvis`, `security`. The `marvis` group is used to retrieve AI-driven network issue detections. Known Marvis alarm types include: `bad_cable`, `bad_wan_uplink`, `dns_failure`, `arp_failure`, `auth_failure`, `dhcp_failure`, `missing_vlan`, `negotiation_mismatch`, `port_flap`. Results include resolution status (`status`, `resolved_time`) and affected entity details. Accepts multiple comma-separated values.'
        style: form
        explode: true
        schema:
          type: string
          examples:
          - security,infrastructure
      - name: severity
        in: query
        description: 'Alarm severity used to filter results. enum: `critical`, `info`, `warn`. Accepts multiple comma-separated values.'
        style: form
        explode: true
        schema:
          type: string
          examples:
          - warn,critical
      - name: type
        in: query
        description: Filter alarms by alarm type. Accepts multiple values separated by comma. Use [List Alarm Definitions](/#operations/listAlarmDefinitions) to get the list of possible alarm types
        style: form
        explode: true
        schema:
          type: string
          examples:
          - infra_dhcp_failure,missing_vlan
      - name: ack_admin_name
        in: query
        description: Name of the admins who have acked the alarms; accepts multiple values separated by comma
        style: form
        explode: true
        schema:
          type: string
      - name: acked
        in: query
        description: Filter alarm results by whether the alarm has been acknowledged
        style: form
        explode: true
        schema:
          type: boolean
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/alarm_search_result'
                - description: Paginated response returned by an alarm search
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/alarm_search_result'
                - description: Paginated response returned by an alarm search
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/alarms/unack:
    post:
      tags:
      - Orgs Alarms
      summary: unackOrgMultipleAlarms
      description: Remove acknowledgement from multiple organization alarms by alarm ID and optionally attach a note.
      operationId: unackOrgMultipleAlarms
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/alarms'
              - description: Request Body
                examples:
                - alarm_ids:
                  - ccb8c94d-ca56-4075-932f-1f2ab444ff2c
                  - 98ff4a3d-ec9b-4138-a42e-54fc3335179d
                  note: maintenance window
              contentMediaType: application/json
            examples:
              Example:
                value:
                  alarm_ids:
                  - ccb8c94d-ca56-4075-932f-1f2ab444ff2c
                  - 98ff4a3d-ec9b-4138-a42e-54fc3335179d
                  note: maintenance window
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/alarms/unack_all:
    post:
      tags:
      - Orgs Alarms
      summary: unackOrgAllAlarms
      description: Remove acknowledgement from all alarms in the organization and optionally attach a note. For targeted bulk updates, use [Unack Org Multiple Alarms]($e/Orgs%20Alarms/unackOrgMultipleAlarms) with up to 1000 alarm IDs per request.
      operationId: unackOrgAllAlarms
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/note_string'
              - description: Request Body
                examples:
                - note: maintenance window
              contentMediaType: application/json
            examples:
              Example:
                value:
                  note: maintenance window
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/alarms/{alarm_id}/ack:
    post:
      tags:
      - Orgs Alarms
      summary: ackOrgAlarm
      description: Acknowledge a single organization alarm and optionally attach a note to the acknowledgement.
      operationId: ackOrgAlarm
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: alarm_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/note_string'
              - description: Request Body
                examples:
                - note: maintenance window
              contentMediaType: application/json
            examples:
              Example:
                value:
                  note: maintenance window
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/subscriptions:
    delete:
      tags:
      - Orgs Alarms
      summary: unsubscribeOrgAlarmsReports
      description: >-
        Unsubscribe from Org Alarms/Reports

        Subscriptions define how Org Alarms/Reports are delivered to whom
      operationId: unsubscribeOrgAlarmsReports
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs Alarms
      summary: subscribeOrgAlarmsReports
      description: >-
        Subscribe to Org Alarms/Reports

        Subscriptions define how Org Alarms/Reports are delivered to whom
      operationId: subscribeOrgAlarmsReports
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/alarmtemplates:
    get:
      tags:
      - Orgs Alarm Templates
      summary: listOrgAlarmTemplates
      description: List alarm templates defined for the organization, including default delivery settings and per-alarm rule configuration.
      operationId: listOrgAlarmTemplates
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/alarm_template'
                description: List of alarm templates
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/alarm_template'
                description: List of alarm templates
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs Alarm Templates
      summary: createOrgAlarmTemplate
      description: >-
        Create an organization alarm template that defines default delivery settings and per-alarm rule overrides.

        Available rules can be found in [List Alarm Definitions]($e/Constants%20Events/listAlarmDefinitions)


        The `delivery` object is only required when it differs from the template delivery settings.

        To assign an Alarm template to a site, use the [Update Site]($e/Sites/updateSiteInfo) endpoint and specify the Alarm template ID in the `alarmtemplate_id` field of the request body.
      operationId: createOrgAlarmTemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/alarm_template'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/alarm_template'
                - description: Alarm template defining default delivery and per-alarm rules
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/alarm_template'
                - description: Alarm template defining default delivery and per-alarm rules
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/alarmtemplates/suppress:
    delete:
      tags:
      - Orgs Alarm Templates
      summary: unsuppressOrgSuppressedAlarms
      description: Remove alarm suppression entries currently configured for this organization.
      operationId: unsuppressOrgSuppressedAlarms
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs Alarm Templates
      summary: listOrgSuppressedAlarms
      description: List alarm suppression entries currently configured for this organization, optionally filtered by organization-wide or site-specific scope.
      operationId: listOrgSuppressedAlarms
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: scope
        in: query
        description: 'Filter results by scope. enum: `org`, `site`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/suppressed_alarm_scope'
          - description: 'Filter results by scope. enum: `org`, `site`'
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_org_suppress_alarm'
                - description: Response containing currently suppressed organization alarm entries
                  examples:
                  - results:
                    - duration: 48
                      expire_time: 1678233080
                      scheduled_time: 1678232900
                      scope: site
                      site_id: 581328b6-e382-f54e-c9dc-9c998d183a34
                    - duration: 48
                      expire_time: 1678233080
                      scheduled_time: 1678232900
                      scope: org
                      site_id: 581328b6-e382-f54e-c9dc-9c998d183a35
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    results:
                    - duration: 48
                      expire_time: 1678233080
                      scheduled_time: 1678232900
                      scope: site
                      site_id: 581328b6-e382-f54e-c9dc-9c998d183a34
                    - duration: 48
                      expire_time: 1678233080
                      scheduled_time: 1678232900
                      scope: org
                      site_id: 581328b6-e382-f54e-c9dc-9c998d183a35
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_org_suppress_alarm'
                - description: Response containing currently suppressed organization alarm entries
                  examples:
                  - results:
                    - duration: 48
                      expire_time: 1678233080
                      scheduled_time: 1678232900
                      scope: site
                      site_id: 581328b6-e382-f54e-c9dc-9c998d183a34
                    - duration: 48
                      expire_time: 1678233080
                      scheduled_time: 1678232900
                      scope: org
                      site_id: 581328b6-e382-f54e-c9dc-9c998d183a35
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    results:
                    - duration: 48
                      expire_time: 1678233080
                      scheduled_time: 1678232900
                      scope: site
                      site_id: 581328b6-e382-f54e-c9dc-9c998d183a34
                    - duration: 48
                      expire_time: 1678233080
                      scheduled_time: 1678232900
                      scope: org
                      site_id: 581328b6-e382-f54e-c9dc-9c998d183a35
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs Alarm Templates
      summary: suppressOrgAlarm
      description: Create or schedule an alarm suppression window for the organization or selected sites, for example during planned maintenance.
      operationId: suppressOrgAlarm
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/suppressed_alarm'
              - examples:
                - '{"duration":3600,"scheduled_time":1678232980,"scope":"org"}'
                - '{"applies":{"org_id":"2818e386-8dec-2562-9ede-5b8a0fbbdc71","site_ids":["4ac1dcf4-9d8b-7211-65c4-057819f0862b"],"sitegroup_ids":["581328b6-e382-f54e-c9dc-999983183a34","f57096b9-0c2f-4df6-c77b-ae6ae87a3d43"]},"duration":3600,"scheduled_time":1678232980,"scope":"site"}'
              contentMediaType: application/json
            examples:
              org_suppression:
                value:
                  duration: 3600
                  scheduled_time: 1678232980
                  scope: org
              site_suppression:
                value:
                  applies:
                    org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                    site_ids:
                    - 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    sitegroup_ids:
                    - 581328b6-e382-f54e-c9dc-999983183a34
                    - f57096b9-0c2f-4df6-c77b-ae6ae87a3d43
                  duration: 3600
                  scheduled_time: 1678232980
                  scope: site
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/alarmtemplates/{alarmtemplate_id}:
    delete:
      tags:
      - Orgs Alarm Templates
      summary: deleteOrgAlarmTemplate
      description: Delete an organization alarm template by template ID from this organization.
      operationId: deleteOrgAlarmTemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: alarmtemplate_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs Alarm Templates
      summary: getOrgAlarmTemplate
      description: Return one organization alarm template, including default delivery settings and per-alarm rule overrides.
      operationId: getOrgAlarmTemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: alarmtemplate_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/alarm_template'
                - description: Alarm template defining default delivery and per-alarm rules
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/alarm_template'
                - description: Alarm template defining default delivery and per-alarm rules
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs Alarm Templates
      summary: updateOrgAlarmTemplate
      description: Update an organization alarm template's default delivery settings or per-alarm rule overrides.
      operationId: updateOrgAlarmTemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: alarmtemplate_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/alarm_template'
              - description: Request Body
                examples:
                - delivery:
                    additional_emails:
                    - string
                    enabled: true
                    to_org_admins: true
                    to_site_admins: true
                  name: string
                  rules:
                    adhoc_network:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    air_magnet_scan:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    ap_offline:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    bad_cable:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    beacon_flood:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    bssid_spoofing:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    device_down:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    device_restarted:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    dhcp_failure:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    disassociation_flood:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    dot1x_failure:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    eap_dictionary_attack:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    eap_failure_injection:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    eap_handshake_flood:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    eap_spoofed_success:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    eapol_logoff_attack:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    essid_jack:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    excessive_client:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    excessive_eapol_start:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    gateway_down:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    gw_bad_cable:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    gw_negotiation_mismatch:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    honeypot_ssid:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    krack_attack:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    missing_vlan:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    monkey_jack:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    negotiation_mismatch:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    non_compliant:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    out_of_sequence:
                      enabled: true
                    psk_failure:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    repeated_auth_failures:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    rogue_ap:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    rogue_client:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    secpolicy_violation:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    ssid_injection:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    switch_down:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    tkip_icv_attack:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    vendor_ie_missing:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    watched_station:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    zero_ssid_association:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
              contentMediaType: application/json
            examples:
              Example:
                value:
                  delivery:
                    additional_emails:
                    - string
                    enabled: true
                    to_org_admins: true
                    to_site_admins: true
                  name: string
                  rules:
                    adhoc_network:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    air_magnet_scan:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    ap_offline:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    bad_cable:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    beacon_flood:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    bssid_spoofing:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    device_down:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    device_restarted:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    dhcp_failure:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    disassociation_flood:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    dot1x_failure:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    eap_dictionary_attack:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    eap_failure_injection:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    eap_handshake_flood:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    eap_spoofed_success:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    eapol_logoff_attack:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    essid_jack:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    excessive_client:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    excessive_eapol_start:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    gateway_down:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    gw_bad_cable:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    gw_negotiation_mismatch:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    honeypot_ssid:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    krack_attack:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    missing_vlan:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    monkey_jack:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    negotiation_mismatch:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    non_compliant:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    out_of_sequence:
                      enabled: true
                    psk_failure:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    repeated_auth_failures:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    rogue_ap:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    rogue_client:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    secpolicy_violation:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    ssid_injection:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    switch_down:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    tkip_icv_attack:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    vendor_ie_missing:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    watched_station:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
                    zero_ssid_association:
                      delivery:
                        additional_emails:
                        - string
                        enabled: true
                        to_org_admins: true
                        to_site_admins: true
                      enabled: true
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/alarm_template'
                - description: Alarm template defining default delivery and per-alarm rules
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/alarm_template'
                - description: Alarm template defining default delivery and per-alarm rules
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/aptemplates:
    get:
      tags:
      - Orgs AP Templates
      summary: listOrgAptemplates
      description: List organization AP templates that define AP matching rules, port configuration, Wi-Fi, and mesh settings for assignment to sites.
      operationId: listOrgAptemplates
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ap_template'
                description: List of AP templates
                examples:
                - - ap_matching:
                      enabled: true
                      rules:
                      - match_model: string
                        name: string
                        port_config:
                          eth1,eth2:
                            disabled: true
                            dynamic_vlan:
                              default_vlan_id: 999
                              enabled: true
                            port_vlan_id: 1
                            vlan_id: 9
                            vlan_ids: 1, 10, 50
                    created_time: 0
                    for_site: true
                    id: 497f6eca-6276-4993-bfeb-53cbbbba9f08
                    modified_time: 0
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    wifi:
                      cisco_enabled: true
                      disable_11k: false
                      disable_radios_when_power_constrained: true
                      enable_arp_spoof: true
                      enable_shared_radio_scanning: false
                      enabled: true
                      locate_connected: false
                      locate_unconnected: false
                      mesh_allow_dfs: false
                      mesh_enable_crm: true
                      mesh_enabled: true
                      proxy_arp: false
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - ap_matching:
                      enabled: true
                      rules:
                      - match_model: string
                        name: string
                        port_config:
                          eth1,eth2:
                            disabled: true
                            dynamic_vlan:
                              default_vlan_id: 999
                              enabled: true
                            port_vlan_id: 1
                            vlan_id: 9
                            vlan_ids: 1, 10, 50
                    created_time: 0
                    for_site: true
                    id: 497f6eca-6276-4993-bfeb-53cbbbba9f08
                    modified_time: 0
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    wifi:
                      cisco_enabled: true
                      disable_11k: false
                      disable_radios_when_power_constrained: true
                      enable_arp_spoof: true
                      enable_shared_radio_scanning: false
                      enabled: true
                      locate_connected: false
                      locate_unconnected: false
                      mesh_allow_dfs: false
                      mesh_enable_crm: true
                      mesh_enabled: true
                      proxy_arp: false
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ap_template'
                description: List of AP templates
                examples:
                - - ap_matching:
                      enabled: true
                      rules:
                      - match_model: string
                        name: string
                        port_config:
                          eth1,eth2:
                            disabled: true
                            dynamic_vlan:
                              default_vlan_id: 999
                              enabled: true
                            port_vlan_id: 1
                            vlan_id: 9
                            vlan_ids: 1, 10, 50
                    created_time: 0
                    for_site: true
                    id: 497f6eca-6276-4993-bfeb-53cbbbba9f08
                    modified_time: 0
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    wifi:
                      cisco_enabled: true
                      disable_11k: false
                      disable_radios_when_power_constrained: true
                      enable_arp_spoof: true
                      enable_shared_radio_scanning: false
                      enabled: true
                      locate_connected: false
                      locate_unconnected: false
                      mesh_allow_dfs: false
                      mesh_enable_crm: true
                      mesh_enabled: true
                      proxy_arp: false
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - ap_matching:
                      enabled: true
                      rules:
                      - match_model: string
                        name: string
                        port_config:
                          eth1,eth2:
                            disabled: true
                            dynamic_vlan:
                              default_vlan_id: 999
                              enabled: true
                            port_vlan_id: 1
                            vlan_id: 9
                            vlan_ids: 1, 10, 50
                    created_time: 0
                    for_site: true
                    id: 497f6eca-6276-4993-bfeb-53cbbbba9f08
                    modified_time: 0
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    wifi:
                      cisco_enabled: true
                      disable_11k: false
                      disable_radios_when_power_constrained: true
                      enable_arp_spoof: true
                      enable_shared_radio_scanning: false
                      enabled: true
                      locate_connected: false
                      locate_unconnected: false
                      mesh_allow_dfs: false
                      mesh_enable_crm: true
                      mesh_enabled: true
                      proxy_arp: false
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs AP Templates
      summary: createOrgAptemplate
      description: Create an organization AP template with AP matching rules, port configuration, Wi-Fi settings, and mesh settings.
      operationId: createOrgAptemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ap_template'
        required: false
      responses:
        '200':
          description: AP Template
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ap_template'
                - description: Access point template configuration
                  examples:
                  - ap_matching:
                      enabled: true
                      rules:
                      - match_model: string
                        name: string
                        port_config:
                          eth1,eth2:
                            disabled: true
                            dynamic_vlan:
                              default_vlan_id: 999
                              enabled: true
                            port_vlan_id: 1
                            vlan_id: 9
                            vlan_ids: 1, 10, 50
                    created_time: 0
                    for_site: true
                    id: 497f6eca-6276-4993-bfeb-53cbbbba8f08
                    modified_time: 0
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    wifi:
                      cisco_enabled: true
                      disable_11k: false
                      disable_radios_when_power_constrained: true
                      enable_arp_spoof: true
                      enable_shared_radio_scanning: false
                      enabled: true
                      locate_connected: false
                      locate_unconnected: false
                      mesh_allow_dfs: false
                      mesh_enable_crm: true
                      mesh_enabled: true
                      proxy_arp: false
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    ap_matching:
                      enabled: true
                      rules:
                      - match_model: string
                        name: string
                        port_config:
                          eth1,eth2:
                            disabled: true
                            dynamic_vlan:
                              default_vlan_id: 999
                              enabled: true
                            port_vlan_id: 1
                            vlan_id: 9
                            vlan_ids: 1, 10, 50
                    created_time: 0
                    for_site: true
                    id: 497f6eca-6276-4993-bfeb-53cbbbba8f08
                    modified_time: 0
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    wifi:
                      cisco_enabled: true
                      disable_11k: false
                      disable_radios_when_power_constrained: true
                      enable_arp_spoof: true
                      enable_shared_radio_scanning: false
                      enabled: true
                      locate_connected: false
                      locate_unconnected: false
                      mesh_allow_dfs: false
                      mesh_enable_crm: true
                      mesh_enabled: true
                      proxy_arp: false
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ap_template'
                - description: Access point template configuration
                  examples:
                  - ap_matching:
                      enabled: true
                      rules:
                      - match_model: string
                        name: string
                        port_config:
                          eth1,eth2:
                            disabled: true
                            dynamic_vlan:
                              default_vlan_id: 999
                              enabled: true
                            port_vlan_id: 1
                            vlan_id: 9
                            vlan_ids: 1, 10, 50
                    created_time: 0
                    for_site: true
                    id: 497f6eca-6276-4993-bfeb-53cbbbba8f08
                    modified_time: 0
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    wifi:
                      cisco_enabled: true
                      disable_11k: false
                      disable_radios_when_power_constrained: true
                      enable_arp_spoof: true
                      enable_shared_radio_scanning: false
                      enabled: true
                      locate_connected: false
                      locate_unconnected: false
                      mesh_allow_dfs: false
                      mesh_enable_crm: true
                      mesh_enabled: true
                      proxy_arp: false
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    ap_matching:
                      enabled: true
                      rules:
                      - match_model: string
                        name: string
                        port_config:
                          eth1,eth2:
                            disabled: true
                            dynamic_vlan:
                              default_vlan_id: 999
                              enabled: true
                            port_vlan_id: 1
                            vlan_id: 9
                            vlan_ids: 1, 10, 50
                    created_time: 0
                    for_site: true
                    id: 497f6eca-6276-4993-bfeb-53cbbbba8f08
                    modified_time: 0
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    wifi:
                      cisco_enabled: true
                      disable_11k: false
                      disable_radios_when_power_constrained: true
                      enable_arp_spoof: true
                      enable_shared_radio_scanning: false
                      enabled: true
                      locate_connected: false
                      locate_unconnected: false
                      mesh_allow_dfs: false
                      mesh_enable_crm: true
                      mesh_enabled: true
                      proxy_arp: false
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/aptemplates/{aptemplate_id}:
    delete:
      tags:
      - Orgs AP Templates
      summary: deleteOrgAptemplate
      description: Delete an organization AP template by template ID from this organization.
      operationId: deleteOrgAptemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: aptemplate_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs AP Templates
      summary: getOrgAptemplate
      description: Return one organization AP template, including AP matching rules, port configuration, Wi-Fi settings, and mesh settings.
      operationId: getOrgAptemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: aptemplate_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
      responses:
        '200':
          description: AP Template
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ap_template'
                - description: Access point template configuration
                  examples:
                  - ap_matching:
                      enabled: true
                      rules:
                      - match_model: string
                        name: string
                        port_config:
                          eth1,eth2:
                            disabled: true
                            dynamic_vlan:
                              default_vlan_id: 999
                              enabled: true
                            port_vlan_id: 1
                            vlan_id: 9
                            vlan_ids: 1, 10, 50
                    created_time: 0
                    for_site: true
                    id: 497f6eca-6276-4993-bfeb-53cbbbba8f08
                    modified_time: 0
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    wifi:
                      cisco_enabled: true
                      disable_11k: false
                      disable_radios_when_power_constrained: true
                      enable_arp_spoof: true
                      enable_shared_radio_scanning: false
                      enabled: true
                      locate_connected: false
                      locate_unconnected: false
                      mesh_allow_dfs: false
                      mesh_enable_crm: true
                      mesh_enabled: true
                      proxy_arp: false
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    ap_matching:
                      enabled: true
                      rules:
                      - match_model: string
                        name: string
                        port_config:
                          eth1,eth2:
                            disabled: true
                            dynamic_vlan:
                              default_vlan_id: 999
                              enabled: true
                            port_vlan_id: 1
                            vlan_id: 9
                            vlan_ids: 1, 10, 50
                    created_time: 0
                    for_site: true
                    id: 497f6eca-6276-4993-bfeb-53cbbbba8f08
                    modified_time: 0
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    wifi:
                      cisco_enabled: true
                      disable_11k: false
                      disable_radios_when_power_constrained: true
                      enable_arp_spoof: true
                      enable_shared_radio_scanning: false
                      enabled: true
                      locate_connected: false
                      locate_unconnected: false
                      mesh_allow_dfs: false
                      mesh_enable_crm: true
                      mesh_enabled: true
                      proxy_arp: false
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ap_template'
                - description: Access point template configuration
                  examples:
                  - ap_matching:
                      enabled: true
                      rules:
                      - match_model: string
                        name: string
                        port_config:
                          eth1,eth2:
                            disabled: true
                            dynamic_vlan:
                              default_vlan_id: 999
                              enabled: true
                            port_vlan_id: 1
                            vlan_id: 9
                            vlan_ids: 1, 10, 50
                    created_time: 0
                    for_site: true
                    id: 497f6eca-6276-4993-bfeb-53cbbbba8f08
                    modified_time: 0
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    wifi:
                      cisco_enabled: true
                      disable_11k: false
                      disable_radios_when_power_constrained: true
                      enable_arp_spoof: true
                      enable_shared_radio_scanning: false
                      enabled: true
                      locate_connected: false
                      locate_unconnected: false
                      mesh_allow_dfs: false
                      mesh_enable_crm: true
                      mesh_enabled: true
                      proxy_arp: false
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    ap_matching:
                      enabled: true
                      rules:
                      - match_model: string
                        name: string
                        port_config:
                          eth1,eth2:
                            disabled: true
                            dynamic_vlan:
                              default_vlan_id: 999
                              enabled: true
                            port_vlan_id: 1
                            vlan_id: 9
                            vlan_ids: 1, 10, 50
                    created_time: 0
                    for_site: true
                    id: 497f6eca-6276-4993-bfeb-53cbbbba8f08
                    modified_time: 0
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    wifi:
                      cisco_enabled: true
                      disable_11k: false
                      disable_radios_when_power_constrained: true
                      enable_arp_spoof: true
                      enable_shared_radio_scanning: false
                      enabled: true
                      locate_connected: false
                      locate_unconnected: false
                      mesh_allow_dfs: false
                      mesh_enable_crm: true
                      mesh_enabled: true
                      proxy_arp: false
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs AP Templates
      summary: updateOrgAptemplate
      description: Update an organization AP template's AP matching rules, port configuration, Wi-Fi settings, or mesh settings.
      operationId: updateOrgAptemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: aptemplate_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ap_template'
              - examples:
                - ap_matching:
                    enabled: true
                    rules:
                    - match_model: string
                      name: string
                      port_config:
                        eth1,eth2:
                          disabled: true
                          dynamic_vlan:
                            default_vlan_id: 999
                            enabled: true
                          port_vlan_id: 1
                          vlan_id: 9
                          vlan_ids: 1, 10, 50
                  wifi:
                    cisco_enabled: true
                    disable_11k: false
                    disable_radios_when_power_constrained: true
                    enable_arp_spoof: true
                    enable_shared_radio_scanning: false
                    enabled: true
                    locate_connected: false
                    locate_unconnected: false
                    mesh_allow_dfs: false
                    mesh_enable_crm: true
                    mesh_enabled: true
                    proxy_arp: false
              contentMediaType: application/json
            examples:
              Example:
                value:
                  ap_matching:
                    enabled: true
                    rules:
                    - match_model: string
                      name: string
                      port_config:
                        eth1,eth2:
                          disabled: true
                          dynamic_vlan:
                            default_vlan_id: 999
                            enabled: true
                          port_vlan_id: 1
                          vlan_id: 9
                          vlan_ids: 1, 10, 50
                  wifi:
                    cisco_enabled: true
                    disable_11k: false
                    disable_radios_when_power_constrained: true
                    enable_arp_spoof: true
                    enable_shared_radio_scanning: false
                    enabled: true
                    locate_connected: false
                    locate_unconnected: false
                    mesh_allow_dfs: false
                    mesh_enable_crm: true
                    mesh_enabled: true
                    proxy_arp: false
        required: false
      responses:
        '200':
          description: AP Template
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ap_template'
                - description: Access point template configuration
                  examples:
                  - ap_matching:
                      enabled: true
                      rules:
                      - match_model: string
                        name: string
                        port_config:
                          eth1,eth2:
                            disabled: true
                            dynamic_vlan:
                              default_vlan_id: 999
                              enabled: true
                            port_vlan_id: 1
                            vlan_id: 9
                            vlan_ids: 1, 10, 50
                    created_time: 0
                    for_site: true
                    id: 497f6eca-6276-4993-bfeb-53cbbbba8f08
                    modified_time: 0
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    wifi:
                      cisco_enabled: true
                      disable_11k: false
                      disable_radios_when_power_constrained: true
                      enable_arp_spoof: true
                      enable_shared_radio_scanning: false
                      enabled: true
                      locate_connected: false
                      locate_unconnected: false
                      mesh_allow_dfs: false
                      mesh_enable_crm: true
                      mesh_enabled: true
                      proxy_arp: false
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    ap_matching:
                      enabled: true
                      rules:
                      - match_model: string
                        name: string
                        port_config:
                          eth1,eth2:
                            disabled: true
                            dynamic_vlan:
                              default_vlan_id: 999
                              enabled: true
                            port_vlan_id: 1
                            vlan_id: 9
                            vlan_ids: 1, 10, 50
                    created_time: 0
                    for_site: true
                    id: 497f6eca-6276-4993-bfeb-53cbbbba8f08
                    modified_time: 0
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    wifi:
                      cisco_enabled: true
                      disable_11k: false
                      disable_radios_when_power_constrained: true
                      enable_arp_spoof: true
                      enable_shared_radio_scanning: false
                      enabled: true
                      locate_connected: false
                      locate_unconnected: false
                      mesh_allow_dfs: false
                      mesh_enable_crm: true
                      mesh_enabled: true
                      proxy_arp: false
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ap_template'
                - description: Access point template configuration
                  examples:
                  - ap_matching:
                      enabled: true
                      rules:
                      - match_model: string
                        name: string
                        port_config:
                          eth1,eth2:
                            disabled: true
                            dynamic_vlan:
                              default_vlan_id: 999
                              enabled: true
                            port_vlan_id: 1
                            vlan_id: 9
                            vlan_ids: 1, 10, 50
                    created_time: 0
                    for_site: true
                    id: 497f6eca-6276-4993-bfeb-53cbbbba8f08
                    modified_time: 0
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    wifi:
                      cisco_enabled: true
                      disable_11k: false
                      disable_radios_when_power_constrained: true
                      enable_arp_spoof: true
                      enable_shared_radio_scanning: false
                      enabled: true
                      locate_connected: false
                      locate_unconnected: false
                      mesh_allow_dfs: false
                      mesh_enable_crm: true
                      mesh_enabled: true
                      proxy_arp: false
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    ap_matching:
                      enabled: true
                      rules:
                      - match_model: string
                        name: string
                        port_config:
                          eth1,eth2:
                            disabled: true
                            dynamic_vlan:
                              default_vlan_id: 999
                              enabled: true
                            port_vlan_id: 1
                            vlan_id: 9
                            vlan_ids: 1, 10, 50
                    created_time: 0
                    for_site: true
                    id: 497f6eca-6276-4993-bfeb-53cbbbba8f08
                    modified_time: 0
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    wifi:
                      cisco_enabled: true
                      disable_11k: false
                      disable_radios_when_power_constrained: true
                      enable_arp_spoof: true
                      enable_shared_radio_scanning: false
                      enabled: true
                      locate_connected: false
                      locate_unconnected: false
                      mesh_allow_dfs: false
                      mesh_enable_crm: true
                      mesh_enabled: true
                      proxy_arp: false
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/apitokens:
    get:
      tags:
      - Orgs API Tokens
      summary: listOrgApiTokens
      description: List organization API tokens, including display names, scoped privileges, allowed source IPs, creator, and last-use metadata.
      operationId: listOrgApiTokens
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/org_apitoken'
                description: List of organization API tokens
                examples:
                - - created_by: user@mycorp.com
                    created_time: 1626875902
                    id: 497f6eca-6276-4993-bfeb-53f0bbba6f08
                    key: 1qkb...QQCL
                    last_used: 1690115110
                    name: org_token_xyz
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    privileges:
                    - org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                      role: admin
                      scope: org
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_by: user@mycorp.com
                    created_time: 1626875902
                    id: 497f6eca-6276-4993-bfeb-53f0bbba6f08
                    key: 1qkb...QQCL
                    last_used: 1690115110
                    name: org_token_xyz
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    privileges:
                    - org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                      role: admin
                      scope: org
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/org_apitoken'
                description: List of organization API tokens
                examples:
                - - created_by: user@mycorp.com
                    created_time: 1626875902
                    id: 497f6eca-6276-4993-bfeb-53f0bbba6f08
                    key: 1qkb...QQCL
                    last_used: 1690115110
                    name: org_token_xyz
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    privileges:
                    - org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                      role: admin
                      scope: org
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_by: user@mycorp.com
                    created_time: 1626875902
                    id: 497f6eca-6276-4993-bfeb-53f0bbba6f08
                    key: 1qkb...QQCL
                    last_used: 1690115110
                    name: org_token_xyz
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    privileges:
                    - org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                      role: admin
                      scope: org
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs API Tokens
      summary: createOrgApiToken
      description: >-
        Create an organization API token with a display name, scoped privileges, and optional source IP restrictions.

        Note that the full token key is only available at creation time.
      operationId: createOrgApiToken
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/org_apitoken'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org_apitoken'
                - description: >-
                    Organization API token with scoped privileges


                    **Note:**

                    `privileges` is required to create the object, but may not be returned in the POST API response. Retrieve the token afterward to inspect it.
                  examples:
                  - created_by: user@mycorp.com
                    created_time: 1626875902
                    id: 497f6eca-6276-4993-bfeb-53efbbba6f08
                    key: 1qkb...QQCL
                    last_used: 1690115110
                    name: org_token_xyz
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    privileges:
                    - org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                      role: admin
                      scope: org
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_by: user@mycorp.com
                    created_time: 1626875902
                    id: 497f6eca-6276-4993-bfeb-53efbbba6f08
                    key: 1qkb...QQCL
                    last_used: 1690115110
                    name: org_token_xyz
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    privileges:
                    - org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                      role: admin
                      scope: org
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org_apitoken'
                - description: >-
                    Organization API token with scoped privileges


                    **Note:**

                    `privileges` is required to create the object, but may not be returned in the POST API response. Retrieve the token afterward to inspect it.
                  examples:
                  - created_by: user@mycorp.com
                    created_time: 1626875902
                    id: 497f6eca-6276-4993-bfeb-53efbbba6f08
                    key: 1qkb...QQCL
                    last_used: 1690115110
                    name: org_token_xyz
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    privileges:
                    - org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                      role: admin
                      scope: org
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_by: user@mycorp.com
                    created_time: 1626875902
                    id: 497f6eca-6276-4993-bfeb-53efbbba6f08
                    key: 1qkb...QQCL
                    last_used: 1690115110
                    name: org_token_xyz
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    privileges:
                    - org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                      role: admin
                      scope: org
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/apitokens/{apitoken_id}:
    delete:
      tags:
      - Orgs API Tokens
      summary: deleteOrgApiToken
      description: Delete an organization API token so it can no longer authenticate API requests.
      operationId: deleteOrgApiToken
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: apitoken_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs API Tokens
      summary: getOrgApiToken
      description: Return metadata for one organization API token. The full token key is only available at creation time and may only be partially shown afterward.
      operationId: getOrgApiToken
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: apitoken_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org_apitoken'
                - description: >-
                    Organization API token with scoped privileges


                    **Note:**

                    `privileges` is required to create the object, but may not be returned in the POST API response. Retrieve the token afterward to inspect it.
                  examples:
                  - created_by: user@mycorp.com
                    created_time: 1626875902
                    id: 497f6eca-6276-4993-bfeb-53efbbba6f08
                    key: 1qkb...QQCL
                    last_used: 1690115110
                    name: org_token_xyz
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    privileges:
                    - org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                      role: admin
                      scope: org
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_by: user@mycorp.com
                    created_time: 1626875902
                    id: 497f6eca-6276-4993-bfeb-53efbbba6f08
                    key: 1qkb...QQCL
                    last_used: 1690115110
                    name: org_token_xyz
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    privileges:
                    - org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                      role: admin
                      scope: org
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org_apitoken'
                - description: >-
                    Organization API token with scoped privileges


                    **Note:**

                    `privileges` is required to create the object, but may not be returned in the POST API response. Retrieve the token afterward to inspect it.
                  examples:
                  - created_by: user@mycorp.com
                    created_time: 1626875902
                    id: 497f6eca-6276-4993-bfeb-53efbbba6f08
                    key: 1qkb...QQCL
                    last_used: 1690115110
                    name: org_token_xyz
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    privileges:
                    - org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                      role: admin
                      scope: org
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_by: user@mycorp.com
                    created_time: 1626875902
                    id: 497f6eca-6276-4993-bfeb-53efbbba6f08
                    key: 1qkb...QQCL
                    last_used: 1690115110
                    name: org_token_xyz
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    privileges:
                    - org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                      role: admin
                      scope: org
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs API Tokens
      summary: updateOrgApiToken
      description: Update an organization API token's display name or scoped privileges. Source IP restrictions are defined when the token is created.
      operationId: updateOrgApiToken
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: apitoken_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/org_apitoken'
              - description: Request Body
                examples:
                - '{"name":"org_token_xyz","privileges":[{"org_id":"a40f5d1f-d889-42e9-94ea-b9b33585fc6b","role":"admin","scope":"org"}]}'
              contentMediaType: application/json
            examples:
              Example:
                value:
                  name: org_token_xyz
                  privileges:
                  - org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    role: admin
                    scope: org
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/assets:
    get:
      tags:
      - Orgs Assets
      summary: listOrgAssets
      description: List named BLE asset records in this organization, including Bluetooth MAC addresses and optional site, map, or tag metadata.
      operationId: listOrgAssets
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/asset'
                description: List of named BLE asset records
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/asset'
                description: List of named BLE asset records
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs Assets
      summary: createOrgAsset
      description: Create a named BLE asset record with a Bluetooth MAC address and optional site, map, or tag metadata.
      operationId: createOrgAsset
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/asset'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/asset'
                - description: Named Bluetooth Low Energy asset record
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    tag_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    tag_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/asset'
                - description: Named Bluetooth Low Energy asset record
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    tag_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    tag_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/assets/import:
    post:
      tags:
      - Orgs Assets
      summary: importOrgAssets
      description: >-
        Import named BLE assets from a JSON payload or CSV file upload. Each asset record includes at least a name and Bluetooth MAC address.


        #### CSV File Format

        ```csv

        name,mac

        "asset_name",5c5b53010101

        ```
      operationId: importOrgAssets
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              type: object
              properties:
                file:
                  type: string
                  description: CSV file containing asset records to import
                  contentEncoding: base64
              contentMediaType: multipart/form-data
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/assets/{asset_id}:
    delete:
      tags:
      - Orgs Assets
      summary: deleteOrgAsset
      description: Delete a named BLE asset record from this organization by asset ID.
      operationId: deleteOrgAsset
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: asset_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '201':
          description: Created
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs Assets
      summary: getOrgAsset
      description: Return one named BLE asset record, including its Bluetooth MAC address and optional site, map, or tag metadata.
      operationId: getOrgAsset
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: asset_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/asset'
                - description: Named Bluetooth Low Energy asset record
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    tag_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    tag_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/asset'
                - description: Named Bluetooth Low Energy asset record
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    tag_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    tag_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs Assets
      summary: updateOrgAsset
      description: Update a named BLE asset record's name, Bluetooth MAC address, or optional site, map, or tag metadata.
      operationId: updateOrgAsset
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: asset_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/asset'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/asset'
                - description: Named Bluetooth Low Energy asset record
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    tag_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    tag_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/asset'
                - description: Named Bluetooth Low Energy asset record
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    tag_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    tag_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/assetfilters:
    get:
      tags:
      - Orgs Asset Filters
      summary: listOrgAssetFilters
      description: List organization-level BLE asset filters. Each filter operates independently, and an asset must match all specified filter properties for that filter to apply.
      operationId: listOrgAssetFilters
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/asset_filter'
                description: List of BLE asset filters
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/asset_filter'
                description: List of BLE asset filters
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs Asset Filters
      summary: createOrgAssetFilter
      description: Create an organization-level BLE asset filter. Any subset of filter properties can be included, and a matching asset must meet all specified conditions.
      operationId: createOrgAssetFilter
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/asset_filter'
              - examples:
                - disabled: true
                  eddystone_uid_namespace: string
                  eddystone_url: string
                  ibeacon_major: 1
                  ibeacon_uuid: 1f89bc00-d0af-481b-82fe-a6629259a39f
                  mfg_company_id: 0
                  name: string
              contentMediaType: application/json
            examples:
              Example:
                value:
                  disabled: true
                  eddystone_uid_namespace: string
                  eddystone_url: string
                  ibeacon_major: 1
                  ibeacon_uuid: 1f89bc00-d0af-481b-82fe-a6629259a39f
                  mfg_company_id: 0
                  name: string
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/asset_filter'
                - description: BLE asset filter definition; all specified criteria must match
                  examples:
                  - created_time: 0
                    disabled: true
                    eddystone_uid_namespace: string
                    eddystone_url: string
                    for_site: true
                    ibeacon_major: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mfg_company_id: 0
                    modified_time: 0
                    mqtt_topic: xxxxx
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    disabled: true
                    eddystone_uid_namespace: string
                    eddystone_url: string
                    for_site: true
                    ibeacon_major: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mfg_company_id: 0
                    modified_time: 0
                    mqtt_topic: xxxxx
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/asset_filter'
                - description: BLE asset filter definition; all specified criteria must match
                  examples:
                  - created_time: 0
                    disabled: true
                    eddystone_uid_namespace: string
                    eddystone_url: string
                    for_site: true
                    ibeacon_major: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mfg_company_id: 0
                    modified_time: 0
                    mqtt_topic: xxxxx
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    disabled: true
                    eddystone_uid_namespace: string
                    eddystone_url: string
                    for_site: true
                    ibeacon_major: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mfg_company_id: 0
                    modified_time: 0
                    mqtt_topic: xxxxx
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/assetfilters/{assetfilter_id}:
    delete:
      tags:
      - Orgs Asset Filters
      summary: deleteOrgAssetFilter
      description: Delete an organization-level BLE asset filter by filter ID.
      operationId: deleteOrgAssetFilter
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: assetfilter_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs Asset Filters
      summary: getOrgAssetFilter
      description: Return one organization-level BLE asset filter, including its name, disabled state, and matching criteria.
      operationId: getOrgAssetFilter
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: assetfilter_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/asset_filter'
                - description: BLE asset filter definition; all specified criteria must match
                  examples:
                  - created_time: 0
                    disabled: true
                    eddystone_uid_namespace: string
                    eddystone_url: string
                    for_site: true
                    ibeacon_major: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mfg_company_id: 0
                    modified_time: 0
                    mqtt_topic: xxxxx
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    disabled: true
                    eddystone_uid_namespace: string
                    eddystone_url: string
                    for_site: true
                    ibeacon_major: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mfg_company_id: 0
                    modified_time: 0
                    mqtt_topic: xxxxx
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/asset_filter'
                - description: BLE asset filter definition; all specified criteria must match
                  examples:
                  - created_time: 0
                    disabled: true
                    eddystone_uid_namespace: string
                    eddystone_url: string
                    for_site: true
                    ibeacon_major: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mfg_company_id: 0
                    modified_time: 0
                    mqtt_topic: xxxxx
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    disabled: true
                    eddystone_uid_namespace: string
                    eddystone_url: string
                    for_site: true
                    ibeacon_major: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mfg_company_id: 0
                    modified_time: 0
                    mqtt_topic: xxxxx
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs Asset Filters
      summary: updateOrgAssetFilter
      description: Update an organization-level BLE asset filter's name, disabled state, or matching criteria.
      operationId: updateOrgAssetFilter
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: assetfilter_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/asset_filter'
              - description: Request Body
                examples:
                - disabled: true
                  eddystone_uid_namespace: string
                  eddystone_url: string
                  ibeacon_major: 1
                  ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab2
                  mfg_company_id: 0
                  name: string
              contentMediaType: application/json
            examples:
              Example:
                value:
                  disabled: true
                  eddystone_uid_namespace: string
                  eddystone_url: string
                  ibeacon_major: 1
                  ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab2
                  mfg_company_id: 0
                  name: string
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/asset_filter'
                - description: BLE asset filter definition; all specified criteria must match
                  examples:
                  - created_time: 0
                    disabled: true
                    eddystone_uid_namespace: string
                    eddystone_url: string
                    for_site: true
                    ibeacon_major: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mfg_company_id: 0
                    modified_time: 0
                    mqtt_topic: xxxxx
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    disabled: true
                    eddystone_uid_namespace: string
                    eddystone_url: string
                    for_site: true
                    ibeacon_major: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mfg_company_id: 0
                    modified_time: 0
                    mqtt_topic: xxxxx
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/asset_filter'
                - description: BLE asset filter definition; all specified criteria must match
                  examples:
                  - created_time: 0
                    disabled: true
                    eddystone_uid_namespace: string
                    eddystone_url: string
                    for_site: true
                    ibeacon_major: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mfg_company_id: 0
                    modified_time: 0
                    mqtt_topic: xxxxx
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    disabled: true
                    eddystone_uid_namespace: string
                    eddystone_url: string
                    for_site: true
                    ibeacon_major: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mfg_company_id: 0
                    modified_time: 0
                    mqtt_topic: xxxxx
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/cert:
    get:
      tags:
      - Orgs Cert
      summary: listOrgCertificates
      description: Return the current organization CA certificate and, when available, the pending auto-renewed certificate scheduled to replace it.
      operationId: listOrgCertificates
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_certificate'
                - description: If the current Org CA certificate is set to expire within 30 days, a pending certificate will be returned along with the expected auto-renewal timestamp.
                  examples:
                  - cert: >-
                      -----BEGIN CERTIFICATE-----

                      MIIowDQYJKoZIhvcNAQELBQE

                      -----END CERTIFICATE-----
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    cert: >-
                      -----BEGIN CERTIFICATE-----

                      MIIowDQYJKoZIhvcNAQELBQE

                      -----END CERTIFICATE-----
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_certificate'
                - description: If the current Org CA certificate is set to expire within 30 days, a pending certificate will be returned along with the expected auto-renewal timestamp.
                  examples:
                  - cert: >-
                      -----BEGIN CERTIFICATE-----

                      MIIowDQYJKoZIhvcNAQELBQE

                      -----END CERTIFICATE-----
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    cert: >-
                      -----BEGIN CERTIFICATE-----

                      MIIowDQYJKoZIhvcNAQELBQE

                      -----END CERTIFICATE-----
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/cert/apply_pending:
    post:
      tags:
      - Orgs Cert
      summary: rotateOrgCertificate
      description: Replace the current organization CA certificate with the pending certificate generated previously.
      operationId: rotateOrgCertificate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/cert/regenerate:
    post:
      tags:
      - Orgs Cert
      summary: clearOrgCertificates
      description: Clear existing organization certificates and trigger certificate regeneration for the organization.
      operationId: clearOrgCertificates
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/crl/truncate:
    post:
      tags:
      - Orgs Cert
      summary: truncateOrgCrlFile
      description: By default, all certs used by recently unclaimed devices within 9 month will be included in CRL. If the list grows too big, you can truncate it
      operationId: truncateOrgCrlFile
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/days_number'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/ssl_proxy_cert:
    get:
      tags:
      - Orgs Cert
      summary: getOrgSslProxyCert
      description: Return the PEM-encoded SSL proxy certificate for the organization, used by SSL proxy inspection.
      operationId: getOrgSslProxyCert
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org_ssl_proxy_cert'
                - description: SSL proxy certificate returned for the organization
                  examples:
                  - cert: '-----BEGIN CERTIFICATE-----\nMIIowDQYJKoZIhvcNAQELBQE\n-----END CERTIFICATE-----'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    cert: '-----BEGIN CERTIFICATE-----\nMIIowDQYJKoZIhvcNAQELBQE\n-----END CERTIFICATE-----'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org_ssl_proxy_cert'
                - description: SSL proxy certificate returned for the organization
                  examples:
                  - cert: '-----BEGIN CERTIFICATE-----\nMIIowDQYJKoZIhvcNAQELBQE\n-----END CERTIFICATE-----'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    cert: '-----BEGIN CERTIFICATE-----\nMIIowDQYJKoZIhvcNAQELBQE\n-----END CERTIFICATE-----'
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/avprofiles:
    get:
      tags:
      - Orgs Antivirus Profiles
      summary: listOrgAntivirusProfiles
      description: List organization antivirus scanning profiles, including inspected protocols, scan limits, whitelist settings, and fallback actions.
      operationId: listOrgAntivirusProfiles
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/avprofile'
                description: List of antivirus scanning profiles
                examples:
                - - fallback_action: permit
                    max_filesize: 10000
                    mime_whitelist: []
                    name: av-custom
                    protocols:
                    - http
                    url_whitelist: []
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - fallback_action: permit
                    max_filesize: 10000
                    mime_whitelist: []
                    name: av-custom
                    protocols:
                    - http
                    url_whitelist: []
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/avprofile'
                description: List of antivirus scanning profiles
                examples:
                - - fallback_action: permit
                    max_filesize: 10000
                    mime_whitelist: []
                    name: av-custom
                    protocols:
                    - http
                    url_whitelist: []
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - fallback_action: permit
                    max_filesize: 10000
                    mime_whitelist: []
                    name: av-custom
                    protocols:
                    - http
                    url_whitelist: []
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs Antivirus Profiles
      summary: createOrgAntivirusProfile
      description: Create an organization antivirus scanning profile with inspected protocols, maximum file size, whitelist settings, and fallback action.
      operationId: createOrgAntivirusProfile
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/avprofile'
              - examples:
                - fallback_action: permit
                  max_filesize: 10000
                  mime_whitelist: []
                  name: av-custom
                  protocols:
                  - http
                  url_whitelist: []
              contentMediaType: application/json
            examples:
              Example:
                value:
                  fallback_action: permit
                  max_filesize: 10000
                  mime_whitelist: []
                  name: av-custom
                  protocols:
                  - http
                  url_whitelist: []
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/avprofile'
                - description: Antivirus scanning profile with protocols, limits, and whitelist settings
                  examples:
                  - fallback_action: permit
                    max_filesize: 10000
                    mime_whitelist: []
                    name: av-custom
                    protocols:
                    - http
                    url_whitelist: []
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    fallback_action: permit
                    max_filesize: 10000
                    mime_whitelist: []
                    name: av-custom
                    protocols:
                    - http
                    url_whitelist: []
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/avprofile'
                - description: Antivirus scanning profile with protocols, limits, and whitelist settings
                  examples:
                  - fallback_action: permit
                    max_filesize: 10000
                    mime_whitelist: []
                    name: av-custom
                    protocols:
                    - http
                    url_whitelist: []
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    fallback_action: permit
                    max_filesize: 10000
                    mime_whitelist: []
                    name: av-custom
                    protocols:
                    - http
                    url_whitelist: []
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/avprofiles/{avprofile_id}:
    delete:
      tags:
      - Orgs Antivirus Profiles
      summary: deleteOrgAntivirusProfile
      description: Delete an organization antivirus scanning profile by profile ID.
      operationId: deleteOrgAntivirusProfile
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: avprofile_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs Antivirus Profiles
      summary: getOrgAntivirusProfile
      description: Return one organization antivirus scanning profile, including inspected protocols, scan limits, whitelist settings, and fallback action.
      operationId: getOrgAntivirusProfile
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: avprofile_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/avprofile'
                - description: Antivirus scanning profile with protocols, limits, and whitelist settings
                  examples:
                  - fallback_action: permit
                    max_filesize: 10000
                    mime_whitelist: []
                    name: av-custom
                    protocols:
                    - http
                    url_whitelist: []
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    fallback_action: permit
                    max_filesize: 10000
                    mime_whitelist: []
                    name: av-custom
                    protocols:
                    - http
                    url_whitelist: []
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/avprofile'
                - description: Antivirus scanning profile with protocols, limits, and whitelist settings
                  examples:
                  - fallback_action: permit
                    max_filesize: 10000
                    mime_whitelist: []
                    name: av-custom
                    protocols:
                    - http
                    url_whitelist: []
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    fallback_action: permit
                    max_filesize: 10000
                    mime_whitelist: []
                    name: av-custom
                    protocols:
                    - http
                    url_whitelist: []
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs Antivirus Profiles
      summary: updateOrgAntivirusProfile
      description: Update an organization antivirus scanning profile's inspected protocols, maximum file size, whitelist settings, or fallback action.
      operationId: updateOrgAntivirusProfile
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: avprofile_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/avprofile'
              - examples:
                - fallback_action: permit
                  max_filesize: 10000
                  mime_whitelist: []
                  name: av-custom
                  protocols:
                  - http
                  url_whitelist: []
              contentMediaType: application/json
            examples:
              Example:
                value:
                  fallback_action: permit
                  max_filesize: 10000
                  mime_whitelist: []
                  name: av-custom
                  protocols:
                  - http
                  url_whitelist: []
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/avprofile'
                - description: Antivirus scanning profile with protocols, limits, and whitelist settings
                  examples:
                  - fallback_action: permit
                    max_filesize: 10000
                    mime_whitelist: []
                    name: av-custom
                    protocols:
                    - http
                    url_whitelist: []
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    fallback_action: permit
                    max_filesize: 10000
                    mime_whitelist: []
                    name: av-custom
                    protocols:
                    - http
                    url_whitelist: []
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/avprofile'
                - description: Antivirus scanning profile with protocols, limits, and whitelist settings
                  examples:
                  - fallback_action: permit
                    max_filesize: 10000
                    mime_whitelist: []
                    name: av-custom
                    protocols:
                    - http
                    url_whitelist: []
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    fallback_action: permit
                    max_filesize: 10000
                    mime_whitelist: []
                    name: av-custom
                    protocols:
                    - http
                    url_whitelist: []
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/insights/marvisclient/{marvisclient_id}/marvisclient-metrics:
    get:
      tags:
      - Orgs Clients - Marvis
      summary: getOrgMarvisClientInsights
      description: Return time-series metrics for a specific Marvis Client device. For the full list of supported metric field names and example values, refer to [List Insight Metrics]($e/Constants%20Definitions/listInsightMetrics) under `/api/v1/const/insight_metrics`.
      operationId: getOrgMarvisClientInsights
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: marvisclient_id
        in: path
        description: Marvis Client device UUID
        required: true
        schema:
          type: string
          contentEncoding: uuid
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: interval
        in: query
        description: Aggregation works by giving a time range plus interval (e.g. 1d, 1h, 10m) where aggregation function would be applied to.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 10m
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: Marvis Client time-series metrics
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/marvis_client_insights'
                - description: Time-series performance metrics for a Marvis Client device
                  examples:
                  - avg_battery:
                    - 82
                    - 79
                    avg_cellular_rssi:
                    - -95
                    - -92
                    avg_cpu:
                    - 12.5
                    - 15.2
                    avg_memory:
                    - 43.1
                    - 44.8
                    avg_wifi_rssi:
                    - -62
                    - -60
                    end: 1717113600
                    interval: 3600
                    limit: 100
                    page: 1
                    rt:
                    - 2026-05-30T16:00:00Z
                    - 2026-05-30T17:00:00Z
                    start: 1717027200
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    avg_battery:
                    - 82
                    - 79
                    avg_cellular_rssi:
                    - -95
                    - -92
                    avg_cpu:
                    - 12.5
                    - 15.2
                    avg_memory:
                    - 43.1
                    - 44.8
                    avg_wifi_rssi:
                    - -62
                    - -60
                    end: 1717113600
                    interval: 3600
                    limit: 100
                    page: 1
                    rt:
                    - 2026-05-30T16:00:00Z
                    - 2026-05-30T17:00:00Z
                    start: 1717027200
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/marvis_client_insights'
                - description: Time-series performance metrics for a Marvis Client device
                  examples:
                  - avg_battery:
                    - 82
                    - 79
                    avg_cellular_rssi:
                    - -95
                    - -92
                    avg_cpu:
                    - 12.5
                    - 15.2
                    avg_memory:
                    - 43.1
                    - 44.8
                    avg_wifi_rssi:
                    - -62
                    - -60
                    end: 1717113600
                    interval: 3600
                    limit: 100
                    page: 1
                    rt:
                    - 2026-05-30T16:00:00Z
                    - 2026-05-30T17:00:00Z
                    start: 1717027200
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    avg_battery:
                    - 82
                    - 79
                    avg_cellular_rssi:
                    - -95
                    - -92
                    avg_cpu:
                    - 12.5
                    - 15.2
                    avg_memory:
                    - 43.1
                    - 44.8
                    avg_wifi_rssi:
                    - -62
                    - -60
                    end: 1717113600
                    interval: 3600
                    limit: 100
                    page: 1
                    rt:
                    - 2026-05-30T16:00:00Z
                    - 2026-05-30T17:00:00Z
                    start: 1717027200
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/marvisclients/events/count:
    get:
      tags:
      - Orgs Clients - Marvis
      summary: countOrgMarvisClientEvents
      description: Count Marvis Client events by a distinct field.
      operationId: countOrgMarvisClientEvents
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field to count by. enum: `type`, `device_id`, `wifi_mac`, `wifi_ip`, `hostname`, `ssid`, `bssid`, `channel`, `pre_bssid`, `pre_channel`'
        style: form
        explode: true
        schema:
          type: string
          default: type
      - name: type
        in: query
        description: Filter by event type
        style: form
        explode: true
        schema:
          type: string
      - name: device_id
        in: query
        description: Filter by Marvis Client installation device UUID
        style: form
        explode: true
        schema:
          type: string
      - name: wifi_mac
        in: query
        description: Filter by device Wi-Fi MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: wifi_ip
        in: query
        description: Filter by device Wi-Fi IP address
        style: form
        explode: true
        schema:
          type: string
      - name: hostname
        in: query
        description: Filter by device hostname
        style: form
        explode: true
        schema:
          type: string
      - name: ssid
        in: query
        description: Filter by SSID involved in roam events
        style: form
        explode: true
        schema:
          type: string
      - name: bssid
        in: query
        description: Filter by BSSID the client roamed to
        style: form
        explode: true
        schema:
          type: string
      - name: channel
        in: query
        description: Filter by channel the client roamed to
        style: form
        explode: true
        schema:
          type: string
      - name: pre_bssid
        in: query
        description: Filter by BSSID the client roamed from
        style: form
        explode: true
        schema:
          type: string
      - name: pre_channel
        in: query
        description: Filter by channel the client roamed from
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      responses:
        '200':
          description: Count result
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/marvisclients/events/search:
    get:
      tags:
      - Orgs Clients - Marvis
      summary: searchOrgMarvisClientEvents
      description: Search Marvis Client events across the organization.
      operationId: searchOrgMarvisClientEvents
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: type
        in: query
        description: Filter by event type
        style: form
        explode: true
        schema:
          type: string
      - name: device_id
        in: query
        description: Filter by Marvis Client installation device UUID
        style: form
        explode: true
        schema:
          type: string
      - name: wifi_mac
        in: query
        description: Filter by device Wi-Fi MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: wifi_ip
        in: query
        description: Filter by device Wi-Fi IP address
        style: form
        explode: true
        schema:
          type: string
      - name: hostname
        in: query
        description: Filter by device hostname
        style: form
        explode: true
        schema:
          type: string
      - name: ssid
        in: query
        description: Filter by SSID involved in roam events
        style: form
        explode: true
        schema:
          type: string
      - name: bssid
        in: query
        description: Filter by BSSID the client roamed to
        style: form
        explode: true
        schema:
          type: string
      - name: channel
        in: query
        description: Filter by channel the client roamed to
        style: form
        explode: true
        schema:
          type: string
      - name: pre_bssid
        in: query
        description: Filter by BSSID the client roamed from
        style: form
        explode: true
        schema:
          type: string
      - name: pre_channel
        in: query
        description: Filter by channel the client roamed from
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      responses:
        '200':
          description: Paginated Marvis Client events search results
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/marvis_client_events_search'
                - description: Paginated list of Marvis Client events
                  examples:
                  - limit: 1000
                    results:
                    - bssid: 5c5b35000002
                      channel: 11
                      device_id: da088609-8e8d-6d8b-0e40-fe1dc94b9218
                      hostname: jdoe123-dell
                      location:
                        map_id: 7735ef91-83b4-6116-1c1a-57819af48867
                        site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                        timestamp: 1678377926
                        x: 12.5
                        y: 45
                      neighbor_ap_report:
                      - band: '5'
                        bssid: 5c5b35000003
                        channel: 44
                        rssi: -55
                      - band: '5'
                        bssid: 5c5b35000004
                        channel: 36
                        rssi: -70
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      pre_bssid: 5c5b35000001
                      pre_channel: 7
                      pre_rssi: -76
                      rssi: -53
                      ssid: Corp
                      timestamp: 1678377926
                      type: MARVISCLIENT_ROAMED
                      wifi_ip: 10.10.20.1
                      wifi_mac: f01c2df166e0
                    - device_id: da088609-8e8d-6d8b-0e40-fe1dc94b9218
                      hostname: jdoe123-dell
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      percent: 9
                      timestamp: 1678378040
                      type: MARVISCLIENT_LOW_BATTERY
                      wifi_ip: 10.10.20.1
                      wifi_mac: f01c2df166e0
                    total: 1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    limit: 1000
                    results:
                    - bssid: 5c5b35000002
                      channel: 11
                      device_id: da088609-8e8d-6d8b-0e40-fe1dc94b9218
                      hostname: jdoe123-dell
                      location:
                        map_id: 7735ef91-83b4-6116-1c1a-57819af48867
                        site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                        timestamp: 1678377926
                        x: 12.5
                        y: 45
                      neighbor_ap_report:
                      - band: '5'
                        bssid: 5c5b35000003
                        channel: 44
                        rssi: -55
                      - band: '5'
                        bssid: 5c5b35000004
                        channel: 36
                        rssi: -70
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      pre_bssid: 5c5b35000001
                      pre_channel: 7
                      pre_rssi: -76
                      rssi: -53
                      ssid: Corp
                      timestamp: 1678377926
                      type: MARVISCLIENT_ROAMED
                      wifi_ip: 10.10.20.1
                      wifi_mac: f01c2df166e0
                    - device_id: da088609-8e8d-6d8b-0e40-fe1dc94b9218
                      hostname: jdoe123-dell
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      percent: 9
                      timestamp: 1678378040
                      type: MARVISCLIENT_LOW_BATTERY
                      wifi_ip: 10.10.20.1
                      wifi_mac: f01c2df166e0
                    total: 1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/marvis_client_events_search'
                - description: Paginated list of Marvis Client events
                  examples:
                  - limit: 1000
                    results:
                    - bssid: 5c5b35000002
                      channel: 11
                      device_id: da088609-8e8d-6d8b-0e40-fe1dc94b9218
                      hostname: jdoe123-dell
                      location:
                        map_id: 7735ef91-83b4-6116-1c1a-57819af48867
                        site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                        timestamp: 1678377926
                        x: 12.5
                        y: 45
                      neighbor_ap_report:
                      - band: '5'
                        bssid: 5c5b35000003
                        channel: 44
                        rssi: -55
                      - band: '5'
                        bssid: 5c5b35000004
                        channel: 36
                        rssi: -70
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      pre_bssid: 5c5b35000001
                      pre_channel: 7
                      pre_rssi: -76
                      rssi: -53
                      ssid: Corp
                      timestamp: 1678377926
                      type: MARVISCLIENT_ROAMED
                      wifi_ip: 10.10.20.1
                      wifi_mac: f01c2df166e0
                    - device_id: da088609-8e8d-6d8b-0e40-fe1dc94b9218
                      hostname: jdoe123-dell
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      percent: 9
                      timestamp: 1678378040
                      type: MARVISCLIENT_LOW_BATTERY
                      wifi_ip: 10.10.20.1
                      wifi_mac: f01c2df166e0
                    total: 1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    limit: 1000
                    results:
                    - bssid: 5c5b35000002
                      channel: 11
                      device_id: da088609-8e8d-6d8b-0e40-fe1dc94b9218
                      hostname: jdoe123-dell
                      location:
                        map_id: 7735ef91-83b4-6116-1c1a-57819af48867
                        site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                        timestamp: 1678377926
                        x: 12.5
                        y: 45
                      neighbor_ap_report:
                      - band: '5'
                        bssid: 5c5b35000003
                        channel: 44
                        rssi: -55
                      - band: '5'
                        bssid: 5c5b35000004
                        channel: 36
                        rssi: -70
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      pre_bssid: 5c5b35000001
                      pre_channel: 7
                      pre_rssi: -76
                      rssi: -53
                      ssid: Corp
                      timestamp: 1678377926
                      type: MARVISCLIENT_ROAMED
                      wifi_ip: 10.10.20.1
                      wifi_mac: f01c2df166e0
                    - device_id: da088609-8e8d-6d8b-0e40-fe1dc94b9218
                      hostname: jdoe123-dell
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      percent: 9
                      timestamp: 1678378040
                      type: MARVISCLIENT_LOW_BATTERY
                      wifi_ip: 10.10.20.1
                      wifi_mac: f01c2df166e0
                    total: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/stats/marvisclients:
    delete:
      tags:
      - Orgs Clients - Marvis
      summary: deleteOrgMarvisClient
      description: Delete Marvis Client
      operationId: deleteOrgMarvisClient
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/marvisinvites:
    get:
      tags:
      - Orgs Marvis Invites
      summary: listOrgMarvisClientInvites
      description: List Marvis Client onboarding invite profiles for the organization, including enrollment URLs and enabled telemetry, location, and synthetic-test capabilities.
      operationId: listOrgMarvisClientInvites
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/marvis_client'
                description: Marvis Client profiles returned by the API
                examples:
                - - enrollment_url: marvisclient://api.mist.com/path/to/url
                    id: 3a14098f-b995-7552-b0a4-b8ee39b337a6
                    name: Handhelds
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - enrollment_url: marvisclient://api.mist.com/path/to/url
                    id: 3a14098f-b995-7552-b0a4-b8ee39b337a6
                    name: Handhelds
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/marvis_client'
                description: Marvis Client profiles returned by the API
                examples:
                - - enrollment_url: marvisclient://api.mist.com/path/to/url
                    id: 3a14098f-b995-7552-b0a4-b8ee39b337a6
                    name: Handhelds
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - enrollment_url: marvisclient://api.mist.com/path/to/url
                    id: 3a14098f-b995-7552-b0a4-b8ee39b337a6
                    name: Handhelds
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs Marvis Invites
      summary: createOrgMarvisClientInvite
      description: Create a Marvis Client onboarding invite profile for the organization, defining the enabled telemetry, location, and synthetic-test capabilities.
      operationId: createOrgMarvisClientInvite
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/marvis_client'
              - examples:
                - location:
                    enabled: true
                  name: Handhelds
                  synthetic_test:
                    enabled: true
                  telemetry:
                    enabled: true
              contentMediaType: application/json
            examples:
              Example:
                value:
                  location:
                    enabled: true
                  name: Handhelds
                  synthetic_test:
                    enabled: true
                  telemetry:
                    enabled: true
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/marvis_client'
                - description: Marvis Client configuration profile
                  examples:
                  - enrollment_url: marvisclient://api.mist.com/path/to/url
                    id: 3a14098f-b995-7552-b0a4-b8ee39b337a6
                    name: Handhelds
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    enrollment_url: marvisclient://api.mist.com/path/to/url
                    id: 3a14098f-b995-7552-b0a4-b8ee39b337a6
                    name: Handhelds
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/marvis_client'
                - description: Marvis Client configuration profile
                  examples:
                  - enrollment_url: marvisclient://api.mist.com/path/to/url
                    id: 3a14098f-b995-7552-b0a4-b8ee39b337a6
                    name: Handhelds
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    enrollment_url: marvisclient://api.mist.com/path/to/url
                    id: 3a14098f-b995-7552-b0a4-b8ee39b337a6
                    name: Handhelds
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/marvisinvites/{marvisinvite_id}:
    delete:
      tags:
      - Orgs Marvis Invites
      summary: deleteOrgMarvisClientInvite
      description: Delete a Marvis Client onboarding invite profile by ID.
      operationId: deleteOrgMarvisClientInvite
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: marvisinvite_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs Marvis Invites
      summary: getOrgMarvisClientInvite
      description: Retrieve a Marvis Client onboarding invite profile, including enrollment URL and enabled client capabilities.
      operationId: getOrgMarvisClientInvite
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: marvisinvite_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/marvis_client'
                - description: Marvis Client configuration profile
                  examples:
                  - enrollment_url: marvisclient://api.mist.com/path/to/url
                    id: 3a14098f-b995-7552-b0a4-b8ee39b337a6
                    name: Handhelds
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    enrollment_url: marvisclient://api.mist.com/path/to/url
                    id: 3a14098f-b995-7552-b0a4-b8ee39b337a6
                    name: Handhelds
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/marvis_client'
                - description: Marvis Client configuration profile
                  examples:
                  - enrollment_url: marvisclient://api.mist.com/path/to/url
                    id: 3a14098f-b995-7552-b0a4-b8ee39b337a6
                    name: Handhelds
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    enrollment_url: marvisclient://api.mist.com/path/to/url
                    id: 3a14098f-b995-7552-b0a4-b8ee39b337a6
                    name: Handhelds
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs Marvis Invites
      summary: updateOrgMarvisClientInvite
      description: Update a Marvis Client onboarding invite profile, including enabled telemetry, location, and synthetic-test capabilities.
      operationId: updateOrgMarvisClientInvite
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: marvisinvite_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/marvis_client'
              - examples:
                - location:
                    enabled: true
                  name: Handhelds
                  synthetic_test:
                    enabled: true
                  telemetry:
                    enabled: true
              contentMediaType: application/json
            examples:
              Example:
                value:
                  location:
                    enabled: true
                  name: Handhelds
                  synthetic_test:
                    enabled: true
                  telemetry:
                    enabled: true
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/marvis_client'
                - description: Marvis Client configuration profile
                  examples:
                  - enrollment_url: marvisclient://api.mist.com/path/to/url
                    id: 3a14098f-b995-7552-b0a4-b8ee39b337a6
                    name: Handhelds
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    enrollment_url: marvisclient://api.mist.com/path/to/url
                    id: 3a14098f-b995-7552-b0a4-b8ee39b337a6
                    name: Handhelds
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/marvis_client'
                - description: Marvis Client configuration profile
                  examples:
                  - enrollment_url: marvisclient://api.mist.com/path/to/url
                    id: 3a14098f-b995-7552-b0a4-b8ee39b337a6
                    name: Handhelds
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    enrollment_url: marvisclient://api.mist.com/path/to/url
                    id: 3a14098f-b995-7552-b0a4-b8ee39b337a6
                    name: Handhelds
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/nac_clients/count:
    get:
      tags:
      - Orgs Clients - NAC
      summary: countOrgNacClients
      description: Count NAC clients across the organization, optionally grouped by `distinct` and filtered by authentication, identity, endpoint, network, site, and time attributes.
      operationId: countOrgNacClients
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `ap`, `auth_type`, `device_mac`, `edr_managed`, `edr_providers`, `edr_status`, `family`, `hostname`, `idp_id`, `mfg`, `mdm_compliance`, `mdm_managed`, `mdm_provider`, `model`, `mxedge_id`, `nacrule_matched`, `nacrule_name`, `nacrule_id`, `nas_ip`, `nas_vendor`, `os`, `site_id`, `ssid`, `status`, `type`, `usermac_label`, `username`, `vlan`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/org_nac_clients_count_distinct'
          - description: 'Field used to group this count response. enum: `ap`, `auth_type`, `device_mac`, `edr_managed`, `edr_providers`, `edr_status`, `family`, `hostname`, `idp_id`, `mfg`, `mdm_compliance`, `mdm_managed`, `mdm_provider`, `model`, `mxedge_id`, `nacrule_matched`, `nacrule_name`, `nacrule_id`, `nas_ip`, `nas_vendor`, `os`, `site_id`, `ssid`, `status`, `type`, `usermac_label`, `username`, `vlan`'
      - name: last_nacrule_id
        in: query
        description: NAC Policy Rule ID, if matched
        style: form
        explode: true
        schema:
          type: string
      - name: nacrule_matched
        in: query
        description: NAC Policy Rule Matched
        style: form
        explode: true
        schema:
          type: boolean
      - name: auth_type
        in: query
        description: Authentication type, e.g. "eap-tls", "eap-peap", "eap-ttls", "eap-teap", "mab", "psk", "device-auth"
        style: form
        explode: true
        schema:
          type: string
      - name: last_vlan_id
        in: query
        description: Filter results by last VLAN ID
        style: form
        explode: true
        schema:
          type: string
      - name: last_nas_vendor
        in: query
        description: Vendor of NAS device
        style: form
        explode: true
        schema:
          type: string
      - name: idp_id
        in: query
        description: SSO ID, if present and used
        style: form
        explode: true
        schema:
          type: string
      - name: last_ssid
        in: query
        description: Filter results by last SSID
        style: form
        explode: true
        schema:
          type: string
      - name: last_username
        in: query
        description: Username presented by the client
        style: form
        explode: true
        schema:
          type: string
      - name: site_id
        in: query
        description: Filter results by site identifier
        style: form
        explode: true
        schema:
          type: string
      - name: last_ap
        in: query
        description: AP MAC connected to by client
        style: form
        explode: true
        schema:
          type: string
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: last_status
        in: query
        description: Connection status of client i.e "permitted", "denied, "session_ended"
        style: form
        explode: true
        schema:
          type: string
      - name: type
        in: query
        description: Client type i.e. "wireless", "wired" etc. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - wired,wireless
      - name: mdm_compliance_status
        in: query
        description: MDM compliance of client i.e "compliant", "not compliant"
        style: form
        explode: true
        schema:
          type: string
      - name: mdm_provider
        in: query
        description: MDM provider of client’s organization eg "intune", "jamf"
        style: form
        explode: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/nac_clients/events/count:
    get:
      tags:
      - Orgs Clients - NAC
      summary: countOrgNacClientEvents
      description: Count NAC client events across the organization, optionally grouped by `distinct` and filtered by event type and time range.
      operationId: countOrgNacClientEvents
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `ap`, `auth_type`, `dryrun_nacrule_id`, `mac`, `nacrule_id`, `nas_vendor`, `ssid`, `type`, `username`, `vlan`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/org_nac_client_events_count_distinct'
          - description: 'Field used to group this count response. enum: `ap`, `auth_type`, `dryrun_nacrule_id`, `mac`, `nacrule_id`, `nas_vendor`, `ssid`, `type`, `username`, `vlan`'
      - name: type
        in: query
        description: See [List Device Events Definitions]($e/Constants%20Events/listNacEventsDefinitions). Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - NAC_CLIENT_PERMIT,NAC_SESSION_STARTED
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/nac_clients/events/search:
    get:
      tags:
      - Orgs Clients - NAC
      summary: searchOrgNacClientEvents
      description: Search NAC client authentication event records across the organization with filters for authentication, NAC rule, identity provider, RADIUS, network, endpoint, site, and time attributes.
      operationId: searchOrgNacClientEvents
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: type
        in: query
        description: See [List Device Events Definitions]($e/Constants%20Events/listNacEventsDefinitions). Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - NAC_CLIENT_PERMIT,NAC_SESSION_STARTED
      - name: nacrule_id
        in: query
        description: NAC Policy Rule ID, if matched. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: uuid
      - name: nacrule_matched
        in: query
        description: NAC Policy Rule Matched
        style: form
        explode: true
        schema:
          type: boolean
      - name: dryrun_nacrule_id
        in: query
        description: NAC Policy Dry Run Rule ID, if present and matched
        style: form
        explode: true
        schema:
          type: string
      - name: dryrun_nacrule_matched
        in: query
        description: True - if dryrun rule present and matched with priority, False - if not matched or not present
        style: form
        explode: true
        schema:
          type: boolean
      - name: auth_type
        in: query
        description: Authentication type, e.g. "eap-tls", "eap-peap", "eap-ttls", "eap-teap", "mab", "psk", "device-auth". Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - mab,eap-tls
      - name: vlan
        in: query
        description: Filter results by VLAN ID. Accepts multiple comma-separated integer values.
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: nas_vendor
        in: query
        description: Vendor of NAS device
        style: form
        explode: true
        schema:
          type: string
      - name: bssid
        in: query
        description: Filter results by BSSID
        style: form
        explode: true
        schema:
          type: string
      - name: idp_id
        in: query
        description: SSO ID, if present and used
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: uuid
      - name: idp_role
        in: query
        description: IDP returned roles/groups for the user
        style: form
        explode: true
        schema:
          type: string
      - name: idp_username
        in: query
        description: Username presented to the Identity Provider
        style: form
        explode: true
        schema:
          type: string
      - name: resp_attrs
        in: query
        description: RADIUS attributes returned by NAC to NAS derive
        style: form
        explode: true
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
          examples:
          - - Tunnel-Type=VLAN
            - Tunnel-Medium-Type=IEEE-802
            - Tunnel-Private-Group-Id=750
            - User-Name=anonymous
      - name: ssid
        in: query
        description: Filter results by SSID
        style: form
        explode: true
        schema:
          type: string
      - name: username
        in: query
        description: Filter results by username. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - john.doe,jane.doe
      - name: site_id
        in: query
        description: Filter results by one site identifier. Use a single value; comma-separated values are not supported
        style: form
        explode: true
        schema:
          type: string
      - name: ap
        in: query
        description: Filter results by AP MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: random_mac
        in: query
        description: Filter results by whether the client is using a randomized MAC address. Accepts multiple comma-separated boolean values.
        style: form
        explode: true
        schema:
          type: boolean
      - name: mac
        in: query
        description: Filter results by one MAC address. Use a single value; comma-separated values are not supported
        style: form
        explode: true
        schema:
          type: string
      - name: usermac_label
        in: query
        description: Labels derived from usermac entry
        style: form
        explode: true
        schema:
          type: string
      - name: text
        in: query
        description: Partial / full MAC address, username, device_mac or ap
        style: form
        explode: true
        schema:
          type: string
      - name: nas_ip
        in: query
        description: IP address of NAS device. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 192.0.2.10,192.0.2.11
      - name: ingress_vlan
        in: query
        description: Vendor specific VLAN ID in RADIUS requests
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order.
        style: form
        explode: true
        schema:
          type: string
          default: wxid
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: NAC Client Events
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_events_nac_client_search'
                - description: Paginated response for NAC client event search results
                  examples:
                  - end: 1513176951
                    limit: 10
                    results:
                    - ap: 5c5b35513227
                      auth_type: eap-ttls
                      bssid: 5c5b355fafcc
                      dryrun_nacrule_id: 32f27e7d-ff26-4a9b-b3d1-ff9bcb264012
                      dryrun_nacrule_matched: true
                      idp_id: 912ef72e-2239-4996-b81e-469e87a27cd6
                      idp_role:
                      - itsuperusers
                      - vip
                      mac: ac3eb179e535
                      nacrule_id: 32f27e7d-ff26-4a9b-b3d1-ff9bcb264c62
                      nacrule_matched: true
                      nas_vendor: juniper-mist
                      org_id: 27547ac2-d114-4e04-beb1-f3f1e6e81ec6
                      random_mac: 'false'
                      resp_attrs:
                      - Tunnel-Type=VLAN
                      - Tunnel-Medium-Type=IEEE-802
                      - Tunnel-Private-Group-Id=750
                      - User-Name=anonymous
                      site_id: 441a1214-6928-442a-8e92-e1d34b8ec6a6
                      ssid: mist_nac
                      timestamp: 1691512031.358188
                      type: NAC_CLIENT_PERMIT
                      username: user@deaflyz.net
                      vlan: '750'
                    start: 1512572151
                    total: 1
                contentMediaType: application/json
              examples:
                NAC-client_events:
                  value:
                    end: 1513176951
                    limit: 10
                    results:
                    - ap: 5c5b35513227
                      auth_type: eap-ttls
                      bssid: 5c5b355fafcc
                      dryrun_nacrule_id: 32f27e7d-ff26-4a9b-b3d1-ff9bcb264012
                      dryrun_nacrule_matched: true
                      idp_id: 912ef72e-2239-4996-b81e-469e87a27cd6
                      idp_role:
                      - itsuperusers
                      - vip
                      mac: ac3eb179e535
                      nacrule_id: 32f27e7d-ff26-4a9b-b3d1-ff9bcb264c62
                      nacrule_matched: true
                      nas_vendor: juniper-mist
                      org_id: 27547ac2-d114-4e04-beb1-f3f1e6e81ec6
                      random_mac: 'false'
                      resp_attrs:
                      - Tunnel-Type=VLAN
                      - Tunnel-Medium-Type=IEEE-802
                      - Tunnel-Private-Group-Id=750
                      - User-Name=anonymous
                      site_id: 441a1214-6928-442a-8e92-e1d34b8ec6a6
                      ssid: mist_nac
                      timestamp: 1691512031.358188
                      type: NAC_CLIENT_PERMIT
                      username: user@deaflyz.net
                      vlan: '750'
                    start: 1512572151
                    total: 1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_events_nac_client_search'
                - description: Paginated response for NAC client event search results
                  examples:
                  - end: 1513176951
                    limit: 10
                    results:
                    - ap: 5c5b35513227
                      auth_type: eap-ttls
                      bssid: 5c5b355fafcc
                      dryrun_nacrule_id: 32f27e7d-ff26-4a9b-b3d1-ff9bcb264012
                      dryrun_nacrule_matched: true
                      idp_id: 912ef72e-2239-4996-b81e-469e87a27cd6
                      idp_role:
                      - itsuperusers
                      - vip
                      mac: ac3eb179e535
                      nacrule_id: 32f27e7d-ff26-4a9b-b3d1-ff9bcb264c62
                      nacrule_matched: true
                      nas_vendor: juniper-mist
                      org_id: 27547ac2-d114-4e04-beb1-f3f1e6e81ec6
                      random_mac: 'false'
                      resp_attrs:
                      - Tunnel-Type=VLAN
                      - Tunnel-Medium-Type=IEEE-802
                      - Tunnel-Private-Group-Id=750
                      - User-Name=anonymous
                      site_id: 441a1214-6928-442a-8e92-e1d34b8ec6a6
                      ssid: mist_nac
                      timestamp: 1691512031.358188
                      type: NAC_CLIENT_PERMIT
                      username: user@deaflyz.net
                      vlan: '750'
                    start: 1512572151
                    total: 1
                contentMediaType: application/vnd.api+json
              examples:
                NAC-client_events:
                  value:
                    end: 1513176951
                    limit: 10
                    results:
                    - ap: 5c5b35513227
                      auth_type: eap-ttls
                      bssid: 5c5b355fafcc
                      dryrun_nacrule_id: 32f27e7d-ff26-4a9b-b3d1-ff9bcb264012
                      dryrun_nacrule_matched: true
                      idp_id: 912ef72e-2239-4996-b81e-469e87a27cd6
                      idp_role:
                      - itsuperusers
                      - vip
                      mac: ac3eb179e535
                      nacrule_id: 32f27e7d-ff26-4a9b-b3d1-ff9bcb264c62
                      nacrule_matched: true
                      nas_vendor: juniper-mist
                      org_id: 27547ac2-d114-4e04-beb1-f3f1e6e81ec6
                      random_mac: 'false'
                      resp_attrs:
                      - Tunnel-Type=VLAN
                      - Tunnel-Medium-Type=IEEE-802
                      - Tunnel-Private-Group-Id=750
                      - User-Name=anonymous
                      site_id: 441a1214-6928-442a-8e92-e1d34b8ec6a6
                      ssid: mist_nac
                      timestamp: 1691512031.358188
                      type: NAC_CLIENT_PERMIT
                      username: user@deaflyz.net
                      vlan: '750'
                    start: 1512572151
                    total: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/nac_clients/search:
    get:
      tags:
      - Orgs Clients - NAC
      summary: searchOrgNacClients
      description: Search NAC client records across the organization with filters for authentication, endpoint posture, identity, network, NAC rule, site, and time attributes.
      operationId: searchOrgNacClients
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: ap
        in: query
        description: MAC address of the AP the client is/was connected to
        style: form
        explode: true
        schema:
          type: string
      - name: auth_type
        in: query
        description: Authentication type, e.g. "eap-tls", "eap-peap", "eap-ttls", "eap-teap", "mab", "psk", "device-auth". Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - mab,eap-tls
      - name: cert_expiry_duration
        in: query
        description: Filter by certificate expiry within a specific duration from now (e.g., "7d" for 7 days, "1m" for 1 month). Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 7d,1m
          - 7d
          - 1m
        examples:
          Untitled Example1:
            value: 7d,1m
          Untitled Example2:
            value: 7d
          Untitled Example3:
            value: 1m
      - name: edr_managed
        in: query
        description: Filters NAC clients that are integrated with EDR providers
        style: form
        explode: true
        schema:
          type: boolean
      - name: edr_providers
        in: query
        description: "EDR provider of the client's organization. enum: `crowdstrike`, `sentinelone`"
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/edr_provider'
          - description: "EDR provider of the client's organization. enum: `crowdstrike`, `sentinelone`"
      - name: edr_status
        in: query
        description: 'EDR status used to filter NAC clients. enum: `sentinelone_healthy`, `sentinelone_infected`, `crowdstrike_low`, `crowdstrike_medium`, `crowdstrike_high`, `crowdstrike_critical`, `crowdstrike_informational`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/edr_status'
          - description: 'EDR status used to filter NAC clients. enum: `sentinelone_healthy`, `sentinelone_infected`, `crowdstrike_low`, `crowdstrike_medium`, `crowdstrike_high`, `crowdstrike_critical`, `crowdstrike_informational`'
      - name: family
        in: query
        description: Partial / full Client family (e.g. "Phone/Tablet/Wearable", "Access Point"). Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `Surveillance*` and `*urveillance*` match `Surveillance Camera`). Suffix-only wildcards (e.g. `*Camera`) are not supported. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Surveillance Camera,Surveillance*
          - Surveillance Camera
          - Surveillance*
          - '*urveillance*'
        examples:
          Untitled Example1:
            value: Surveillance Camera,Surveillance*
          Untitled Example2:
            value: Surveillance Camera
          Untitled Example3:
            value: Surveillance*
          Untitled Example4:
            value: '*urveillance*'
      - name: hostname
        in: query
        description: Partial / full Client hostname. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `everest*` and `*rest*` match `my-everest-client`). Suffix-only wildcards (e.g. `*everest`) are not supported. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - my-everest-client,my-everest*
          - my-everest-client
          - my-everest*
          - '*everest*'
        examples:
          Untitled Example1:
            value: my-everest-client,my-everest*
          Untitled Example2:
            value: my-everest-client
          Untitled Example3:
            value: my-everest*
          Untitled Example4:
            value: '*everest*'
      - name: idp_id
        in: query
        description: SSO ID, if present and used
        style: form
        explode: true
        schema:
          type: string
      - name: mac
        in: query
        description: Partial / full Client MAC address. Use a single value; comma-separated values are not supported. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `aabbcc*` and `*bbcc*` match `aabbccddeeff`). Suffix-only wildcards (e.g. `*bccddeeff`) are not supported
        style: form
        explode: true
        schema:
          type: string
          examples:
          - aabbccddeeff
          - aabbcc*
          - '*bbcc*'
        examples:
          Untitled Example1:
            value: aabbccddeeff
          Untitled Example2:
            value: aabbcc*
          Untitled Example3:
            value: '*bbcc*'
      - name: mdm_compliance
        in: query
        description: MDM compliance of client i.e "compliant", "not compliant"
        style: form
        explode: true
        schema:
          type: string
      - name: mdm_provider
        in: query
        description: MDM provider of client’s organization eg "intune", "jamf"
        style: form
        explode: true
        schema:
          type: string
      - name: mdm_managed
        in: query
        description: Filters NAC clients that are managed by MDM providers
        style: form
        explode: true
        schema:
          type: boolean
      - name: mfg
        in: query
        description: Partial / full Client manufacturer (e.g. "apple", "cisco", "juniper"). Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `Raspberry Pi*` and `*Pi*` match `Raspberry Pi Trading Ltd`). Suffix-only wildcards (e.g. `*Ltd`) are not supported. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Raspberry Pi Trading Ltd,Raspberry Pi*
          - Raspberry Pi Trading Ltd
          - Raspberry Pi*
          - '*Pi*'
        examples:
          Untitled Example1:
            value: Raspberry Pi Trading Ltd,Raspberry Pi*
          Untitled Example2:
            value: Raspberry Pi Trading Ltd
          Untitled Example3:
            value: Raspberry Pi*
          Untitled Example4:
            value: '*Pi*'
      - name: model
        in: query
        description: Client model, e.g. "iPhone 12", "MX100"
        style: form
        explode: true
        schema:
          type: string
      - name: nacrule_name
        in: query
        description: NAC Policy Rule Name matched
        style: form
        explode: true
        schema:
          type: string
      - name: nacrule_id
        in: query
        description: NAC Policy Rule ID, if matched
        style: form
        explode: true
        schema:
          type: string
      - name: nacrule_matched
        in: query
        description: NAC Policy Rule Matched
        style: form
        explode: true
        schema:
          type: boolean
      - name: nas_vendor
        in: query
        description: Vendor of NAS device
        style: form
        explode: true
        schema:
          type: string
      - name: nas_ip
        in: query
        description: IP address of NAS device. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 192.0.2.10,192.0.2.11
      - name: ingress_vlan
        in: query
        description: Vendor specific VLAN ID in RADIUS requests
        style: form
        explode: true
        schema:
          type: string
      - name: os
        in: query
        description: Client OS, e.g. "iOS 18.1", "Android", "Windows", "Linux"
        style: form
        explode: true
        schema:
          type: string
      - name: ssid
        in: query
        description: Filter results by SSID
        style: form
        explode: true
        schema:
          type: string
      - name: status
        in: query
        description: 'Client connection status used to filter results. enum: `permitted`, `session_started`, `session_stopped`, `denied`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/nac_client_last_status'
          - description: 'Client connection status used to filter results. enum: `permitted`, `session_started`, `session_stopped`, `denied`'
            examples:
            - permitted
      - name: text
        in: query
        description: partial / full MAC address, last_username, device_mac, nas_ip or last_ap
        style: form
        explode: true
        schema:
          type: string
      - name: type
        in: query
        description: Client type i.e. "wireless", "wired" etc. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - wired,wireless
      - name: usermac_label
        in: query
        description: Labels derived from usermac entry
        style: form
        explode: true
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: username
        in: query
        description: Filter results by username
        style: form
        explode: true
        schema:
          type: string
      - name: vlan
        in: query
        description: Filter results by VLAN ID
        style: form
        explode: true
        schema:
          type: string
      - name: site_id
        in: query
        description: Filter results by one site identifier. Use a single value; comma-separated values are not supported
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order.
        style: form
        explode: true
        schema:
          type: string
          default: wxid
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_client_nac_search'
                - description: Paginated NAC client search response
                  examples:
                  - end: 1513362753
                    limit: 3
                    results:
                    - ap:
                      - 5c5b35bf16bb
                      - d4dc090041b4
                      auth_type: eap-tls
                      cert_cn:
                      - john@mycorp.net
                      cert_issuer:
                      - /C=US/ST=CA/CN=MyCorp
                      client_ip:
                      - 10.7.51.74
                      edr_managed: true
                      edr_providers:
                      - sentinelone
                      edr_status:
                      - sentinelone_healthy
                      idp_id: string
                      idp_role:
                      - string
                      last_ap: string
                      last_cert_cn: john@mycorp.net
                      last_cert_expiry: 1746711240
                      last_cert_issuer: /C=US/ST=CA/CN=MyCorp
                      last_cert_serial: 2c63510123456789
                      last_cert_subject: /C=US/O=MyCorp/CN=john@mycorp.net/emailAddress=john@mycorp.net
                      last_client_ip: 10.7.51.74
                      last_nacrule_id: 603b62db-d839-4152-9f7f-f2578443de8d
                      last_nacrule_name: Wireless Cert Auth
                      last_nas_vendor: juniper-mist
                      last_ssid: string
                      last_status: permitted
                      mac: string
                      nacrule_id:
                      - 603b62db-d839-4152-9f7f-f2578443de8d
                      nacrule_matched: true
                      nacrule_name:
                      - Wireless Cert Auth
                      nas_vendor:
                      - juniper-mist
                      org_id: 31f27122-68a9-47a4-b526-8fb8a62a8acb
                      random_mac: 'true'
                      site_id: 832b1d74-9531-409b-ae37-4d7f3edbde92
                      ssid:
                      - string
                      timestamp: 1694689718.612
                      type: wireless
                      usermac_label:
                      - non-compliant
                      - building26
                      - floor52
                    start: 1513276353
                    total: 2
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1513362753
                    limit: 3
                    results:
                    - ap:
                      - 5c5b35bf16bb
                      - d4dc090041b4
                      auth_type: eap-tls
                      cert_cn:
                      - john@mycorp.net
                      cert_issuer:
                      - /C=US/ST=CA/CN=MyCorp
                      client_ip:
                      - 10.7.51.74
                      edr_managed: true
                      edr_providers:
                      - sentinelone
                      edr_status:
                      - sentinelone_healthy
                      idp_id: string
                      idp_role:
                      - string
                      last_ap: string
                      last_cert_cn: john@mycorp.net
                      last_cert_expiry: 1746711240
                      last_cert_issuer: /C=US/ST=CA/CN=MyCorp
                      last_cert_serial: 2c63510123456789
                      last_cert_subject: /C=US/O=MyCorp/CN=john@mycorp.net/emailAddress=john@mycorp.net
                      last_client_ip: 10.7.51.74
                      last_nacrule_id: 603b62db-d839-4152-9f7f-f2578443de8d
                      last_nacrule_name: Wireless Cert Auth
                      last_nas_vendor: juniper-mist
                      last_ssid: string
                      last_status: permitted
                      mac: string
                      nacrule_id:
                      - 603b62db-d839-4152-9f7f-f2578443de8d
                      nacrule_matched: true
                      nacrule_name:
                      - Wireless Cert Auth
                      nas_vendor:
                      - juniper-mist
                      org_id: 31f27122-68a9-47a4-b526-8fb8a62a8acb
                      random_mac: 'true'
                      site_id: 832b1d74-9531-409b-ae37-4d7f3edbde92
                      ssid:
                      - string
                      timestamp: 1694689718.612
                      type: wireless
                      usermac_label:
                      - non-compliant
                      - building26
                      - floor52
                    start: 1513276353
                    total: 2
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_client_nac_search'
                - description: Paginated NAC client search response
                  examples:
                  - end: 1513362753
                    limit: 3
                    results:
                    - ap:
                      - 5c5b35bf16bb
                      - d4dc090041b4
                      auth_type: eap-tls
                      cert_cn:
                      - john@mycorp.net
                      cert_issuer:
                      - /C=US/ST=CA/CN=MyCorp
                      client_ip:
                      - 10.7.51.74
                      edr_managed: true
                      edr_providers:
                      - sentinelone
                      edr_status:
                      - sentinelone_healthy
                      idp_id: string
                      idp_role:
                      - string
                      last_ap: string
                      last_cert_cn: john@mycorp.net
                      last_cert_expiry: 1746711240
                      last_cert_issuer: /C=US/ST=CA/CN=MyCorp
                      last_cert_serial: 2c63510123456789
                      last_cert_subject: /C=US/O=MyCorp/CN=john@mycorp.net/emailAddress=john@mycorp.net
                      last_client_ip: 10.7.51.74
                      last_nacrule_id: 603b62db-d839-4152-9f7f-f2578443de8d
                      last_nacrule_name: Wireless Cert Auth
                      last_nas_vendor: juniper-mist
                      last_ssid: string
                      last_status: permitted
                      mac: string
                      nacrule_id:
                      - 603b62db-d839-4152-9f7f-f2578443de8d
                      nacrule_matched: true
                      nacrule_name:
                      - Wireless Cert Auth
                      nas_vendor:
                      - juniper-mist
                      org_id: 31f27122-68a9-47a4-b526-8fb8a62a8acb
                      random_mac: 'true'
                      site_id: 832b1d74-9531-409b-ae37-4d7f3edbde92
                      ssid:
                      - string
                      timestamp: 1694689718.612
                      type: wireless
                      usermac_label:
                      - non-compliant
                      - building26
                      - floor52
                    start: 1513276353
                    total: 2
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1513362753
                    limit: 3
                    results:
                    - ap:
                      - 5c5b35bf16bb
                      - d4dc090041b4
                      auth_type: eap-tls
                      cert_cn:
                      - john@mycorp.net
                      cert_issuer:
                      - /C=US/ST=CA/CN=MyCorp
                      client_ip:
                      - 10.7.51.74
                      edr_managed: true
                      edr_providers:
                      - sentinelone
                      edr_status:
                      - sentinelone_healthy
                      idp_id: string
                      idp_role:
                      - string
                      last_ap: string
                      last_cert_cn: john@mycorp.net
                      last_cert_expiry: 1746711240
                      last_cert_issuer: /C=US/ST=CA/CN=MyCorp
                      last_cert_serial: 2c63510123456789
                      last_cert_subject: /C=US/O=MyCorp/CN=john@mycorp.net/emailAddress=john@mycorp.net
                      last_client_ip: 10.7.51.74
                      last_nacrule_id: 603b62db-d839-4152-9f7f-f2578443de8d
                      last_nacrule_name: Wireless Cert Auth
                      last_nas_vendor: juniper-mist
                      last_ssid: string
                      last_status: permitted
                      mac: string
                      nacrule_id:
                      - 603b62db-d839-4152-9f7f-f2578443de8d
                      nacrule_matched: true
                      nacrule_name:
                      - Wireless Cert Auth
                      nas_vendor:
                      - juniper-mist
                      org_id: 31f27122-68a9-47a4-b526-8fb8a62a8acb
                      random_mac: 'true'
                      site_id: 832b1d74-9531-409b-ae37-4d7f3edbde92
                      ssid:
                      - string
                      timestamp: 1694689718.612
                      type: wireless
                      usermac_label:
                      - non-compliant
                      - building26
                      - floor52
                    start: 1513276353
                    total: 2
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/nac_clients/{client_mac}/coa:
    post:
      tags:
      - Orgs Clients - NAC
      summary: sendOrgNacClientCoA
      description: Sends CoA (Change of Authorization) command to a NAC client.
      operationId: sendOrgNacClientCoA
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: client_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/nac_client_coa'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/nac_client_coa_response'
                - description: Response returned after sending a NAC client CoA command
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/nac_client_coa_response'
                - description: Response returned after sending a NAC client CoA command
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/wan_client/events/count:
    get:
      tags:
      - Orgs Clients - Wan
      summary: countOrgWanClientEvents
      description: Count by Distinct Attributes of Org WAN Client-Events
      operationId: countOrgWanClientEvents
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `hostname`, `ip`, `mac`, `mfg`, `type`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/org_wan_clients_events_count_distinct'
          - description: 'Field used to group this count response. enum: `hostname`, `ip`, `mac`, `mfg`, `type`'
      - name: type
        in: query
        description: See [List Device Events Definitions]($e/Constants%20Events/listDeviceEventsDefinitions)
        style: form
        explode: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/wan_clients/count:
    get:
      tags:
      - Orgs Clients - Wan
      summary: countOrgWanClients
      description: Count by Distinct Attributes of Org WAN Clients
      operationId: countOrgWanClients
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `hostname`, `ip`, `mac`, `mfg`, `network`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/org_wan_clients_count_distinct'
          - description: 'Field used to group this count response. enum: `hostname`, `ip`, `mac`, `mfg`, `network`'
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/wan_clients/events/search:
    get:
      tags:
      - Orgs Clients - Wan
      summary: searchOrgWanClientEvents
      description: Search Org WAN Client Events
      operationId: searchOrgWanClientEvents
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: type
        in: query
        description: See [List Device Events Definitions]($e/Constants%20Events/listDeviceEventsDefinitions)
        style: form
        explode: true
        schema:
          type: string
      - name: mac
        in: query
        description: Partial / full Client MAC address. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `aabbcc*` and `*bbcc*` match `aabbccddeeff`). Suffix-only wildcards (e.g. `*bccddeeff`) are not supported
        style: form
        explode: true
        schema:
          type: string
          examples:
          - aabbccddeeff
          - aabbcc*
          - '*bbcc*'
        examples:
          Untitled Example1:
            value: aabbccddeeff
          Untitled Example2:
            value: aabbcc*
          Untitled Example3:
            value: '*bbcc*'
      - name: hostname
        in: query
        description: Partial / full Client hostname. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `everest*` and `*rest*` match `my-everest-client`). Suffix-only wildcards (e.g. `*everest`) are not supported
        style: form
        explode: true
        schema:
          type: string
          examples:
          - my-everest-client
          - my-everest*
          - '*everest*'
        examples:
          Untitled Example1:
            value: my-everest-client
          Untitled Example2:
            value: my-everest*
          Untitled Example3:
            value: '*everest*'
      - name: ip
        in: query
        description: Partial / full Client IP address. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `10.100.10.*` and `*100.10.*` match `10.100.10.54`). Suffix-only wildcards (e.g. `*.54`) are not supported
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 10.100.10.54
          - 10.100.10.*
          - '*100.10.*'
        examples:
          Untitled Example1:
            value: 10.100.10.54
          Untitled Example2:
            value: 10.100.10.*
          Untitled Example3:
            value: '*100.10.*'
      - name: mfg
        in: query
        description: Partial / full Client manufacturer (e.g. "apple", "cisco", "juniper"). Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `Raspberry Pi*` and `*Pi*` match `Raspberry Pi Trading Ltd`). Suffix-only wildcards (e.g. `*Ltd`) are not supported
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Raspberry Pi Trading Ltd
          - Raspberry Pi*
          - '*Pi*'
        examples:
          Untitled Example1:
            value: Raspberry Pi Trading Ltd
          Untitled Example2:
            value: Raspberry Pi*
          Untitled Example3:
            value: '*Pi*'
      - name: nacrule_id
        in: query
        description: Filter results by NAC rule identifier
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/search_events_wan_client'
                - description: Paginated response for WAN client event searches
                  examples:
                  - end: 0
                    limit: 0
                    results:
                    - When: 2022-12-31 23:59:59.293000+00:00
                      ev_type: CLIENT_IP_ASSIGNED
                      metadata: {}
                      org_id: b0b9f142-aaba-11e6-aafc-0242ac110002
                      random_mac: true
                      site_id: fc656275-b157-43fd-b922-5f4f341c19bf
                      text: DHCP Ack IP 192.168.88.216
                      wcid: 62bbfb75-10d8-49d1-dec7-d2df91624287
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 0
                    limit: 0
                    results:
                    - When: 2022-12-31 23:59:59.293000+00:00
                      ev_type: CLIENT_IP_ASSIGNED
                      metadata: {}
                      org_id: b0b9f142-aaba-11e6-aafc-0242ac110002
                      random_mac: true
                      site_id: fc656275-b157-43fd-b922-5f4f341c19bf
                      text: DHCP Ack IP 192.168.88.216
                      wcid: 62bbfb75-10d8-49d1-dec7-d2df91624287
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/search_events_wan_client'
                - description: Paginated response for WAN client event searches
                  examples:
                  - end: 0
                    limit: 0
                    results:
                    - When: 2022-12-31 23:59:59.293000+00:00
                      ev_type: CLIENT_IP_ASSIGNED
                      metadata: {}
                      org_id: b0b9f142-aaba-11e6-aafc-0242ac110002
                      random_mac: true
                      site_id: fc656275-b157-43fd-b922-5f4f341c19bf
                      text: DHCP Ack IP 192.168.88.216
                      wcid: 62bbfb75-10d8-49d1-dec7-d2df91624287
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 0
                    limit: 0
                    results:
                    - When: 2022-12-31 23:59:59.293000+00:00
                      ev_type: CLIENT_IP_ASSIGNED
                      metadata: {}
                      org_id: b0b9f142-aaba-11e6-aafc-0242ac110002
                      random_mac: true
                      site_id: fc656275-b157-43fd-b922-5f4f341c19bf
                      text: DHCP Ack IP 192.168.88.216
                      wcid: 62bbfb75-10d8-49d1-dec7-d2df91624287
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/wan_clients/search:
    get:
      tags:
      - Orgs Clients - Wan
      summary: searchOrgWanClients
      description: Search Org WAN Clients
      operationId: searchOrgWanClients
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: site_id
        in: query
        description: Filter results by site identifier
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 72771e6a-6f5e-4de4-a5b9-1266c4197811
      - name: hostname
        in: query
        description: Partial / full Client hostname. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `everest*` and `*rest*` match `my-everest-client`). Suffix-only wildcards (e.g. `*everest`) are not supported. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - my-everest-client,my-everest*
          - my-everest-client
          - my-everest*
          - '*everest*'
        examples:
          Untitled Example1:
            value: my-everest-client,my-everest*
          Untitled Example2:
            value: my-everest-client
          Untitled Example3:
            value: my-everest*
          Untitled Example4:
            value: '*everest*'
      - name: ip
        in: query
        description: Partial / full Client IP address. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `10.100.10.*` and `*100.10.*` match `10.100.10.54`). Suffix-only wildcards (e.g. `*.54`) are not supported. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 10.100.10.54,10.100.10.*
          - 10.100.10.54
          - 10.100.10.*
          - '*100.10.*'
        examples:
          Untitled Example1:
            value: 10.100.10.54,10.100.10.*
          Untitled Example2:
            value: 10.100.10.54
          Untitled Example3:
            value: 10.100.10.*
          Untitled Example4:
            value: '*100.10.*'
      - name: ip_src
        in: query
        description: Filter results by source IP address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - dhcp
      - name: mac
        in: query
        description: Filter results by MAC address. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b53010101,5c5b53020202
          - 5c5b53010101
        examples:
          Untitled Example1:
            value: 5c5b53010101,5c5b53020202
          Untitled Example2:
            value: 5c5b53010101
      - name: mfg
        in: query
        description: Filter results by manufacturer. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Unknown,Juniper Networks
      - name: network
        in: query
        description: Partial / full Name of the network the client is/was connected to. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `my-corp*` and `*corp*` match `my-corp-network`). Suffix-only wildcards (e.g. `*corp`) are not supported. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - my-corp-network,my-corp*
          - my-corp-network
          - my-corp*
          - '*corp*'
        examples:
          Untitled Example1:
            value: my-corp-network,my-corp*
          Untitled Example2:
            value: my-corp-network
          Untitled Example3:
            value: my-corp*
          Untitled Example4:
            value: '*corp*'
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/search_wan_client'
                - description: Paginated response for WAN client searches
                  examples:
                  - end: 0
                    limit: 0
                    results:
                    - hostname:
                      - sonoszp
                      ip:
                      - 192.168.1.139
                      last_hostname: sonoszp
                      last_ip: 192.168.1.139
                      mfg: Sonos
                      org_id: b4e16c72-d50e-4c03-a952-a3217e231e2c
                      site_id: f688779c-e335-4f88-8d7c-9c5e9964528b
                      wcid: 8bbe7389-212b-c65d-2208-00fab2017936
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 0
                    limit: 0
                    results:
                    - hostname:
                      - sonoszp
                      ip:
                      - 192.168.1.139
                      last_hostname: sonoszp
                      last_ip: 192.168.1.139
                      mfg: Sonos
                      org_id: b4e16c72-d50e-4c03-a952-a3217e231e2c
                      site_id: f688779c-e335-4f88-8d7c-9c5e9964528b
                      wcid: 8bbe7389-212b-c65d-2208-00fab2017936
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/search_wan_client'
                - description: Paginated response for WAN client searches
                  examples:
                  - end: 0
                    limit: 0
                    results:
                    - hostname:
                      - sonoszp
                      ip:
                      - 192.168.1.139
                      last_hostname: sonoszp
                      last_ip: 192.168.1.139
                      mfg: Sonos
                      org_id: b4e16c72-d50e-4c03-a952-a3217e231e2c
                      site_id: f688779c-e335-4f88-8d7c-9c5e9964528b
                      wcid: 8bbe7389-212b-c65d-2208-00fab2017936
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 0
                    limit: 0
                    results:
                    - hostname:
                      - sonoszp
                      ip:
                      - 192.168.1.139
                      last_hostname: sonoszp
                      last_ip: 192.168.1.139
                      mfg: Sonos
                      org_id: b4e16c72-d50e-4c03-a952-a3217e231e2c
                      site_id: f688779c-e335-4f88-8d7c-9c5e9964528b
                      wcid: 8bbe7389-212b-c65d-2208-00fab2017936
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/wired_clients/count:
    get:
      tags:
      - Orgs Clients - Wired
      summary: countOrgWiredClients
      description: >-
        Count by Distinct Attributes of Clients


        Note: For list of available `type` values, please refer to [List Client Events Definitions]($e/Constants%20Events/listClientEventsDefinitions)
      operationId: countOrgWiredClients
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `device_mac`, `mac`, `port_id`, `site_id`, `type`, `vlan`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/org_wired_clients_count_distinct'
          - description: 'Field used to group this count response. enum: `device_mac`, `mac`, `port_id`, `site_id`, `type`, `vlan`'
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/wired_clients/search:
    get:
      tags:
      - Orgs Clients - Wired
      summary: searchOrgWiredClients
      description: >-
        Search for Wired Clients in org


        Note: For list of available `type` values, please refer to [List Client Events Definitions]($e/Constants%20Events/listClientEventsDefinitions)
      operationId: searchOrgWiredClients
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: auth_state
        in: query
        description: Filter results by auth state
        style: form
        explode: true
        schema:
          type: string
      - name: auth_method
        in: query
        description: Filter results by authentication method. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - server_reject,mac_auth
      - name: source
        in: query
        description: 'Filter results by client learning source. enum: `lldp`, `mac`. Accepts multiple comma-separated values.'
        style: form
        explode: true
        schema:
          type: string
          examples:
          - lldp,mac
      - name: site_id
        in: query
        description: Filter results by site identifier
        style: form
        explode: true
        schema:
          type: string
      - name: device_mac
        in: query
        description: Filter results by one or more gateway or switch MAC addresses where the client has connected. Supports comma-separated values
        style: form
        explode: true
        schema:
          type: string
      - name: mac
        in: query
        description: Partial / full Client MAC address. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `aabbcc*` and `*bbcc*` match `aabbccddeeff`). Suffix-only wildcards (e.g. `*bccddeeff`) are not supported. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - aabbccddeeff,aabbcc*
          - aabbccddeeff
          - aabbcc*
          - '*bbcc*'
        examples:
          Untitled Example1:
            value: aabbccddeeff,aabbcc*
          Untitled Example2:
            value: aabbccddeeff
          Untitled Example3:
            value: aabbcc*
          Untitled Example4:
            value: '*bbcc*'
      - name: port_id
        in: query
        description: Filter results by one or more port identifiers where the client has connected. Supports comma-separated values
        style: form
        explode: true
        schema:
          type: string
      - name: vlan
        in: query
        description: Filter results by one or more VLAN IDs. Supports comma-separated values
        style: form
        explode: true
        schema:
          type: string
          examples:
          - '1'
          - 1,2
        examples:
          Untitled Example1:
            value: '1'
          Untitled Example2:
            value: 1,2
      - name: ip
        in: query
        description: Filter results by one or more IPv4 addresses. Supports comma-separated values
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 192.168.1.1
          - 192.168.1.1,192.168.1.2
        examples:
          Untitled Example1:
            value: 192.168.1.1
          Untitled Example2:
            value: 192.168.1.1,192.168.1.2
      - name: manufacture
        in: query
        description: Filter results by manufacturer. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Unknown,GIFA
      - name: text
        in: query
        description: Partial / full Client MAC address, hostname or username. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `aabbcc*` and `*bbcc*` match `aabbccddeeff`). Suffix-only wildcards (e.g. `*ddeeff`) are not supported
        style: form
        explode: true
        schema:
          type: string
      - name: nacrule_id
        in: query
        description: Filter results by NAC rule identifier
        style: form
        explode: true
        schema:
          type: string
      - name: dhcp_hostname
        in: query
        description: Filter results by DHCP hostname. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - client-a,client-b
      - name: dhcp_fqdn
        in: query
        description: Filter results by DHCP FQDN
        style: form
        explode: true
        schema:
          type: string
      - name: dhcp_client_identifier
        in: query
        description: Filter results by DHCP client identifier. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - MAC address a8f7d982288f,MAC address 5c5b351e120c
      - name: dhcp_vendor_class_identifier
        in: query
        description: DHCP Vendor Class Identifier. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Mist AP34-WW,Mist BT11-WW
      - name: dhcp_request_params
        in: query
        description: Filter results by DHCP request parameters. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 1 121 3 6 12 15 28 42 43 180,1 3 6 12 15 28 42 43 180
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/search_wired_client'
                - description: Paginated response for wired client searches
                  examples:
                  - end: 1648529800.8221116
                    limit: 1000
                    results:
                    - auth_method: mac_auth
                      auth_state: authenticated
                      device_mac:
                      - '001122334455'
                      dhcp_client_identifier: MAC address 00155df6d500
                      dhcp_client_options:
                      - code: DHO_DHCP_MESSAGE_TYPE(53)
                        data: DHCPREQUEST
                      - code: DHO_DHCP_CLIENT_IDENTIFIER(61)
                        data: MAC address 00155df6d500
                      - code: DHO_DHCP_REQUESTED_ADDRESS(50)
                        data: 172.17.10.255
                      - code: DHO_DHCP_SERVER_IDENTIFIER(54)
                        data: 172.17.8.1
                      - code: DHO_DHCP_MAX_MESSAGE_SIZE(57)
                        data: '1280'
                      - code: DHO_DHCP_PARAMETER_REQUEST_LIST(55)
                        data: ' 1 3 6 12 15 28 43 180'
                      - code: DHO_VENDOR_CLASS_IDENTIFIER(60)
                        data: MSFT 5.0
                      - code: DHO_HOST_NAME(12)
                        data: ITS-VMMT0-D1N02
                      dhcp_fqdn: ITS-VMMT0-D1N02.mgthub.local
                      dhcp_hostname: ITS-VMMT0-D1N02
                      dhcp_request_params: 1 3 6 15 31 33 43 44 46 47 119 121 249 252
                      dhcp_vendor_class_identifier: MSFT 5.0
                      mac: '112233445566'
                      org_id: c168ddee-c14c-11e5-8e81-1258369c38a9
                      port_id:
                      - et-0/0/1
                      site_id: c168ddee-c14c-11e5-8e81-1258369c38a9
                      timestamp: 1571174567.807
                      vlan:
                      - 0
                      - 1001
                    start: 1648443400.8221116
                    total: 1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1648529800.8221116
                    limit: 1000
                    results:
                    - auth_method: mac_auth
                      auth_state: authenticated
                      device_mac:
                      - '001122334455'
                      dhcp_client_identifier: MAC address 00155df6d500
                      dhcp_client_options:
                      - code: DHO_DHCP_MESSAGE_TYPE(53)
                        data: DHCPREQUEST
                      - code: DHO_DHCP_CLIENT_IDENTIFIER(61)
                        data: MAC address 00155df6d500
                      - code: DHO_DHCP_REQUESTED_ADDRESS(50)
                        data: 172.17.10.255
                      - code: DHO_DHCP_SERVER_IDENTIFIER(54)
                        data: 172.17.8.1
                      - code: DHO_DHCP_MAX_MESSAGE_SIZE(57)
                        data: '1280'
                      - code: DHO_DHCP_PARAMETER_REQUEST_LIST(55)
                        data: ' 1 3 6 12 15 28 43 180'
                      - code: DHO_VENDOR_CLASS_IDENTIFIER(60)
                        data: MSFT 5.0
                      - code: DHO_HOST_NAME(12)
                        data: ITS-VMMT0-D1N02
                      dhcp_fqdn: ITS-VMMT0-D1N02.mgthub.local
                      dhcp_hostname: ITS-VMMT0-D1N02
                      dhcp_request_params: 1 3 6 15 31 33 43 44 46 47 119 121 249 252
                      dhcp_vendor_class_identifier: MSFT 5.0
                      mac: '112233445566'
                      org_id: c168ddee-c14c-11e5-8e81-1258369c38a9
                      port_id:
                      - et-0/0/1
                      site_id: c168ddee-c14c-11e5-8e81-1258369c38a9
                      timestamp: 1571174567.807
                      vlan:
                      - 0
                      - 1001
                    start: 1648443400.8221116
                    total: 1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/search_wired_client'
                - description: Paginated response for wired client searches
                  examples:
                  - end: 1648529800.8221116
                    limit: 1000
                    results:
                    - auth_method: mac_auth
                      auth_state: authenticated
                      device_mac:
                      - '001122334455'
                      dhcp_client_identifier: MAC address 00155df6d500
                      dhcp_client_options:
                      - code: DHO_DHCP_MESSAGE_TYPE(53)
                        data: DHCPREQUEST
                      - code: DHO_DHCP_CLIENT_IDENTIFIER(61)
                        data: MAC address 00155df6d500
                      - code: DHO_DHCP_REQUESTED_ADDRESS(50)
                        data: 172.17.10.255
                      - code: DHO_DHCP_SERVER_IDENTIFIER(54)
                        data: 172.17.8.1
                      - code: DHO_DHCP_MAX_MESSAGE_SIZE(57)
                        data: '1280'
                      - code: DHO_DHCP_PARAMETER_REQUEST_LIST(55)
                        data: ' 1 3 6 12 15 28 43 180'
                      - code: DHO_VENDOR_CLASS_IDENTIFIER(60)
                        data: MSFT 5.0
                      - code: DHO_HOST_NAME(12)
                        data: ITS-VMMT0-D1N02
                      dhcp_fqdn: ITS-VMMT0-D1N02.mgthub.local
                      dhcp_hostname: ITS-VMMT0-D1N02
                      dhcp_request_params: 1 3 6 15 31 33 43 44 46 47 119 121 249 252
                      dhcp_vendor_class_identifier: MSFT 5.0
                      mac: '112233445566'
                      org_id: c168ddee-c14c-11e5-8e81-1258369c38a9
                      port_id:
                      - et-0/0/1
                      site_id: c168ddee-c14c-11e5-8e81-1258369c38a9
                      timestamp: 1571174567.807
                      vlan:
                      - 0
                      - 1001
                    start: 1648443400.8221116
                    total: 1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1648529800.8221116
                    limit: 1000
                    results:
                    - auth_method: mac_auth
                      auth_state: authenticated
                      device_mac:
                      - '001122334455'
                      dhcp_client_identifier: MAC address 00155df6d500
                      dhcp_client_options:
                      - code: DHO_DHCP_MESSAGE_TYPE(53)
                        data: DHCPREQUEST
                      - code: DHO_DHCP_CLIENT_IDENTIFIER(61)
                        data: MAC address 00155df6d500
                      - code: DHO_DHCP_REQUESTED_ADDRESS(50)
                        data: 172.17.10.255
                      - code: DHO_DHCP_SERVER_IDENTIFIER(54)
                        data: 172.17.8.1
                      - code: DHO_DHCP_MAX_MESSAGE_SIZE(57)
                        data: '1280'
                      - code: DHO_DHCP_PARAMETER_REQUEST_LIST(55)
                        data: ' 1 3 6 12 15 28 43 180'
                      - code: DHO_VENDOR_CLASS_IDENTIFIER(60)
                        data: MSFT 5.0
                      - code: DHO_HOST_NAME(12)
                        data: ITS-VMMT0-D1N02
                      dhcp_fqdn: ITS-VMMT0-D1N02.mgthub.local
                      dhcp_hostname: ITS-VMMT0-D1N02
                      dhcp_request_params: 1 3 6 15 31 33 43 44 46 47 119 121 249 252
                      dhcp_vendor_class_identifier: MSFT 5.0
                      mac: '112233445566'
                      org_id: c168ddee-c14c-11e5-8e81-1258369c38a9
                      port_id:
                      - et-0/0/1
                      site_id: c168ddee-c14c-11e5-8e81-1258369c38a9
                      timestamp: 1571174567.807
                      vlan:
                      - 0
                      - 1001
                    start: 1648443400.8221116
                    total: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/clients/count:
    get:
      tags:
      - Orgs Clients - Wireless
      summary: countOrgWirelessClients
      description: Count wireless client records across the organization, optionally grouped by `distinct` and filtered by client identity, AP, SSID, VLAN, IP, and time range.
      operationId: countOrgWirelessClients
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `ap`, `device`, `hostname`, `ip`, `mac`, `model`, `os`, `ssid`, `vlan`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/org_clients_count_distinct'
          - description: 'Field used to group this count response. enum: `ap`, `device`, `hostname`, `ip`, `mac`, `model`, `os`, `ssid`, `vlan`'
      - name: mac
        in: query
        description: Partial / full Client MAC address. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `aabbcc*` and `*bbcc*` match `aabbccddeeff`). Suffix-only wildcards (e.g. `*bccddeeff`) are not supported. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - aabbccddeeff,aabbcc*
          - aabbccddeeff
          - aabbcc*
          - '*bbcc*'
        examples:
          Untitled Example1:
            value: aabbccddeeff,aabbcc*
          Untitled Example2:
            value: aabbccddeeff
          Untitled Example3:
            value: aabbcc*
          Untitled Example4:
            value: '*bbcc*'
      - name: hostname
        in: query
        description: Partial / full Client hostname. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `everest*` and `*rest*` match `my-everest-client`). Suffix-only wildcards (e.g. `*everest`) are not supported. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - my-everest-client,my-everest*
          - my-everest-client
          - my-everest*
          - '*everest*'
        examples:
          Untitled Example1:
            value: my-everest-client,my-everest*
          Untitled Example2:
            value: my-everest-client
          Untitled Example3:
            value: my-everest*
          Untitled Example4:
            value: '*everest*'
      - name: device
        in: query
        description: Filter results by device type
        style: form
        explode: true
        schema:
          type: string
          examples:
          - iPhone
      - name: os
        in: query
        description: Filter results by operating system
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Windows 10
      - name: model
        in: query
        description: Filter results by device model
        style: form
        explode: true
        schema:
          type: string
          examples:
          - iPhone 8
      - name: ap
        in: query
        description: Filter results by AP MAC address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b53010101
      - name: vlan
        in: query
        description: Filter results by VLAN ID
        style: form
        explode: true
        schema:
          type: string
          examples:
          - '10'
      - name: ssid
        in: query
        description: Filter results by SSID
        style: form
        explode: true
        schema:
          type: string
          examples:
          - MySSID
      - name: ip
        in: query
        description: Filter results by IPv4 address
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: ipv4
          examples:
          - 192.168.1.1
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/clients/events/count:
    get:
      tags:
      - Orgs Clients - Wireless
      summary: countOrgWirelessClientEvents
      description: Count wireless client event records across the organization, optionally grouped by event attributes and filtered by event type, WLAN, radio, site, and time range.
      operationId: countOrgWirelessClientEvents
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `band`, `channel`, `proto`, `ssid`, `type`, `wlan_id`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/site_client_events_count_distinct'
          - description: 'Field used to group this count response. enum: `band`, `channel`, `proto`, `ssid`, `type`, `wlan_id`'
            examples:
            - type
      - name: type
        in: query
        description: See [List Device Events Definitions]($e/Constants%20Events/listDeviceEventsDefinitions). Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - MARVIS_EVENT_CLIENT_AUTH_FAILURE,CLIENT_DEAUTHENTICATION
      - name: reason_code
        in: query
        description: Reason code filter for association and disassociation events
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: ssid
        in: query
        description: Filter results by SSID
        style: form
        explode: true
        schema:
          type: string
      - name: ap
        in: query
        description: Filter results by AP MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: proto
        in: query
        description: '802.11 protocol used to filter results. enum: `a`, `ac`, `ax`, `b`, `be`, `g`, `n`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/dot11_proto'
          - description: '802.11 protocol used to filter results. enum: `a`, `ac`, `ax`, `b`, `be`, `g`, `n`'
      - name: band
        in: query
        description: '802.11 band used to filter radio results. enum: `24`, `5`, `5-dedicated`, `5-selectable`, `6`, `6-dedicated`, `6-selectable`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/dot11_band'
          - description: '802.11 band used to filter radio results. enum: `24`, `5`, `5-dedicated`, `5-selectable`, `6`, `6-dedicated`, `6-selectable`'
      - name: wlan_id
        in: query
        description: Filter results by WLAN identifier
        style: form
        explode: true
        schema:
          type: string
      - name: site_id
        in: query
        description: Filter results by site identifier
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 72771e6a-6f5e-4de4-a5b9-1266c4197811
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/clients/events/search:
    get:
      tags:
      - Orgs Clients - Wireless
      summary: searchOrgWirelessClientEvents
      description: Search wireless client event records across the organization with filters for event type, reason code, SSID, AP, key management, protocol, band, WLAN, NAC rule, and time range.
      operationId: searchOrgWirelessClientEvents
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: type
        in: query
        description: See [List Device Events Definitions]($e/Constants%20Events/listDeviceEventsDefinitions). Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - CLIENT_IP_ASSIGNED,CLIENT_DEAUTHENTICATION
      - name: reason_code
        in: query
        description: Reason code filter for association and disassociation events. Accepts multiple comma-separated integer values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 0,14
          - '7'
        examples:
          Untitled Example1:
            value: 0,14
          Untitled Example2:
            value: '7'
      - name: ssid
        in: query
        description: Filter results by SSID. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Corp,Guest
          - MySSID
        examples:
          Untitled Example1:
            value: Corp,Guest
          Untitled Example2:
            value: MySSID
      - name: ap
        in: query
        description: Filter results by AP MAC address. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b53010101,5c5b53020202
          - 5c5b53010101
        examples:
          Untitled Example1:
            value: 5c5b53010101,5c5b53020202
          Untitled Example2:
            value: 5c5b53010101
      - name: key_mgmt
        in: query
        description: 'Key management protocol used to filter client events. enum: `WPA2-PSK`, `WPA2-PSK/CCMP`, `WPA2-PSK-FT`, `WPA2-PSK-SHA256`, `WPA3-EAP-SHA256`, `WPA3-EAP-SHA256/CCMP`, `WPA3-EAP-FT/GCMP256`, `WPA3-SAE-FT`, `WPA3-SAE-PSK`. Accepts multiple comma-separated values.'
        style: form
        explode: true
        schema:
          type: string
          examples:
          - WPA2-PSK,WPA2-PSK/CCMP
      - name: proto
        in: query
        description: '802.11 protocol used to filter results. enum: `a`, `ac`, `ax`, `b`, `be`, `g`, `n`. Accepts multiple comma-separated values.'
        style: form
        explode: true
        schema:
          type: string
          examples:
          - ax,ac
      - name: band
        in: query
        description: '802.11 band used to filter radio results. enum: `24`, `5`, `5-dedicated`, `5-selectable`, `6`, `6-dedicated`, `6-selectable`. Accepts multiple comma-separated values.'
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 6,5
      - name: wlan_id
        in: query
        description: Filter results by WLAN identifier
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 7dae216d-7c98-a51b-e068-dd7d477b7216
      - name: nacrule_id
        in: query
        description: Filter results by NAC rule identifier. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 7dae216d-7c98-a51b-e068-dd7d477b7216
        examples:
          Untitled Example2:
            value: 7dae216d-7c98-a51b-e068-dd7d477b7216
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_events_search'
                - description: Paginated response for wireless client event search results
                  examples:
                  - end: 0
                    limit: 0
                    results:
                    - ap: string
                      band: '24'
                      bssid: string
                      channel: 0
                      proto: a
                      ssid: string
                      text: string
                      timestamp: 0
                      type: string
                      type_code: 0
                      wlan_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 0
                    limit: 0
                    results:
                    - ap: string
                      band: '24'
                      bssid: string
                      channel: 0
                      proto: a
                      ssid: string
                      text: string
                      timestamp: 0
                      type: string
                      type_code: 0
                      wlan_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_events_search'
                - description: Paginated response for wireless client event search results
                  examples:
                  - end: 0
                    limit: 0
                    results:
                    - ap: string
                      band: '24'
                      bssid: string
                      channel: 0
                      proto: a
                      ssid: string
                      text: string
                      timestamp: 0
                      type: string
                      type_code: 0
                      wlan_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 0
                    limit: 0
                    results:
                    - ap: string
                      band: '24'
                      bssid: string
                      channel: 0
                      proto: a
                      ssid: string
                      text: string
                      timestamp: 0
                      type: string
                      type_code: 0
                      wlan_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/clients/search:
    get:
      tags:
      - Orgs Clients - Wireless
      summary: searchOrgWirelessClients
      description: Search wireless client records across the organization with filters for site, AP, band, device identity, hostname, IP, MAC address, username, SSID, PPSK, VLAN, and time range.
      operationId: searchOrgWirelessClients
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: site_id
        in: query
        description: Filter results by site identifier
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 7dae216d-7c98-a51b-e068-dd7d477b7216
      - name: ap
        in: query
        description: Filter results by AP MAC address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b53010101
      - name: band
        in: query
        description: 'Comma separated list of Radio band (e.g. `24,5`). enum: `24`, `5`, `6`'
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5,6
          - '5'
        examples:
          Untitled Example1:
            value: 5,6
          Untitled Example2:
            value: '5'
      - name: device
        in: query
        description: Comma separated list of Device type (e.g. `Mac,iPhone`). Case sensitive
        style: form
        explode: true
        schema:
          type: string
          examples:
          - iPhone
      - name: hostname
        in: query
        description: Partial / full Client hostname. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `everest*` and `*rest*` match `my-everest-client`). Suffix-only wildcards (e.g. `*everest`) are not supported. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - my-everest-client,my-everest*
          - my-everest-client
          - my-everest*
          - '*everest*'
        examples:
          Untitled Example1:
            value: my-everest-client,my-everest*
          Untitled Example2:
            value: my-everest-client
          Untitled Example3:
            value: my-everest*
          Untitled Example4:
            value: '*everest*'
      - name: ip
        in: query
        description: Partial / full Client IP address. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `10.100.10.*` and `*100.10.*` match `10.100.10.54`). Suffix-only wildcards (e.g. `*.54`) are not supported. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 10.100.10.54,10.100.10.*
          - 10.100.10.54
          - 10.100.10.*
          - '*100.10.*'
        examples:
          Untitled Example1:
            value: 10.100.10.54,10.100.10.*
          Untitled Example2:
            value: 10.100.10.54
          Untitled Example3:
            value: 10.100.10.*
          Untitled Example4:
            value: '*100.10.*'
      - name: mac
        in: query
        description: Partial / full Client MAC address. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `aabbcc*` and `*bbcc*` match `aabbccddeeff`). Suffix-only wildcards (e.g. `*bccddeeff`) are not supported. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - aabbccddeeff,aabbcc*
          - aabbccddeeff
          - aabbcc*
          - '*bbcc*'
        examples:
          Untitled Example1:
            value: aabbccddeeff,aabbcc*
          Untitled Example2:
            value: aabbccddeeff
          Untitled Example3:
            value: aabbcc*
          Untitled Example4:
            value: '*bbcc*'
      - name: model
        in: query
        description: Only available for clients running the Marvis Client app, model, e.g. "MBP 15 late 2013", 6, 6s, "8+ GSM"
        style: form
        explode: true
        schema:
          type: string
          examples:
          - iPhone 8
      - name: os
        in: query
        description: Only available for clients running the Marvis Client app, os, e.g. Sierra, Yosemite, Windows 10
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Windows 10
      - name: psk_id
        in: query
        description: PSK identifier used to filter the results
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: psk_name
        in: query
        description: Only available for clients using PPSK authentication, the Name of the PSK
        style: form
        explode: true
        schema:
          type: string
          examples:
          - MyPPSK
      - name: ssid
        in: query
        description: Filter results by SSID
        style: form
        explode: true
        schema:
          type: string
          examples:
          - MySSID
      - name: text
        in: query
        description: Partial / full MAC address, hostname, username, psk_name or ip. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `everest*` and `*rest*` match `my-everest-client`). Suffix-only wildcards (e.g. `*everest`) are not supported
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b530
      - name: username
        in: query
        description: Partial / full username. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `johndoe*` and `*mycorp*` match `johndoe@mycorp.com`). Suffix-only wildcards (e.g. `*mycorp.com`) are not supported. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - johndoe,johnd*
          - johndoe
          - johnd*
          - '*ohnd*'
        examples:
          Untitled Example1:
            value: johndoe,johnd*
          Untitled Example2:
            value: johndoe
          Untitled Example3:
            value: johnd*
          Untitled Example4:
            value: '*ohnd*'
      - name: vlan
        in: query
        description: Filter results by VLAN ID
        style: form
        explode: true
        schema:
          type: string
          examples:
          - '10'
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_client_search'
                - description: Paginated wireless client search response
                  examples:
                  - end: 17141231418.812
                    limit: 118
                    next: next8
                    results:
                    - ap:
                      - a83a79a947ee
                      - 003e73170b4c
                      app_version:
                      - 0.100.3
                      band: '5'
                      device:
                      - Mac
                      ftc: false
                      hardware: Apple Wi-Fi adapter
                      hostname:
                      - hostname-a
                      - hostname-b
                      ip:
                      - 10.5.23.43
                      - 192.168.0.2
                      last_ap: a83a79a947ee
                      last_device: Mac
                      last_firmware: 'wl0: Jan 20 2024 04:08:41 version 20.103.12.0.8.7.171 FWID 01-e09d2675'
                      last_hostname: hostname-a
                      last_ip: 10.5.23.43
                      last_model: MBP 16\" M1 2021
                      last_os: Sonoma
                      last_os_version: 14.4.1 (Build 23E224)
                      last_psk_id: abf7dc5c-bb51-4bb7-93b6-5547400ffe11
                      last_psk_name: iot
                      last_ssid: IoT SSID
                      last_username: user@corp.com
                      last_vlan: 10
                      last_wlan_id: e5d67b07-aae8-494b-8584-cbc20c8110aa
                      mac: bcd074000000
                      mfg: Apple
                      model: MBP 16\" M1 2021
                      org_id: 1abff1aa-4571-4c1f-a409-153a1e7a7a24
                      os:
                      - Sonoma
                      os_version:
                      - 14.4.1 (Build 23E224)
                      protocol: ax
                      psk_id:
                      - abf7dc5c-bb51-4bb7-93b6-5547400ffe11
                      psk_name:
                      - iot
                      sdk_version:
                      - 0.100.3
                      site_id: 25ff5219-9be7-4db9-907d-0c9b60445147
                      site_ids:
                      - 25ff5219-9be7-4db9-907d-0c9b60445147
                      ssid:
                      - IoT SSID
                      timestamp: 1714124722.113
                      username:
                      - user@corp.com
                      vlan:
                      - 10
                    start: 10
                    total: 44
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 17141231418.812
                    limit: 118
                    next: next8
                    results:
                    - ap:
                      - a83a79a947ee
                      - 003e73170b4c
                      app_version:
                      - 0.100.3
                      band: '5'
                      device:
                      - Mac
                      ftc: false
                      hardware: Apple Wi-Fi adapter
                      hostname:
                      - hostname-a
                      - hostname-b
                      ip:
                      - 10.5.23.43
                      - 192.168.0.2
                      last_ap: a83a79a947ee
                      last_device: Mac
                      last_firmware: 'wl0: Jan 20 2024 04:08:41 version 20.103.12.0.8.7.171 FWID 01-e09d2675'
                      last_hostname: hostname-a
                      last_ip: 10.5.23.43
                      last_model: MBP 16\" M1 2021
                      last_os: Sonoma
                      last_os_version: 14.4.1 (Build 23E224)
                      last_psk_id: abf7dc5c-bb51-4bb7-93b6-5547400ffe11
                      last_psk_name: iot
                      last_ssid: IoT SSID
                      last_username: user@corp.com
                      last_vlan: 10
                      last_wlan_id: e5d67b07-aae8-494b-8584-cbc20c8110aa
                      mac: bcd074000000
                      mfg: Apple
                      model: MBP 16\" M1 2021
                      org_id: 1abff1aa-4571-4c1f-a409-153a1e7a7a24
                      os:
                      - Sonoma
                      os_version:
                      - 14.4.1 (Build 23E224)
                      protocol: ax
                      psk_id:
                      - abf7dc5c-bb51-4bb7-93b6-5547400ffe11
                      psk_name:
                      - iot
                      sdk_version:
                      - 0.100.3
                      site_id: 25ff5219-9be7-4db9-907d-0c9b60445147
                      site_ids:
                      - 25ff5219-9be7-4db9-907d-0c9b60445147
                      ssid:
                      - IoT SSID
                      timestamp: 1714124722.113
                      username:
                      - user@corp.com
                      vlan:
                      - 10
                    start: 10
                    total: 44
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_client_search'
                - description: Paginated wireless client search response
                  examples:
                  - end: 17141231418.812
                    limit: 118
                    next: next8
                    results:
                    - ap:
                      - a83a79a947ee
                      - 003e73170b4c
                      app_version:
                      - 0.100.3
                      band: '5'
                      device:
                      - Mac
                      ftc: false
                      hardware: Apple Wi-Fi adapter
                      hostname:
                      - hostname-a
                      - hostname-b
                      ip:
                      - 10.5.23.43
                      - 192.168.0.2
                      last_ap: a83a79a947ee
                      last_device: Mac
                      last_firmware: 'wl0: Jan 20 2024 04:08:41 version 20.103.12.0.8.7.171 FWID 01-e09d2675'
                      last_hostname: hostname-a
                      last_ip: 10.5.23.43
                      last_model: MBP 16\" M1 2021
                      last_os: Sonoma
                      last_os_version: 14.4.1 (Build 23E224)
                      last_psk_id: abf7dc5c-bb51-4bb7-93b6-5547400ffe11
                      last_psk_name: iot
                      last_ssid: IoT SSID
                      last_username: user@corp.com
                      last_vlan: 10
                      last_wlan_id: e5d67b07-aae8-494b-8584-cbc20c8110aa
                      mac: bcd074000000
                      mfg: Apple
                      model: MBP 16\" M1 2021
                      org_id: 1abff1aa-4571-4c1f-a409-153a1e7a7a24
                      os:
                      - Sonoma
                      os_version:
                      - 14.4.1 (Build 23E224)
                      protocol: ax
                      psk_id:
                      - abf7dc5c-bb51-4bb7-93b6-5547400ffe11
                      psk_name:
                      - iot
                      sdk_version:
                      - 0.100.3
                      site_id: 25ff5219-9be7-4db9-907d-0c9b60445147
                      site_ids:
                      - 25ff5219-9be7-4db9-907d-0c9b60445147
                      ssid:
                      - IoT SSID
                      timestamp: 1714124722.113
                      username:
                      - user@corp.com
                      vlan:
                      - 10
                    start: 10
                    total: 44
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 17141231418.812
                    limit: 118
                    next: next8
                    results:
                    - ap:
                      - a83a79a947ee
                      - 003e73170b4c
                      app_version:
                      - 0.100.3
                      band: '5'
                      device:
                      - Mac
                      ftc: false
                      hardware: Apple Wi-Fi adapter
                      hostname:
                      - hostname-a
                      - hostname-b
                      ip:
                      - 10.5.23.43
                      - 192.168.0.2
                      last_ap: a83a79a947ee
                      last_device: Mac
                      last_firmware: 'wl0: Jan 20 2024 04:08:41 version 20.103.12.0.8.7.171 FWID 01-e09d2675'
                      last_hostname: hostname-a
                      last_ip: 10.5.23.43
                      last_model: MBP 16\" M1 2021
                      last_os: Sonoma
                      last_os_version: 14.4.1 (Build 23E224)
                      last_psk_id: abf7dc5c-bb51-4bb7-93b6-5547400ffe11
                      last_psk_name: iot
                      last_ssid: IoT SSID
                      last_username: user@corp.com
                      last_vlan: 10
                      last_wlan_id: e5d67b07-aae8-494b-8584-cbc20c8110aa
                      mac: bcd074000000
                      mfg: Apple
                      model: MBP 16\" M1 2021
                      org_id: 1abff1aa-4571-4c1f-a409-153a1e7a7a24
                      os:
                      - Sonoma
                      os_version:
                      - 14.4.1 (Build 23E224)
                      protocol: ax
                      psk_id:
                      - abf7dc5c-bb51-4bb7-93b6-5547400ffe11
                      psk_name:
                      - iot
                      sdk_version:
                      - 0.100.3
                      site_id: 25ff5219-9be7-4db9-907d-0c9b60445147
                      site_ids:
                      - 25ff5219-9be7-4db9-907d-0c9b60445147
                      ssid:
                      - IoT SSID
                      timestamp: 1714124722.113
                      username:
                      - user@corp.com
                      vlan:
                      - 10
                    start: 10
                    total: 44
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/clients/sessions/count:
    get:
      tags:
      - Orgs Clients - Wireless
      summary: countOrgWirelessClientsSessions
      description: Count historical wireless client sessions across the organization, optionally grouped by `distinct` and filtered by AP, band, client attributes, SSID, WLAN, and time range.
      operationId: countOrgWirelessClientsSessions
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `ap`, `device`, `hostname`, `ip`, `model`, `os`, `ssid`, `vlan`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/org_client_sessions_count_distinct'
          - description: 'Field used to group this count response. enum: `ap`, `device`, `hostname`, `ip`, `model`, `os`, `ssid`, `vlan`'
      - name: ap
        in: query
        description: Filter results by AP MAC address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b53010101
      - name: band
        in: query
        description: '802.11 band used to filter radio results. enum: `24`, `5`, `5-dedicated`, `5-selectable`, `6`, `6-dedicated`, `6-selectable`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/dot11_band'
          - description: '802.11 band used to filter radio results. enum: `24`, `5`, `5-dedicated`, `5-selectable`, `6`, `6-dedicated`, `6-selectable`'
      - name: client_family
        in: query
        description: E.g. "Mac", "iPhone", "Apple watch"
        style: form
        explode: true
        schema:
          type: string
          examples:
          - iPhone
      - name: client_manufacture
        in: query
        description: Filter results by client manufacturer, e.g. "Apple"
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Apple
      - name: client_model
        in: query
        description: Filter results by client model, e.g. "8+", "XS"
        style: form
        explode: true
        schema:
          type: string
          examples:
          - iPhone 8
      - name: client_os
        in: query
        description: E.g. "Mojave", "Windows 10", "Linux"
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Windows 10
      - name: ssid
        in: query
        description: Filter results by SSID
        style: form
        explode: true
        schema:
          type: string
          examples:
          - MySSID
      - name: wlan_id
        in: query
        description: Filter results by WLAN identifier
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 7dae216d-7c98-a51b-e068-dd7d477b7216
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/clients/sessions/search:
    get:
      tags:
      - Orgs Clients - Wireless
      summary: searchOrgWirelessClientSessions
      description: Search historical wireless client sessions across the organization with filters for AP, band, client family, manufacturer, model, OS, username, SSID, WLAN, PPSK, and time range.
      operationId: searchOrgWirelessClientSessions
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: ap
        in: query
        description: Filter results by AP MAC address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b53010101
      - name: band
        in: query
        description: '802.11 band used to filter radio results. enum: `24`, `5`, `5-dedicated`, `5-selectable`, `6`, `6-dedicated`, `6-selectable`. Accepts multiple comma-separated values.'
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5,6
      - name: client_family
        in: query
        description: E.g. "Mac", "iPhone", "Apple watch". Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Phone/Tablet/Wearable,Monitoring Device
          - iPhone
        examples:
          Untitled Example1:
            value: Phone/Tablet/Wearable,Monitoring Device
          Untitled Example2:
            value: iPhone
      - name: client_manufacture
        in: query
        description: Filter results by client manufacturer, e.g. "Apple". Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Hewlett Packard Enterprise,Unknown
          - Apple
        examples:
          Untitled Example1:
            value: Hewlett Packard Enterprise,Unknown
          Untitled Example2:
            value: Apple
      - name: client_model
        in: query
        description: Filter results by client model, e.g. "8+", "XS". Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - iPhone 8,Aruba S0U52A
          - iPhone 8
        examples:
          Untitled Example1:
            value: iPhone 8,Aruba S0U52A
          Untitled Example2:
            value: iPhone 8
      - name: client_username
        in: query
        description: Filter results by client username. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - john.doe,jane.doe
          - john.doe
        examples:
          Untitled Example1:
            value: john.doe,jane.doe
          Untitled Example2:
            value: john.doe
      - name: client_os
        in: query
        description: E.g. "Mojave", "Windows 10", "Linux". Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - iOS 16.7.16,Unknown
          - Windows 10
        examples:
          Untitled Example1:
            value: iOS 16.7.16,Unknown
          Untitled Example2:
            value: Windows 10
      - name: ssid
        in: query
        description: Filter results by SSID. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Corp,Guest
          - MySSID
        examples:
          Untitled Example1:
            value: Corp,Guest
          Untitled Example2:
            value: MySSID
      - name: wlan_id
        in: query
        description: Filter results by WLAN identifier
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 7dae216d-7c98-a51b-e068-dd7d477b7216
      - name: psk_id
        in: query
        description: PSK identifier used to filter the results
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: psk_name
        in: query
        description: Filter results by PSK name. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - psk-a,psk-b
          - MyPPSK
        examples:
          Untitled Example1:
            value: psk-a,psk-b
          Untitled Example2:
            value: MyPPSK
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/search_wireless_client_session'
                - description: Paginated response for wireless client session searches
                  examples:
                  - end: 1513177200
                    limit: 10
                    results:
                    - ap: 5c5b350e0262
                      band: '5'
                      client_manufacture: Apple
                      connect: 1565208388
                      disconnect: 1565208448
                      duration: 60.09423865
                      mac: b019c66c8348
                      org_id: 3139f2c2-fac6-11e5-8156-0242ac110006
                      site_id: 70e0f468-fc13-11e5-85ad-0242ac110008
                      ssid: Dummy WLAN 2
                      tags:
                      - disassociate
                      timestamp: 1565208448.662
                      wlan_id: 99bb4c74-f954-4f36-b844-6b030faffabc
                    start: 1511967600
                    total: 100
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1513177200
                    limit: 10
                    results:
                    - ap: 5c5b350e0262
                      band: '5'
                      client_manufacture: Apple
                      connect: 1565208388
                      disconnect: 1565208448
                      duration: 60.09423865
                      mac: b019c66c8348
                      org_id: 3139f2c2-fac6-11e5-8156-0242ac110006
                      site_id: 70e0f468-fc13-11e5-85ad-0242ac110008
                      ssid: Dummy WLAN 2
                      tags:
                      - disassociate
                      timestamp: 1565208448.662
                      wlan_id: 99bb4c74-f954-4f36-b844-6b030faffabc
                    start: 1511967600
                    total: 100
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/search_wireless_client_session'
                - description: Paginated response for wireless client session searches
                  examples:
                  - end: 1513177200
                    limit: 10
                    results:
                    - ap: 5c5b350e0262
                      band: '5'
                      client_manufacture: Apple
                      connect: 1565208388
                      disconnect: 1565208448
                      duration: 60.09423865
                      mac: b019c66c8348
                      org_id: 3139f2c2-fac6-11e5-8156-0242ac110006
                      site_id: 70e0f468-fc13-11e5-85ad-0242ac110008
                      ssid: Dummy WLAN 2
                      tags:
                      - disassociate
                      timestamp: 1565208448.662
                      wlan_id: 99bb4c74-f954-4f36-b844-6b030faffabc
                    start: 1511967600
                    total: 100
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1513177200
                    limit: 10
                    results:
                    - ap: 5c5b350e0262
                      band: '5'
                      client_manufacture: Apple
                      connect: 1565208388
                      disconnect: 1565208448
                      duration: 60.09423865
                      mac: b019c66c8348
                      org_id: 3139f2c2-fac6-11e5-8156-0242ac110006
                      site_id: 70e0f468-fc13-11e5-85ad-0242ac110008
                      ssid: Dummy WLAN 2
                      tags:
                      - disassociate
                      timestamp: 1565208448.662
                      wlan_id: 99bb4c74-f954-4f36-b844-6b030faffabc
                    start: 1511967600
                    total: 100
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/sdkclients/{sdkclient_id}:
    put:
      tags:
      - Orgs Clients - SDK
      summary: updateSdkClient
      description: Update the display name of an SDK client registered in the organization.
      operationId: updateSdkClient
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: sdkclient_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/name_string'
              - description: Request Body
                examples:
                - name: John Smith
              contentMediaType: application/json
            examples:
              Example:
                value:
                  name: John Smith
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/setting/cradlepoint/setup:
    delete:
      tags:
      - Orgs Integration Cradlepoint
      summary: deleteOrgCradlepointConnection
      description: Remove the Cradlepoint integration configuration from the organization.
      operationId: deleteOrgCradlepointConnection
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs Integration Cradlepoint
      summary: testOrgCradlepointConnection
      description: Test the current Cradlepoint integration configuration and return whether the most recent integration status is active or inactive.
      operationId: testOrgCradlepointConnection
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/test_cradlepoint'
                - description: Cradlepoint integration connectivity test result
                  examples:
                  - alert_config_id: 8b7e06ac-0yu5-11f1-88h2-42628k552c3d
                    cp_api_id: '********'
                    cp_api_key: '********'
                    destination_config_id: 8ad364de-0yu5-13r1-9abc-263675be6074
                    ecm_api_id: '********'
                    ecm_api_key: '********'
                    enable_lldp: false
                    error: Cradlepoint API keys are no longer valid, please verify and update the keys under organization settings.
                    last_status: inactive
                    shared_secret: '********'
                contentMediaType: application/json
              examples:
                Crowdstrike:
                  value:
                    alert_config_id: 8b7e06ac-0yu5-11f1-88h2-42628k552c3d
                    cp_api_id: '********'
                    cp_api_key: '********'
                    destination_config_id: 8ad364de-0yu5-13r1-9abc-263675be6074
                    ecm_api_id: '********'
                    ecm_api_key: '********'
                    enable_lldp: false
                    error: Cradlepoint API keys are no longer valid, please verify and update the keys under organization settings.
                    last_status: inactive
                    shared_secret: '********'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/test_cradlepoint'
                - description: Cradlepoint integration connectivity test result
                  examples:
                  - alert_config_id: 8b7e06ac-0yu5-11f1-88h2-42628k552c3d
                    cp_api_id: '********'
                    cp_api_key: '********'
                    destination_config_id: 8ad364de-0yu5-13r1-9abc-263675be6074
                    ecm_api_id: '********'
                    ecm_api_key: '********'
                    enable_lldp: false
                    error: Cradlepoint API keys are no longer valid, please verify and update the keys under organization settings.
                    last_status: inactive
                    shared_secret: '********'
                contentMediaType: application/vnd.api+json
              examples:
                Crowdstrike:
                  value:
                    alert_config_id: 8b7e06ac-0yu5-11f1-88h2-42628k552c3d
                    cp_api_id: '********'
                    cp_api_key: '********'
                    destination_config_id: 8ad364de-0yu5-13r1-9abc-263675be6074
                    ecm_api_id: '********'
                    ecm_api_key: '********'
                    enable_lldp: false
                    error: Cradlepoint API keys are no longer valid, please verify and update the keys under organization settings.
                    last_status: inactive
                    shared_secret: '********'
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs Integration Cradlepoint
      summary: setupOrgCradlepointConnectionToMist
      description: Configure the Cradlepoint integration by storing Cradlepoint API and ECM credentials and setting up Cradlepoint webhooks to send events to Mist.
      operationId: setupOrgCradlepointConnectionToMist
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/account_cradlepoint_config'
              - examples:
                - cp_api_id: 84446d61-2206-4ea5-855a-0043f980be54
                  cp_api_key: 79c329da9893e34099c7d8ad5cb9c941
                  ecm_api_id: 73446d61-2206-4ea5-855a-0043f980be62
                  ecm_api_key: 68b329da9893e34099c7d8ad5cb9c9405
                  enable_lldp: true
              contentMediaType: application/json
            examples:
              Example:
                value:
                  cp_api_id: 84446d61-2206-4ea5-855a-0043f980be54
                  cp_api_key: 79c329da9893e34099c7d8ad5cb9c941
                  ecm_api_id: 73446d61-2206-4ea5-855a-0043f980be62
                  ecm_api_key: 68b329da9893e34099c7d8ad5cb9c9405
                  enable_lldp: true
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs Integration Cradlepoint
      summary: updateOrgCradlepointConnectionToMist
      description: Update the stored Cradlepoint API and ECM credentials and the LLDP-based device linking option used by Mist.
      operationId: updateOrgCradlepointConnectionToMist
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/account_cradlepoint_config'
              - examples:
                - cp_api_id: 84446d61-2206-4ea5-855a-0043f980be54
                  cp_api_key: 79c329da9893e34099c7d8ad5cb9c941
                  ecm_api_id: 73446d61-2206-4ea5-855a-0043f980be62
                  ecm_api_key: 68b329da9893e34099c7d8ad5cb9c9405
                  enable_lldp: true
              contentMediaType: application/json
            examples:
              Example:
                value:
                  cp_api_id: 84446d61-2206-4ea5-855a-0043f980be54
                  cp_api_key: 79c329da9893e34099c7d8ad5cb9c941
                  ecm_api_id: 73446d61-2206-4ea5-855a-0043f980be62
                  ecm_api_key: 68b329da9893e34099c7d8ad5cb9c9405
                  enable_lldp: true
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/setting/cradlepoint/sync:
    post:
      tags:
      - Orgs Integration Cradlepoint
      summary: syncOrgCradlepointRouters
      description: Trigger a Cradlepoint device synchronization with Mist. When LLDP linking is enabled, Mist also uses Cradlepoint LLDP data to associate routers with Mist sites and devices.
      operationId: syncOrgCradlepointRouters
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/crl:
    get:
      tags:
      - Orgs CRL
      summary: getOrgCrlFile
      description: Download the organization certificate revocation list (CRL) file used to identify certificates that should no longer be trusted.
      operationId: getOrgCrlFile
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: string
                description: File
                contentEncoding: base64
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                type: string
                description: File
                contentEncoding: base64
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/deviceprofiles:
    get:
      tags:
      - Orgs Device Profiles
      summary: listOrgDeviceProfiles
      description: List org-level device profiles, which define reusable AP, switch, or gateway configuration subsets that can be applied to matching devices.
      operationId: listOrgDeviceProfiles
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: type
        in: query
        description: 'Filter results by one device profile type. Use a single value; comma-separated values are not supported. enum: `ap`, `gateway`, `switch`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/device_type_default_ap'
          - description: 'Filter results by one device profile type. Use a single value; comma-separated values are not supported. enum: `ap`, `gateway`, `switch`'
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/deviceprofile'
                description: List of device profile configurations
                examples:
                - '[{"aeroscout":{"enabled":true,"host":"string"},"created_time":0,"disable_eth1":true,"disable_module":true,"id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","ip_config":{"dns":["string"],"dns_suffix":["string"],"gateway":"192.168.0.1","gateway6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","ip":"192.168.0.1","ip6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","mtu":1500,"netmask":"192.168.0.1","netmask6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","type":"static","type6":"static","vlan_id":1},"mesh":{"enabled":true,"group":1,"role":"base"},"modified_time":0,"name":"string","org_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","poe_passthrough":true,"switch_config":{"enabled":true,"eth0":{"port_vlan_id":1,"vlan_ids":[1,10]},"eth1":{"port_vlan_id":1,"vlan_ids":[10]},"eth2":{"port_vlan_id":1,"vlan_ids":[10]},"eth3":{"port_vlan_id":1,"vlan_ids":[10]},"module":{"port_vlan_id":1,"vlan_ids":[10]},"wds":{"port_vlan_id":1,"vlan_ids":[10]}},"type":"ap","usb_config":{"cacert":"string","enabled":true,"host":"string","type":"imagotag","verify_cert":true}}]'
                - '[{"created_time":1680762730,"dhcpd_config":{"Corp-Mgmt":{"dns_servers":["8.8.8.8"],"dns_suffix":["stag.one"],"gateway":"10.3.172.9","ip_end":"10.3.172.99","ip_start":"10.3.172.50","type":"local"},"Corp-lan":{"dns_servers":["8.8.8.8"],"dns_suffix":["stag.one"],"gateway":"10.3.171.9","ip_end":"10.3.171.99","ip_start":"10.3.171.50","type":"local"}},"dnsOverride":true,"dns_servers":["10.3.20.201","10.3.51.222","1.1.1.1"],"dns_suffix":["example.com"],"extra_routes":{"10.101.0.0/16":{"via":"10.3.100.10"}},"id":"4ea55b5d-7313-4a81-a292-7ee125fd4ebb","ip_configs":{"Corp-Core":{"ip":"10.3.100.9","netmask":"/24","type":"static"},"Corp-Mgmt":{"ip":"10.3.172.9","netmask":"/24","type":"static"},"Corp-lan":{"ip":"10.3.171.9","netmask":"/24","type":"static"}},"modified_time":1680762890,"name":"ITParis","ntpOverride":true,"ntp_servers":["10.3.51.222"],"org_id":"93986f10-773b-42be-9438-8d3e6d127f1a","path_preferences":{"core":{"paths":[{"networks":["Corp-Core"],"type":"local"}],"strategy":"ordered"},"lab":{"paths":[{"networks":["Corp-lan"],"type":"local"}],"strategy":"ordered"},"mgmt":{"paths":[{"networks":["Corp-Mgmt"],"type":"local"}],"strategy":"ordered"},"untrust":{"paths":[{"name":"wan","type":"wan"}],"strategy":"ordered"}},"port_config":{"ge-0/0/0":{"aggregated":false,"ip_config":{"gateway":"192.168.1.1","ip":"192.168.1.9","netmask":"/24","type":"static"},"name":"wan","redundant":false,"traffic_shaping":{"enabled":false},"usage":"wan","wan_type":"broadband"},"ge-0/0/6-7":{"ae_disable_lacp":false,"ae_idx":"0","ae_lacp_force_up":true,"aggregated":true,"networks":["Corp-lan","Corp-Mgmt","Corp-Core"],"usage":"lan"}},"service_policies":[{"action":"allow","idp":{"enabled":false},"name":"ITParis-Internal","path_preference":"core","services":["internal_dns","drive"],"tenants":["ITParis"]},{"action":"deny","idp":{"enabled":false},"name":"ITParis-internet","path_preference":"untrust","services":["internet_any"],"tenants":["ITParis"]}],"type":"gateway"}]'
                contentMediaType: application/json
              examples:
                Deviceprofile Ap:
                  value:
                  - aeroscout:
                      enabled: true
                      host: string
                    created_time: 0
                    disable_eth1: true
                    disable_module: true
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ip_config:
                      dns:
                      - string
                      dns_suffix:
                      - string
                      gateway: 192.168.0.1
                      gateway6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
                      ip: 192.168.0.1
                      ip6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
                      mtu: 1500
                      netmask: 192.168.0.1
                      netmask6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
                      type: static
                      type6: static
                      vlan_id: 1
                    mesh:
                      enabled: true
                      group: 1
                      role: base
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    poe_passthrough: true
                    switch_config:
                      enabled: true
                      eth0:
                        port_vlan_id: 1
                        vlan_ids:
                        - 1
                        - 10
                      eth1:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      eth2:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      eth3:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      module:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      wds:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                    type: ap
                    usb_config:
                      cacert: string
                      enabled: true
                      host: string
                      type: imagotag
                      verify_cert: true
                Deviceprofile Hub:
                  value:
                  - created_time: 1680762730
                    dhcpd_config:
                      Corp-Mgmt:
                        dns_servers:
                        - 8.8.8.8
                        dns_suffix:
                        - stag.one
                        gateway: 10.3.172.9
                        ip_end: 10.3.172.99
                        ip_start: 10.3.172.50
                        type: local
                      Corp-lan:
                        dns_servers:
                        - 8.8.8.8
                        dns_suffix:
                        - stag.one
                        gateway: 10.3.171.9
                        ip_end: 10.3.171.99
                        ip_start: 10.3.171.50
                        type: local
                    dnsOverride: true
                    dns_servers:
                    - 10.3.20.201
                    - 10.3.51.222
                    - 1.1.1.1
                    dns_suffix:
                    - example.com
                    extra_routes:
                      10.101.0.0/16:
                        via: 10.3.100.10
                    id: 4ea55b5d-7313-4a81-a292-7ee125fd4ebb
                    ip_configs:
                      Corp-Core:
                        ip: 10.3.100.9
                        netmask: /24
                        type: static
                      Corp-Mgmt:
                        ip: 10.3.172.9
                        netmask: /24
                        type: static
                      Corp-lan:
                        ip: 10.3.171.9
                        netmask: /24
                        type: static
                    modified_time: 1680762890
                    name: ITParis
                    ntpOverride: true
                    ntp_servers:
                    - 10.3.51.222
                    org_id: 93986f10-773b-42be-9438-8d3e6d127f1a
                    path_preferences:
                      core:
                        paths:
                        - networks:
                          - Corp-Core
                          type: local
                        strategy: ordered
                      lab:
                        paths:
                        - networks:
                          - Corp-lan
                          type: local
                        strategy: ordered
                      mgmt:
                        paths:
                        - networks:
                          - Corp-Mgmt
                          type: local
                        strategy: ordered
                      untrust:
                        paths:
                        - name: wan
                          type: wan
                        strategy: ordered
                    port_config:
                      ge-0/0/0:
                        aggregated: false
                        ip_config:
                          gateway: 192.168.1.1
                          ip: 192.168.1.9
                          netmask: /24
                          type: static
                        name: wan
                        redundant: false
                        traffic_shaping:
                          enabled: false
                        usage: wan
                        wan_type: broadband
                      ge-0/0/6-7:
                        ae_disable_lacp: false
                        ae_idx: '0'
                        ae_lacp_force_up: true
                        aggregated: true
                        networks:
                        - Corp-lan
                        - Corp-Mgmt
                        - Corp-Core
                        usage: lan
                    service_policies:
                    - action: allow
                      idp:
                        enabled: false
                      name: ITParis-Internal
                      path_preference: core
                      services:
                      - internal_dns
                      - drive
                      tenants:
                      - ITParis
                    - action: deny
                      idp:
                        enabled: false
                      name: ITParis-internet
                      path_preference: untrust
                      services:
                      - internet_any
                      tenants:
                      - ITParis
                    type: gateway
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/deviceprofile'
                description: List of device profile configurations
                examples:
                - '[{"aeroscout":{"enabled":true,"host":"string"},"created_time":0,"disable_eth1":true,"disable_module":true,"id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","ip_config":{"dns":["string"],"dns_suffix":["string"],"gateway":"192.168.0.1","gateway6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","ip":"192.168.0.1","ip6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","mtu":1500,"netmask":"192.168.0.1","netmask6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","type":"static","type6":"static","vlan_id":1},"mesh":{"enabled":true,"group":1,"role":"base"},"modified_time":0,"name":"string","org_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","poe_passthrough":true,"switch_config":{"enabled":true,"eth0":{"port_vlan_id":1,"vlan_ids":[1,10]},"eth1":{"port_vlan_id":1,"vlan_ids":[10]},"eth2":{"port_vlan_id":1,"vlan_ids":[10]},"eth3":{"port_vlan_id":1,"vlan_ids":[10]},"module":{"port_vlan_id":1,"vlan_ids":[10]},"wds":{"port_vlan_id":1,"vlan_ids":[10]}},"type":"ap","usb_config":{"cacert":"string","enabled":true,"host":"string","type":"imagotag","verify_cert":true}}]'
                - '[{"created_time":1680762730,"dhcpd_config":{"Corp-Mgmt":{"dns_servers":["8.8.8.8"],"dns_suffix":["stag.one"],"gateway":"10.3.172.9","ip_end":"10.3.172.99","ip_start":"10.3.172.50","type":"local"},"Corp-lan":{"dns_servers":["8.8.8.8"],"dns_suffix":["stag.one"],"gateway":"10.3.171.9","ip_end":"10.3.171.99","ip_start":"10.3.171.50","type":"local"}},"dnsOverride":true,"dns_servers":["10.3.20.201","10.3.51.222","1.1.1.1"],"dns_suffix":["example.com"],"extra_routes":{"10.101.0.0/16":{"via":"10.3.100.10"}},"id":"4ea55b5d-7313-4a81-a292-7ee125fd4ebb","ip_configs":{"Corp-Core":{"ip":"10.3.100.9","netmask":"/24","type":"static"},"Corp-Mgmt":{"ip":"10.3.172.9","netmask":"/24","type":"static"},"Corp-lan":{"ip":"10.3.171.9","netmask":"/24","type":"static"}},"modified_time":1680762890,"name":"ITParis","ntpOverride":true,"ntp_servers":["10.3.51.222"],"org_id":"93986f10-773b-42be-9438-8d3e6d127f1a","path_preferences":{"core":{"paths":[{"networks":["Corp-Core"],"type":"local"}],"strategy":"ordered"},"lab":{"paths":[{"networks":["Corp-lan"],"type":"local"}],"strategy":"ordered"},"mgmt":{"paths":[{"networks":["Corp-Mgmt"],"type":"local"}],"strategy":"ordered"},"untrust":{"paths":[{"name":"wan","type":"wan"}],"strategy":"ordered"}},"port_config":{"ge-0/0/0":{"aggregated":false,"ip_config":{"gateway":"192.168.1.1","ip":"192.168.1.9","netmask":"/24","type":"static"},"name":"wan","redundant":false,"traffic_shaping":{"enabled":false},"usage":"wan","wan_type":"broadband"},"ge-0/0/6-7":{"ae_disable_lacp":false,"ae_idx":"0","ae_lacp_force_up":true,"aggregated":true,"networks":["Corp-lan","Corp-Mgmt","Corp-Core"],"usage":"lan"}},"service_policies":[{"action":"allow","idp":{"enabled":false},"name":"ITParis-Internal","path_preference":"core","services":["internal_dns","drive"],"tenants":["ITParis"]},{"action":"deny","idp":{"enabled":false},"name":"ITParis-internet","path_preference":"untrust","services":["internet_any"],"tenants":["ITParis"]}],"type":"gateway"}]'
                contentMediaType: application/vnd.api+json
              examples:
                Deviceprofile Ap:
                  value:
                  - aeroscout:
                      enabled: true
                      host: string
                    created_time: 0
                    disable_eth1: true
                    disable_module: true
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ip_config:
                      dns:
                      - string
                      dns_suffix:
                      - string
                      gateway: 192.168.0.1
                      gateway6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
                      ip: 192.168.0.1
                      ip6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
                      mtu: 1500
                      netmask: 192.168.0.1
                      netmask6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
                      type: static
                      type6: static
                      vlan_id: 1
                    mesh:
                      enabled: true
                      group: 1
                      role: base
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    poe_passthrough: true
                    switch_config:
                      enabled: true
                      eth0:
                        port_vlan_id: 1
                        vlan_ids:
                        - 1
                        - 10
                      eth1:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      eth2:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      eth3:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      module:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      wds:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                    type: ap
                    usb_config:
                      cacert: string
                      enabled: true
                      host: string
                      type: imagotag
                      verify_cert: true
                Deviceprofile Hub:
                  value:
                  - created_time: 1680762730
                    dhcpd_config:
                      Corp-Mgmt:
                        dns_servers:
                        - 8.8.8.8
                        dns_suffix:
                        - stag.one
                        gateway: 10.3.172.9
                        ip_end: 10.3.172.99
                        ip_start: 10.3.172.50
                        type: local
                      Corp-lan:
                        dns_servers:
                        - 8.8.8.8
                        dns_suffix:
                        - stag.one
                        gateway: 10.3.171.9
                        ip_end: 10.3.171.99
                        ip_start: 10.3.171.50
                        type: local
                    dnsOverride: true
                    dns_servers:
                    - 10.3.20.201
                    - 10.3.51.222
                    - 1.1.1.1
                    dns_suffix:
                    - example.com
                    extra_routes:
                      10.101.0.0/16:
                        via: 10.3.100.10
                    id: 4ea55b5d-7313-4a81-a292-7ee125fd4ebb
                    ip_configs:
                      Corp-Core:
                        ip: 10.3.100.9
                        netmask: /24
                        type: static
                      Corp-Mgmt:
                        ip: 10.3.172.9
                        netmask: /24
                        type: static
                      Corp-lan:
                        ip: 10.3.171.9
                        netmask: /24
                        type: static
                    modified_time: 1680762890
                    name: ITParis
                    ntpOverride: true
                    ntp_servers:
                    - 10.3.51.222
                    org_id: 93986f10-773b-42be-9438-8d3e6d127f1a
                    path_preferences:
                      core:
                        paths:
                        - networks:
                          - Corp-Core
                          type: local
                        strategy: ordered
                      lab:
                        paths:
                        - networks:
                          - Corp-lan
                          type: local
                        strategy: ordered
                      mgmt:
                        paths:
                        - networks:
                          - Corp-Mgmt
                          type: local
                        strategy: ordered
                      untrust:
                        paths:
                        - name: wan
                          type: wan
                        strategy: ordered
                    port_config:
                      ge-0/0/0:
                        aggregated: false
                        ip_config:
                          gateway: 192.168.1.1
                          ip: 192.168.1.9
                          netmask: /24
                          type: static
                        name: wan
                        redundant: false
                        traffic_shaping:
                          enabled: false
                        usage: wan
                        wan_type: broadband
                      ge-0/0/6-7:
                        ae_disable_lacp: false
                        ae_idx: '0'
                        ae_lacp_force_up: true
                        aggregated: true
                        networks:
                        - Corp-lan
                        - Corp-Mgmt
                        - Corp-Core
                        usage: lan
                    service_policies:
                    - action: allow
                      idp:
                        enabled: false
                      name: ITParis-Internal
                      path_preference: core
                      services:
                      - internal_dns
                      - drive
                      tenants:
                      - ITParis
                    - action: deny
                      idp:
                        enabled: false
                      name: ITParis-internet
                      path_preference: untrust
                      services:
                      - internet_any
                      tenants:
                      - ITParis
                    type: gateway
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs Device Profiles
      summary: createOrgDeviceProfile
      description: Create an org-level device profile containing reusable AP, switch, or gateway configuration.
      operationId: createOrgDeviceProfile
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/deviceprofile'
              - description: Request Body
                examples:
                - '{"aeroscout":{"enabled":false,"host":"aero.pvt.net","locate_connected":true},"led":{"brightness":255,"enabled":true},"name":"string","ntp_servers":["10.10.10.10"],"type":"ap","usb_config":{"cacert":"string","channel":3,"enabled":true,"host":"1.1.1.1","port":0,"type":"imagotag","verify_cert":true,"vlan_id":1}}'
                - '{"dhcpd_config":{"Corp-Mgmt":{"dns_servers":["8.8.8.8"],"dns_suffix":["stag.one"],"gateway":"10.3.172.9","ip_end":"10.3.172.99","ip_start":"10.3.172.50","type":"local"},"Corp-lan":{"dns_servers":["8.8.8.8"],"dns_suffix":["stag.one"],"gateway":"10.3.171.9","ip_end":"10.3.171.99","ip_start":"10.3.171.50","type":"local"}},"dnsOverride":true,"dns_servers":["10.3.20.201","10.3.51.222","1.1.1.1"],"dns_suffix":["example.com"],"extra_routes":{"10.101.0.0/16":{"via":"10.3.100.10"}},"ip_configs":{"Corp-Core":{"ip":"10.3.100.9","netmask":"/24","type":"static"},"Corp-Mgmt":{"ip":"10.3.172.9","netmask":"/24","type":"static"},"Corp-lan":{"ip":"10.3.171.9","netmask":"/24","type":"static"}},"name":"Demo","ntpOverride":true,"ntp_servers":["10.3.51.222"],"path_preferences":{"core":{"paths":[{"networks":["Corp-Core"],"type":"local"}],"strategy":"ordered"},"lab":{"paths":[{"networks":["Corp-lan"],"type":"local"}],"strategy":"ordered"},"mgmt":{"paths":[{"networks":["Corp-Mgmt"],"type":"local"}],"strategy":"ordered"},"untrust":{"paths":[{"name":"wan","type":"wan"}],"strategy":"ordered"}},"port_config":{"ge-0/0/0":{"aggregated":false,"ip_config":{"gateway":"192.168.1.1","ip":"192.168.1.9","netmask":"/24","type":"static"},"name":"wan","redundant":false,"usage":"wan","wan_type":"broadband"},"ge-0/0/6-7":{"ae_disable_lacp":false,"ae_idx":"0","ae_lacp_force_up":true,"aggregated":true,"networks":["Corp-lan","Corp-Mgmt","Corp-Core"],"usage":"lan"}},"service_policies":[{"action":"allow","idp":{"enabled":false},"name":"ITParis-Internal","path_preference":"core","services":["internal_dns","drive"],"tenants":["ITParis"]}],"type":"gateway"}'
              contentMediaType: application/json
            examples:
              deviceprofile_ap:
                value:
                  aeroscout:
                    enabled: false
                    host: aero.pvt.net
                    locate_connected: true
                  led:
                    brightness: 255
                    enabled: true
                  name: string
                  ntp_servers:
                  - 10.10.10.10
                  type: ap
                  usb_config:
                    cacert: string
                    channel: 3
                    enabled: true
                    host: 1.1.1.1
                    port: 0
                    type: imagotag
                    verify_cert: true
                    vlan_id: 1
              deviceprofile_hub:
                value:
                  dhcpd_config:
                    Corp-Mgmt:
                      dns_servers:
                      - 8.8.8.8
                      dns_suffix:
                      - stag.one
                      gateway: 10.3.172.9
                      ip_end: 10.3.172.99
                      ip_start: 10.3.172.50
                      type: local
                    Corp-lan:
                      dns_servers:
                      - 8.8.8.8
                      dns_suffix:
                      - stag.one
                      gateway: 10.3.171.9
                      ip_end: 10.3.171.99
                      ip_start: 10.3.171.50
                      type: local
                  dnsOverride: true
                  dns_servers:
                  - 10.3.20.201
                  - 10.3.51.222
                  - 1.1.1.1
                  dns_suffix:
                  - example.com
                  extra_routes:
                    10.101.0.0/16:
                      via: 10.3.100.10
                  ip_configs:
                    Corp-Core:
                      ip: 10.3.100.9
                      netmask: /24
                      type: static
                    Corp-Mgmt:
                      ip: 10.3.172.9
                      netmask: /24
                      type: static
                    Corp-lan:
                      ip: 10.3.171.9
                      netmask: /24
                      type: static
                  name: Demo
                  ntpOverride: true
                  ntp_servers:
                  - 10.3.51.222
                  path_preferences:
                    core:
                      paths:
                      - networks:
                        - Corp-Core
                        type: local
                      strategy: ordered
                    lab:
                      paths:
                      - networks:
                        - Corp-lan
                        type: local
                      strategy: ordered
                    mgmt:
                      paths:
                      - networks:
                        - Corp-Mgmt
                        type: local
                      strategy: ordered
                    untrust:
                      paths:
                      - name: wan
                        type: wan
                      strategy: ordered
                  port_config:
                    ge-0/0/0:
                      aggregated: false
                      ip_config:
                        gateway: 192.168.1.1
                        ip: 192.168.1.9
                        netmask: /24
                        type: static
                      name: wan
                      redundant: false
                      usage: wan
                      wan_type: broadband
                    ge-0/0/6-7:
                      ae_disable_lacp: false
                      ae_idx: '0'
                      ae_lacp_force_up: true
                      aggregated: true
                      networks:
                      - Corp-lan
                      - Corp-Mgmt
                      - Corp-Core
                      usage: lan
                  service_policies:
                  - action: allow
                    idp:
                      enabled: false
                    name: ITParis-Internal
                    path_preference: core
                    services:
                    - internal_dns
                    - drive
                    tenants:
                    - ITParis
                  type: gateway
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/deviceprofile'
                - description: Device profile configuration for an AP, switch, or gateway
                  examples:
                  - '{"aeroscout":{"enabled":true,"host":"string"},"created_time":0,"disable_eth1":true,"disable_module":true,"id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","ip_config":{"dns":["string"],"dns_suffix":["string"],"gateway":"192.168.0.1","gateway6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","ip":"192.168.0.1","ip6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","mtu":1500,"netmask":"192.168.0.1","netmask6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","type":"static","type6":"static","vlan_id":1},"mesh":{"enabled":true,"group":1,"role":"base"},"modified_time":0,"name":"string","org_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","poe_passthrough":true,"switch_config":{"enabled":true,"eth0":{"port_vlan_id":1,"vlan_ids":[1,10]},"eth1":{"port_vlan_id":1,"vlan_ids":[10]},"eth2":{"port_vlan_id":1,"vlan_ids":[10]},"eth3":{"port_vlan_id":1,"vlan_ids":[10]},"module":{"port_vlan_id":1,"vlan_ids":[10]},"wds":{"port_vlan_id":1,"vlan_ids":[10]}},"type":"ap","usb_config":{"cacert":"string","enabled":true,"host":"string","type":"imagotag","verify_cert":true}}'
                  - '{"created_time":1680762730,"dhcpd_config":{"Corp-Mgmt":{"dns_servers":["8.8.8.8"],"dns_suffix":["stag.one"],"gateway":"10.3.172.9","ip_end":"10.3.172.99","ip_start":"10.3.172.50","type":"local"},"Corp-lan":{"dns_servers":["8.8.8.8"],"dns_suffix":["stag.one"],"gateway":"10.3.171.9","ip_end":"10.3.171.99","ip_start":"10.3.171.50","type":"local"}},"dnsOverride":true,"dns_servers":["10.3.20.201","10.3.51.222","1.1.1.1"],"dns_suffix":["example.com"],"extra_routes":{"10.101.0.0/16":{"via":"10.3.100.10"}},"id":"4ea55b5d-7313-4a81-a292-7ee125fd4ebb","ip_configs":{"Corp-Core":{"ip":"10.3.100.9","netmask":"/24","type":"static"},"Corp-Mgmt":{"ip":"10.3.172.9","netmask":"/24","type":"static"},"Corp-lan":{"ip":"10.3.171.9","netmask":"/24","type":"static"}},"modified_time":1680762890,"name":"ITParis","ntpOverride":true,"ntp_servers":["10.3.51.222"],"org_id":"93986f10-773b-42be-9438-8d3e6d127f1a","path_preferences":{"core":{"paths":[{"networks":["Corp-Core"],"type":"local"}],"strategy":"ordered"},"lab":{"paths":[{"networks":["Corp-lan"],"type":"local"}],"strategy":"ordered"},"mgmt":{"paths":[{"networks":["Corp-Mgmt"],"type":"local"}],"strategy":"ordered"},"untrust":{"paths":[{"name":"wan","type":"wan"}],"strategy":"ordered"}},"port_config":{"ge-0/0/0":{"aggregated":false,"ip_config":{"gateway":"192.168.1.1","ip":"192.168.1.9","netmask":"/24","type":"static"},"name":"wan","redundant":false,"traffic_shaping":{"enabled":false},"usage":"wan","wan_type":"broadband"},"ge-0/0/6-7":{"ae_disable_lacp":false,"ae_idx":"0","ae_lacp_force_up":true,"aggregated":true,"networks":["Corp-lan","Corp-Mgmt","Corp-Core"],"usage":"lan"}},"service_policies":[{"action":"allow","idp":{"enabled":false},"name":"ITParis-Internal","path_preference":"core","services":["internal_dns","drive"],"tenants":["ITParis"]},{"action":"deny","idp":{"enabled":false},"name":"ITParis-internet","path_preference":"untrust","services":["internet_any"],"tenants":["ITParis"]}],"type":"gateway"}'
                contentMediaType: application/json
              examples:
                Deviceprofile Ap:
                  value:
                    aeroscout:
                      enabled: true
                      host: string
                    created_time: 0
                    disable_eth1: true
                    disable_module: true
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ip_config:
                      dns:
                      - string
                      dns_suffix:
                      - string
                      gateway: 192.168.0.1
                      gateway6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
                      ip: 192.168.0.1
                      ip6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
                      mtu: 1500
                      netmask: 192.168.0.1
                      netmask6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
                      type: static
                      type6: static
                      vlan_id: 1
                    mesh:
                      enabled: true
                      group: 1
                      role: base
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    poe_passthrough: true
                    switch_config:
                      enabled: true
                      eth0:
                        port_vlan_id: 1
                        vlan_ids:
                        - 1
                        - 10
                      eth1:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      eth2:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      eth3:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      module:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      wds:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                    type: ap
                    usb_config:
                      cacert: string
                      enabled: true
                      host: string
                      type: imagotag
                      verify_cert: true
                Deviceprofile Hub:
                  value:
                    created_time: 1680762730
                    dhcpd_config:
                      Corp-Mgmt:
                        dns_servers:
                        - 8.8.8.8
                        dns_suffix:
                        - stag.one
                        gateway: 10.3.172.9
                        ip_end: 10.3.172.99
                        ip_start: 10.3.172.50
                        type: local
                      Corp-lan:
                        dns_servers:
                        - 8.8.8.8
                        dns_suffix:
                        - stag.one
                        gateway: 10.3.171.9
                        ip_end: 10.3.171.99
                        ip_start: 10.3.171.50
                        type: local
                    dnsOverride: true
                    dns_servers:
                    - 10.3.20.201
                    - 10.3.51.222
                    - 1.1.1.1
                    dns_suffix:
                    - example.com
                    extra_routes:
                      10.101.0.0/16:
                        via: 10.3.100.10
                    id: 4ea55b5d-7313-4a81-a292-7ee125fd4ebb
                    ip_configs:
                      Corp-Core:
                        ip: 10.3.100.9
                        netmask: /24
                        type: static
                      Corp-Mgmt:
                        ip: 10.3.172.9
                        netmask: /24
                        type: static
                      Corp-lan:
                        ip: 10.3.171.9
                        netmask: /24
                        type: static
                    modified_time: 1680762890
                    name: ITParis
                    ntpOverride: true
                    ntp_servers:
                    - 10.3.51.222
                    org_id: 93986f10-773b-42be-9438-8d3e6d127f1a
                    path_preferences:
                      core:
                        paths:
                        - networks:
                          - Corp-Core
                          type: local
                        strategy: ordered
                      lab:
                        paths:
                        - networks:
                          - Corp-lan
                          type: local
                        strategy: ordered
                      mgmt:
                        paths:
                        - networks:
                          - Corp-Mgmt
                          type: local
                        strategy: ordered
                      untrust:
                        paths:
                        - name: wan
                          type: wan
                        strategy: ordered
                    port_config:
                      ge-0/0/0:
                        aggregated: false
                        ip_config:
                          gateway: 192.168.1.1
                          ip: 192.168.1.9
                          netmask: /24
                          type: static
                        name: wan
                        redundant: false
                        traffic_shaping:
                          enabled: false
                        usage: wan
                        wan_type: broadband
                      ge-0/0/6-7:
                        ae_disable_lacp: false
                        ae_idx: '0'
                        ae_lacp_force_up: true
                        aggregated: true
                        networks:
                        - Corp-lan
                        - Corp-Mgmt
                        - Corp-Core
                        usage: lan
                    service_policies:
                    - action: allow
                      idp:
                        enabled: false
                      name: ITParis-Internal
                      path_preference: core
                      services:
                      - internal_dns
                      - drive
                      tenants:
                      - ITParis
                    - action: deny
                      idp:
                        enabled: false
                      name: ITParis-internet
                      path_preference: untrust
                      services:
                      - internet_any
                      tenants:
                      - ITParis
                    type: gateway
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/deviceprofile'
                - description: Device profile configuration for an AP, switch, or gateway
                  examples:
                  - '{"aeroscout":{"enabled":true,"host":"string"},"created_time":0,"disable_eth1":true,"disable_module":true,"id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","ip_config":{"dns":["string"],"dns_suffix":["string"],"gateway":"192.168.0.1","gateway6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","ip":"192.168.0.1","ip6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","mtu":1500,"netmask":"192.168.0.1","netmask6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","type":"static","type6":"static","vlan_id":1},"mesh":{"enabled":true,"group":1,"role":"base"},"modified_time":0,"name":"string","org_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","poe_passthrough":true,"switch_config":{"enabled":true,"eth0":{"port_vlan_id":1,"vlan_ids":[1,10]},"eth1":{"port_vlan_id":1,"vlan_ids":[10]},"eth2":{"port_vlan_id":1,"vlan_ids":[10]},"eth3":{"port_vlan_id":1,"vlan_ids":[10]},"module":{"port_vlan_id":1,"vlan_ids":[10]},"wds":{"port_vlan_id":1,"vlan_ids":[10]}},"type":"ap","usb_config":{"cacert":"string","enabled":true,"host":"string","type":"imagotag","verify_cert":true}}'
                  - '{"created_time":1680762730,"dhcpd_config":{"Corp-Mgmt":{"dns_servers":["8.8.8.8"],"dns_suffix":["stag.one"],"gateway":"10.3.172.9","ip_end":"10.3.172.99","ip_start":"10.3.172.50","type":"local"},"Corp-lan":{"dns_servers":["8.8.8.8"],"dns_suffix":["stag.one"],"gateway":"10.3.171.9","ip_end":"10.3.171.99","ip_start":"10.3.171.50","type":"local"}},"dnsOverride":true,"dns_servers":["10.3.20.201","10.3.51.222","1.1.1.1"],"dns_suffix":["example.com"],"extra_routes":{"10.101.0.0/16":{"via":"10.3.100.10"}},"id":"4ea55b5d-7313-4a81-a292-7ee125fd4ebb","ip_configs":{"Corp-Core":{"ip":"10.3.100.9","netmask":"/24","type":"static"},"Corp-Mgmt":{"ip":"10.3.172.9","netmask":"/24","type":"static"},"Corp-lan":{"ip":"10.3.171.9","netmask":"/24","type":"static"}},"modified_time":1680762890,"name":"ITParis","ntpOverride":true,"ntp_servers":["10.3.51.222"],"org_id":"93986f10-773b-42be-9438-8d3e6d127f1a","path_preferences":{"core":{"paths":[{"networks":["Corp-Core"],"type":"local"}],"strategy":"ordered"},"lab":{"paths":[{"networks":["Corp-lan"],"type":"local"}],"strategy":"ordered"},"mgmt":{"paths":[{"networks":["Corp-Mgmt"],"type":"local"}],"strategy":"ordered"},"untrust":{"paths":[{"name":"wan","type":"wan"}],"strategy":"ordered"}},"port_config":{"ge-0/0/0":{"aggregated":false,"ip_config":{"gateway":"192.168.1.1","ip":"192.168.1.9","netmask":"/24","type":"static"},"name":"wan","redundant":false,"traffic_shaping":{"enabled":false},"usage":"wan","wan_type":"broadband"},"ge-0/0/6-7":{"ae_disable_lacp":false,"ae_idx":"0","ae_lacp_force_up":true,"aggregated":true,"networks":["Corp-lan","Corp-Mgmt","Corp-Core"],"usage":"lan"}},"service_policies":[{"action":"allow","idp":{"enabled":false},"name":"ITParis-Internal","path_preference":"core","services":["internal_dns","drive"],"tenants":["ITParis"]},{"action":"deny","idp":{"enabled":false},"name":"ITParis-internet","path_preference":"untrust","services":["internet_any"],"tenants":["ITParis"]}],"type":"gateway"}'
                contentMediaType: application/vnd.api+json
              examples:
                Deviceprofile Ap:
                  value:
                    aeroscout:
                      enabled: true
                      host: string
                    created_time: 0
                    disable_eth1: true
                    disable_module: true
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ip_config:
                      dns:
                      - string
                      dns_suffix:
                      - string
                      gateway: 192.168.0.1
                      gateway6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
                      ip: 192.168.0.1
                      ip6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
                      mtu: 1500
                      netmask: 192.168.0.1
                      netmask6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
                      type: static
                      type6: static
                      vlan_id: 1
                    mesh:
                      enabled: true
                      group: 1
                      role: base
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    poe_passthrough: true
                    switch_config:
                      enabled: true
                      eth0:
                        port_vlan_id: 1
                        vlan_ids:
                        - 1
                        - 10
                      eth1:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      eth2:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      eth3:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      module:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      wds:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                    type: ap
                    usb_config:
                      cacert: string
                      enabled: true
                      host: string
                      type: imagotag
                      verify_cert: true
                Deviceprofile Hub:
                  value:
                    created_time: 1680762730
                    dhcpd_config:
                      Corp-Mgmt:
                        dns_servers:
                        - 8.8.8.8
                        dns_suffix:
                        - stag.one
                        gateway: 10.3.172.9
                        ip_end: 10.3.172.99
                        ip_start: 10.3.172.50
                        type: local
                      Corp-lan:
                        dns_servers:
                        - 8.8.8.8
                        dns_suffix:
                        - stag.one
                        gateway: 10.3.171.9
                        ip_end: 10.3.171.99
                        ip_start: 10.3.171.50
                        type: local
                    dnsOverride: true
                    dns_servers:
                    - 10.3.20.201
                    - 10.3.51.222
                    - 1.1.1.1
                    dns_suffix:
                    - example.com
                    extra_routes:
                      10.101.0.0/16:
                        via: 10.3.100.10
                    id: 4ea55b5d-7313-4a81-a292-7ee125fd4ebb
                    ip_configs:
                      Corp-Core:
                        ip: 10.3.100.9
                        netmask: /24
                        type: static
                      Corp-Mgmt:
                        ip: 10.3.172.9
                        netmask: /24
                        type: static
                      Corp-lan:
                        ip: 10.3.171.9
                        netmask: /24
                        type: static
                    modified_time: 1680762890
                    name: ITParis
                    ntpOverride: true
                    ntp_servers:
                    - 10.3.51.222
                    org_id: 93986f10-773b-42be-9438-8d3e6d127f1a
                    path_preferences:
                      core:
                        paths:
                        - networks:
                          - Corp-Core
                          type: local
                        strategy: ordered
                      lab:
                        paths:
                        - networks:
                          - Corp-lan
                          type: local
                        strategy: ordered
                      mgmt:
                        paths:
                        - networks:
                          - Corp-Mgmt
                          type: local
                        strategy: ordered
                      untrust:
                        paths:
                        - name: wan
                          type: wan
                        strategy: ordered
                    port_config:
                      ge-0/0/0:
                        aggregated: false
                        ip_config:
                          gateway: 192.168.1.1
                          ip: 192.168.1.9
                          netmask: /24
                          type: static
                        name: wan
                        redundant: false
                        traffic_shaping:
                          enabled: false
                        usage: wan
                        wan_type: broadband
                      ge-0/0/6-7:
                        ae_disable_lacp: false
                        ae_idx: '0'
                        ae_lacp_force_up: true
                        aggregated: true
                        networks:
                        - Corp-lan
                        - Corp-Mgmt
                        - Corp-Core
                        usage: lan
                    service_policies:
                    - action: allow
                      idp:
                        enabled: false
                      name: ITParis-Internal
                      path_preference: core
                      services:
                      - internal_dns
                      - drive
                      tenants:
                      - ITParis
                    - action: deny
                      idp:
                        enabled: false
                      name: ITParis-internet
                      path_preference: untrust
                      services:
                      - internet_any
                      tenants:
                      - ITParis
                    type: gateway
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/deviceprofiles/{deviceprofile_id}:
    delete:
      tags:
      - Orgs Device Profiles
      summary: deleteOrgDeviceProfile
      description: Delete an org-level device profile and remove that reusable device configuration object from the organization.
      operationId: deleteOrgDeviceProfile
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: deviceprofile_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs Device Profiles
      summary: getOrgDeviceProfile
      description: Retrieve the AP, switch, or gateway configuration stored in a specific org-level device profile.
      operationId: getOrgDeviceProfile
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: deviceprofile_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/deviceprofile'
                - description: Device profile configuration for an AP, switch, or gateway
                  examples:
                  - '{"aeroscout":{"enabled":true,"host":"string"},"created_time":0,"disable_eth1":true,"disable_module":true,"id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","ip_config":{"dns":["string"],"dns_suffix":["string"],"gateway":"192.168.0.1","gateway6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","ip":"192.168.0.1","ip6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","mtu":1500,"netmask":"192.168.0.1","netmask6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","type":"static","type6":"static","vlan_id":1},"mesh":{"enabled":true,"group":1,"role":"base"},"modified_time":0,"name":"string","org_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","poe_passthrough":true,"switch_config":{"enabled":true,"eth0":{"port_vlan_id":1,"vlan_ids":[1,10]},"eth1":{"port_vlan_id":1,"vlan_ids":[10]},"eth2":{"port_vlan_id":1,"vlan_ids":[10]},"eth3":{"port_vlan_id":1,"vlan_ids":[10]},"module":{"port_vlan_id":1,"vlan_ids":[10]},"wds":{"port_vlan_id":1,"vlan_ids":[10]}},"type":"ap","usb_config":{"cacert":"string","enabled":true,"host":"string","type":"imagotag","verify_cert":true}}'
                  - '{"created_time":1680762730,"dhcpd_config":{"Corp-Mgmt":{"dns_servers":["8.8.8.8"],"dns_suffix":["stag.one"],"gateway":"10.3.172.9","ip_end":"10.3.172.99","ip_start":"10.3.172.50","type":"local"},"Corp-lan":{"dns_servers":["8.8.8.8"],"dns_suffix":["stag.one"],"gateway":"10.3.171.9","ip_end":"10.3.171.99","ip_start":"10.3.171.50","type":"local"}},"dnsOverride":true,"dns_servers":["10.3.20.201","10.3.51.222","1.1.1.1"],"dns_suffix":["example.com"],"extra_routes":{"10.101.0.0/16":{"via":"10.3.100.10"}},"id":"4ea55b5d-7313-4a81-a292-7ee125fd4ebb","ip_configs":{"Corp-Core":{"ip":"10.3.100.9","netmask":"/24","type":"static"},"Corp-Mgmt":{"ip":"10.3.172.9","netmask":"/24","type":"static"},"Corp-lan":{"ip":"10.3.171.9","netmask":"/24","type":"static"}},"modified_time":1680762890,"name":"ITParis","ntpOverride":true,"ntp_servers":["10.3.51.222"],"org_id":"93986f10-773b-42be-9438-8d3e6d127f1a","path_preferences":{"core":{"paths":[{"networks":["Corp-Core"],"type":"local"}],"strategy":"ordered"},"lab":{"paths":[{"networks":["Corp-lan"],"type":"local"}],"strategy":"ordered"},"mgmt":{"paths":[{"networks":["Corp-Mgmt"],"type":"local"}],"strategy":"ordered"},"untrust":{"paths":[{"name":"wan","type":"wan"}],"strategy":"ordered"}},"port_config":{"ge-0/0/0":{"aggregated":false,"ip_config":{"gateway":"192.168.1.1","ip":"192.168.1.9","netmask":"/24","type":"static"},"name":"wan","redundant":false,"traffic_shaping":{"enabled":false},"usage":"wan","wan_type":"broadband"},"ge-0/0/6-7":{"ae_disable_lacp":false,"ae_idx":"0","ae_lacp_force_up":true,"aggregated":true,"networks":["Corp-lan","Corp-Mgmt","Corp-Core"],"usage":"lan"}},"service_policies":[{"action":"allow","idp":{"enabled":false},"name":"ITParis-Internal","path_preference":"core","services":["internal_dns","drive"],"tenants":["ITParis"]},{"action":"deny","idp":{"enabled":false},"name":"ITParis-internet","path_preference":"untrust","services":["internet_any"],"tenants":["ITParis"]}],"type":"gateway"}'
                contentMediaType: application/json
              examples:
                Deviceprofile Ap:
                  value:
                    aeroscout:
                      enabled: true
                      host: string
                    created_time: 0
                    disable_eth1: true
                    disable_module: true
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ip_config:
                      dns:
                      - string
                      dns_suffix:
                      - string
                      gateway: 192.168.0.1
                      gateway6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
                      ip: 192.168.0.1
                      ip6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
                      mtu: 1500
                      netmask: 192.168.0.1
                      netmask6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
                      type: static
                      type6: static
                      vlan_id: 1
                    mesh:
                      enabled: true
                      group: 1
                      role: base
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    poe_passthrough: true
                    switch_config:
                      enabled: true
                      eth0:
                        port_vlan_id: 1
                        vlan_ids:
                        - 1
                        - 10
                      eth1:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      eth2:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      eth3:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      module:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      wds:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                    type: ap
                    usb_config:
                      cacert: string
                      enabled: true
                      host: string
                      type: imagotag
                      verify_cert: true
                Deviceprofile Hub:
                  value:
                    created_time: 1680762730
                    dhcpd_config:
                      Corp-Mgmt:
                        dns_servers:
                        - 8.8.8.8
                        dns_suffix:
                        - stag.one
                        gateway: 10.3.172.9
                        ip_end: 10.3.172.99
                        ip_start: 10.3.172.50
                        type: local
                      Corp-lan:
                        dns_servers:
                        - 8.8.8.8
                        dns_suffix:
                        - stag.one
                        gateway: 10.3.171.9
                        ip_end: 10.3.171.99
                        ip_start: 10.3.171.50
                        type: local
                    dnsOverride: true
                    dns_servers:
                    - 10.3.20.201
                    - 10.3.51.222
                    - 1.1.1.1
                    dns_suffix:
                    - example.com
                    extra_routes:
                      10.101.0.0/16:
                        via: 10.3.100.10
                    id: 4ea55b5d-7313-4a81-a292-7ee125fd4ebb
                    ip_configs:
                      Corp-Core:
                        ip: 10.3.100.9
                        netmask: /24
                        type: static
                      Corp-Mgmt:
                        ip: 10.3.172.9
                        netmask: /24
                        type: static
                      Corp-lan:
                        ip: 10.3.171.9
                        netmask: /24
                        type: static
                    modified_time: 1680762890
                    name: ITParis
                    ntpOverride: true
                    ntp_servers:
                    - 10.3.51.222
                    org_id: 93986f10-773b-42be-9438-8d3e6d127f1a
                    path_preferences:
                      core:
                        paths:
                        - networks:
                          - Corp-Core
                          type: local
                        strategy: ordered
                      lab:
                        paths:
                        - networks:
                          - Corp-lan
                          type: local
                        strategy: ordered
                      mgmt:
                        paths:
                        - networks:
                          - Corp-Mgmt
                          type: local
                        strategy: ordered
                      untrust:
                        paths:
                        - name: wan
                          type: wan
                        strategy: ordered
                    port_config:
                      ge-0/0/0:
                        aggregated: false
                        ip_config:
                          gateway: 192.168.1.1
                          ip: 192.168.1.9
                          netmask: /24
                          type: static
                        name: wan
                        redundant: false
                        traffic_shaping:
                          enabled: false
                        usage: wan
                        wan_type: broadband
                      ge-0/0/6-7:
                        ae_disable_lacp: false
                        ae_idx: '0'
                        ae_lacp_force_up: true
                        aggregated: true
                        networks:
                        - Corp-lan
                        - Corp-Mgmt
                        - Corp-Core
                        usage: lan
                    service_policies:
                    - action: allow
                      idp:
                        enabled: false
                      name: ITParis-Internal
                      path_preference: core
                      services:
                      - internal_dns
                      - drive
                      tenants:
                      - ITParis
                    - action: deny
                      idp:
                        enabled: false
                      name: ITParis-internet
                      path_preference: untrust
                      services:
                      - internet_any
                      tenants:
                      - ITParis
                    type: gateway
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/deviceprofile'
                - description: Device profile configuration for an AP, switch, or gateway
                  examples:
                  - '{"aeroscout":{"enabled":true,"host":"string"},"created_time":0,"disable_eth1":true,"disable_module":true,"id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","ip_config":{"dns":["string"],"dns_suffix":["string"],"gateway":"192.168.0.1","gateway6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","ip":"192.168.0.1","ip6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","mtu":1500,"netmask":"192.168.0.1","netmask6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","type":"static","type6":"static","vlan_id":1},"mesh":{"enabled":true,"group":1,"role":"base"},"modified_time":0,"name":"string","org_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","poe_passthrough":true,"switch_config":{"enabled":true,"eth0":{"port_vlan_id":1,"vlan_ids":[1,10]},"eth1":{"port_vlan_id":1,"vlan_ids":[10]},"eth2":{"port_vlan_id":1,"vlan_ids":[10]},"eth3":{"port_vlan_id":1,"vlan_ids":[10]},"module":{"port_vlan_id":1,"vlan_ids":[10]},"wds":{"port_vlan_id":1,"vlan_ids":[10]}},"type":"ap","usb_config":{"cacert":"string","enabled":true,"host":"string","type":"imagotag","verify_cert":true}}'
                  - '{"created_time":1680762730,"dhcpd_config":{"Corp-Mgmt":{"dns_servers":["8.8.8.8"],"dns_suffix":["stag.one"],"gateway":"10.3.172.9","ip_end":"10.3.172.99","ip_start":"10.3.172.50","type":"local"},"Corp-lan":{"dns_servers":["8.8.8.8"],"dns_suffix":["stag.one"],"gateway":"10.3.171.9","ip_end":"10.3.171.99","ip_start":"10.3.171.50","type":"local"}},"dnsOverride":true,"dns_servers":["10.3.20.201","10.3.51.222","1.1.1.1"],"dns_suffix":["example.com"],"extra_routes":{"10.101.0.0/16":{"via":"10.3.100.10"}},"id":"4ea55b5d-7313-4a81-a292-7ee125fd4ebb","ip_configs":{"Corp-Core":{"ip":"10.3.100.9","netmask":"/24","type":"static"},"Corp-Mgmt":{"ip":"10.3.172.9","netmask":"/24","type":"static"},"Corp-lan":{"ip":"10.3.171.9","netmask":"/24","type":"static"}},"modified_time":1680762890,"name":"ITParis","ntpOverride":true,"ntp_servers":["10.3.51.222"],"org_id":"93986f10-773b-42be-9438-8d3e6d127f1a","path_preferences":{"core":{"paths":[{"networks":["Corp-Core"],"type":"local"}],"strategy":"ordered"},"lab":{"paths":[{"networks":["Corp-lan"],"type":"local"}],"strategy":"ordered"},"mgmt":{"paths":[{"networks":["Corp-Mgmt"],"type":"local"}],"strategy":"ordered"},"untrust":{"paths":[{"name":"wan","type":"wan"}],"strategy":"ordered"}},"port_config":{"ge-0/0/0":{"aggregated":false,"ip_config":{"gateway":"192.168.1.1","ip":"192.168.1.9","netmask":"/24","type":"static"},"name":"wan","redundant":false,"traffic_shaping":{"enabled":false},"usage":"wan","wan_type":"broadband"},"ge-0/0/6-7":{"ae_disable_lacp":false,"ae_idx":"0","ae_lacp_force_up":true,"aggregated":true,"networks":["Corp-lan","Corp-Mgmt","Corp-Core"],"usage":"lan"}},"service_policies":[{"action":"allow","idp":{"enabled":false},"name":"ITParis-Internal","path_preference":"core","services":["internal_dns","drive"],"tenants":["ITParis"]},{"action":"deny","idp":{"enabled":false},"name":"ITParis-internet","path_preference":"untrust","services":["internet_any"],"tenants":["ITParis"]}],"type":"gateway"}'
                contentMediaType: application/vnd.api+json
              examples:
                Deviceprofile Ap:
                  value:
                    aeroscout:
                      enabled: true
                      host: string
                    created_time: 0
                    disable_eth1: true
                    disable_module: true
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ip_config:
                      dns:
                      - string
                      dns_suffix:
                      - string
                      gateway: 192.168.0.1
                      gateway6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
                      ip: 192.168.0.1
                      ip6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
                      mtu: 1500
                      netmask: 192.168.0.1
                      netmask6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
                      type: static
                      type6: static
                      vlan_id: 1
                    mesh:
                      enabled: true
                      group: 1
                      role: base
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    poe_passthrough: true
                    switch_config:
                      enabled: true
                      eth0:
                        port_vlan_id: 1
                        vlan_ids:
                        - 1
                        - 10
                      eth1:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      eth2:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      eth3:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      module:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      wds:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                    type: ap
                    usb_config:
                      cacert: string
                      enabled: true
                      host: string
                      type: imagotag
                      verify_cert: true
                Deviceprofile Hub:
                  value:
                    created_time: 1680762730
                    dhcpd_config:
                      Corp-Mgmt:
                        dns_servers:
                        - 8.8.8.8
                        dns_suffix:
                        - stag.one
                        gateway: 10.3.172.9
                        ip_end: 10.3.172.99
                        ip_start: 10.3.172.50
                        type: local
                      Corp-lan:
                        dns_servers:
                        - 8.8.8.8
                        dns_suffix:
                        - stag.one
                        gateway: 10.3.171.9
                        ip_end: 10.3.171.99
                        ip_start: 10.3.171.50
                        type: local
                    dnsOverride: true
                    dns_servers:
                    - 10.3.20.201
                    - 10.3.51.222
                    - 1.1.1.1
                    dns_suffix:
                    - example.com
                    extra_routes:
                      10.101.0.0/16:
                        via: 10.3.100.10
                    id: 4ea55b5d-7313-4a81-a292-7ee125fd4ebb
                    ip_configs:
                      Corp-Core:
                        ip: 10.3.100.9
                        netmask: /24
                        type: static
                      Corp-Mgmt:
                        ip: 10.3.172.9
                        netmask: /24
                        type: static
                      Corp-lan:
                        ip: 10.3.171.9
                        netmask: /24
                        type: static
                    modified_time: 1680762890
                    name: ITParis
                    ntpOverride: true
                    ntp_servers:
                    - 10.3.51.222
                    org_id: 93986f10-773b-42be-9438-8d3e6d127f1a
                    path_preferences:
                      core:
                        paths:
                        - networks:
                          - Corp-Core
                          type: local
                        strategy: ordered
                      lab:
                        paths:
                        - networks:
                          - Corp-lan
                          type: local
                        strategy: ordered
                      mgmt:
                        paths:
                        - networks:
                          - Corp-Mgmt
                          type: local
                        strategy: ordered
                      untrust:
                        paths:
                        - name: wan
                          type: wan
                        strategy: ordered
                    port_config:
                      ge-0/0/0:
                        aggregated: false
                        ip_config:
                          gateway: 192.168.1.1
                          ip: 192.168.1.9
                          netmask: /24
                          type: static
                        name: wan
                        redundant: false
                        traffic_shaping:
                          enabled: false
                        usage: wan
                        wan_type: broadband
                      ge-0/0/6-7:
                        ae_disable_lacp: false
                        ae_idx: '0'
                        ae_lacp_force_up: true
                        aggregated: true
                        networks:
                        - Corp-lan
                        - Corp-Mgmt
                        - Corp-Core
                        usage: lan
                    service_policies:
                    - action: allow
                      idp:
                        enabled: false
                      name: ITParis-Internal
                      path_preference: core
                      services:
                      - internal_dns
                      - drive
                      tenants:
                      - ITParis
                    - action: deny
                      idp:
                        enabled: false
                      name: ITParis-internet
                      path_preference: untrust
                      services:
                      - internet_any
                      tenants:
                      - ITParis
                    type: gateway
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs Device Profiles
      summary: updateOrgDeviceProfile
      description: Update the AP, switch, or gateway configuration stored in an org-level device profile.
      operationId: updateOrgDeviceProfile
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: deviceprofile_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/deviceprofile'
              - description: Request Body
                examples:
                - '{"aeroscout":{"enabled":true,"host":"aero.pvt.net"},"disable_eth1":true,"disable_module":true,"mesh":{"enabled":true,"group":1,"role":"base"},"name":"string","poe_passthrough":true,"radio_config":{"ant_gain_24":0,"ant_gain_5":0,"band_24":{"allow_rrm_disable":true,"antenna_mode":"default","bandwidth":20,"channel":6,"disabled":true,"power":8,"preamble":"auto"},"band_24_usage":"24","band_5":{"allow_rrm_disable":true,"antenna_mode":"default","bandwidth":20,"channel":50,"disabled":true,"power_max":8,"power_min":15,"preamble":"auto"},"scanning_enabled":true},"type":"ap"}'
                - '{"dhcpd_config":{"Corp-Mgmt":{"dns_servers":["8.8.8.8"],"dns_suffix":["stag.one"],"gateway":"10.3.172.9","ip_end":"10.3.172.99","ip_start":"10.3.172.50","type":"local"},"Corp-lan":{"dns_servers":["8.8.8.8"],"dns_suffix":["stag.one"],"gateway":"10.3.171.9","ip_end":"10.3.171.99","ip_start":"10.3.171.50","type":"local"}},"dnsOverride":true,"dns_servers":["10.3.20.201","10.3.51.222","1.1.1.1"],"dns_suffix":["example.com"],"extra_routes":{"10.101.0.0/16":{"via":"10.3.100.10"}},"ip_configs":{"Corp-Core":{"ip":"10.3.100.9","netmask":"/24","type":"static"},"Corp-Mgmt":{"ip":"10.3.172.9","netmask":"/24","type":"static"},"Corp-lan":{"ip":"10.3.171.9","netmask":"/24","type":"static"}},"name":"ITParis","ntpOverride":true,"ntp_servers":["10.3.51.222"],"path_preferences":{"core":{"paths":[{"networks":["Corp-Core"],"type":"local"}],"strategy":"ordered"},"lab":{"paths":[{"networks":["Corp-lan"],"type":"local"}],"strategy":"ordered"},"mgmt":{"paths":[{"networks":["Corp-Mgmt"],"type":"local"}],"strategy":"ordered"},"untrust":{"paths":[{"name":"wan","type":"wan"}],"strategy":"ordered"}},"port_config":{"ge-0/0/0":{"aggregated":false,"ip_config":{"gateway":"192.168.1.1","ip":"192.168.1.9","netmask":"/24","type":"static"},"name":"wan","redundant":false,"traffic_shaping":{"enabled":false},"usage":"wan","wan_type":"broadband"},"ge-0/0/6-7":{"ae_disable_lacp":false,"ae_idx":"0","ae_lacp_force_up":true,"aggregated":true,"networks":["Corp-lan","Corp-Mgmt","Corp-Core"],"usage":"lan"}},"service_policies":[{"action":"allow","idp":{"enabled":false},"name":"ITParis-Internal","path_preference":"core","services":["internal_dns","drive"],"tenants":["ITParis"]},{"action":"deny","idp":{"enabled":false},"name":"ITParis-internet","path_preference":"untrust","services":["internet_any"],"tenants":["ITParis"]}],"type":"gateway"}'
              contentMediaType: application/json
            examples:
              deviceprofile_ap:
                value:
                  aeroscout:
                    enabled: true
                    host: aero.pvt.net
                  disable_eth1: true
                  disable_module: true
                  mesh:
                    enabled: true
                    group: 1
                    role: base
                  name: string
                  poe_passthrough: true
                  radio_config:
                    ant_gain_24: 0
                    ant_gain_5: 0
                    band_24:
                      allow_rrm_disable: true
                      antenna_mode: default
                      bandwidth: 20
                      channel: 6
                      disabled: true
                      power: 8
                      preamble: auto
                    band_24_usage: '24'
                    band_5:
                      allow_rrm_disable: true
                      antenna_mode: default
                      bandwidth: 20
                      channel: 50
                      disabled: true
                      power_max: 8
                      power_min: 15
                      preamble: auto
                    scanning_enabled: true
                  type: ap
              deviceprofile_hub:
                value:
                  dhcpd_config:
                    Corp-Mgmt:
                      dns_servers:
                      - 8.8.8.8
                      dns_suffix:
                      - stag.one
                      gateway: 10.3.172.9
                      ip_end: 10.3.172.99
                      ip_start: 10.3.172.50
                      type: local
                    Corp-lan:
                      dns_servers:
                      - 8.8.8.8
                      dns_suffix:
                      - stag.one
                      gateway: 10.3.171.9
                      ip_end: 10.3.171.99
                      ip_start: 10.3.171.50
                      type: local
                  dnsOverride: true
                  dns_servers:
                  - 10.3.20.201
                  - 10.3.51.222
                  - 1.1.1.1
                  dns_suffix:
                  - example.com
                  extra_routes:
                    10.101.0.0/16:
                      via: 10.3.100.10
                  ip_configs:
                    Corp-Core:
                      ip: 10.3.100.9
                      netmask: /24
                      type: static
                    Corp-Mgmt:
                      ip: 10.3.172.9
                      netmask: /24
                      type: static
                    Corp-lan:
                      ip: 10.3.171.9
                      netmask: /24
                      type: static
                  name: ITParis
                  ntpOverride: true
                  ntp_servers:
                  - 10.3.51.222
                  path_preferences:
                    core:
                      paths:
                      - networks:
                        - Corp-Core
                        type: local
                      strategy: ordered
                    lab:
                      paths:
                      - networks:
                        - Corp-lan
                        type: local
                      strategy: ordered
                    mgmt:
                      paths:
                      - networks:
                        - Corp-Mgmt
                        type: local
                      strategy: ordered
                    untrust:
                      paths:
                      - name: wan
                        type: wan
                      strategy: ordered
                  port_config:
                    ge-0/0/0:
                      aggregated: false
                      ip_config:
                        gateway: 192.168.1.1
                        ip: 192.168.1.9
                        netmask: /24
                        type: static
                      name: wan
                      redundant: false
                      traffic_shaping:
                        enabled: false
                      usage: wan
                      wan_type: broadband
                    ge-0/0/6-7:
                      ae_disable_lacp: false
                      ae_idx: '0'
                      ae_lacp_force_up: true
                      aggregated: true
                      networks:
                      - Corp-lan
                      - Corp-Mgmt
                      - Corp-Core
                      usage: lan
                  service_policies:
                  - action: allow
                    idp:
                      enabled: false
                    name: ITParis-Internal
                    path_preference: core
                    services:
                    - internal_dns
                    - drive
                    tenants:
                    - ITParis
                  - action: deny
                    idp:
                      enabled: false
                    name: ITParis-internet
                    path_preference: untrust
                    services:
                    - internet_any
                    tenants:
                    - ITParis
                  type: gateway
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/deviceprofile'
                - description: Device profile configuration for an AP, switch, or gateway
                  examples:
                  - '{"aeroscout":{"enabled":true,"host":"string"},"created_time":0,"disable_eth1":true,"disable_module":true,"id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","ip_config":{"dns":["string"],"dns_suffix":["string"],"gateway":"192.168.0.1","gateway6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","ip":"192.168.0.1","ip6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","mtu":1500,"netmask":"192.168.0.1","netmask6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","type":"static","type6":"static","vlan_id":1},"mesh":{"enabled":true,"group":1,"role":"base"},"modified_time":0,"name":"string","org_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","poe_passthrough":true,"switch_config":{"enabled":true,"eth0":{"port_vlan_id":1,"vlan_ids":[1,10]},"eth1":{"port_vlan_id":1,"vlan_ids":[10]},"eth2":{"port_vlan_id":1,"vlan_ids":[10]},"eth3":{"port_vlan_id":1,"vlan_ids":[10]},"module":{"port_vlan_id":1,"vlan_ids":[10]},"wds":{"port_vlan_id":1,"vlan_ids":[10]}},"type":"ap","usb_config":{"cacert":"string","enabled":true,"host":"string","type":"imagotag","verify_cert":true}}'
                  - '{"created_time":1680762730,"dhcpd_config":{"Corp-Mgmt":{"dns_servers":["8.8.8.8"],"dns_suffix":["stag.one"],"gateway":"10.3.172.9","ip_end":"10.3.172.99","ip_start":"10.3.172.50","type":"local"},"Corp-lan":{"dns_servers":["8.8.8.8"],"dns_suffix":["stag.one"],"gateway":"10.3.171.9","ip_end":"10.3.171.99","ip_start":"10.3.171.50","type":"local"}},"dnsOverride":true,"dns_servers":["10.3.20.201","10.3.51.222","1.1.1.1"],"dns_suffix":["example.com"],"extra_routes":{"10.101.0.0/16":{"via":"10.3.100.10"}},"id":"4ea55b5d-7313-4a81-a292-7ee125fd4ebb","ip_configs":{"Corp-Core":{"ip":"10.3.100.9","netmask":"/24","type":"static"},"Corp-Mgmt":{"ip":"10.3.172.9","netmask":"/24","type":"static"},"Corp-lan":{"ip":"10.3.171.9","netmask":"/24","type":"static"}},"modified_time":1680762890,"name":"ITParis","ntpOverride":true,"ntp_servers":["10.3.51.222"],"org_id":"93986f10-773b-42be-9438-8d3e6d127f1a","path_preferences":{"core":{"paths":[{"networks":["Corp-Core"],"type":"local"}],"strategy":"ordered"},"lab":{"paths":[{"networks":["Corp-lan"],"type":"local"}],"strategy":"ordered"},"mgmt":{"paths":[{"networks":["Corp-Mgmt"],"type":"local"}],"strategy":"ordered"},"untrust":{"paths":[{"name":"wan","type":"wan"}],"strategy":"ordered"}},"port_config":{"ge-0/0/0":{"aggregated":false,"ip_config":{"gateway":"192.168.1.1","ip":"192.168.1.9","netmask":"/24","type":"static"},"name":"wan","redundant":false,"traffic_shaping":{"enabled":false},"usage":"wan","wan_type":"broadband"},"ge-0/0/6-7":{"ae_disable_lacp":false,"ae_idx":"0","ae_lacp_force_up":true,"aggregated":true,"networks":["Corp-lan","Corp-Mgmt","Corp-Core"],"usage":"lan"}},"service_policies":[{"action":"allow","idp":{"enabled":false},"name":"ITParis-Internal","path_preference":"core","services":["internal_dns","drive"],"tenants":["ITParis"]},{"action":"deny","idp":{"enabled":false},"name":"ITParis-internet","path_preference":"untrust","services":["internet_any"],"tenants":["ITParis"]}],"type":"gateway"}'
                contentMediaType: application/json
              examples:
                Deviceprofile Ap:
                  value:
                    aeroscout:
                      enabled: true
                      host: string
                    created_time: 0
                    disable_eth1: true
                    disable_module: true
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ip_config:
                      dns:
                      - string
                      dns_suffix:
                      - string
                      gateway: 192.168.0.1
                      gateway6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
                      ip: 192.168.0.1
                      ip6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
                      mtu: 1500
                      netmask: 192.168.0.1
                      netmask6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
                      type: static
                      type6: static
                      vlan_id: 1
                    mesh:
                      enabled: true
                      group: 1
                      role: base
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    poe_passthrough: true
                    switch_config:
                      enabled: true
                      eth0:
                        port_vlan_id: 1
                        vlan_ids:
                        - 1
                        - 10
                      eth1:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      eth2:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      eth3:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      module:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      wds:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                    type: ap
                    usb_config:
                      cacert: string
                      enabled: true
                      host: string
                      type: imagotag
                      verify_cert: true
                Deviceprofile Hub:
                  value:
                    created_time: 1680762730
                    dhcpd_config:
                      Corp-Mgmt:
                        dns_servers:
                        - 8.8.8.8
                        dns_suffix:
                        - stag.one
                        gateway: 10.3.172.9
                        ip_end: 10.3.172.99
                        ip_start: 10.3.172.50
                        type: local
                      Corp-lan:
                        dns_servers:
                        - 8.8.8.8
                        dns_suffix:
                        - stag.one
                        gateway: 10.3.171.9
                        ip_end: 10.3.171.99
                        ip_start: 10.3.171.50
                        type: local
                    dnsOverride: true
                    dns_servers:
                    - 10.3.20.201
                    - 10.3.51.222
                    - 1.1.1.1
                    dns_suffix:
                    - example.com
                    extra_routes:
                      10.101.0.0/16:
                        via: 10.3.100.10
                    id: 4ea55b5d-7313-4a81-a292-7ee125fd4ebb
                    ip_configs:
                      Corp-Core:
                        ip: 10.3.100.9
                        netmask: /24
                        type: static
                      Corp-Mgmt:
                        ip: 10.3.172.9
                        netmask: /24
                        type: static
                      Corp-lan:
                        ip: 10.3.171.9
                        netmask: /24
                        type: static
                    modified_time: 1680762890
                    name: ITParis
                    ntpOverride: true
                    ntp_servers:
                    - 10.3.51.222
                    org_id: 93986f10-773b-42be-9438-8d3e6d127f1a
                    path_preferences:
                      core:
                        paths:
                        - networks:
                          - Corp-Core
                          type: local
                        strategy: ordered
                      lab:
                        paths:
                        - networks:
                          - Corp-lan
                          type: local
                        strategy: ordered
                      mgmt:
                        paths:
                        - networks:
                          - Corp-Mgmt
                          type: local
                        strategy: ordered
                      untrust:
                        paths:
                        - name: wan
                          type: wan
                        strategy: ordered
                    port_config:
                      ge-0/0/0:
                        aggregated: false
                        ip_config:
                          gateway: 192.168.1.1
                          ip: 192.168.1.9
                          netmask: /24
                          type: static
                        name: wan
                        redundant: false
                        traffic_shaping:
                          enabled: false
                        usage: wan
                        wan_type: broadband
                      ge-0/0/6-7:
                        ae_disable_lacp: false
                        ae_idx: '0'
                        ae_lacp_force_up: true
                        aggregated: true
                        networks:
                        - Corp-lan
                        - Corp-Mgmt
                        - Corp-Core
                        usage: lan
                    service_policies:
                    - action: allow
                      idp:
                        enabled: false
                      name: ITParis-Internal
                      path_preference: core
                      services:
                      - internal_dns
                      - drive
                      tenants:
                      - ITParis
                    - action: deny
                      idp:
                        enabled: false
                      name: ITParis-internet
                      path_preference: untrust
                      services:
                      - internet_any
                      tenants:
                      - ITParis
                    type: gateway
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/deviceprofile'
                - description: Device profile configuration for an AP, switch, or gateway
                  examples:
                  - '{"aeroscout":{"enabled":true,"host":"string"},"created_time":0,"disable_eth1":true,"disable_module":true,"id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","ip_config":{"dns":["string"],"dns_suffix":["string"],"gateway":"192.168.0.1","gateway6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","ip":"192.168.0.1","ip6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","mtu":1500,"netmask":"192.168.0.1","netmask6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","type":"static","type6":"static","vlan_id":1},"mesh":{"enabled":true,"group":1,"role":"base"},"modified_time":0,"name":"string","org_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","poe_passthrough":true,"switch_config":{"enabled":true,"eth0":{"port_vlan_id":1,"vlan_ids":[1,10]},"eth1":{"port_vlan_id":1,"vlan_ids":[10]},"eth2":{"port_vlan_id":1,"vlan_ids":[10]},"eth3":{"port_vlan_id":1,"vlan_ids":[10]},"module":{"port_vlan_id":1,"vlan_ids":[10]},"wds":{"port_vlan_id":1,"vlan_ids":[10]}},"type":"ap","usb_config":{"cacert":"string","enabled":true,"host":"string","type":"imagotag","verify_cert":true}}'
                  - '{"created_time":1680762730,"dhcpd_config":{"Corp-Mgmt":{"dns_servers":["8.8.8.8"],"dns_suffix":["stag.one"],"gateway":"10.3.172.9","ip_end":"10.3.172.99","ip_start":"10.3.172.50","type":"local"},"Corp-lan":{"dns_servers":["8.8.8.8"],"dns_suffix":["stag.one"],"gateway":"10.3.171.9","ip_end":"10.3.171.99","ip_start":"10.3.171.50","type":"local"}},"dnsOverride":true,"dns_servers":["10.3.20.201","10.3.51.222","1.1.1.1"],"dns_suffix":["example.com"],"extra_routes":{"10.101.0.0/16":{"via":"10.3.100.10"}},"id":"4ea55b5d-7313-4a81-a292-7ee125fd4ebb","ip_configs":{"Corp-Core":{"ip":"10.3.100.9","netmask":"/24","type":"static"},"Corp-Mgmt":{"ip":"10.3.172.9","netmask":"/24","type":"static"},"Corp-lan":{"ip":"10.3.171.9","netmask":"/24","type":"static"}},"modified_time":1680762890,"name":"ITParis","ntpOverride":true,"ntp_servers":["10.3.51.222"],"org_id":"93986f10-773b-42be-9438-8d3e6d127f1a","path_preferences":{"core":{"paths":[{"networks":["Corp-Core"],"type":"local"}],"strategy":"ordered"},"lab":{"paths":[{"networks":["Corp-lan"],"type":"local"}],"strategy":"ordered"},"mgmt":{"paths":[{"networks":["Corp-Mgmt"],"type":"local"}],"strategy":"ordered"},"untrust":{"paths":[{"name":"wan","type":"wan"}],"strategy":"ordered"}},"port_config":{"ge-0/0/0":{"aggregated":false,"ip_config":{"gateway":"192.168.1.1","ip":"192.168.1.9","netmask":"/24","type":"static"},"name":"wan","redundant":false,"traffic_shaping":{"enabled":false},"usage":"wan","wan_type":"broadband"},"ge-0/0/6-7":{"ae_disable_lacp":false,"ae_idx":"0","ae_lacp_force_up":true,"aggregated":true,"networks":["Corp-lan","Corp-Mgmt","Corp-Core"],"usage":"lan"}},"service_policies":[{"action":"allow","idp":{"enabled":false},"name":"ITParis-Internal","path_preference":"core","services":["internal_dns","drive"],"tenants":["ITParis"]},{"action":"deny","idp":{"enabled":false},"name":"ITParis-internet","path_preference":"untrust","services":["internet_any"],"tenants":["ITParis"]}],"type":"gateway"}'
                contentMediaType: application/vnd.api+json
              examples:
                Deviceprofile Ap:
                  value:
                    aeroscout:
                      enabled: true
                      host: string
                    created_time: 0
                    disable_eth1: true
                    disable_module: true
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ip_config:
                      dns:
                      - string
                      dns_suffix:
                      - string
                      gateway: 192.168.0.1
                      gateway6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
                      ip: 192.168.0.1
                      ip6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
                      mtu: 1500
                      netmask: 192.168.0.1
                      netmask6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
                      type: static
                      type6: static
                      vlan_id: 1
                    mesh:
                      enabled: true
                      group: 1
                      role: base
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    poe_passthrough: true
                    switch_config:
                      enabled: true
                      eth0:
                        port_vlan_id: 1
                        vlan_ids:
                        - 1
                        - 10
                      eth1:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      eth2:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      eth3:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      module:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      wds:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                    type: ap
                    usb_config:
                      cacert: string
                      enabled: true
                      host: string
                      type: imagotag
                      verify_cert: true
                Deviceprofile Hub:
                  value:
                    created_time: 1680762730
                    dhcpd_config:
                      Corp-Mgmt:
                        dns_servers:
                        - 8.8.8.8
                        dns_suffix:
                        - stag.one
                        gateway: 10.3.172.9
                        ip_end: 10.3.172.99
                        ip_start: 10.3.172.50
                        type: local
                      Corp-lan:
                        dns_servers:
                        - 8.8.8.8
                        dns_suffix:
                        - stag.one
                        gateway: 10.3.171.9
                        ip_end: 10.3.171.99
                        ip_start: 10.3.171.50
                        type: local
                    dnsOverride: true
                    dns_servers:
                    - 10.3.20.201
                    - 10.3.51.222
                    - 1.1.1.1
                    dns_suffix:
                    - example.com
                    extra_routes:
                      10.101.0.0/16:
                        via: 10.3.100.10
                    id: 4ea55b5d-7313-4a81-a292-7ee125fd4ebb
                    ip_configs:
                      Corp-Core:
                        ip: 10.3.100.9
                        netmask: /24
                        type: static
                      Corp-Mgmt:
                        ip: 10.3.172.9
                        netmask: /24
                        type: static
                      Corp-lan:
                        ip: 10.3.171.9
                        netmask: /24
                        type: static
                    modified_time: 1680762890
                    name: ITParis
                    ntpOverride: true
                    ntp_servers:
                    - 10.3.51.222
                    org_id: 93986f10-773b-42be-9438-8d3e6d127f1a
                    path_preferences:
                      core:
                        paths:
                        - networks:
                          - Corp-Core
                          type: local
                        strategy: ordered
                      lab:
                        paths:
                        - networks:
                          - Corp-lan
                          type: local
                        strategy: ordered
                      mgmt:
                        paths:
                        - networks:
                          - Corp-Mgmt
                          type: local
                        strategy: ordered
                      untrust:
                        paths:
                        - name: wan
                          type: wan
                        strategy: ordered
                    port_config:
                      ge-0/0/0:
                        aggregated: false
                        ip_config:
                          gateway: 192.168.1.1
                          ip: 192.168.1.9
                          netmask: /24
                          type: static
                        name: wan
                        redundant: false
                        traffic_shaping:
                          enabled: false
                        usage: wan
                        wan_type: broadband
                      ge-0/0/6-7:
                        ae_disable_lacp: false
                        ae_idx: '0'
                        ae_lacp_force_up: true
                        aggregated: true
                        networks:
                        - Corp-lan
                        - Corp-Mgmt
                        - Corp-Core
                        usage: lan
                    service_policies:
                    - action: allow
                      idp:
                        enabled: false
                      name: ITParis-Internal
                      path_preference: core
                      services:
                      - internal_dns
                      - drive
                      tenants:
                      - ITParis
                    - action: deny
                      idp:
                        enabled: false
                      name: ITParis-internet
                      path_preference: untrust
                      services:
                      - internet_any
                      tenants:
                      - ITParis
                    type: gateway
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/deviceprofiles/{deviceprofile_id}/assign:
    post:
      tags:
      - Orgs Device Profiles
      summary: assignOrgDeviceProfile
      description: Assign Org Device Profile to Devices
      operationId: assignOrgDeviceProfile
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: deviceprofile_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/mac_addresses'
              - description: Request Body
                examples:
                - macs:
                  - 5c5b350e0001
                  - 5c5b350e0003
              contentMediaType: application/json
            examples:
              Example:
                value:
                  macs:
                  - 5c5b350e0001
                  - 5c5b350e0003
        required: false
      responses:
        '200':
          description: OK - list only devices that has deviceprofile_id changed
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_assign_success'
                - description: Assignment operation success response
                  examples:
                  - success:
                    - 5c5b350e0001
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    success:
                    - 5c5b350e0001
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_assign_success'
                - description: Assignment operation success response
                  examples:
                  - success:
                    - 5c5b350e0001
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    success:
                    - 5c5b350e0001
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/deviceprofiles/{deviceprofile_id}/unassign:
    post:
      tags:
      - Orgs Device Profiles
      summary: unassignOrgDeviceProfile
      description: Unassign Org Device Profile from Devices
      operationId: unassignOrgDeviceProfile
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: deviceprofile_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/mac_addresses'
              - description: Request Body
                examples:
                - macs:
                  - 5c5b350e0001
                  - 5c5b350e0003
              contentMediaType: application/json
            examples:
              Example:
                value:
                  macs:
                  - 5c5b350e0001
                  - 5c5b350e0003
        required: false
      responses:
        '200':
          description: OK - list only devices that has deviceprofile_id changed
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_assign_success'
                - description: Assignment operation success response
                  examples:
                  - success:
                    - 5c5b350e0001
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    success:
                    - 5c5b350e0001
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_assign_success'
                - description: Assignment operation success response
                  examples:
                  - success:
                    - 5c5b350e0001
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    success:
                    - 5c5b350e0001
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/devices:
    get:
      tags:
      - Orgs Devices
      summary: listOrgDevices
      description: List devices in the organization, including APs, switches and gateways managed or monitored by Mist.
      operationId: listOrgDevices
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_org_devices'
                - description: Response containing organization device records
                  examples:
                  - results:
                    - mac: string
                      name: string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    results:
                    - mac: string
                      name: string
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_org_devices'
                - description: Response containing organization device records
                  examples:
                  - results:
                    - mac: string
                      name: string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    results:
                    - mac: string
                      name: string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/devices/count:
    get:
      tags:
      - Orgs Devices
      summary: countOrgDevices
      description: Count organization device records, optionally grouped by `distinct` and filtered by device identifiers, model, LLDP attributes, Mist Edge, tunnel status, device type, and time range.
      operationId: countOrgDevices
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `hostname`, `ip`, `lldp_mgmt_addr`, `lldp_port_id`, `lldp_system_desc`, `lldp_system_name`, `mac`, `model`, `mxedge_id`, `mxtunnel_status`, `site_id`, `version`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/org_devices_count_distinct'
          - description: 'Field used to group this count response. enum: `hostname`, `ip`, `lldp_mgmt_addr`, `lldp_port_id`, `lldp_system_desc`, `lldp_system_name`, `mac`, `model`, `mxedge_id`, `mxtunnel_status`, `site_id`, `version`'
      - name: hostname
        in: query
        description: Partial / full hostname
        style: form
        explode: true
        schema:
          type: string
          examples:
          - my-hostname
      - name: site_id
        in: query
        description: Filter results by site identifier
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 7dae216d-7c98-a51b-e068-dd7d477b7216
      - name: model
        in: query
        description: Filter results by device model. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - AP45,AP47D
          - MR84
        examples:
          Untitled Example1:
            value: AP45,AP47D
          Untitled Example2:
            value: MR84
      - name: managed
        in: query
        description: 'for switches and gateways, to filter on managed/unmanaged devices. Deprecated in favour of mist_configured. enum: `true`, `false`'
        deprecated: true
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 'true'
          deprecated: true
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b53010101
      - name: version
        in: query
        description: Filter results by software version
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 10.0.0
      - name: ip
        in: query
        description: Filter results by IPv4 address
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: ipv4
          examples:
          - 192.168.1.1
      - name: mxtunnel_status
        in: query
        description: 'MxTunnel status, enum: `up`, `down`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/count_org_devices_mxtunnel_status'
          - description: 'MxTunnel status, enum: `up`, `down`'
      - name: mxedge_id
        in: query
        description: Mist Edge id, if AP is connecting to a Mist Edge
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 7dae216d-7c98-a51b-e068-dd7d477b7216
      - name: lldp_system_name
        in: query
        description: Filter results by LLDP system name
        style: form
        explode: true
        schema:
          type: string
          examples:
          - my-lldp-system
      - name: lldp_system_desc
        in: query
        description: Filter results by LLDP system description
        style: form
        explode: true
        schema:
          type: string
          examples:
          - my-lldp-system-description
      - name: lldp_port_id
        in: query
        description: Filter results by LLDP port identifier
        style: form
        explode: true
        schema:
          type: string
          examples:
          - ge-0/0/1
      - name: lldp_mgmt_addr
        in: query
        description: LLDP management IP address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 10.4.2.3
      - name: type
        in: query
        description: 'Filter results by type. enum: `ap`, `gateway`, `switch`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/device_type_default_ap'
          - description: 'Filter results by type. enum: `ap`, `gateway`, `switch`'
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/devices/events/count:
    get:
      tags:
      - Orgs Devices
      summary: countOrgDeviceEvents
      description: Count device event records across the organization, optionally grouped by `distinct` and filtered by site, AP, firmware, model, event text, event type, and time range.
      operationId: countOrgDeviceEvents
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `ap`, `apfw`, `model`, `org_id`, `site_id`, `status`, `text`, `timestamp`, `type`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/org_devices_events_count_distinct'
          - description: 'Field used to group this count response. enum: `ap`, `apfw`, `model`, `org_id`, `site_id`, `status`, `text`, `timestamp`, `type`'
      - name: site_id
        in: query
        description: Filter results by site identifier
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 7dae216d-7c98-a51b-e068-dd7d477b7216
      - name: ap
        in: query
        description: Filter results by AP MAC address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b53010101
      - name: apfw
        in: query
        description: Filter results by AP firmware version
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 10.0.0
      - name: model
        in: query
        description: Filter results by device model
        style: form
        explode: true
        schema:
          type: string
          examples:
          - AP43
      - name: text
        in: query
        description: Filter results by event message text
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Device connected
      - name: type
        in: query
        description: See [List Device Events Definitions]($e/Constants%20Events/listDeviceEventsDefinitions)
        style: form
        explode: true
        schema:
          type: string
      - name: includes
        in: query
        description: Keyword to include events from additional indices (e.g. ext_tunnel for ext tunnel events)
        style: form
        explode: true
        schema:
          type: string
          examples:
          - ext_tunnel
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/devices/events/search:
    get:
      tags:
      - Orgs Devices
      summary: searchOrgDeviceEvents
      description: Search device event records across the organization with filters for MAC address, model, device type, event text, event type, additional event indices, and time range.
      operationId: searchOrgDeviceEvents
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mac
        in: query
        description: Filter results by MAC address. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b53010101,5c5b53020202
          - 5c5b53010101
        examples:
          Untitled Example1:
            value: 5c5b53010101,5c5b53020202
          Untitled Example2:
            value: 5c5b53010101
      - name: model
        in: query
        description: Filter results by device model. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - EX4100-48MP,AP17
          - AP43
        examples:
          Untitled Example1:
            value: EX4100-48MP,AP17
          Untitled Example2:
            value: AP43
      - name: device_type
        in: query
        description: Filter results by device type. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          default: ap
          examples:
          - switch,ap
      - name: text
        in: query
        description: Filter results by event message text
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Device connected
      - name: type
        in: query
        description: See [List Device Events Definitions]($e/Constants%20Events/listDeviceEventsDefinitions). Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - SW_PORT_DOWN,AP_CONFIGURED
      - name: last_by
        in: query
        description: Return last/recent event for passed in field
        style: form
        explode: true
        schema:
          type: string
          examples:
          - port_id
      - name: includes
        in: query
        description: Keyword to include events from additional indices (e.g. ext_tunnel for ext tunnel events)
        style: form
        explode: true
        schema:
          type: string
          examples:
          - ext_tunnel
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_device_events_search'
                - description: Paginated response for device or system event search results
                  examples:
                  - end: 0
                    limit: 0
                    next: string
                    results:
                    - ap: 5c5b351e13b5
                      apfw: 5c5b351e13b5
                      model: BT11-WW
                      org_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862a
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      text: Succeeding DNS query from 172.29.101.134 to 172.29.101.7 for "portal.mistsys.com" on vlan 1, id 60224
                      timestamp: 1547235620.89
                      type: CLIENT_DNS_OK
                    - device_type: gateway
                      job_id: c2096de9-0ca4-4a8b-b500-d37cbe0f0baf
                      mac: d007ca6c6ac0
                      org_id: 86f0c649-06b1-4337-b3d4-25eeb887f732
                      site_id: 9f8d28eb-77c7-44c7-a85b-4426bf291679
                      status: PROVISION_IN_PROGRESS
                      template_id: 660e8400-e29b-41d4-a716-446655440001
                      timestamp: 1748987445.959
                      tunnel_name: zs1
                      type: NOTICE
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 0
                    limit: 0
                    next: string
                    results:
                    - ap: 5c5b351e13b5
                      apfw: 5c5b351e13b5
                      model: BT11-WW
                      org_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862a
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      text: Succeeding DNS query from 172.29.101.134 to 172.29.101.7 for "portal.mistsys.com" on vlan 1, id 60224
                      timestamp: 1547235620.89
                      type: CLIENT_DNS_OK
                    - device_type: gateway
                      job_id: c2096de9-0ca4-4a8b-b500-d37cbe0f0baf
                      mac: d007ca6c6ac0
                      org_id: 86f0c649-06b1-4337-b3d4-25eeb887f732
                      site_id: 9f8d28eb-77c7-44c7-a85b-4426bf291679
                      status: PROVISION_IN_PROGRESS
                      template_id: 660e8400-e29b-41d4-a716-446655440001
                      timestamp: 1748987445.959
                      tunnel_name: zs1
                      type: NOTICE
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_device_events_search'
                - description: Paginated response for device or system event search results
                  examples:
                  - end: 0
                    limit: 0
                    next: string
                    results:
                    - ap: 5c5b351e13b5
                      apfw: 5c5b351e13b5
                      model: BT11-WW
                      org_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862a
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      text: Succeeding DNS query from 172.29.101.134 to 172.29.101.7 for "portal.mistsys.com" on vlan 1, id 60224
                      timestamp: 1547235620.89
                      type: CLIENT_DNS_OK
                    - device_type: gateway
                      job_id: c2096de9-0ca4-4a8b-b500-d37cbe0f0baf
                      mac: d007ca6c6ac0
                      org_id: 86f0c649-06b1-4337-b3d4-25eeb887f732
                      site_id: 9f8d28eb-77c7-44c7-a85b-4426bf291679
                      status: PROVISION_IN_PROGRESS
                      template_id: 660e8400-e29b-41d4-a716-446655440001
                      timestamp: 1748987445.959
                      tunnel_name: zs1
                      type: NOTICE
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 0
                    limit: 0
                    next: string
                    results:
                    - ap: 5c5b351e13b5
                      apfw: 5c5b351e13b5
                      model: BT11-WW
                      org_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862a
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      text: Succeeding DNS query from 172.29.101.134 to 172.29.101.7 for "portal.mistsys.com" on vlan 1, id 60224
                      timestamp: 1547235620.89
                      type: CLIENT_DNS_OK
                    - device_type: gateway
                      job_id: c2096de9-0ca4-4a8b-b500-d37cbe0f0baf
                      mac: d007ca6c6ac0
                      org_id: 86f0c649-06b1-4337-b3d4-25eeb887f732
                      site_id: 9f8d28eb-77c7-44c7-a85b-4426bf291679
                      status: PROVISION_IN_PROGRESS
                      template_id: 660e8400-e29b-41d4-a716-446655440001
                      timestamp: 1748987445.959
                      tunnel_name: zs1
                      type: NOTICE
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/devices/last_config/count:
    get:
      tags:
      - Orgs Devices
      summary: countOrgDeviceLastConfigs
      description: Count device config history records across the organization, optionally grouped by `distinct` and filtered by device type and time range.
      operationId: countOrgDeviceLastConfigs
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: type
        in: query
        description: 'Filter results by type. enum: `ap`, `gateway`, `switch`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/device_type_default_ap'
          - description: 'Filter results by type. enum: `ap`, `gateway`, `switch`'
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `mac`, `name`, `site_id`, `version`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/org_devices_last_configs_count_distinct'
          - description: 'Field used to group this count response. enum: `mac`, `name`, `site_id`, `version`'
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/devices/last_config/search:
    get:
      tags:
      - Orgs Devices
      summary: searchOrgDeviceLastConfigs
      description: Search device config history records across the organization with filters for device type, MAC address, name, software version, certificate-expiry duration, and time range.
      operationId: searchOrgDeviceLastConfigs
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_type
        in: query
        description: 'Filter results by device type. enum: `ap`, `gateway`, `switch`, `mxedge`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/last_config_device_type'
          - description: 'Filter results by device type. enum: `ap`, `gateway`, `switch`, `mxedge`'
      - name: mac
        in: query
        description: Filter results by MAC address. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b53010101,5c5b53020202
          - 5c5b53010101
        examples:
          Untitled Example1:
            value: 5c5b53010101,5c5b53020202
          Untitled Example2:
            value: 5c5b53010101
      - name: name
        in: query
        description: Filter results by name. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - name-a,name-b
          - My AP
        examples:
          Untitled Example1:
            value: name-a,name-b
          Untitled Example2:
            value: My AP
      - name: version
        in: query
        description: Filter results by software version. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - apfw-0.15.34615-noro-0a3c,apfw-0.15.34436-noro-d810
          - 10.0.0
        examples:
          Untitled Example1:
            value: apfw-0.15.34615-noro-0a3c,apfw-0.15.34436-noro-d810
          Untitled Example2:
            value: 10.0.0
      - name: cert_expiry_duration
        in: query
        description: 'Duration for expiring cert queries (format: 2d/3h/172800 seconds)'
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 2d
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_config_history_search'
                - description: Paginated device config history search response
                  examples:
                  - end: 1531862583
                    limit: 10
                    results:
                    - channel_24: 11
                      channel_5: 100
                      radio_macs:
                      - 5c5b352e000a
                      - 5c5b352e000b
                      - 5c5b352e000c
                      radios:
                      - band: '24'
                        channel: 11
                      - band: '5'
                        channel: 100
                      secpolicy_violated: false
                      ssids:
                      - test24
                      - test5
                      ssids_24:
                      - test24
                      ssids_5:
                      - test5
                      timestamp: 1531855856.643369
                      version: apfw-0.2.14754-cersei-75c8
                      wlans:
                      - auth: psk
                        bands:
                        - '24'
                        id: be22bba7-8e22-e1cf-5185-b880816fe2cf
                        ssid: test24
                        vlan_ids:
                        - '1'
                      - auth: psk
                        bands:
                        - '5'
                        id: f8c18724-4118-3487-811a-f98964988604
                        ssid: test5
                        vlan_ids:
                        - '1'
                    start: 1531776183
                    total: 1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1531862583
                    limit: 10
                    results:
                    - channel_24: 11
                      channel_5: 100
                      radio_macs:
                      - 5c5b352e000a
                      - 5c5b352e000b
                      - 5c5b352e000c
                      radios:
                      - band: '24'
                        channel: 11
                      - band: '5'
                        channel: 100
                      secpolicy_violated: false
                      ssids:
                      - test24
                      - test5
                      ssids_24:
                      - test24
                      ssids_5:
                      - test5
                      timestamp: 1531855856.643369
                      version: apfw-0.2.14754-cersei-75c8
                      wlans:
                      - auth: psk
                        bands:
                        - '24'
                        id: be22bba7-8e22-e1cf-5185-b880816fe2cf
                        ssid: test24
                        vlan_ids:
                        - '1'
                      - auth: psk
                        bands:
                        - '5'
                        id: f8c18724-4118-3487-811a-f98964988604
                        ssid: test5
                        vlan_ids:
                        - '1'
                    start: 1531776183
                    total: 1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_config_history_search'
                - description: Paginated device config history search response
                  examples:
                  - end: 1531862583
                    limit: 10
                    results:
                    - channel_24: 11
                      channel_5: 100
                      radio_macs:
                      - 5c5b352e000a
                      - 5c5b352e000b
                      - 5c5b352e000c
                      radios:
                      - band: '24'
                        channel: 11
                      - band: '5'
                        channel: 100
                      secpolicy_violated: false
                      ssids:
                      - test24
                      - test5
                      ssids_24:
                      - test24
                      ssids_5:
                      - test5
                      timestamp: 1531855856.643369
                      version: apfw-0.2.14754-cersei-75c8
                      wlans:
                      - auth: psk
                        bands:
                        - '24'
                        id: be22bba7-8e22-e1cf-5185-b880816fe2cf
                        ssid: test24
                        vlan_ids:
                        - '1'
                      - auth: psk
                        bands:
                        - '5'
                        id: f8c18724-4118-3487-811a-f98964988604
                        ssid: test5
                        vlan_ids:
                        - '1'
                    start: 1531776183
                    total: 1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1531862583
                    limit: 10
                    results:
                    - channel_24: 11
                      channel_5: 100
                      radio_macs:
                      - 5c5b352e000a
                      - 5c5b352e000b
                      - 5c5b352e000c
                      radios:
                      - band: '24'
                        channel: 11
                      - band: '5'
                        channel: 100
                      secpolicy_violated: false
                      ssids:
                      - test24
                      - test5
                      ssids_24:
                      - test24
                      ssids_5:
                      - test5
                      timestamp: 1531855856.643369
                      version: apfw-0.2.14754-cersei-75c8
                      wlans:
                      - auth: psk
                        bands:
                        - '24'
                        id: be22bba7-8e22-e1cf-5185-b880816fe2cf
                        ssid: test24
                        vlan_ids:
                        - '1'
                      - auth: psk
                        bands:
                        - '5'
                        id: f8c18724-4118-3487-811a-f98964988604
                        ssid: test5
                        vlan_ids:
                        - '1'
                    start: 1531776183
                    total: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/devices/radio_macs:
    get:
      tags:
      - Orgs Devices
      summary: listOrgApsMacs
      description: >-
        For some scenarios like E911 or security systems, the BSSIDs are required to identify which AP the client is connecting to. Then the location of the AP can be used as the approximate location of the client.


        Each radio MAC can have up to 16 BSSIDs. These are derived by incrementing the least significant hexadecimal digit (last nibble) of the MAC address from 0 to F, while keeping the remaining bits unchanged.
      operationId: listOrgApsMacs
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                minItems: 1
                uniqueItems: true
                type: array
                items:
                  $ref: '#/components/schemas/ap_radio_mac'
                description: Access point radio MAC records supplied in an import payload
                examples:
                - - mac: 5c5b35000001
                    radio_macs:
                    - 5c5b35000040
                    - 5c5b35000050
                    - 5c5b35000060
                  - mac: 5c5b45000001
                    radio_macs:
                    - 5c5b45000040
                    - 5c5b45000050
                    - 5c5b45000060
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - mac: 5c5b35000001
                    radio_macs:
                    - 5c5b35000040
                    - 5c5b35000050
                    - 5c5b35000060
                  - mac: 5c5b45000001
                    radio_macs:
                    - 5c5b45000040
                    - 5c5b45000050
                    - 5c5b45000060
            application/vnd.api+json:
              schema:
                minItems: 1
                uniqueItems: true
                type: array
                items:
                  $ref: '#/components/schemas/ap_radio_mac'
                description: Access point radio MAC records supplied in an import payload
                examples:
                - - mac: 5c5b35000001
                    radio_macs:
                    - 5c5b35000040
                    - 5c5b35000050
                    - 5c5b35000060
                  - mac: 5c5b45000001
                    radio_macs:
                    - 5c5b45000040
                    - 5c5b45000050
                    - 5c5b45000060
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - mac: 5c5b35000001
                    radio_macs:
                    - 5c5b35000040
                    - 5c5b35000050
                    - 5c5b35000060
                  - mac: 5c5b45000001
                    radio_macs:
                    - 5c5b45000040
                    - 5c5b45000050
                    - 5c5b45000060
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/devices/search:
    get:
      tags:
      - Orgs Devices
      summary: searchOrgDevices
      description: Search organization devices with filters for AP radio attributes, gateway HA attributes, switch EVPN attributes, LLDP data, MAC address, IP address, model, software version, site, Mist Edge, and time range. Set `stats=true` to include device stats in the response.
      operationId: searchOrgDevices
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: band_24_channel
        in: query
        description: When `type`==`ap`, Channel of band_24. Accepts multiple comma-separated integer values.
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: band_5_channel
        in: query
        description: When `type`==`ap`, Channel of band_5. Accepts multiple comma-separated integer values.
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: band_6_channel
        in: query
        description: When `type`==`ap`, Channel of band_6. Accepts multiple comma-separated integer values.
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: band_24_bandwidth
        in: query
        description: When `type`==`ap`, Bandwidth of band_24. Accepts multiple comma-separated integer values.
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: band_5_bandwidth
        in: query
        description: When `type`==`ap`, Bandwidth of band_5. Accepts multiple comma-separated integer values.
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: band_6_bandwidth
        in: query
        description: When `type`==`ap`, Bandwidth of band_6. Accepts multiple comma-separated integer values.
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: band_24_power
        in: query
        description: When `type`==`ap`, Power of band_24. Accepts multiple comma-separated integer values.
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: band_5_power
        in: query
        description: When `type`==`ap`, Power of band_5. Accepts multiple comma-separated integer values.
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: band_6_power
        in: query
        description: When `type`==`ap`, Power of band_6. Accepts multiple comma-separated integer values.
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: clustered
        in: query
        description: When `type`==`gateway`, true / false
        style: form
        explode: true
        schema:
          type: boolean
      - name: eth0_port_speed
        in: query
        description: When `type`==`ap`, Port speed of eth0. Accepts multiple comma-separated integer values.
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
          examples:
          - '100'
          - '1000'
        examples:
          Untitled Example2:
            value: 100
          Untitled Example3:
            value: 1000
      - name: evpntopo_id
        in: query
        description: When `type`==`switch`, EVPN topology id
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: uuid
      - name: ext_ip
        in: query
        description: Partial / full Device external ip. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `1.2.3.*` and `*.2.3.*` match `1.2.3.4`). Suffix-only wildcards (e.g. `*.2.3.4`) are not supported. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 1.2.3.4,1.2.3.*
          - 1.2.3.4
          - 1.2.3.*
          - '*2.3.*'
        examples:
          Untitled Example1:
            value: 1.2.3.4,1.2.3.*
          Untitled Example2:
            value: 1.2.3.4
          Untitled Example3:
            value: 1.2.3.*
          Untitled Example4:
            value: '*2.3.*'
      - name: hostname
        in: query
        description: Partial / full Device hostname. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `my-london*` and `*london*` match `my-london-1`). Suffix-only wildcards (e.g. `*london-1`) are not supported. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - my-london-1,my-london*
          - my-london-1
          - my-london*
          - '*london*'
        examples:
          Untitled Example1:
            value: my-london-1,my-london*
          Untitled Example2:
            value: my-london-1
          Untitled Example3:
            value: my-london*
          Untitled Example4:
            value: '*london*'
      - name: ip
        in: query
        description: Partial / full Device IP address. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `10.100.10.*` and `*100.10.*` match `10.100.10.54`). Suffix-only wildcards (e.g. `*.54`) are not supported. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 10.100.10.54,10.100.10.*
          - 10.100.10.54
          - 10.100.10.*
          - '*100.10.*'
        examples:
          Untitled Example1:
            value: 10.100.10.54,10.100.10.*
          Untitled Example2:
            value: 10.100.10.54
          Untitled Example3:
            value: 10.100.10.*
          Untitled Example4:
            value: '*100.10.*'
      - name: last_config_status
        in: query
        description: When `type`==`switch` or `type`==`gateway`, last configuration status
        style: form
        explode: true
        schema:
          type: string
          examples:
          - success
      - name: last_hostname
        in: query
        description: Last hostname of the device. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - ap-01,ap-02
      - name: lldp_mgmt_addr
        in: query
        description: When `type`==`ap`, LLDP management IP address. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 192.0.2.10,192.0.2.11
      - name: lldp_port_id
        in: query
        description: When `type`==`ap`, LLDP port id. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `ge-0/0/*` and `*-0/0/*` match `ge-0/0/30`). Suffix-only wildcards (e.g. `*switch-01`) are not supported. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002
      - name: lldp_system_desc
        in: query
        description: When `type`==`ap`, LLDP system description. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `Juniper Networks*` and `*Networks*` match `Juniper Networks, Inc.`). Suffix-only wildcards (e.g. `*switch-01`) are not supported
        style: form
        explode: true
        schema:
          type: string
      - name: lldp_system_name
        in: query
        description: When `type`==`ap`, LLDP system name. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `my-switch*` and `*switch*` match `my-switch-01`). Suffix-only wildcards (e.g. `*switch-01`) are not supported. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - richmond-hill-switch,Phoenix_Switch
      - name: mac
        in: query
        description: Partial / full Device MAC address. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `001122*` and `*1122*` match `001122334455`). Suffix-only wildcards (e.g. `*4455`) are not supported. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - aabbccddeeff,aabbcc*
          - aabbccddeeff
          - aabbcc*
          - '*bbcc*'
        examples:
          Untitled Example1:
            value: aabbccddeeff,aabbcc*
          Untitled Example2:
            value: aabbccddeeff
          Untitled Example3:
            value: aabbcc*
          Untitled Example4:
            value: '*bbcc*'
      - name: model
        in: query
        description: Partial / full Device model. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `AP4*` and `*P4*` match `AP43`). Suffix-only wildcards (e.g. `*43`) are not supported. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - AP43,AP4*
          - AP43
          - AP4*
          - '*P4*'
        examples:
          Untitled Example1:
            value: AP43,AP4*
          Untitled Example2:
            value: AP43
          Untitled Example3:
            value: AP4*
          Untitled Example4:
            value: '*P4*'
      - name: mxedge_id
        in: query
        description: When `type`==`ap`, Mist Edge id, if AP is connecting to a Mist Edge. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: uuid
      - name: mxedge_ids
        in: query
        description: When `type`==`ap`, Comma separated list of Mist Edge id, if AP is connecting to a Mist Edge
        style: form
        explode: true
        schema:
          type: string
      - name: mxtunnel_status
        in: query
        description: 'When `type`==`ap`, Mist Tunnel status used to filter results. enum: `down`, `up`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/search_org_devices_mxtunnel_status'
          - description: 'When `type`==`ap`, Mist Tunnel status used to filter results. enum: `down`, `up`'
      - name: node
        in: query
        description: 'When `type`==`gateway`. enum: `node0`, `node1`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/ha_cluster_node_enum'
          - description: 'When `type`==`gateway`. enum: `node0`, `node1`'
      - name: node0_mac
        in: query
        description: When `type`==`gateway`, node0 MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: node1_mac
        in: query
        description: When `type`==`gateway`, node1 MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: power_constrained
        in: query
        description: When `type`==`ap`, whether the AP is power constrained.
        style: form
        explode: true
        schema:
          type: boolean
      - name: radius_stats
        in: query
        description: >-
          When `type`==`switch` or `type`==`gateway`, Key-value pairs where the key

          is the RADIUS server address and the value contains authentication statistics:
            * <server_address> (string): IP address of the RADIUS server as the key
            * `auth_accepts` (long): Number of accepted authentication requests
            * `auth_rejects` (long): Number of rejected authentication requests
            * `auth_timeouts` (long): Number of authentication timeouts
            * `auth_server_status` (string): Status of the server. Possible values: `up`, `down`, `unreachable`
        style: form
        explode: true
        schema:
          type: string
      - name: site_id
        in: query
        description: Filter results by site identifier
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 7dae216d-7c98-a51b-e068-dd7d477b7216
      - name: stats
        in: query
        description: Whether to return device stats
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: t128agent_version
        in: query
        description: When `type`==`gateway` (SSR only), version of 128T agent
        style: form
        explode: true
        schema:
          type: string
      - name: type
        in: query
        description: 'Device type used to filter results. enum: `ap`, `gateway`, `switch`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/device_type_default_ap'
          - description: 'Device type used to filter results. enum: `ap`, `gateway`, `switch`'
      - name: version
        in: query
        description: Filter results by software version. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 0.15.34615,0.14.29967
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_device_search'
                - description: Paginated response for organization or site device search results
                  examples:
                  - '{"end":0,"limit":0,"next":"string","results":[{"hostname":["AP41-STB-3E5299-WH-2001","AP41-STB-3E5299-WH-50","AP41-STB-3E5299","5c5b353e5299"],"ip":"10.2.16.205","lldp_mgmt_addr":"10.2.10.139","lldp_port_desc":"GigabitEthernet1/0/1","lldp_port_id":"Gi1/0/1","lldp_system_desc":"Cisco IOS Software, C2960S Software (C2960S-UNIVERSALK9-M), Version 15.2(1)E1, RELEASE SOFTWARE (fc2)\nTechnical Support: https://www.cisco.com/techsupport\nCopyright (c) 1986-2013 by Cisco Systems, Inc.\nCompiled Fri 22-Nov-13 07:10 by prod_rel_team","lldp_system_name":"ME-DC-1-ACC-SW","mac":"5c5b353e5299","model":"AP41","mxedge_id":"00000000-0000-0000-1000-43a81f238391","mxtunnel_status":"down","org_id":"6748cfa6-4e12-11e6-9188-0242ac110007","power_constrained":false,"power_opmode":"","site_id":"a8178443-ecb5-461c-b854-f16627619ab3","sku":"AP41-US","timestamp":1596588619.007,"uptime":85280,"version":"0.7.20216","wlans":[{"id":"28c36fc7-dc22-4960-9d81-34087511c2e5","ssid":"Live-Demo-NAC"},{"id":"51b82e2b-f9e8-470b-a32a-cecde5501b0f","ssid":"Live-Demo"}]}],"start":0,"total":0}'
                  - '{"end":0,"limit":0,"next":"string","results":[{"clustered":true,"evpn_missing_links":false,"evpntopo_id":"","ext_ip":"250.242.0.102","hostname":["wan-teleworker","00ec77599d00","router"],"ip":"250.242.0.102","last_config_status":"success","last_hostname":"wan-teleworker","mac":"00ec77599d00","mist_configured":true,"model":"SSR120","node":"node1","node0_mac":"00ec77599d00","node1_mac":"00ec77599d01","num_members":0,"org_id":"6748cfa6-4e12-11e6-9188-0242ac110007","role":"","site_id":"a8178443-ecb5-461c-b854-f16627619ab3","t128agent_version":"3.8.0-201","time_drifted":false,"timestamp":1734001399.025,"type":"gateway","uptime":3586951,"version":"6.2.5-5.r2"}],"start":0,"total":0}'
                  - '{"end":0,"limit":0,"next":"string","results":[{"clustered":false,"evpn_missing_links":false,"evpntopo_id":"","ext_ip":"0.0.0.0","hostname":["ld-cup-idf-bbb"],"ip":"10.0.0.217","last_config_status":"success","last_hostname":"ld-cup-idf-bbb","last_trouble_code":"106","last_trouble_timestamp":1719540,"mac":"00c78d939c00","mist_configured":true,"model":"EX4100-48MP","num_members":1,"org_id":"6748cfa6-4e12-11e6-9188-0242ac110007","role":"","site_id":"a8178443-ecb5-461c-b854-f16627619ab3","time_drifted":false,"timestamp":1733998766.256,"type":"switch","uptime":19287811,"version":"22.4R3.25"}],"start":0,"total":0}'
                contentMediaType: application/json
              examples:
                Ap:
                  value:
                    end: 0
                    limit: 0
                    next: string
                    results:
                    - hostname:
                      - AP41-STB-3E5299-WH-2001
                      - AP41-STB-3E5299-WH-50
                      - AP41-STB-3E5299
                      - 5c5b353e5299
                      ip: 10.2.16.205
                      lldp_mgmt_addr: 10.2.10.139
                      lldp_port_desc: GigabitEthernet1/0/1
                      lldp_port_id: Gi1/0/1
                      lldp_system_desc: >-
                        Cisco IOS Software, C2960S Software (C2960S-UNIVERSALK9-M), Version 15.2(1)E1, RELEASE SOFTWARE (fc2)

                        Technical Support: https://www.cisco.com/techsupport

                        Copyright (c) 1986-2013 by Cisco Systems, Inc.

                        Compiled Fri 22-Nov-13 07:10 by prod_rel_team
                      lldp_system_name: ME-DC-1-ACC-SW
                      mac: 5c5b353e5299
                      model: AP41
                      mxedge_id: 00000000-0000-0000-1000-43a81f238391
                      mxtunnel_status: down
                      org_id: 6748cfa6-4e12-11e6-9188-0242ac110007
                      power_constrained: false
                      power_opmode: ''
                      site_id: a8178443-ecb5-461c-b854-f16627619ab3
                      sku: AP41-US
                      timestamp: 1596588619.007
                      uptime: 85280
                      version: 0.7.20216
                      wlans:
                      - id: 28c36fc7-dc22-4960-9d81-34087511c2e5
                        ssid: Live-Demo-NAC
                      - id: 51b82e2b-f9e8-470b-a32a-cecde5501b0f
                        ssid: Live-Demo
                    start: 0
                    total: 0
                Gateway:
                  value:
                    end: 0
                    limit: 0
                    next: string
                    results:
                    - clustered: true
                      evpn_missing_links: false
                      evpntopo_id: ''
                      ext_ip: 250.242.0.102
                      hostname:
                      - wan-teleworker
                      - 00ec77599d00
                      - router
                      ip: 250.242.0.102
                      last_config_status: success
                      last_hostname: wan-teleworker
                      mac: 00ec77599d00
                      mist_configured: true
                      model: SSR120
                      node: node1
                      node0_mac: 00ec77599d00
                      node1_mac: 00ec77599d01
                      num_members: 0
                      org_id: 6748cfa6-4e12-11e6-9188-0242ac110007
                      role: ''
                      site_id: a8178443-ecb5-461c-b854-f16627619ab3
                      t128agent_version: 3.8.0-201
                      time_drifted: false
                      timestamp: 1734001399.025
                      type: gateway
                      uptime: 3586951
                      version: 6.2.5-5.r2
                    start: 0
                    total: 0
                Switch:
                  value:
                    end: 0
                    limit: 0
                    next: string
                    results:
                    - clustered: false
                      evpn_missing_links: false
                      evpntopo_id: ''
                      ext_ip: 0.0.0.0
                      hostname:
                      - ld-cup-idf-bbb
                      ip: 10.0.0.217
                      last_config_status: success
                      last_hostname: ld-cup-idf-bbb
                      last_trouble_code: '106'
                      last_trouble_timestamp: 1719540
                      mac: 00c78d939c00
                      mist_configured: true
                      model: EX4100-48MP
                      num_members: 1
                      org_id: 6748cfa6-4e12-11e6-9188-0242ac110007
                      role: ''
                      site_id: a8178443-ecb5-461c-b854-f16627619ab3
                      time_drifted: false
                      timestamp: 1733998766.256
                      type: switch
                      uptime: 19287811
                      version: 22.4R3.25
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_device_search'
                - description: Paginated response for organization or site device search results
                  examples:
                  - '{"end":0,"limit":0,"next":"string","results":[{"hostname":["AP41-STB-3E5299-WH-2001","AP41-STB-3E5299-WH-50","AP41-STB-3E5299","5c5b353e5299"],"ip":"10.2.16.205","lldp_mgmt_addr":"10.2.10.139","lldp_port_desc":"GigabitEthernet1/0/1","lldp_port_id":"Gi1/0/1","lldp_system_desc":"Cisco IOS Software, C2960S Software (C2960S-UNIVERSALK9-M), Version 15.2(1)E1, RELEASE SOFTWARE (fc2)\nTechnical Support: https://www.cisco.com/techsupport\nCopyright (c) 1986-2013 by Cisco Systems, Inc.\nCompiled Fri 22-Nov-13 07:10 by prod_rel_team","lldp_system_name":"ME-DC-1-ACC-SW","mac":"5c5b353e5299","model":"AP41","mxedge_id":"00000000-0000-0000-1000-43a81f238391","mxtunnel_status":"down","org_id":"6748cfa6-4e12-11e6-9188-0242ac110007","power_constrained":false,"power_opmode":"","site_id":"a8178443-ecb5-461c-b854-f16627619ab3","sku":"AP41-US","timestamp":1596588619.007,"uptime":85280,"version":"0.7.20216","wlans":[{"id":"28c36fc7-dc22-4960-9d81-34087511c2e5","ssid":"Live-Demo-NAC"},{"id":"51b82e2b-f9e8-470b-a32a-cecde5501b0f","ssid":"Live-Demo"}]}],"start":0,"total":0}'
                  - '{"end":0,"limit":0,"next":"string","results":[{"clustered":true,"evpn_missing_links":false,"evpntopo_id":"","ext_ip":"250.242.0.102","hostname":["wan-teleworker","00ec77599d00","router"],"ip":"250.242.0.102","last_config_status":"success","last_hostname":"wan-teleworker","mac":"00ec77599d00","mist_configured":true,"model":"SSR120","node":"node1","node0_mac":"00ec77599d00","node1_mac":"00ec77599d01","num_members":0,"org_id":"6748cfa6-4e12-11e6-9188-0242ac110007","role":"","site_id":"a8178443-ecb5-461c-b854-f16627619ab3","t128agent_version":"3.8.0-201","time_drifted":false,"timestamp":1734001399.025,"type":"gateway","uptime":3586951,"version":"6.2.5-5.r2"}],"start":0,"total":0}'
                  - '{"end":0,"limit":0,"next":"string","results":[{"clustered":false,"evpn_missing_links":false,"evpntopo_id":"","ext_ip":"0.0.0.0","hostname":["ld-cup-idf-bbb"],"ip":"10.0.0.217","last_config_status":"success","last_hostname":"ld-cup-idf-bbb","last_trouble_code":"106","last_trouble_timestamp":1719540,"mac":"00c78d939c00","mist_configured":true,"model":"EX4100-48MP","num_members":1,"org_id":"6748cfa6-4e12-11e6-9188-0242ac110007","role":"","site_id":"a8178443-ecb5-461c-b854-f16627619ab3","time_drifted":false,"timestamp":1733998766.256,"type":"switch","uptime":19287811,"version":"22.4R3.25"}],"start":0,"total":0}'
                contentMediaType: application/vnd.api+json
              examples:
                Ap:
                  value:
                    end: 0
                    limit: 0
                    next: string
                    results:
                    - hostname:
                      - AP41-STB-3E5299-WH-2001
                      - AP41-STB-3E5299-WH-50
                      - AP41-STB-3E5299
                      - 5c5b353e5299
                      ip: 10.2.16.205
                      lldp_mgmt_addr: 10.2.10.139
                      lldp_port_desc: GigabitEthernet1/0/1
                      lldp_port_id: Gi1/0/1
                      lldp_system_desc: >-
                        Cisco IOS Software, C2960S Software (C2960S-UNIVERSALK9-M), Version 15.2(1)E1, RELEASE SOFTWARE (fc2)

                        Technical Support: https://www.cisco.com/techsupport

                        Copyright (c) 1986-2013 by Cisco Systems, Inc.

                        Compiled Fri 22-Nov-13 07:10 by prod_rel_team
                      lldp_system_name: ME-DC-1-ACC-SW
                      mac: 5c5b353e5299
                      model: AP41
                      mxedge_id: 00000000-0000-0000-1000-43a81f238391
                      mxtunnel_status: down
                      org_id: 6748cfa6-4e12-11e6-9188-0242ac110007
                      power_constrained: false
                      power_opmode: ''
                      site_id: a8178443-ecb5-461c-b854-f16627619ab3
                      sku: AP41-US
                      timestamp: 1596588619.007
                      uptime: 85280
                      version: 0.7.20216
                      wlans:
                      - id: 28c36fc7-dc22-4960-9d81-34087511c2e5
                        ssid: Live-Demo-NAC
                      - id: 51b82e2b-f9e8-470b-a32a-cecde5501b0f
                        ssid: Live-Demo
                    start: 0
                    total: 0
                Gateway:
                  value:
                    end: 0
                    limit: 0
                    next: string
                    results:
                    - clustered: true
                      evpn_missing_links: false
                      evpntopo_id: ''
                      ext_ip: 250.242.0.102
                      hostname:
                      - wan-teleworker
                      - 00ec77599d00
                      - router
                      ip: 250.242.0.102
                      last_config_status: success
                      last_hostname: wan-teleworker
                      mac: 00ec77599d00
                      mist_configured: true
                      model: SSR120
                      node: node1
                      node0_mac: 00ec77599d00
                      node1_mac: 00ec77599d01
                      num_members: 0
                      org_id: 6748cfa6-4e12-11e6-9188-0242ac110007
                      role: ''
                      site_id: a8178443-ecb5-461c-b854-f16627619ab3
                      t128agent_version: 3.8.0-201
                      time_drifted: false
                      timestamp: 1734001399.025
                      type: gateway
                      uptime: 3586951
                      version: 6.2.5-5.r2
                    start: 0
                    total: 0
                Switch:
                  value:
                    end: 0
                    limit: 0
                    next: string
                    results:
                    - clustered: false
                      evpn_missing_links: false
                      evpntopo_id: ''
                      ext_ip: 0.0.0.0
                      hostname:
                      - ld-cup-idf-bbb
                      ip: 10.0.0.217
                      last_config_status: success
                      last_hostname: ld-cup-idf-bbb
                      last_trouble_code: '106'
                      last_trouble_timestamp: 1719540
                      mac: 00c78d939c00
                      mist_configured: true
                      model: EX4100-48MP
                      num_members: 1
                      org_id: 6748cfa6-4e12-11e6-9188-0242ac110007
                      role: ''
                      site_id: a8178443-ecb5-461c-b854-f16627619ab3
                      time_drifted: false
                      timestamp: 1733998766.256
                      type: switch
                      uptime: 19287811
                      version: 22.4R3.25
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/devices/summary:
    get:
      tags:
      - Orgs Devices
      summary: listOrgDevicesSummary
      description: Return aggregate organization device counts by device category and assignment state.
      operationId: listOrgDevicesSummary
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_org_devices_summary'
                - description: Organization device count summary
                  examples:
                  - num_aps: 630
                    num_gateways: 6
                    num_mxedges: 1
                    num_switches: 30
                    num_unassigned_aps: 5
                    num_unassigned_gateways: 0
                    num_unassigned_switches: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    num_aps: 630
                    num_gateways: 6
                    num_mxedges: 1
                    num_switches: 30
                    num_unassigned_aps: 5
                    num_unassigned_gateways: 0
                    num_unassigned_switches: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_org_devices_summary'
                - description: Organization device count summary
                  examples:
                  - num_aps: 630
                    num_gateways: 6
                    num_mxedges: 1
                    num_switches: 30
                    num_unassigned_aps: 5
                    num_unassigned_gateways: 0
                    num_unassigned_switches: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    num_aps: 630
                    num_gateways: 6
                    num_mxedges: 1
                    num_switches: 30
                    num_unassigned_aps: 5
                    num_unassigned_gateways: 0
                    num_unassigned_switches: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/ocdevices/outbound_ssh_cmd:
    get:
      tags:
      - Orgs Devices
      summary: getOrgJuniperDevicesCommand
      description: >-
        Get Org Juniper Devices command


        Juniper devices can be managed/adopted by Mist. Currently outbound-ssh + netconf is used.

        A few lines of CLI commands are generated per-Org, allowing the Juniper devices to phone home to Mist.
      operationId: getOrgJuniperDevicesCommand
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: site_id
        in: query
        description: Filter results by site identifier
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_device_config_cmd'
                - description: Device configuration command response
                  examples:
                  - cmd: >-
                      set system services ssh...

                      ...

                      set system services outbound-ssh client mist ...
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    cmd: >-
                      set system services ssh...

                      ...

                      set system services outbound-ssh client mist ...
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_device_config_cmd'
                - description: Device configuration command response
                  examples:
                  - cmd: >-
                      set system services ssh...

                      ...

                      set system services outbound-ssh client mist ...
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    cmd: >-
                      set system services ssh...

                      ...

                      set system services outbound-ssh client mist ...
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/128routers/register_cmd:
    get:
      tags:
      - Orgs Devices - SSR
      summary: getOrg128TRegistrationCommands
      description: 128T devices can be managed/adopted by Mist.
      operationId: getOrg128TRegistrationCommands
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: ttl
        in: query
        description: Token validity duration in seconds. Defaults to 1 year (31536000 seconds)
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
          examples:
          - 31536000
      - name: asset_ids
        in: query
        description: When specified restricts registration to listed assets only. Prefer HTTP body over headers for this parameter, especially with long lists to avoid header size limits.
        style: form
        explode: true
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_router_ssr_register_cmd'
                - description: SSR registration token and commands used to register the router with Mist
                  examples:
                  - conductor_cmd: register mist eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvcmdfaWQiOiIyODE4ZTM4Ni04ZGVjLTI1NjItOWVkZS01YjhhMGZiYmRjNzEiLCJzdmMiOiIxMjhyb3V0ZXIiLCJwcm92aWRlciI6ImF3cyIsImVudiI6ImxvY2FsIiwiZXB0ZXJtX3VybCI6IndzczovL2xvY2FsL3dzIiwiaWF0IjoxNjEzODQ3NDg0LCJleHAiOjE2NDUzODM0ODR9.YnhgThKYAj1uaooi6j-zY8dMipp5YqJxnn79B9TB5XQ
                    registration_code: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvcmdfaWQiOiIyODE4ZTM4Ni04ZGVjLTI1NjItOWVkZS01YjhhMGZiYmRjNzEiLCJzdmMiOiIxMjhyb3V0ZXIiLCJwcm92aWRlciI6ImF3cyIsImVudiI6ImxvY2FsIiwiZXB0ZXJtX3VybCI6IndzczovL2xvY2FsL3dzIiwiaWF0IjoxNjEzODQ3NDg0LCJleHAiOjE2NDUzODM0ODR9.YnhgThKYAj1uaooi6j-zY8dMipp5YqJxnn79B9TB5XQ
                    router_shell_cmd: 128agent register --registration-code eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvcmdfaWQiOiIyODE4ZTM4Ni04ZGVjLTI1NjItOWVkZS01YjhhMGZiYmRjNzEiLCJzdmMiOiIxMjhyb3V0ZXIiLCJwcm92aWRlciI6ImF3cyIsImVudiI6ImxvY2FsIiwiZXB0ZXJtX3VybCI6IndzczovL2xvY2FsL3dzIiwiaWF0IjoxNjEzODQ3NDg0LCJleHAiOjE2NDUzODM0ODR9.YnhgThKYAj1uaooi6j-zY8dMipp5YqJxnn79B9TB5XQ
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    conductor_cmd: register mist eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvcmdfaWQiOiIyODE4ZTM4Ni04ZGVjLTI1NjItOWVkZS01YjhhMGZiYmRjNzEiLCJzdmMiOiIxMjhyb3V0ZXIiLCJwcm92aWRlciI6ImF3cyIsImVudiI6ImxvY2FsIiwiZXB0ZXJtX3VybCI6IndzczovL2xvY2FsL3dzIiwiaWF0IjoxNjEzODQ3NDg0LCJleHAiOjE2NDUzODM0ODR9.YnhgThKYAj1uaooi6j-zY8dMipp5YqJxnn79B9TB5XQ
                    registration_code: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvcmdfaWQiOiIyODE4ZTM4Ni04ZGVjLTI1NjItOWVkZS01YjhhMGZiYmRjNzEiLCJzdmMiOiIxMjhyb3V0ZXIiLCJwcm92aWRlciI6ImF3cyIsImVudiI6ImxvY2FsIiwiZXB0ZXJtX3VybCI6IndzczovL2xvY2FsL3dzIiwiaWF0IjoxNjEzODQ3NDg0LCJleHAiOjE2NDUzODM0ODR9.YnhgThKYAj1uaooi6j-zY8dMipp5YqJxnn79B9TB5XQ
                    router_shell_cmd: 128agent register --registration-code eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvcmdfaWQiOiIyODE4ZTM4Ni04ZGVjLTI1NjItOWVkZS01YjhhMGZiYmRjNzEiLCJzdmMiOiIxMjhyb3V0ZXIiLCJwcm92aWRlciI6ImF3cyIsImVudiI6ImxvY2FsIiwiZXB0ZXJtX3VybCI6IndzczovL2xvY2FsL3dzIiwiaWF0IjoxNjEzODQ3NDg0LCJleHAiOjE2NDUzODM0ODR9.YnhgThKYAj1uaooi6j-zY8dMipp5YqJxnn79B9TB5XQ
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_router_ssr_register_cmd'
                - description: SSR registration token and commands used to register the router with Mist
                  examples:
                  - conductor_cmd: register mist eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvcmdfaWQiOiIyODE4ZTM4Ni04ZGVjLTI1NjItOWVkZS01YjhhMGZiYmRjNzEiLCJzdmMiOiIxMjhyb3V0ZXIiLCJwcm92aWRlciI6ImF3cyIsImVudiI6ImxvY2FsIiwiZXB0ZXJtX3VybCI6IndzczovL2xvY2FsL3dzIiwiaWF0IjoxNjEzODQ3NDg0LCJleHAiOjE2NDUzODM0ODR9.YnhgThKYAj1uaooi6j-zY8dMipp5YqJxnn79B9TB5XQ
                    registration_code: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvcmdfaWQiOiIyODE4ZTM4Ni04ZGVjLTI1NjItOWVkZS01YjhhMGZiYmRjNzEiLCJzdmMiOiIxMjhyb3V0ZXIiLCJwcm92aWRlciI6ImF3cyIsImVudiI6ImxvY2FsIiwiZXB0ZXJtX3VybCI6IndzczovL2xvY2FsL3dzIiwiaWF0IjoxNjEzODQ3NDg0LCJleHAiOjE2NDUzODM0ODR9.YnhgThKYAj1uaooi6j-zY8dMipp5YqJxnn79B9TB5XQ
                    router_shell_cmd: 128agent register --registration-code eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvcmdfaWQiOiIyODE4ZTM4Ni04ZGVjLTI1NjItOWVkZS01YjhhMGZiYmRjNzEiLCJzdmMiOiIxMjhyb3V0ZXIiLCJwcm92aWRlciI6ImF3cyIsImVudiI6ImxvY2FsIiwiZXB0ZXJtX3VybCI6IndzczovL2xvY2FsL3dzIiwiaWF0IjoxNjEzODQ3NDg0LCJleHAiOjE2NDUzODM0ODR9.YnhgThKYAj1uaooi6j-zY8dMipp5YqJxnn79B9TB5XQ
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    conductor_cmd: register mist eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvcmdfaWQiOiIyODE4ZTM4Ni04ZGVjLTI1NjItOWVkZS01YjhhMGZiYmRjNzEiLCJzdmMiOiIxMjhyb3V0ZXIiLCJwcm92aWRlciI6ImF3cyIsImVudiI6ImxvY2FsIiwiZXB0ZXJtX3VybCI6IndzczovL2xvY2FsL3dzIiwiaWF0IjoxNjEzODQ3NDg0LCJleHAiOjE2NDUzODM0ODR9.YnhgThKYAj1uaooi6j-zY8dMipp5YqJxnn79B9TB5XQ
                    registration_code: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvcmdfaWQiOiIyODE4ZTM4Ni04ZGVjLTI1NjItOWVkZS01YjhhMGZiYmRjNzEiLCJzdmMiOiIxMjhyb3V0ZXIiLCJwcm92aWRlciI6ImF3cyIsImVudiI6ImxvY2FsIiwiZXB0ZXJtX3VybCI6IndzczovL2xvY2FsL3dzIiwiaWF0IjoxNjEzODQ3NDg0LCJleHAiOjE2NDUzODM0ODR9.YnhgThKYAj1uaooi6j-zY8dMipp5YqJxnn79B9TB5XQ
                    router_shell_cmd: 128agent register --registration-code eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvcmdfaWQiOiIyODE4ZTM4Ni04ZGVjLTI1NjItOWVkZS01YjhhMGZiYmRjNzEiLCJzdmMiOiIxMjhyb3V0ZXIiLCJwcm92aWRlciI6ImF3cyIsImVudiI6ImxvY2FsIiwiZXB0ZXJtX3VybCI6IndzczovL2xvY2FsL3dzIiwiaWF0IjoxNjEzODQ3NDg0LCJleHAiOjE2NDUzODM0ODR9.YnhgThKYAj1uaooi6j-zY8dMipp5YqJxnn79B9TB5XQ
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: true
    parameters: []
  /api/v1/orgs/{org_id}/ssr/export_idtokens:
    post:
      tags:
      - Orgs Devices - SSR
      summary: exportOrgSsrIdTokens
      description: Export SSR ID tokens for the requested device MAC addresses so they can be imported into Conductor during SSR onboarding.
      operationId: exportOrgSsrIdTokens
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/mac_addresses'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_ssr_export_id_tokens'
                - description: Response containing SSR ID tokens exported for device onboarding
                  examples:
                  - results:
                    - mac: 025b35000020
                      token: string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    results:
                    - mac: 025b35000020
                      token: string
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_ssr_export_id_tokens'
                - description: Response containing SSR ID tokens exported for device onboarding
                  examples:
                  - results:
                    - mac: 025b35000020
                      token: string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    results:
                    - mac: 025b35000020
                      token: string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/ssr/register_cmd:
    get:
      tags:
      - Orgs Devices - SSR
      summary: getOrgSsrRegistrationCommands
      description: Return the registration token and conductor or router commands used to register SSR routers with Mist. The optional TTL controls token validity, and asset IDs can restrict registration to specific assets.
      operationId: getOrgSsrRegistrationCommands
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: ttl
        in: query
        description: Token validity duration in seconds. Defaults to 1 year (31536000 seconds)
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
          examples:
          - 31536000
      - name: asset_ids
        in: query
        description: When specified restricts registration to listed assets only. Prefer HTTP body over headers for this parameter, especially with long lists to avoid header size limits.
        style: form
        explode: true
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_router_ssr_register_cmd'
                - description: SSR registration token and commands used to register the router with Mist
                  examples:
                  - conductor_cmd: register mist eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvcmdfaWQiOiIyODE4ZTM4Ni04ZGVjLTI1NjItOWVkZS01YjhhMGZiYmRjNzEiLCJzdmMiOiIxMjhyb3V0ZXIiLCJwcm92aWRlciI6ImF3cyIsImVudiI6ImxvY2FsIiwiZXB0ZXJtX3VybCI6IndzczovL2xvY2FsL3dzIiwiaWF0IjoxNjEzODQ3NDg0LCJleHAiOjE2NDUzODM0ODR9.YnhgThKYAj1uaooi6j-zY8dMipp5YqJxnn79B9TB5XQ
                    registration_code: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvcmdfaWQiOiIyODE4ZTM4Ni04ZGVjLTI1NjItOWVkZS01YjhhMGZiYmRjNzEiLCJzdmMiOiIxMjhyb3V0ZXIiLCJwcm92aWRlciI6ImF3cyIsImVudiI6ImxvY2FsIiwiZXB0ZXJtX3VybCI6IndzczovL2xvY2FsL3dzIiwiaWF0IjoxNjEzODQ3NDg0LCJleHAiOjE2NDUzODM0ODR9.YnhgThKYAj1uaooi6j-zY8dMipp5YqJxnn79B9TB5XQ
                    router_shell_cmd: 128agent register --registration-code eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvcmdfaWQiOiIyODE4ZTM4Ni04ZGVjLTI1NjItOWVkZS01YjhhMGZiYmRjNzEiLCJzdmMiOiIxMjhyb3V0ZXIiLCJwcm92aWRlciI6ImF3cyIsImVudiI6ImxvY2FsIiwiZXB0ZXJtX3VybCI6IndzczovL2xvY2FsL3dzIiwiaWF0IjoxNjEzODQ3NDg0LCJleHAiOjE2NDUzODM0ODR9.YnhgThKYAj1uaooi6j-zY8dMipp5YqJxnn79B9TB5XQ
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    conductor_cmd: register mist eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvcmdfaWQiOiIyODE4ZTM4Ni04ZGVjLTI1NjItOWVkZS01YjhhMGZiYmRjNzEiLCJzdmMiOiIxMjhyb3V0ZXIiLCJwcm92aWRlciI6ImF3cyIsImVudiI6ImxvY2FsIiwiZXB0ZXJtX3VybCI6IndzczovL2xvY2FsL3dzIiwiaWF0IjoxNjEzODQ3NDg0LCJleHAiOjE2NDUzODM0ODR9.YnhgThKYAj1uaooi6j-zY8dMipp5YqJxnn79B9TB5XQ
                    registration_code: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvcmdfaWQiOiIyODE4ZTM4Ni04ZGVjLTI1NjItOWVkZS01YjhhMGZiYmRjNzEiLCJzdmMiOiIxMjhyb3V0ZXIiLCJwcm92aWRlciI6ImF3cyIsImVudiI6ImxvY2FsIiwiZXB0ZXJtX3VybCI6IndzczovL2xvY2FsL3dzIiwiaWF0IjoxNjEzODQ3NDg0LCJleHAiOjE2NDUzODM0ODR9.YnhgThKYAj1uaooi6j-zY8dMipp5YqJxnn79B9TB5XQ
                    router_shell_cmd: 128agent register --registration-code eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvcmdfaWQiOiIyODE4ZTM4Ni04ZGVjLTI1NjItOWVkZS01YjhhMGZiYmRjNzEiLCJzdmMiOiIxMjhyb3V0ZXIiLCJwcm92aWRlciI6ImF3cyIsImVudiI6ImxvY2FsIiwiZXB0ZXJtX3VybCI6IndzczovL2xvY2FsL3dzIiwiaWF0IjoxNjEzODQ3NDg0LCJleHAiOjE2NDUzODM0ODR9.YnhgThKYAj1uaooi6j-zY8dMipp5YqJxnn79B9TB5XQ
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_router_ssr_register_cmd'
                - description: SSR registration token and commands used to register the router with Mist
                  examples:
                  - conductor_cmd: register mist eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvcmdfaWQiOiIyODE4ZTM4Ni04ZGVjLTI1NjItOWVkZS01YjhhMGZiYmRjNzEiLCJzdmMiOiIxMjhyb3V0ZXIiLCJwcm92aWRlciI6ImF3cyIsImVudiI6ImxvY2FsIiwiZXB0ZXJtX3VybCI6IndzczovL2xvY2FsL3dzIiwiaWF0IjoxNjEzODQ3NDg0LCJleHAiOjE2NDUzODM0ODR9.YnhgThKYAj1uaooi6j-zY8dMipp5YqJxnn79B9TB5XQ
                    registration_code: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvcmdfaWQiOiIyODE4ZTM4Ni04ZGVjLTI1NjItOWVkZS01YjhhMGZiYmRjNzEiLCJzdmMiOiIxMjhyb3V0ZXIiLCJwcm92aWRlciI6ImF3cyIsImVudiI6ImxvY2FsIiwiZXB0ZXJtX3VybCI6IndzczovL2xvY2FsL3dzIiwiaWF0IjoxNjEzODQ3NDg0LCJleHAiOjE2NDUzODM0ODR9.YnhgThKYAj1uaooi6j-zY8dMipp5YqJxnn79B9TB5XQ
                    router_shell_cmd: 128agent register --registration-code eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvcmdfaWQiOiIyODE4ZTM4Ni04ZGVjLTI1NjItOWVkZS01YjhhMGZiYmRjNzEiLCJzdmMiOiIxMjhyb3V0ZXIiLCJwcm92aWRlciI6ImF3cyIsImVudiI6ImxvY2FsIiwiZXB0ZXJtX3VybCI6IndzczovL2xvY2FsL3dzIiwiaWF0IjoxNjEzODQ3NDg0LCJleHAiOjE2NDUzODM0ODR9.YnhgThKYAj1uaooi6j-zY8dMipp5YqJxnn79B9TB5XQ
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    conductor_cmd: register mist eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvcmdfaWQiOiIyODE4ZTM4Ni04ZGVjLTI1NjItOWVkZS01YjhhMGZiYmRjNzEiLCJzdmMiOiIxMjhyb3V0ZXIiLCJwcm92aWRlciI6ImF3cyIsImVudiI6ImxvY2FsIiwiZXB0ZXJtX3VybCI6IndzczovL2xvY2FsL3dzIiwiaWF0IjoxNjEzODQ3NDg0LCJleHAiOjE2NDUzODM0ODR9.YnhgThKYAj1uaooi6j-zY8dMipp5YqJxnn79B9TB5XQ
                    registration_code: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvcmdfaWQiOiIyODE4ZTM4Ni04ZGVjLTI1NjItOWVkZS01YjhhMGZiYmRjNzEiLCJzdmMiOiIxMjhyb3V0ZXIiLCJwcm92aWRlciI6ImF3cyIsImVudiI6ImxvY2FsIiwiZXB0ZXJtX3VybCI6IndzczovL2xvY2FsL3dzIiwiaWF0IjoxNjEzODQ3NDg0LCJleHAiOjE2NDUzODM0ODR9.YnhgThKYAj1uaooi6j-zY8dMipp5YqJxnn79B9TB5XQ
                    router_shell_cmd: 128agent register --registration-code eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvcmdfaWQiOiIyODE4ZTM4Ni04ZGVjLTI1NjItOWVkZS01YjhhMGZiYmRjNzEiLCJzdmMiOiIxMjhyb3V0ZXIiLCJwcm92aWRlciI6ImF3cyIsImVudiI6ImxvY2FsIiwiZXB0ZXJtX3VybCI6IndzczovL2xvY2FsL3dzIiwiaWF0IjoxNjEzODQ3NDg0LCJleHAiOjE2NDUzODM0ODR9.YnhgThKYAj1uaooi6j-zY8dMipp5YqJxnn79B9TB5XQ
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/aoscx/register_cmd:
    get:
      tags:
      - Orgs Devices - AOSCX
      summary: getOrgAoscxRegisterCmd
      description: Generates a registration challenge token for TPM-based brownfield registration of AOSCX devices. The returned command string can be copied and pasted directly into an AOSCX device to register it with Mist.
      operationId: getOrgAoscxRegisterCmd
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: AOSCX Brownfield Registration Commands
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aoscx_register_cmd'
                - description: AOSCX Brownfield Registration Commands
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aoscx_register_cmd'
                - description: AOSCX Brownfield Registration Commands
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/edgeconnect/register_cmd:
    get:
      tags:
      - Orgs Devices - EdgeConnect
      summary: getOrgEdgeconnectRegisterCmd
      description: Returns a registration code for adopting an EdgeConnect device into Mist.
      operationId: getOrgEdgeconnectRegisterCmd
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: EdgeConnect Registration Command
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/edgeconnect_register_cmd'
                - description: EdgeConnect device registration command response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/edgeconnect_register_cmd'
                - description: EdgeConnect device registration command response
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/evpn_topologies:
    get:
      tags:
      - Orgs EVPN Topologies
      summary: listOrgEvpnTopologies
      description: List EVPN topology records in the organization, optionally filtering for org-level, site-level, or all topologies with `for_site`.
      operationId: listOrgEvpnTopologies
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: for_site
        in: query
        description: 'Filter for org/site level EVPN topologies. enum: `any`, `false`, `true`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/mxedge_for_site'
          - description: 'Filter for org/site level EVPN topologies. enum: `any`, `false`, `true`'
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/evpn_topology_response'
                description: EVPN topology records returned by list APIs
                examples:
                - - created_time: 1736421230
                    evpn_options:
                      auto_loopback_subnet: 172.16.192.0/24
                      auto_loopback_subnet6: fd33:ab00:2::/64
                      auto_router_id_subnet: 172.16.254.0/23
                      core_as_border: true
                      overlay:
                        as: 65000
                      per_vlan_vga_v4_mac: false
                      routed_at: core
                      underlay:
                        as_base: 65001
                        subnet: 10.255.240.0/20
                        use_ipv6: false
                    for_site: false
                    id: 764fb173-94f9-447c-8454-def62e5a999f
                    modified_time: 1736421230
                    name: tert
                    org_id: 3a2627d7-bfbc-45af-b85d-8841581c6d63
                    pod_names:
                      '1': Pod 1
                    site_id: 00000000-0000-0000-0000-000000000000
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 1736421230
                    evpn_options:
                      auto_loopback_subnet: 172.16.192.0/24
                      auto_loopback_subnet6: fd33:ab00:2::/64
                      auto_router_id_subnet: 172.16.254.0/23
                      core_as_border: true
                      overlay:
                        as: 65000
                      per_vlan_vga_v4_mac: false
                      routed_at: core
                      underlay:
                        as_base: 65001
                        subnet: 10.255.240.0/20
                        use_ipv6: false
                    for_site: false
                    id: 764fb173-94f9-447c-8454-def62e5a999f
                    modified_time: 1736421230
                    name: tert
                    org_id: 3a2627d7-bfbc-45af-b85d-8841581c6d63
                    pod_names:
                      '1': Pod 1
                    site_id: 00000000-0000-0000-0000-000000000000
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/evpn_topology_response'
                description: EVPN topology records returned by list APIs
                examples:
                - - created_time: 1736421230
                    evpn_options:
                      auto_loopback_subnet: 172.16.192.0/24
                      auto_loopback_subnet6: fd33:ab00:2::/64
                      auto_router_id_subnet: 172.16.254.0/23
                      core_as_border: true
                      overlay:
                        as: 65000
                      per_vlan_vga_v4_mac: false
                      routed_at: core
                      underlay:
                        as_base: 65001
                        subnet: 10.255.240.0/20
                        use_ipv6: false
                    for_site: false
                    id: 764fb173-94f9-447c-8454-def62e5a999f
                    modified_time: 1736421230
                    name: tert
                    org_id: 3a2627d7-bfbc-45af-b85d-8841581c6d63
                    pod_names:
                      '1': Pod 1
                    site_id: 00000000-0000-0000-0000-000000000000
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 1736421230
                    evpn_options:
                      auto_loopback_subnet: 172.16.192.0/24
                      auto_loopback_subnet6: fd33:ab00:2::/64
                      auto_router_id_subnet: 172.16.254.0/23
                      core_as_border: true
                      overlay:
                        as: 65000
                      per_vlan_vga_v4_mac: false
                      routed_at: core
                      underlay:
                        as_base: 65001
                        subnet: 10.255.240.0/20
                        use_ipv6: false
                    for_site: false
                    id: 764fb173-94f9-447c-8454-def62e5a999f
                    modified_time: 1736421230
                    name: tert
                    org_id: 3a2627d7-bfbc-45af-b85d-8841581c6d63
                    pod_names:
                      '1': Pod 1
                    site_id: 00000000-0000-0000-0000-000000000000
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs EVPN Topologies
      summary: createOrgEvpnTopology
      description: >-
        While all the `evpn_id` / `downlink_ips` can be specified by hand, the easiest way is to call the `build_vpn_topology` API, allowing you to examine the diff, and update it yourself. You can also simply call it with `overwrite=true` which will apply the updates for you.


        **Notes:**

        1. You can use `core` / `distribution` / `access` to create a CLOS topology

        2. You can also use `core` / `distribution` to form a 2-tier EVPN topology where ESI-Lag is configured distribution to connect to access switches

        3. In a small/medium campus, `collapsed-core` can be used where core switches are the inter-connected to do EVPN

        4. The API uses a few pre-defined parameters and best-practices to generate the configs. It can be customized by using `evpn_options` in Site Setting / Network Template. (e.g. a different subnet for the underlay)


        #### Collapsed Core

        In a small-medium campus, EVPN can also be enabled only at the core switches (up to 4) by assigning all participating switches with `collapsed-core role`. When there are more than 2 switches, a ring-like topology will be formed.


        #### ESI-Lag

        If the access switches does not have EVPN support, you can take advantage of EVPN by setting up ESI-Lag on distribution switches


        #### Leaf / Access / Collapsed-Core

        For leaf nodes in a EVPN topology, you’d have to configure the IPs for networks that would participate in EVPN. Optionally, VRFs to isolate traffic from one tenant versus another
      operationId: createOrgEvpnTopology
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/evpn_topology'
              - examples:
                - name: CC
                  pod_names:
                    '1': default
                    '2': default
                  switches:
                  - mac: 5c5b35000003
                    role: collapsed-core
                  - mac: 5c5b35000004
                    role: collapsed-core
              contentMediaType: application/json
            examples:
              Example:
                value:
                  name: CC
                  pod_names:
                    '1': default
                    '2': default
                  switches:
                  - mac: 5c5b35000003
                    role: collapsed-core
                  - mac: 5c5b35000004
                    role: collapsed-core
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/evpn_topology'
                - description: EVPN topology create or update payload
                  examples:
                  - id: 9197ec96-4c8d-529f-c595-035895e688b2
                    name: CC
                    overwrite: true
                    pod_names:
                      '1': default
                      '2': default
                    switches:
                    - deviceprofile_id: 6a1deab1-96df-4fa2-8455-d5253f943d06
                      downlink_ips:
                      - 10.255.240.6
                      - 10.255.240.8
                      downlinks:
                      - 5c5b35000007
                      - 5c5b35000008
                      esilaglinks:
                      - 5c5b3500000f
                      evpn_id: 1
                      mac: 5c5b35000003
                      model: QFX10002-36Q
                      role: collapsed-core
                      site_id: 1916d52a-4a90-11e5-8b45-1258369c38a9
                      uplinks:
                      - 5c5b35000005
                      - 5c5b35000006
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    id: 9197ec96-4c8d-529f-c595-035895e688b2
                    name: CC
                    overwrite: true
                    pod_names:
                      '1': default
                      '2': default
                    switches:
                    - deviceprofile_id: 6a1deab1-96df-4fa2-8455-d5253f943d06
                      downlink_ips:
                      - 10.255.240.6
                      - 10.255.240.8
                      downlinks:
                      - 5c5b35000007
                      - 5c5b35000008
                      esilaglinks:
                      - 5c5b3500000f
                      evpn_id: 1
                      mac: 5c5b35000003
                      model: QFX10002-36Q
                      role: collapsed-core
                      site_id: 1916d52a-4a90-11e5-8b45-1258369c38a9
                      uplinks:
                      - 5c5b35000005
                      - 5c5b35000006
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/evpn_topology'
                - description: EVPN topology create or update payload
                  examples:
                  - id: 9197ec96-4c8d-529f-c595-035895e688b2
                    name: CC
                    overwrite: true
                    pod_names:
                      '1': default
                      '2': default
                    switches:
                    - deviceprofile_id: 6a1deab1-96df-4fa2-8455-d5253f943d06
                      downlink_ips:
                      - 10.255.240.6
                      - 10.255.240.8
                      downlinks:
                      - 5c5b35000007
                      - 5c5b35000008
                      esilaglinks:
                      - 5c5b3500000f
                      evpn_id: 1
                      mac: 5c5b35000003
                      model: QFX10002-36Q
                      role: collapsed-core
                      site_id: 1916d52a-4a90-11e5-8b45-1258369c38a9
                      uplinks:
                      - 5c5b35000005
                      - 5c5b35000006
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    id: 9197ec96-4c8d-529f-c595-035895e688b2
                    name: CC
                    overwrite: true
                    pod_names:
                      '1': default
                      '2': default
                    switches:
                    - deviceprofile_id: 6a1deab1-96df-4fa2-8455-d5253f943d06
                      downlink_ips:
                      - 10.255.240.6
                      - 10.255.240.8
                      downlinks:
                      - 5c5b35000007
                      - 5c5b35000008
                      esilaglinks:
                      - 5c5b3500000f
                      evpn_id: 1
                      mac: 5c5b35000003
                      model: QFX10002-36Q
                      role: collapsed-core
                      site_id: 1916d52a-4a90-11e5-8b45-1258369c38a9
                      uplinks:
                      - 5c5b35000005
                      - 5c5b35000006
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/evpn_topologies/{evpn_topology_id}:
    delete:
      tags:
      - Orgs EVPN Topologies
      summary: deleteOrgEvpnTopology
      description: Delete an EVPN topology from the organization by topology ID.
      operationId: deleteOrgEvpnTopology
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: evpn_topology_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs EVPN Topologies
      summary: getOrgEvpnTopology
      description: Retrieve the switch roles, links, and generation options for a specific EVPN topology.
      operationId: getOrgEvpnTopology
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: evpn_topology_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/evpn_topology'
                - description: EVPN topology create or update payload
                  examples:
                  - id: 9197ec96-4c8d-529f-c595-035895e688b2
                    name: CC
                    overwrite: true
                    pod_names:
                      '1': default
                      '2': default
                    switches:
                    - deviceprofile_id: 6a1deab1-96df-4fa2-8455-d5253f943d06
                      downlink_ips:
                      - 10.255.240.6
                      - 10.255.240.8
                      downlinks:
                      - 5c5b35000007
                      - 5c5b35000008
                      esilaglinks:
                      - 5c5b3500000f
                      evpn_id: 1
                      mac: 5c5b35000003
                      model: QFX10002-36Q
                      role: collapsed-core
                      site_id: 1916d52a-4a90-11e5-8b45-1258369c38a9
                      uplinks:
                      - 5c5b35000005
                      - 5c5b35000006
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    id: 9197ec96-4c8d-529f-c595-035895e688b2
                    name: CC
                    overwrite: true
                    pod_names:
                      '1': default
                      '2': default
                    switches:
                    - deviceprofile_id: 6a1deab1-96df-4fa2-8455-d5253f943d06
                      downlink_ips:
                      - 10.255.240.6
                      - 10.255.240.8
                      downlinks:
                      - 5c5b35000007
                      - 5c5b35000008
                      esilaglinks:
                      - 5c5b3500000f
                      evpn_id: 1
                      mac: 5c5b35000003
                      model: QFX10002-36Q
                      role: collapsed-core
                      site_id: 1916d52a-4a90-11e5-8b45-1258369c38a9
                      uplinks:
                      - 5c5b35000005
                      - 5c5b35000006
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/evpn_topology'
                - description: EVPN topology create or update payload
                  examples:
                  - id: 9197ec96-4c8d-529f-c595-035895e688b2
                    name: CC
                    overwrite: true
                    pod_names:
                      '1': default
                      '2': default
                    switches:
                    - deviceprofile_id: 6a1deab1-96df-4fa2-8455-d5253f943d06
                      downlink_ips:
                      - 10.255.240.6
                      - 10.255.240.8
                      downlinks:
                      - 5c5b35000007
                      - 5c5b35000008
                      esilaglinks:
                      - 5c5b3500000f
                      evpn_id: 1
                      mac: 5c5b35000003
                      model: QFX10002-36Q
                      role: collapsed-core
                      site_id: 1916d52a-4a90-11e5-8b45-1258369c38a9
                      uplinks:
                      - 5c5b35000005
                      - 5c5b35000006
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    id: 9197ec96-4c8d-529f-c595-035895e688b2
                    name: CC
                    overwrite: true
                    pod_names:
                      '1': default
                      '2': default
                    switches:
                    - deviceprofile_id: 6a1deab1-96df-4fa2-8455-d5253f943d06
                      downlink_ips:
                      - 10.255.240.6
                      - 10.255.240.8
                      downlinks:
                      - 5c5b35000007
                      - 5c5b35000008
                      esilaglinks:
                      - 5c5b3500000f
                      evpn_id: 1
                      mac: 5c5b35000003
                      model: QFX10002-36Q
                      role: collapsed-core
                      site_id: 1916d52a-4a90-11e5-8b45-1258369c38a9
                      uplinks:
                      - 5c5b35000005
                      - 5c5b35000006
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs EVPN Topologies
      summary: updateOrgEvpnTopology
      description: Update an EVPN topology, including switch membership, switch roles, links, and generation options.
      operationId: updateOrgEvpnTopology
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: evpn_topology_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/evpn_topology'
              - examples:
                - overwrite: false
                  switches:
                  - mac: 5c5b35000003
                    role: collapsed-core
                  - mac: 5c5b35000004
                    role: none
              contentMediaType: application/json
            examples:
              Example:
                value:
                  overwrite: false
                  switches:
                  - mac: 5c5b35000003
                    role: collapsed-core
                  - mac: 5c5b35000004
                    role: none
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/evpn_topology'
                - description: EVPN topology create or update payload
                  examples:
                  - id: 9197ec96-4c8d-529f-c595-035895e688b2
                    name: CC
                    overwrite: true
                    pod_names:
                      '1': default
                      '2': default
                    switches:
                    - deviceprofile_id: 6a1deab1-96df-4fa2-8455-d5253f943d06
                      downlink_ips:
                      - 10.255.240.6
                      - 10.255.240.8
                      downlinks:
                      - 5c5b35000007
                      - 5c5b35000008
                      esilaglinks:
                      - 5c5b3500000f
                      evpn_id: 1
                      mac: 5c5b35000003
                      model: QFX10002-36Q
                      role: collapsed-core
                      site_id: 1916d52a-4a90-11e5-8b45-1258369c38a9
                      uplinks:
                      - 5c5b35000005
                      - 5c5b35000006
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    id: 9197ec96-4c8d-529f-c595-035895e688b2
                    name: CC
                    overwrite: true
                    pod_names:
                      '1': default
                      '2': default
                    switches:
                    - deviceprofile_id: 6a1deab1-96df-4fa2-8455-d5253f943d06
                      downlink_ips:
                      - 10.255.240.6
                      - 10.255.240.8
                      downlinks:
                      - 5c5b35000007
                      - 5c5b35000008
                      esilaglinks:
                      - 5c5b3500000f
                      evpn_id: 1
                      mac: 5c5b35000003
                      model: QFX10002-36Q
                      role: collapsed-core
                      site_id: 1916d52a-4a90-11e5-8b45-1258369c38a9
                      uplinks:
                      - 5c5b35000005
                      - 5c5b35000006
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/evpn_topology'
                - description: EVPN topology create or update payload
                  examples:
                  - id: 9197ec96-4c8d-529f-c595-035895e688b2
                    name: CC
                    overwrite: true
                    pod_names:
                      '1': default
                      '2': default
                    switches:
                    - deviceprofile_id: 6a1deab1-96df-4fa2-8455-d5253f943d06
                      downlink_ips:
                      - 10.255.240.6
                      - 10.255.240.8
                      downlinks:
                      - 5c5b35000007
                      - 5c5b35000008
                      esilaglinks:
                      - 5c5b3500000f
                      evpn_id: 1
                      mac: 5c5b35000003
                      model: QFX10002-36Q
                      role: collapsed-core
                      site_id: 1916d52a-4a90-11e5-8b45-1258369c38a9
                      uplinks:
                      - 5c5b35000005
                      - 5c5b35000006
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    id: 9197ec96-4c8d-529f-c595-035895e688b2
                    name: CC
                    overwrite: true
                    pod_names:
                      '1': default
                      '2': default
                    switches:
                    - deviceprofile_id: 6a1deab1-96df-4fa2-8455-d5253f943d06
                      downlink_ips:
                      - 10.255.240.6
                      - 10.255.240.8
                      downlinks:
                      - 5c5b35000007
                      - 5c5b35000008
                      esilaglinks:
                      - 5c5b3500000f
                      evpn_id: 1
                      mac: 5c5b35000003
                      model: QFX10002-36Q
                      role: collapsed-core
                      site_id: 1916d52a-4a90-11e5-8b45-1258369c38a9
                      uplinks:
                      - 5c5b35000005
                      - 5c5b35000006
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/setting/juniper/link_accounts:
    post:
      tags:
      - Orgs Integration Juniper
      summary: linkOrgToJuniperJuniperAccount
      description: Link a Juniper account to the organization using Juniper account credentials. Linked accounts are returned in organization settings and can be used by Juniper integrations.
      operationId: linkOrgToJuniperJuniperAccount
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/account_juniper_config'
              - examples:
                - password: password
                  username: john@nmo.com
              contentMediaType: application/json
            examples:
              Example:
                value:
                  password: password
                  username: john@nmo.com
        required: false
      responses:
        '200':
          description: Account linked
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/account_juniper_info'
                - description: Linked Juniper account information returned by the integration
                  examples:
                  - account:
                      linked_by: John Smith (john@abccorp.com)
                      name: ABC Corp
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    account:
                      linked_by: John Smith (john@abccorp.com)
                      name: ABC Corp
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/account_juniper_info'
                - description: Linked Juniper account information returned by the integration
                  examples:
                  - account:
                      linked_by: John Smith (john@abccorp.com)
                      name: ABC Corp
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    account:
                      linked_by: John Smith (john@abccorp.com)
                      name: ABC Corp
        '400':
          description: Account already linked
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_detail_string'
                - description: Response containing a human-readable detail message
                  examples:
                  - detail: Account[ABC Corp] already linked
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Account[ABC Corp] already linked
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_detail_string'
                - description: Response containing a human-readable detail message
                  examples:
                  - detail: Account[ABC Corp] already linked
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Account[ABC Corp] already linked
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/setting/juniper/unlink_account:
    delete:
      tags:
      - Orgs Integration Juniper
      summary: unlinkOrgFromJuniperCustomerId
      description: Unlink a Juniper customer account from the organization. The `linked_by` field is required only when multiple linked accounts share the same account name.
      operationId: unlinkOrgFromJuniperCustomerId
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/account_juniper_info'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/otherdevices:
    get:
      tags:
      - Orgs Devices - Others
      summary: listOrgOtherDevices
      description: List third-party devices across the organization, such as devices discovered or tracked outside the managed Mist device inventory.
      operationId: listOrgOtherDevices
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: vendor
        in: query
        description: Filter results by vendor
        style: form
        explode: true
        schema:
          type: string
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: serial
        in: query
        description: Filter results by device serial number
        style: form
        explode: true
        schema:
          type: string
      - name: model
        in: query
        description: Filter results by device model
        style: form
        explode: true
        schema:
          type: string
      - name: name
        in: query
        description: Filter results by name
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/device_other'
                description: List of third-party devices reported by external integrations
                examples:
                - - created_time: 1676983730
                    device_mac: '001122334455'
                    id: ae9dee49-69e7-4710-a114-5b827a777738
                    mac: 5c5b35000018
                    model: AP41
                    modified_time: 1676983730
                    name: hallway
                    org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                    serial: FXLH2015150025
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    vendor: cradlepoint
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 1676983730
                    device_mac: '001122334455'
                    id: ae9dee49-69e7-4710-a114-5b827a777738
                    mac: 5c5b35000018
                    model: AP41
                    modified_time: 1676983730
                    name: hallway
                    org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                    serial: FXLH2015150025
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    vendor: cradlepoint
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/device_other'
                description: List of third-party devices reported by external integrations
                examples:
                - - created_time: 1676983730
                    device_mac: '001122334455'
                    id: ae9dee49-69e7-4710-a114-5b827a777738
                    mac: 5c5b35000018
                    model: AP41
                    modified_time: 1676983730
                    name: hallway
                    org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                    serial: FXLH2015150025
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    vendor: cradlepoint
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 1676983730
                    device_mac: '001122334455'
                    id: ae9dee49-69e7-4710-a114-5b827a777738
                    mac: 5c5b35000018
                    model: AP41
                    modified_time: 1676983730
                    name: hallway
                    org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                    serial: FXLH2015150025
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    vendor: cradlepoint
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs Devices - Others
      summary: updateOrgOtherDevices
      description: Bulk assign or unassign third-party devices to or from a site by MAC address.
      operationId: updateOrgOtherDevices
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/other_device_update_multi'
              - examples:
                - device_mac: 0adfea67e65b
                  macs:
                  - 5c5b350e0001
                  - 5c5b350e0003
                  op: assign
                  site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
              contentMediaType: application/json
            examples:
              Example:
                value:
                  device_mac: 0adfea67e65b
                  macs:
                  - 5c5b350e0001
                  - 5c5b350e0003
                  op: assign
                  site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/otherdevices/events/count:
    get:
      tags:
      - Orgs Devices - Others
      summary: countOrgOtherDeviceEvents
      description: Count third-party device events across the organization, optionally grouped by `distinct` and filtered by event type and time range.
      operationId: countOrgOtherDeviceEvents
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `mac`, `site_id`, `type`, `vendor`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/org_otherdevices_events_count_distinct'
          - description: 'Field used to group this count response. enum: `mac`, `site_id`, `type`, `vendor`'
      - name: type
        in: query
        description: See [List Device Events Definitions]($e/Constants%20Events/listOtherDeviceEventsDefinitions)
        style: form
        explode: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/otherdevices/events/search:
    get:
      tags:
      - Orgs Devices - Others
      summary: searchOrgOtherDeviceEvents
      description: Search third-party device events across the organization with filters for site, MAC address, attached device MAC address, model, vendor, event type, and time range.
      operationId: searchOrgOtherDeviceEvents
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: site_id
        in: query
        description: Filter results by site identifier
        style: form
        explode: true
        schema:
          type: string
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: device_mac
        in: query
        description: MAC of attached device
        style: form
        explode: true
        schema:
          type: string
      - name: model
        in: query
        description: Filter results by device model
        style: form
        explode: true
        schema:
          type: string
      - name: vendor
        in: query
        description: Filter results by vendor
        style: form
        explode: true
        schema:
          type: string
      - name: type
        in: query
        description: See [List Device Events Definitions]($e/Constants%20Events/listOtherDeviceEventsDefinitions)
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_events_other_devices_search'
                - description: Paginated response for other-device event search results
                  examples:
                  - end: 0
                    limit: 0
                    results:
                    - device_mac: string
                      mac: 5c5b351e13b5
                      org_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862a
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      text: 'Plugged: The Internal 5GB (SIM1) has been inserted into Internal 1.'
                      timestamp: 547235620.89
                      type: CELLULAR_EDGE_MODEM_WAN_PLUGGED
                      vendor: cradlepoint
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 0
                    limit: 0
                    results:
                    - device_mac: string
                      mac: 5c5b351e13b5
                      org_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862a
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      text: 'Plugged: The Internal 5GB (SIM1) has been inserted into Internal 1.'
                      timestamp: 547235620.89
                      type: CELLULAR_EDGE_MODEM_WAN_PLUGGED
                      vendor: cradlepoint
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_events_other_devices_search'
                - description: Paginated response for other-device event search results
                  examples:
                  - end: 0
                    limit: 0
                    results:
                    - device_mac: string
                      mac: 5c5b351e13b5
                      org_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862a
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      text: 'Plugged: The Internal 5GB (SIM1) has been inserted into Internal 1.'
                      timestamp: 547235620.89
                      type: CELLULAR_EDGE_MODEM_WAN_PLUGGED
                      vendor: cradlepoint
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 0
                    limit: 0
                    results:
                    - device_mac: string
                      mac: 5c5b351e13b5
                      org_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862a
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      text: 'Plugged: The Internal 5GB (SIM1) has been inserted into Internal 1.'
                      timestamp: 547235620.89
                      type: CELLULAR_EDGE_MODEM_WAN_PLUGGED
                      vendor: cradlepoint
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/otherdevices/{device_mac}:
    delete:
      tags:
      - Orgs Devices - Others
      summary: deleteOrgOtherDevice
      description: Delete a third-party device record from the organization by device MAC address.
      operationId: deleteOrgOtherDevice
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs Devices - Others
      summary: getOrgOtherDevice
      description: Retrieve details for a third-party device record, including vendor, model, serial, attached Mist device MAC address, site assignment, and state.
      operationId: getOrgOtherDevice
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/device_other'
                - description: Third-party device discovered or managed through an external vendor integration
                  examples:
                  - device_mac: 00112233abcd
                    id: ae9dee49-69e7-4710-a114-5b827a777738
                    mac: 5c5b35000018
                    model: W2005
                    name: W2005-268
                    org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                    serial: WB23015E025468
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    state: online
                    vendor: cradlepoint
                    vendor_api_id: '4658714'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    device_mac: 00112233abcd
                    id: ae9dee49-69e7-4710-a114-5b827a777738
                    mac: 5c5b35000018
                    model: W2005
                    name: W2005-268
                    org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                    serial: WB23015E025468
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    state: online
                    vendor: cradlepoint
                    vendor_api_id: '4658714'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/device_other'
                - description: Third-party device discovered or managed through an external vendor integration
                  examples:
                  - device_mac: 00112233abcd
                    id: ae9dee49-69e7-4710-a114-5b827a777738
                    mac: 5c5b35000018
                    model: W2005
                    name: W2005-268
                    org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                    serial: WB23015E025468
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    state: online
                    vendor: cradlepoint
                    vendor_api_id: '4658714'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    device_mac: 00112233abcd
                    id: ae9dee49-69e7-4710-a114-5b827a777738
                    mac: 5c5b35000018
                    model: W2005
                    name: W2005-268
                    org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                    serial: WB23015E025468
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    state: online
                    vendor: cradlepoint
                    vendor_api_id: '4658714'
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs Devices - Others
      summary: updateOrgOtherDevice
      description: Manually update the site or attached Mist device association for a third-party device when automatic identification is unavailable.
      operationId: updateOrgOtherDevice
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/other_device_update'
              - examples:
                - device_mac: 0adfea67e65b
                  site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
              contentMediaType: application/json
            examples:
              Example:
                value:
                  device_mac: 0adfea67e65b
                  site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/otherdevices/{device_mac}/reboot:
    post:
      tags:
      - Orgs Devices - Others
      summary: rebootOrgOtherDevice
      description: Request a reboot for a third-party device by device MAC address.
      operationId: rebootOrgOtherDevice
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/setting/zscaler/setup:
    delete:
      tags:
      - Orgs Integration Zscaler
      summary: deleteOrgZscalerIntegration
      description: Remove the Zscaler integration configuration from the organization.
      operationId: deleteOrgZscalerIntegration
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs Integration Zscaler
      summary: getOrgZscalerIntegration
      description: Return the Zscaler integration configuration, including Zscaler Internet Access cloud name, partner key, and partner administrator username.
      operationId: getOrgZscalerIntegration
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/account_zscaler_info'
                - description: OAuth linked Zscaler apps account details
                  examples:
                  - cloud_name: zscalerbeta.net
                    partner_key: K35vrZcK3JvrZc
                    username: john@nmo.com
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    cloud_name: zscalerbeta.net
                    partner_key: K35vrZcK3JvrZc
                    username: john@nmo.com
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/account_zscaler_info'
                - description: OAuth linked Zscaler apps account details
                  examples:
                  - cloud_name: zscalerbeta.net
                    partner_key: K35vrZcK3JvrZc
                    username: john@nmo.com
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    cloud_name: zscalerbeta.net
                    partner_key: K35vrZcK3JvrZc
                    username: john@nmo.com
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs Integration Zscaler
      summary: setupOrgZscalerIntegration
      description: Configure the Zscaler integration with the Zscaler Internet Access cloud name, partner key, and partner administrator credentials used by Mist.
      operationId: setupOrgZscalerIntegration
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/account_zscaler_config'
              - examples:
                - cloud_name: zscalerbeta.net
                  partner_key: K35vrZcK3JvrZc
                  password: password
                  username: john@nmo.com
              contentMediaType: application/json
            examples:
              Example:
                value:
                  cloud_name: zscalerbeta.net
                  partner_key: K35vrZcK3JvrZc
                  password: password
                  username: john@nmo.com
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/setting/mist_scep:
    delete:
      tags:
      - Orgs SCEP
      summary: disableOrgMistScep
      description: Disable Mist SCEP for the organization and return the updated read-only SCEP settings.
      operationId: disableOrgMistScep
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org_setting_scep_response'
                - description: Read-only Mist SCEP settings returned for the organization
                  examples:
                  - cert_providers:
                    - jamf
                    - intune
                    - byod
                    enabled: false
                    intune_scep_url: https://scep.mistsys.com/api/v1/incoming/intune/:org_id/scep
                    jamf_access_token: 1Z4QqEnCt05Jjt3TV5LgPJ4V_WL_RWnJ7dqVMLYHj81=
                    jamf_scep_url: https://scep.mistsys.com/api/v1/incoming/intune/:org_id/scep
                    jamf_webhook_url: https://scep.mistsys.com/api/v1/webhook/jamf/:org_id/scep
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    cert_providers:
                    - jamf
                    - intune
                    - byod
                    enabled: false
                    intune_scep_url: https://scep.mistsys.com/api/v1/incoming/intune/:org_id/scep
                    jamf_access_token: 1Z4QqEnCt05Jjt3TV5LgPJ4V_WL_RWnJ7dqVMLYHj81=
                    jamf_scep_url: https://scep.mistsys.com/api/v1/incoming/intune/:org_id/scep
                    jamf_webhook_url: https://scep.mistsys.com/api/v1/webhook/jamf/:org_id/scep
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org_setting_scep_response'
                - description: Read-only Mist SCEP settings returned for the organization
                  examples:
                  - cert_providers:
                    - jamf
                    - intune
                    - byod
                    enabled: false
                    intune_scep_url: https://scep.mistsys.com/api/v1/incoming/intune/:org_id/scep
                    jamf_access_token: 1Z4QqEnCt05Jjt3TV5LgPJ4V_WL_RWnJ7dqVMLYHj81=
                    jamf_scep_url: https://scep.mistsys.com/api/v1/incoming/intune/:org_id/scep
                    jamf_webhook_url: https://scep.mistsys.com/api/v1/webhook/jamf/:org_id/scep
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    cert_providers:
                    - jamf
                    - intune
                    - byod
                    enabled: false
                    intune_scep_url: https://scep.mistsys.com/api/v1/incoming/intune/:org_id/scep
                    jamf_access_token: 1Z4QqEnCt05Jjt3TV5LgPJ4V_WL_RWnJ7dqVMLYHj81=
                    jamf_scep_url: https://scep.mistsys.com/api/v1/incoming/intune/:org_id/scep
                    jamf_webhook_url: https://scep.mistsys.com/api/v1/webhook/jamf/:org_id/scep
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs SCEP
      summary: getOrgMistScep
      description: Return Mist SCEP settings for the organization, including enabled and suspended status, configured certificate providers, and generated enrollment or webhook URLs.
      operationId: getOrgMistScep
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org_setting_scep_response'
                - description: Read-only Mist SCEP settings returned for the organization
                  examples:
                  - cert_providers:
                    - jamf
                    - intune
                    - byod
                    enabled: false
                    intune_scep_url: https://scep.mistsys.com/api/v1/incoming/intune/:org_id/scep
                    jamf_access_token: 1Z4QqEnCt05Jjt3TV5LgPJ4V_WL_RWnJ7dqVMLYHj81=
                    jamf_scep_url: https://scep.mistsys.com/api/v1/incoming/intune/:org_id/scep
                    jamf_webhook_url: https://scep.mistsys.com/api/v1/webhook/jamf/:org_id/scep
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    cert_providers:
                    - jamf
                    - intune
                    - byod
                    enabled: false
                    intune_scep_url: https://scep.mistsys.com/api/v1/incoming/intune/:org_id/scep
                    jamf_access_token: 1Z4QqEnCt05Jjt3TV5LgPJ4V_WL_RWnJ7dqVMLYHj81=
                    jamf_scep_url: https://scep.mistsys.com/api/v1/incoming/intune/:org_id/scep
                    jamf_webhook_url: https://scep.mistsys.com/api/v1/webhook/jamf/:org_id/scep
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org_setting_scep_response'
                - description: Read-only Mist SCEP settings returned for the organization
                  examples:
                  - cert_providers:
                    - jamf
                    - intune
                    - byod
                    enabled: false
                    intune_scep_url: https://scep.mistsys.com/api/v1/incoming/intune/:org_id/scep
                    jamf_access_token: 1Z4QqEnCt05Jjt3TV5LgPJ4V_WL_RWnJ7dqVMLYHj81=
                    jamf_scep_url: https://scep.mistsys.com/api/v1/incoming/intune/:org_id/scep
                    jamf_webhook_url: https://scep.mistsys.com/api/v1/webhook/jamf/:org_id/scep
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    cert_providers:
                    - jamf
                    - intune
                    - byod
                    enabled: false
                    intune_scep_url: https://scep.mistsys.com/api/v1/incoming/intune/:org_id/scep
                    jamf_access_token: 1Z4QqEnCt05Jjt3TV5LgPJ4V_WL_RWnJ7dqVMLYHj81=
                    jamf_scep_url: https://scep.mistsys.com/api/v1/incoming/intune/:org_id/scep
                    jamf_webhook_url: https://scep.mistsys.com/api/v1/webhook/jamf/:org_id/scep
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs SCEP
      summary: updateOrgMistScep
      description: Update Mist SCEP settings for the organization, including enabled state, suspension state, and certificate providers.
      operationId: updateOrgMistScep
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/org_setting_scep'
              - examples:
                - enabled: true
              contentMediaType: application/json
            examples:
              Example:
                value:
                  enabled: true
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org_setting_scep_response'
                - description: Read-only Mist SCEP settings returned for the organization
                  examples:
                  - cert_providers:
                    - jamf
                    - intune
                    - byod
                    enabled: false
                    intune_scep_url: https://scep.mistsys.com/api/v1/incoming/intune/:org_id/scep
                    jamf_access_token: 1Z4QqEnCt05Jjt3TV5LgPJ4V_WL_RWnJ7dqVMLYHj81=
                    jamf_scep_url: https://scep.mistsys.com/api/v1/incoming/intune/:org_id/scep
                    jamf_webhook_url: https://scep.mistsys.com/api/v1/webhook/jamf/:org_id/scep
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    cert_providers:
                    - jamf
                    - intune
                    - byod
                    enabled: false
                    intune_scep_url: https://scep.mistsys.com/api/v1/incoming/intune/:org_id/scep
                    jamf_access_token: 1Z4QqEnCt05Jjt3TV5LgPJ4V_WL_RWnJ7dqVMLYHj81=
                    jamf_scep_url: https://scep.mistsys.com/api/v1/incoming/intune/:org_id/scep
                    jamf_webhook_url: https://scep.mistsys.com/api/v1/webhook/jamf/:org_id/scep
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org_setting_scep_response'
                - description: Read-only Mist SCEP settings returned for the organization
                  examples:
                  - cert_providers:
                    - jamf
                    - intune
                    - byod
                    enabled: false
                    intune_scep_url: https://scep.mistsys.com/api/v1/incoming/intune/:org_id/scep
                    jamf_access_token: 1Z4QqEnCt05Jjt3TV5LgPJ4V_WL_RWnJ7dqVMLYHj81=
                    jamf_scep_url: https://scep.mistsys.com/api/v1/incoming/intune/:org_id/scep
                    jamf_webhook_url: https://scep.mistsys.com/api/v1/webhook/jamf/:org_id/scep
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    cert_providers:
                    - jamf
                    - intune
                    - byod
                    enabled: false
                    intune_scep_url: https://scep.mistsys.com/api/v1/incoming/intune/:org_id/scep
                    jamf_access_token: 1Z4QqEnCt05Jjt3TV5LgPJ4V_WL_RWnJ7dqVMLYHj81=
                    jamf_scep_url: https://scep.mistsys.com/api/v1/incoming/intune/:org_id/scep
                    jamf_webhook_url: https://scep.mistsys.com/api/v1/webhook/jamf/:org_id/scep
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/setting/mist_scep/client_certs:
    get:
      tags:
      - Orgs SCEP
      summary: listOrgIssuedClientCertificates
      description: List Mist SCEP client certificates issued for the organization. Results can be filtered by common name, certificate provider, serial number, device ID, or time range.
      operationId: listOrgIssuedClientCertificates
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: common_name
        in: query
        description: Filter by certificate common name (e.g. user UPN or device identifier)
        style: form
        explode: true
        schema:
          type: string
      - name: cert_provider
        in: query
        description: Filter by MDM or certificate provider that issued the certificate. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
      - name: serial_number
        in: query
        description: Filter by certificate serial number. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
      - name: device_id
        in: query
        description: Filter by device identifier associated with the certificate. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
      - name: expire_time
        in: query
        description: Filter by certificate expiry time, in epoch seconds
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: created_time
        in: query
        description: Filter by certificate issuance time, in epoch seconds
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/issued_client_certificates_results'
                - description: Issued client certificate search results wrapper
                  examples:
                  - limit: 100
                    page: 1
                    results:
                    - cert_provider: jamf
                      common_name: john@corp.com
                      created_time: 1431382121
                      device_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      expire_time: 1718921115
                      serial_number: 13 00 13 03 23 EE D5 84 01
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    limit: 100
                    page: 1
                    results:
                    - cert_provider: jamf
                      common_name: john@corp.com
                      created_time: 1431382121
                      device_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      expire_time: 1718921115
                      serial_number: 13 00 13 03 23 EE D5 84 01
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/issued_client_certificates_results'
                - description: Issued client certificate search results wrapper
                  examples:
                  - limit: 100
                    page: 1
                    results:
                    - cert_provider: jamf
                      common_name: john@corp.com
                      created_time: 1431382121
                      device_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      expire_time: 1718921115
                      serial_number: 13 00 13 03 23 EE D5 84 01
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    limit: 100
                    page: 1
                    results:
                    - cert_provider: jamf
                      common_name: john@corp.com
                      created_time: 1431382121
                      device_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      expire_time: 1718921115
                      serial_number: 13 00 13 03 23 EE D5 84 01
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/setting/mist_scep/client_certs/revoke:
    post:
      tags:
      - Orgs SCEP
      summary: revokeOrgIssuedClientCertificates
      description: Revoke issued Mist SCEP client certificates by certificate serial number.
      operationId: revokeOrgIssuedClientCertificates
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/client_cert_serial_numbers'
              - examples:
                - serial_numbers:
                  - 13 00 13 03 23 EE D5 84 01
              contentMediaType: application/json
            examples:
              Example:
                value:
                  serial_numbers:
                  - 13 00 13 03 23 EE D5 84 01
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/gatewaytemplates:
    get:
      tags:
      - Orgs Gateway Templates
      summary: listOrgGatewayTemplates
      description: List organization gateway templates, which provide reusable WAN gateway configuration that can be applied to gateways at sites.
      operationId: listOrgGatewayTemplates
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/gateway_template'
                description: List of gateway device profiles
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/gateway_template'
                description: List of gateway device profiles
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs Gateway Templates
      summary: createOrgGatewayTemplate
      description: >-
        Create an organization gateway template with reusable WAN gateway networks, ports, routing, and service-policy configuration.


        Gateway templates can be applied to multiple sites within the organization to provide consistent gateway configuration across sites.

        To assign a gateway template to a site, use the [Update Site]($e/Sites/updateSiteInfo) endpoint and specify the gateway template ID in the `gatewaytemplate_id` field of the request body.
      operationId: createOrgGatewayTemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Gateway Template
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/gateway_template'
              - description: Gateway Template
                examples:
                - dhcpd_config:
                    Corp-Mgmt:
                      dns_servers:
                      - 8.8.8.8
                      dns_suffix:
                      - stag.one
                      gateway: 10.3.172.9
                      ip_end: 10.3.172.99
                      ip_start: 10.3.172.50
                      type: local
                    Corp-lan:
                      dns_servers:
                      - 8.8.8.8
                      dns_suffix:
                      - stag.one
                      gateway: 10.3.171.9
                      ip_end: 10.3.171.99
                      ip_start: 10.3.171.50
                      type: local
                  dnsOverride: true
                  dns_servers:
                  - 10.3.20.201
                  - 10.3.51.222
                  - 1.1.1.1
                  dns_suffix:
                  - example.com
                  extra_routes:
                    10.101.0.0/16:
                      via: 10.3.100.10
                  ip_configs:
                    Corp-Core:
                      ip: 10.3.100.9
                      netmask: /24
                      type: static
                    Corp-Mgmt:
                      ip: 10.3.172.9
                      netmask: /24
                      type: static
                    Corp-lan:
                      ip: 10.3.171.9
                      netmask: /24
                      type: static
                  name: ITParis
                  ntpOverride: true
                  ntp_servers:
                  - 10.3.51.222
                  path_preferences:
                    core:
                      paths:
                      - networks:
                        - Corp-Core
                        type: local
                      strategy: ordered
                    lab:
                      paths:
                      - networks:
                        - Corp-lan
                        type: local
                      strategy: ordered
                    mgmt:
                      paths:
                      - networks:
                        - Corp-Mgmt
                        type: local
                      strategy: ordered
                    untrust:
                      paths:
                      - name: wan
                        type: wan
                      strategy: ordered
                  port_config:
                    ge-0/0/0:
                      aggregated: false
                      ip_config:
                        gateway: 192.168.1.1
                        ip: 192.168.1.9
                        netmask: /24
                        type: static
                      name: wan
                      redundant: false
                      traffic_shaping:
                        enabled: false
                      usage: wan
                      wan_type: broadband
                    ge-0/0/6-7:
                      ae_disable_lacp: false
                      ae_idx: '0'
                      ae_lacp_force_up: true
                      aggregated: true
                      networks:
                      - Corp-lan
                      - Corp-Mgmt
                      - Corp-Core
                      usage: lan
                  service_policies:
                  - action: allow
                    idp:
                      enabled: false
                    name: ITParis-Internal
                    path_preference: core
                    services:
                    - internal_dns
                    - drive
                    tenants:
                    - ITParis
                  - action: deny
                    idp:
                      enabled: false
                    name: ITParis-internet
                    path_preference: untrust
                    services:
                    - internet_any
                    tenants:
                    - ITParis
                  type: standalone
              contentMediaType: application/json
            examples:
              Example:
                value:
                  dhcpd_config:
                    Corp-Mgmt:
                      dns_servers:
                      - 8.8.8.8
                      dns_suffix:
                      - stag.one
                      gateway: 10.3.172.9
                      ip_end: 10.3.172.99
                      ip_start: 10.3.172.50
                      type: local
                    Corp-lan:
                      dns_servers:
                      - 8.8.8.8
                      dns_suffix:
                      - stag.one
                      gateway: 10.3.171.9
                      ip_end: 10.3.171.99
                      ip_start: 10.3.171.50
                      type: local
                  dnsOverride: true
                  dns_servers:
                  - 10.3.20.201
                  - 10.3.51.222
                  - 1.1.1.1
                  dns_suffix:
                  - example.com
                  extra_routes:
                    10.101.0.0/16:
                      via: 10.3.100.10
                  ip_configs:
                    Corp-Core:
                      ip: 10.3.100.9
                      netmask: /24
                      type: static
                    Corp-Mgmt:
                      ip: 10.3.172.9
                      netmask: /24
                      type: static
                    Corp-lan:
                      ip: 10.3.171.9
                      netmask: /24
                      type: static
                  name: ITParis
                  ntpOverride: true
                  ntp_servers:
                  - 10.3.51.222
                  path_preferences:
                    core:
                      paths:
                      - networks:
                        - Corp-Core
                        type: local
                      strategy: ordered
                    lab:
                      paths:
                      - networks:
                        - Corp-lan
                        type: local
                      strategy: ordered
                    mgmt:
                      paths:
                      - networks:
                        - Corp-Mgmt
                        type: local
                      strategy: ordered
                    untrust:
                      paths:
                      - name: wan
                        type: wan
                      strategy: ordered
                  port_config:
                    ge-0/0/0:
                      aggregated: false
                      ip_config:
                        gateway: 192.168.1.1
                        ip: 192.168.1.9
                        netmask: /24
                        type: static
                      name: wan
                      redundant: false
                      traffic_shaping:
                        enabled: false
                      usage: wan
                      wan_type: broadband
                    ge-0/0/6-7:
                      ae_disable_lacp: false
                      ae_idx: '0'
                      ae_lacp_force_up: true
                      aggregated: true
                      networks:
                      - Corp-lan
                      - Corp-Mgmt
                      - Corp-Core
                      usage: lan
                  service_policies:
                  - action: allow
                    idp:
                      enabled: false
                    name: ITParis-Internal
                    path_preference: core
                    services:
                    - internal_dns
                    - drive
                    tenants:
                    - ITParis
                  - action: deny
                    idp:
                      enabled: false
                    name: ITParis-internet
                    path_preference: untrust
                    services:
                    - internet_any
                    tenants:
                    - ITParis
                  type: standalone
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/gateway_template'
                - description: Gateway Template is applied to a site for gateway(s) in a site.
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/gateway_template'
                - description: Gateway Template is applied to a site for gateway(s) in a site.
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/gatewaytemplates/{gatewaytemplate_id}:
    delete:
      tags:
      - Orgs Gateway Templates
      summary: deleteOrgGatewayTemplate
      description: Delete an organization gateway template and remove that reusable gateway configuration object from the organization.
      operationId: deleteOrgGatewayTemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: gatewaytemplate_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs Gateway Templates
      summary: getOrgGatewayTemplate
      description: Retrieve the configuration stored in a specific organization gateway template.
      operationId: getOrgGatewayTemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: gatewaytemplate_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/gateway_template'
                - description: Gateway Template is applied to a site for gateway(s) in a site.
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/gateway_template'
                - description: Gateway Template is applied to a site for gateway(s) in a site.
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs Gateway Templates
      summary: updateOrgGatewayTemplate
      description: Update the configuration stored in an organization gateway template.
      operationId: updateOrgGatewayTemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: gatewaytemplate_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Gateway Template
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/gateway_template'
              - description: Gateway Template
                examples:
                - dhcpd_config:
                    Corp-Mgmt:
                      dns_servers:
                      - 8.8.8.8
                      dns_suffix:
                      - stag.one
                      gateway: 10.3.172.9
                      ip_end: 10.3.172.99
                      ip_start: 10.3.172.50
                      type: local
                    Corp-lan:
                      dns_servers:
                      - 8.8.8.8
                      dns_suffix:
                      - stag.one
                      gateway: 10.3.171.9
                      ip_end: 10.3.171.99
                      ip_start: 10.3.171.50
                      type: local
                  dnsOverride: true
                  dns_servers:
                  - 10.3.20.201
                  - 10.3.51.222
                  - 1.1.1.1
                  dns_suffix:
                  - example.com
                  extra_routes:
                    10.101.0.0/16:
                      via: 10.3.100.10
                  ip_configs:
                    Corp-Core:
                      ip: 10.3.100.9
                      netmask: /24
                      type: static
                    Corp-Mgmt:
                      ip: 10.3.172.9
                      netmask: /24
                      type: static
                    Corp-lan:
                      ip: 10.3.171.9
                      netmask: /24
                      type: static
                  name: ITParis
                  ntpOverride: true
                  ntp_servers:
                  - 10.3.51.222
                  path_preferences:
                    core:
                      paths:
                      - networks:
                        - Corp-Core
                        type: local
                      strategy: ordered
                    lab:
                      paths:
                      - networks:
                        - Corp-lan
                        type: local
                      strategy: ordered
                    mgmt:
                      paths:
                      - networks:
                        - Corp-Mgmt
                        type: local
                      strategy: ordered
                    untrust:
                      paths:
                      - name: wan
                        type: wan
                      strategy: ordered
                  port_config:
                    ge-0/0/0:
                      aggregated: false
                      ip_config:
                        gateway: 192.168.1.1
                        ip: 192.168.1.9
                        netmask: /24
                        type: static
                      name: wan
                      redundant: false
                      traffic_shaping:
                        enabled: false
                      usage: wan
                      wan_type: broadband
                    ge-0/0/6-7:
                      ae_disable_lacp: false
                      ae_idx: '0'
                      ae_lacp_force_up: true
                      aggregated: true
                      networks:
                      - Corp-lan
                      - Corp-Mgmt
                      - Corp-Core
                      usage: lan
                  service_policies:
                  - action: allow
                    idp:
                      enabled: false
                    name: ITParis-Internal
                    path_preference: core
                    services:
                    - internal_dns
                    - drive
                    tenants:
                    - ITParis
                  - action: deny
                    idp:
                      enabled: false
                    name: ITParis-internet
                    path_preference: untrust
                    services:
                    - internet_any
                    tenants:
                    - ITParis
                  type: standalone
              contentMediaType: application/json
            examples:
              Example:
                value:
                  dhcpd_config:
                    Corp-Mgmt:
                      dns_servers:
                      - 8.8.8.8
                      dns_suffix:
                      - stag.one
                      gateway: 10.3.172.9
                      ip_end: 10.3.172.99
                      ip_start: 10.3.172.50
                      type: local
                    Corp-lan:
                      dns_servers:
                      - 8.8.8.8
                      dns_suffix:
                      - stag.one
                      gateway: 10.3.171.9
                      ip_end: 10.3.171.99
                      ip_start: 10.3.171.50
                      type: local
                  dnsOverride: true
                  dns_servers:
                  - 10.3.20.201
                  - 10.3.51.222
                  - 1.1.1.1
                  dns_suffix:
                  - example.com
                  extra_routes:
                    10.101.0.0/16:
                      via: 10.3.100.10
                  ip_configs:
                    Corp-Core:
                      ip: 10.3.100.9
                      netmask: /24
                      type: static
                    Corp-Mgmt:
                      ip: 10.3.172.9
                      netmask: /24
                      type: static
                    Corp-lan:
                      ip: 10.3.171.9
                      netmask: /24
                      type: static
                  name: ITParis
                  ntpOverride: true
                  ntp_servers:
                  - 10.3.51.222
                  path_preferences:
                    core:
                      paths:
                      - networks:
                        - Corp-Core
                        type: local
                      strategy: ordered
                    lab:
                      paths:
                      - networks:
                        - Corp-lan
                        type: local
                      strategy: ordered
                    mgmt:
                      paths:
                      - networks:
                        - Corp-Mgmt
                        type: local
                      strategy: ordered
                    untrust:
                      paths:
                      - name: wan
                        type: wan
                      strategy: ordered
                  port_config:
                    ge-0/0/0:
                      aggregated: false
                      ip_config:
                        gateway: 192.168.1.1
                        ip: 192.168.1.9
                        netmask: /24
                        type: static
                      name: wan
                      redundant: false
                      traffic_shaping:
                        enabled: false
                      usage: wan
                      wan_type: broadband
                    ge-0/0/6-7:
                      ae_disable_lacp: false
                      ae_idx: '0'
                      ae_lacp_force_up: true
                      aggregated: true
                      networks:
                      - Corp-lan
                      - Corp-Mgmt
                      - Corp-Core
                      usage: lan
                  service_policies:
                  - action: allow
                    idp:
                      enabled: false
                    name: ITParis-Internal
                    path_preference: core
                    services:
                    - internal_dns
                    - drive
                    tenants:
                    - ITParis
                  - action: deny
                    idp:
                      enabled: false
                    name: ITParis-internet
                    path_preference: untrust
                    services:
                    - internet_any
                    tenants:
                    - ITParis
                  type: standalone
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/gateway_template'
                - description: Gateway Template is applied to a site for gateway(s) in a site.
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/gateway_template'
                - description: Gateway Template is applied to a site for gateway(s) in a site.
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/guests:
    get:
      tags:
      - Orgs Guests
      summary: listOrgGuestAuthorizations
      description: List guest authorization records across the organization, including WLAN, SSID, authentication method, expiration, and guest identity details.
      operationId: listOrgGuestAuthorizations
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/guest'
                description: List of guest authorization records
                examples:
                - '[{"authorized":true,"authorized_expiring_time":0,"authorized_time":0,"company":"string","email":"user@example.com","field1":"string","field2":"string","field3":"string","field4":"string","mac":"string","minutes":0,"name":"string"}]'
                - '[{"authorized":true,"authorized_expiring_time":1480704955,"authorized_time":1480704355,"company":"abc","email":"john@abc.com","field1":"xxx","mac":"5684dae9ac8b","name":"John Smith"}]'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - authorized: true
                    authorized_expiring_time: 0
                    authorized_time: 0
                    company: string
                    email: user@example.com
                    field1: string
                    field2: string
                    field3: string
                    field4: string
                    mac: string
                    minutes: 0
                    name: string
                Example2:
                  value:
                  - authorized: true
                    authorized_expiring_time: 1480704955
                    authorized_time: 1480704355
                    company: abc
                    email: john@abc.com
                    field1: xxx
                    mac: 5684dae9ac8b
                    name: John Smith
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/guest'
                description: List of guest authorization records
                examples:
                - '[{"authorized":true,"authorized_expiring_time":0,"authorized_time":0,"company":"string","email":"user@example.com","field1":"string","field2":"string","field3":"string","field4":"string","mac":"string","minutes":0,"name":"string"}]'
                - '[{"authorized":true,"authorized_expiring_time":1480704955,"authorized_time":1480704355,"company":"abc","email":"john@abc.com","field1":"xxx","mac":"5684dae9ac8b","name":"John Smith"}]'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - authorized: true
                    authorized_expiring_time: 0
                    authorized_time: 0
                    company: string
                    email: user@example.com
                    field1: string
                    field2: string
                    field3: string
                    field4: string
                    mac: string
                    minutes: 0
                    name: string
                Example2:
                  value:
                  - authorized: true
                    authorized_expiring_time: 1480704955
                    authorized_time: 1480704355
                    company: abc
                    email: john@abc.com
                    field1: xxx
                    mac: 5684dae9ac8b
                    name: John Smith
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/guests/count:
    get:
      tags:
      - Orgs Guests
      summary: countOrgGuestAuthorizations
      description: Count organization guest authorization records, optionally grouped by `distinct` and filtered by time range.
      operationId: countOrgGuestAuthorizations
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `auth_method`, `company`, `ssid`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/org_guests_count_distinct'
          - description: 'Field used to group this count response. enum: `auth_method`, `company`, `ssid`'
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/guests/search:
    get:
      tags:
      - Orgs Guests
      summary: searchOrgGuestAuthorization
      description: Search organization guest authorization records with filters for WLAN, SSID, authentication method, and time range.
      operationId: searchOrgGuestAuthorization
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wlan_id
        in: query
        description: Filter results by WLAN identifier
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 00000000-0000-0000-0000-000000000000
      - name: auth_method
        in: query
        description: Filter results by authentication method
        style: form
        explode: true
        schema:
          type: string
          examples:
          - psk
      - name: ssid
        in: query
        description: Filter results by SSID
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Guest
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_guest_search'
                - description: Paginated response for guest authorization search results
                  examples:
                  - end: 1531862583
                    limit: 2
                    next: /api/v1/sites/8aaba0aa-09cc-44bd-9709-33b98040550c/guests/search?wlan_id=88ffe630-95b8-11e8-b294-346895ed1b7d&end=1531855849.000&limit=2&start=1531776183.0
                    results:
                    - ap: 5c5b350e0001
                      auth_method: passphrase
                      authorized_expiring_time: 1531810258.186273
                      authorized_time: 1531782218
                      company: mistsystems
                      email: user@mistsys.com
                      name: john
                      ssid: openNet
                      timestamp: 1531782218
                    - ap: 5c5b350e0001
                      auth_method: facebook
                      authorized_expiring_time: 1531810821.145
                      authorized_time: 1531782632
                      company: xyz inc.
                      email: cool_user@yahoo.com
                      name: John White
                      ssid: openNet
                      timestamp: 1531782632
                    start: 1531776183
                    total: 14
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1531862583
                    limit: 2
                    next: /api/v1/sites/8aaba0aa-09cc-44bd-9709-33b98040550c/guests/search?wlan_id=88ffe630-95b8-11e8-b294-346895ed1b7d&end=1531855849.000&limit=2&start=1531776183.0
                    results:
                    - ap: 5c5b350e0001
                      auth_method: passphrase
                      authorized_expiring_time: 1531810258.186273
                      authorized_time: 1531782218
                      company: mistsystems
                      email: user@mistsys.com
                      name: john
                      ssid: openNet
                      timestamp: 1531782218
                    - ap: 5c5b350e0001
                      auth_method: facebook
                      authorized_expiring_time: 1531810821.145
                      authorized_time: 1531782632
                      company: xyz inc.
                      email: cool_user@yahoo.com
                      name: John White
                      ssid: openNet
                      timestamp: 1531782632
                    start: 1531776183
                    total: 14
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_guest_search'
                - description: Paginated response for guest authorization search results
                  examples:
                  - end: 1531862583
                    limit: 2
                    next: /api/v1/sites/8aaba0aa-09cc-44bd-9709-33b98040550c/guests/search?wlan_id=88ffe630-95b8-11e8-b294-346895ed1b7d&end=1531855849.000&limit=2&start=1531776183.0
                    results:
                    - ap: 5c5b350e0001
                      auth_method: passphrase
                      authorized_expiring_time: 1531810258.186273
                      authorized_time: 1531782218
                      company: mistsystems
                      email: user@mistsys.com
                      name: john
                      ssid: openNet
                      timestamp: 1531782218
                    - ap: 5c5b350e0001
                      auth_method: facebook
                      authorized_expiring_time: 1531810821.145
                      authorized_time: 1531782632
                      company: xyz inc.
                      email: cool_user@yahoo.com
                      name: John White
                      ssid: openNet
                      timestamp: 1531782632
                    start: 1531776183
                    total: 14
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1531862583
                    limit: 2
                    next: /api/v1/sites/8aaba0aa-09cc-44bd-9709-33b98040550c/guests/search?wlan_id=88ffe630-95b8-11e8-b294-346895ed1b7d&end=1531855849.000&limit=2&start=1531776183.0
                    results:
                    - ap: 5c5b350e0001
                      auth_method: passphrase
                      authorized_expiring_time: 1531810258.186273
                      authorized_time: 1531782218
                      company: mistsystems
                      email: user@mistsys.com
                      name: john
                      ssid: openNet
                      timestamp: 1531782218
                    - ap: 5c5b350e0001
                      auth_method: facebook
                      authorized_expiring_time: 1531810821.145
                      authorized_time: 1531782632
                      company: xyz inc.
                      email: cool_user@yahoo.com
                      name: John White
                      ssid: openNet
                      timestamp: 1531782632
                    start: 1531776183
                    total: 14
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/guests/{guest_mac}:
    delete:
      tags:
      - Orgs Guests
      summary: deleteOrgGuestAuthorization
      description: Delete a guest authorization record by guest MAC address.
      operationId: deleteOrgGuestAuthorization
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: guest_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs Guests
      summary: getOrgGuestAuthorization
      description: Retrieve the guest authorization record associated with a guest MAC address.
      operationId: getOrgGuestAuthorization
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: guest_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/guest'
                - description: Guest authorization record at site scope
                  examples:
                  - '{"authorized":true,"authorized_expiring_time":0,"authorized_time":0,"company":"string","email":"user@example.com","field1":"string","field2":"string","field3":"string","field4":"string","mac":"string","minutes":0,"name":"string"}'
                  - '{"authorized":true,"authorized_expiring_time":1480704955,"authorized_time":1480704355,"company":"abc","email":"john@abc.com","field1":"xxx","mac":"5684dae9ac8b","name":"John Smith"}'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    authorized: true
                    authorized_expiring_time: 0
                    authorized_time: 0
                    company: string
                    email: user@example.com
                    field1: string
                    field2: string
                    field3: string
                    field4: string
                    mac: string
                    minutes: 0
                    name: string
                Example2:
                  value:
                    authorized: true
                    authorized_expiring_time: 1480704955
                    authorized_time: 1480704355
                    company: abc
                    email: john@abc.com
                    field1: xxx
                    mac: 5684dae9ac8b
                    name: John Smith
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/guest'
                - description: Guest authorization record at site scope
                  examples:
                  - '{"authorized":true,"authorized_expiring_time":0,"authorized_time":0,"company":"string","email":"user@example.com","field1":"string","field2":"string","field3":"string","field4":"string","mac":"string","minutes":0,"name":"string"}'
                  - '{"authorized":true,"authorized_expiring_time":1480704955,"authorized_time":1480704355,"company":"abc","email":"john@abc.com","field1":"xxx","mac":"5684dae9ac8b","name":"John Smith"}'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    authorized: true
                    authorized_expiring_time: 0
                    authorized_time: 0
                    company: string
                    email: user@example.com
                    field1: string
                    field2: string
                    field3: string
                    field4: string
                    mac: string
                    minutes: 0
                    name: string
                Example2:
                  value:
                    authorized: true
                    authorized_expiring_time: 1480704955
                    authorized_time: 1480704355
                    company: abc
                    email: john@abc.com
                    field1: xxx
                    mac: 5684dae9ac8b
                    name: John Smith
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs Guests
      summary: updateOrgGuestAuthorization
      description: Update the organization guest authorization record for a guest MAC address, including authorization state, duration, WLAN, and guest identity fields.
      operationId: updateOrgGuestAuthorization
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: guest_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/guest_org'
              - examples:
                - company: string
                  email: user@example.com
                  mac: string
                  minutes: 1440
                  name: John Smith
                  wlan_id: 6748cfa6-4e12-11e6-9188-0242ac110007
              contentMediaType: application/json
            examples:
              Example:
                value:
                  company: string
                  email: user@example.com
                  mac: string
                  minutes: 1440
                  name: John Smith
                  wlan_id: 6748cfa6-4e12-11e6-9188-0242ac110007
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/guest'
                - description: Guest authorization record at site scope
                  examples:
                  - '{"authorized":true,"authorized_expiring_time":0,"authorized_time":0,"company":"string","email":"user@example.com","field1":"string","field2":"string","field3":"string","field4":"string","mac":"string","minutes":0,"name":"string"}'
                  - '{"authorized":true,"authorized_expiring_time":1480704955,"authorized_time":1480704355,"company":"abc","email":"john@abc.com","field1":"xxx","mac":"5684dae9ac8b","name":"John Smith"}'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    authorized: true
                    authorized_expiring_time: 0
                    authorized_time: 0
                    company: string
                    email: user@example.com
                    field1: string
                    field2: string
                    field3: string
                    field4: string
                    mac: string
                    minutes: 0
                    name: string
                Example2:
                  value:
                    authorized: true
                    authorized_expiring_time: 1480704955
                    authorized_time: 1480704355
                    company: abc
                    email: john@abc.com
                    field1: xxx
                    mac: 5684dae9ac8b
                    name: John Smith
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/guest'
                - description: Guest authorization record at site scope
                  examples:
                  - '{"authorized":true,"authorized_expiring_time":0,"authorized_time":0,"company":"string","email":"user@example.com","field1":"string","field2":"string","field3":"string","field4":"string","mac":"string","minutes":0,"name":"string"}'
                  - '{"authorized":true,"authorized_expiring_time":1480704955,"authorized_time":1480704355,"company":"abc","email":"john@abc.com","field1":"xxx","mac":"5684dae9ac8b","name":"John Smith"}'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    authorized: true
                    authorized_expiring_time: 0
                    authorized_time: 0
                    company: string
                    email: user@example.com
                    field1: string
                    field2: string
                    field3: string
                    field4: string
                    mac: string
                    minutes: 0
                    name: string
                Example2:
                  value:
                    authorized: true
                    authorized_expiring_time: 1480704955
                    authorized_time: 1480704355
                    company: abc
                    email: john@abc.com
                    field1: xxx
                    mac: 5684dae9ac8b
                    name: John Smith
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/idpprofiles:
    get:
      tags:
      - Orgs IDP Profiles
      summary: listOrgIdpProfiles
      description: List organization Intrusion Detection and Prevention (IDP) profiles, including their base profile and signature overwrite rules.
      operationId: listOrgIdpProfiles
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/idp_profile'
                description: IDP profile records returned for an organization
                examples:
                - - base_profile: strict
                    created_time: 0
                    id: 874ca978-d736-4d4b-bc90-a49a29eec133
                    modified_time: 0
                    name: relaxed
                    overwrites:
                    - action: alert
                      matching:
                        attack_name:
                        - HTTP:INVALID:HDR-FIELD
                        dst_subnet:
                        - 63.1.2.0/24
                        severity:
                        - major
                contentMediaType: application/json
              examples:
                Idpprofiles:
                  value:
                  - base_profile: strict
                    created_time: 0
                    id: 874ca978-d736-4d4b-bc90-a49a29eec133
                    modified_time: 0
                    name: relaxed
                    overwrites:
                    - action: alert
                      matching:
                        attack_name:
                        - HTTP:INVALID:HDR-FIELD
                        dst_subnet:
                        - 63.1.2.0/24
                        severity:
                        - major
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/idp_profile'
                description: IDP profile records returned for an organization
                examples:
                - - base_profile: strict
                    created_time: 0
                    id: 874ca978-d736-4d4b-bc90-a49a29eec133
                    modified_time: 0
                    name: relaxed
                    overwrites:
                    - action: alert
                      matching:
                        attack_name:
                        - HTTP:INVALID:HDR-FIELD
                        dst_subnet:
                        - 63.1.2.0/24
                        severity:
                        - major
                contentMediaType: application/vnd.api+json
              examples:
                Idpprofiles:
                  value:
                  - base_profile: strict
                    created_time: 0
                    id: 874ca978-d736-4d4b-bc90-a49a29eec133
                    modified_time: 0
                    name: relaxed
                    overwrites:
                    - action: alert
                      matching:
                        attack_name:
                        - HTTP:INVALID:HDR-FIELD
                        dst_subnet:
                        - 63.1.2.0/24
                        severity:
                        - major
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs IDP Profiles
      summary: createOrgIdpProfile
      description: Create an organization Intrusion Detection and Prevention (IDP) profile with a built-in base profile and optional signature overwrite rules.
      operationId: createOrgIdpProfile
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/idp_profile'
              - examples:
                - base_profile: strict
                  name: relaxed
                  overwrites:
                  - action: alert
                    matching:
                      attack_name:
                      - HTTP:INVALID:HDR-FIELD
                      dst_subnet:
                      - 63.1.2.0/24
                      severity:
                      - major
              contentMediaType: application/json
            examples:
              Example:
                value:
                  base_profile: strict
                  name: relaxed
                  overwrites:
                  - action: alert
                    matching:
                      attack_name:
                      - HTTP:INVALID:HDR-FIELD
                      dst_subnet:
                      - 63.1.2.0/24
                      severity:
                      - major
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/idp_profile'
                - description: Organization IDP profile with a base profile and targeted overwrite rules
                  examples:
                  - base_profile: strict
                    created_time: 0
                    id: 874ca978-d736-4d4b-bc90-a49a29eec133
                    modified_time: 0
                    name: relaxed
                    overwrites:
                    - action: alert
                      matching:
                        attack_name:
                        - HTTP:INVALID:HDR-FIELD
                        dst_subnet:
                        - 63.1.2.0/24
                        severity:
                        - major
                contentMediaType: application/json
              examples:
                Idpprofile:
                  value:
                    base_profile: strict
                    created_time: 0
                    id: 874ca978-d736-4d4b-bc90-a49a29eec133
                    modified_time: 0
                    name: relaxed
                    overwrites:
                    - action: alert
                      matching:
                        attack_name:
                        - HTTP:INVALID:HDR-FIELD
                        dst_subnet:
                        - 63.1.2.0/24
                        severity:
                        - major
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/idp_profile'
                - description: Organization IDP profile with a base profile and targeted overwrite rules
                  examples:
                  - base_profile: strict
                    created_time: 0
                    id: 874ca978-d736-4d4b-bc90-a49a29eec133
                    modified_time: 0
                    name: relaxed
                    overwrites:
                    - action: alert
                      matching:
                        attack_name:
                        - HTTP:INVALID:HDR-FIELD
                        dst_subnet:
                        - 63.1.2.0/24
                        severity:
                        - major
                contentMediaType: application/vnd.api+json
              examples:
                Idpprofile:
                  value:
                    base_profile: strict
                    created_time: 0
                    id: 874ca978-d736-4d4b-bc90-a49a29eec133
                    modified_time: 0
                    name: relaxed
                    overwrites:
                    - action: alert
                      matching:
                        attack_name:
                        - HTTP:INVALID:HDR-FIELD
                        dst_subnet:
                        - 63.1.2.0/24
                        severity:
                        - major
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/idpprofiles/{idpprofile_id}:
    delete:
      tags:
      - Orgs IDP Profiles
      summary: deleteOrgIdpProfile
      description: Delete an organization Intrusion Detection and Prevention (IDP) profile by profile ID.
      operationId: deleteOrgIdpProfile
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: idpprofile_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs IDP Profiles
      summary: getOrgIdpProfile
      description: Retrieve the base profile and signature overwrite rules for a specific organization IDP profile.
      operationId: getOrgIdpProfile
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: idpprofile_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/idp_profile'
                - description: Organization IDP profile with a base profile and targeted overwrite rules
                  examples:
                  - base_profile: strict
                    created_time: 0
                    id: 874ca978-d736-4d4b-bc90-a49a29eec133
                    modified_time: 0
                    name: relaxed
                    overwrites:
                    - action: alert
                      matching:
                        attack_name:
                        - HTTP:INVALID:HDR-FIELD
                        dst_subnet:
                        - 63.1.2.0/24
                        severity:
                        - major
                contentMediaType: application/json
              examples:
                Idpprofile:
                  value:
                    base_profile: strict
                    created_time: 0
                    id: 874ca978-d736-4d4b-bc90-a49a29eec133
                    modified_time: 0
                    name: relaxed
                    overwrites:
                    - action: alert
                      matching:
                        attack_name:
                        - HTTP:INVALID:HDR-FIELD
                        dst_subnet:
                        - 63.1.2.0/24
                        severity:
                        - major
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/idp_profile'
                - description: Organization IDP profile with a base profile and targeted overwrite rules
                  examples:
                  - base_profile: strict
                    created_time: 0
                    id: 874ca978-d736-4d4b-bc90-a49a29eec133
                    modified_time: 0
                    name: relaxed
                    overwrites:
                    - action: alert
                      matching:
                        attack_name:
                        - HTTP:INVALID:HDR-FIELD
                        dst_subnet:
                        - 63.1.2.0/24
                        severity:
                        - major
                contentMediaType: application/vnd.api+json
              examples:
                Idpprofile:
                  value:
                    base_profile: strict
                    created_time: 0
                    id: 874ca978-d736-4d4b-bc90-a49a29eec133
                    modified_time: 0
                    name: relaxed
                    overwrites:
                    - action: alert
                      matching:
                        attack_name:
                        - HTTP:INVALID:HDR-FIELD
                        dst_subnet:
                        - 63.1.2.0/24
                        severity:
                        - major
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs IDP Profiles
      summary: updateOrgIdpProfile
      description: Update an organization IDP profile, including its base profile and signature overwrite rules.
      operationId: updateOrgIdpProfile
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: idpprofile_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/idp_profile'
              - examples:
                - base_profile: strict
                  name: relaxed
                  overwrites:
                  - action: alert
                    matching:
                      attack_name:
                      - HTTP:INVALID:HDR-FIELD
                      dst_subnet:
                      - 63.1.2.0/24
                      severity:
                      - major
              contentMediaType: application/json
            examples:
              idpprofile:
                value:
                  base_profile: strict
                  name: relaxed
                  overwrites:
                  - action: alert
                    matching:
                      attack_name:
                      - HTTP:INVALID:HDR-FIELD
                      dst_subnet:
                      - 63.1.2.0/24
                      severity:
                      - major
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/idp_profile'
                - description: Organization IDP profile with a base profile and targeted overwrite rules
                  examples:
                  - base_profile: strict
                    created_time: 0
                    id: 874ca978-d736-4d4b-bc90-a49a29eec133
                    modified_time: 0
                    name: relaxed
                    overwrites:
                    - action: alert
                      matching:
                        attack_name:
                        - HTTP:INVALID:HDR-FIELD
                        dst_subnet:
                        - 63.1.2.0/24
                        severity:
                        - major
                contentMediaType: application/json
              examples:
                Idpprofile:
                  value:
                    base_profile: strict
                    created_time: 0
                    id: 874ca978-d736-4d4b-bc90-a49a29eec133
                    modified_time: 0
                    name: relaxed
                    overwrites:
                    - action: alert
                      matching:
                        attack_name:
                        - HTTP:INVALID:HDR-FIELD
                        dst_subnet:
                        - 63.1.2.0/24
                        severity:
                        - major
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/idp_profile'
                - description: Organization IDP profile with a base profile and targeted overwrite rules
                  examples:
                  - base_profile: strict
                    created_time: 0
                    id: 874ca978-d736-4d4b-bc90-a49a29eec133
                    modified_time: 0
                    name: relaxed
                    overwrites:
                    - action: alert
                      matching:
                        attack_name:
                        - HTTP:INVALID:HDR-FIELD
                        dst_subnet:
                        - 63.1.2.0/24
                        severity:
                        - major
                contentMediaType: application/vnd.api+json
              examples:
                Idpprofile:
                  value:
                    base_profile: strict
                    created_time: 0
                    id: 874ca978-d736-4d4b-bc90-a49a29eec133
                    modified_time: 0
                    name: relaxed
                    overwrites:
                    - action: alert
                      matching:
                        attack_name:
                        - HTTP:INVALID:HDR-FIELD
                        dst_subnet:
                        - 63.1.2.0/24
                        severity:
                        - major
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/inventory:
    get:
      tags:
      - Orgs Inventory
      summary: getOrgInventory
      description: "Get Org Inventory\n\n### VC (Virtual-Chassis) Management \n\nStarting with the April release, Virtual Chassis devices in Mist will now use\na cloud-assigned virtual MAC address as the device ID, instead of the physical\nMAC address of the FPC0 member.\n\n\n**Retrieving the device ID or Site ID of a Virtual Chassis:**\n\n1. Use this API call with the query parameters `vc=true` and `mac` set to the MAC address of the VC member.\n\n2. In the response, check the `vc_mac` and `mac` fields:\n\n    - If `vc_mac` is empty or not present, the device is not part of a Virtual Chassis.\n    The `device_id` and `site_id` will be available in the device information.\n\n    - If `vc_mac` differs from the `mac` field, the device is part of a Virtual Chassis\n    but is not the device used to generate the Virtual Chassis ID. Use the `vc_mac` value with the [Get Org Inventory]($e/Orgs%20Inventory/getOrgInventory)\n    API call to retrieve the `device_id` and `site_id`.\n\n    - If `vc_mac` matches the `mac` field, the device is the device used to generate the Virtual Chassis ID and he `device_id` and `site_id` will be available\n    in the device information.  \n    This is the case if the device is the Virtual Chassis \"virtual device\" (MAC starting with `020003`) or if the device is the Virtual Chassis FPC0 and the Virtual Chassis is still using the FPC0 MAC address to generate the device ID.\n"
      operationId: getOrgInventory
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: serial
        in: query
        description: Filter results by device serial number. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - PE3717390301,EY2523AN0523
          - FXLH2015150025
        examples:
          Untitled Example1:
            value: PE3717390301,EY2523AN0523
          Untitled Example2:
            value: FXLH2015150025
      - name: model
        in: query
        description: Filter results by device model. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - EX4300-48T,EX4100-48MP
          - AP43
        examples:
          Untitled Example1:
            value: EX4300-48T,EX4100-48MP
          Untitled Example2:
            value: AP43
      - name: type
        in: query
        description: 'Filter results by type. enum: `ap`, `gateway`, `switch`. Accepts multiple comma-separated values.'
        style: form
        explode: true
        schema:
          type: string
          examples:
          - switch,ap
      - name: mac
        in: query
        description: Filter results by MAC address. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b53010101,5c5b53020202
          - 5c5b350e0001
        examples:
          Untitled Example1:
            value: 5c5b53010101,5c5b53020202
          Untitled Example2:
            value: 5c5b350e0001
      - name: site_id
        in: query
        description: Filter results by one site identifier. Use a single value; comma-separated values are not supported
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 4ac1dcf4-9d8b-7211-65c4-057819f0862b
      - name: vc_mac
        in: query
        description: Virtual Chassis MAC address. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b53010101,5c5b53020202
          - 5c5b350e0001
        examples:
          Untitled Example1:
            value: 5c5b53010101,5c5b53020202
          Untitled Example2:
            value: 5c5b350e0001
      - name: vc
        in: query
        description: To display Virtual Chassis members
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          examples:
          - false
      - name: unassigned
        in: query
        description: To display Unassigned devices
        style: form
        explode: true
        schema:
          type: boolean
          default: true
          examples:
          - true
      - name: modified_after
        in: query
        description: Filter on inventory last modified time, in epoch
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
          examples:
          - 1703003296
      - name: disconnected_before
        in: query
        description: Filter results to devices that were last disconnected before this time, in epoch seconds
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
          examples:
          - 1733522845
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/inventory'
                description: Inventory records for claimed devices
                examples:
                - - connected: true
                    created_time: 1542328276
                    deviceprofile_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                    id: 00000000-0000-0000-0000-5c5b35000018
                    last_disconnected: 1542828000
                    mac: 5c5b35000018
                    model: AP41
                    modified_time: 1542829778
                    name: hallway
                    serial: FXLH2015150025
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    type: ap
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - connected: true
                    created_time: 1542328276
                    deviceprofile_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                    id: 00000000-0000-0000-0000-5c5b35000018
                    last_disconnected: 1542828000
                    mac: 5c5b35000018
                    model: AP41
                    modified_time: 1542829778
                    name: hallway
                    serial: FXLH2015150025
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    type: ap
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/inventory'
                description: Inventory records for claimed devices
                examples:
                - - connected: true
                    created_time: 1542328276
                    deviceprofile_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                    id: 00000000-0000-0000-0000-5c5b35000018
                    last_disconnected: 1542828000
                    mac: 5c5b35000018
                    model: AP41
                    modified_time: 1542829778
                    name: hallway
                    serial: FXLH2015150025
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    type: ap
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - connected: true
                    created_time: 1542328276
                    deviceprofile_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                    id: 00000000-0000-0000-0000-5c5b35000018
                    last_disconnected: 1542828000
                    mac: 5c5b35000018
                    model: AP41
                    modified_time: 1542829778
                    name: hallway
                    serial: FXLH2015150025
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    type: ap
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs Inventory
      summary: addOrgInventory
      description: Claim devices into the organization inventory using order activation codes or device claim codes.
      operationId: addOrgInventory
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              uniqueItems: true
              type: array
              items:
                type: string
              description: Request Body
              examples:
              - - 6JG8E-PTFV2-A9Z2N
                - DVH4V-SNMSZ-PDXBR
              contentMediaType: application/json
            examples:
              Example:
                value:
                - 6JG8E-PTFV2-A9Z2N
                - DVH4V-SNMSZ-PDXBR
        required: false
      responses:
        '200':
          description: OK - if any of entries are valid or there’s no errors
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_inventory'
                - description: Result of adding device claim codes to organization inventory
                  examples:
                  - added:
                    - 6JG8E-PTFV2-A9Z2N
                    duplicated:
                    - DVH4V-SNMSZ-PDXBR
                    error:
                    - PO1025335ohoh
                    inventory_added:
                    - mac: 5c5b35000018
                      magic: 6JG8EPTFV2A9Z2N
                      model: AP41
                      serial: FXLH2015150025
                      type: ap
                    inventory_duplicated:
                    - mac: 5c5b35000012
                      magic: DVH4VSNMSZPDXBR
                      model: AP41
                      serial: FXLH2015150027
                      type: ap
                    reason:
                    - belongs to another org ('e2f543f7-d6e1-409f-a565-e77a1f098d3b' (other) != '0de5d6fc-219a-414d-a840-67d6b919ad8f' (you))
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    added:
                    - 6JG8E-PTFV2-A9Z2N
                    duplicated:
                    - DVH4V-SNMSZ-PDXBR
                    error:
                    - PO1025335ohoh
                    inventory_added:
                    - mac: 5c5b35000018
                      magic: 6JG8EPTFV2A9Z2N
                      model: AP41
                      serial: FXLH2015150025
                      type: ap
                    inventory_duplicated:
                    - mac: 5c5b35000012
                      magic: DVH4VSNMSZPDXBR
                      model: AP41
                      serial: FXLH2015150027
                      type: ap
                    reason:
                    - belongs to another org ('e2f543f7-d6e1-409f-a565-e77a1f098d3b' (other) != '0de5d6fc-219a-414d-a840-67d6b919ad8f' (you))
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_inventory'
                - description: Result of adding device claim codes to organization inventory
                  examples:
                  - added:
                    - 6JG8E-PTFV2-A9Z2N
                    duplicated:
                    - DVH4V-SNMSZ-PDXBR
                    error:
                    - PO1025335ohoh
                    inventory_added:
                    - mac: 5c5b35000018
                      magic: 6JG8EPTFV2A9Z2N
                      model: AP41
                      serial: FXLH2015150025
                      type: ap
                    inventory_duplicated:
                    - mac: 5c5b35000012
                      magic: DVH4VSNMSZPDXBR
                      model: AP41
                      serial: FXLH2015150027
                      type: ap
                    reason:
                    - belongs to another org ('e2f543f7-d6e1-409f-a565-e77a1f098d3b' (other) != '0de5d6fc-219a-414d-a840-67d6b919ad8f' (you))
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    added:
                    - 6JG8E-PTFV2-A9Z2N
                    duplicated:
                    - DVH4V-SNMSZ-PDXBR
                    error:
                    - PO1025335ohoh
                    inventory_added:
                    - mac: 5c5b35000018
                      magic: 6JG8EPTFV2A9Z2N
                      model: AP41
                      serial: FXLH2015150025
                      type: ap
                    inventory_duplicated:
                    - mac: 5c5b35000012
                      magic: DVH4VSNMSZPDXBR
                      model: AP41
                      serial: FXLH2015150027
                      type: ap
                    reason:
                    - belongs to another org ('e2f543f7-d6e1-409f-a565-e77a1f098d3b' (other) != '0de5d6fc-219a-414d-a840-67d6b919ad8f' (you))
        '400':
          description: OK - if any of entries are valid or there’s no errors
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_inventory'
                - description: Result of adding device claim codes to organization inventory
                  examples:
                  - added:
                    - 6JG8E-PTFV2-A9Z2N
                    duplicated:
                    - DVH4V-SNMSZ-PDXBR
                    error:
                    - PO1025335ohoh
                    inventory_added:
                    - mac: 5c5b35000018
                      magic: 6JG8EPTFV2A9Z2N
                      model: AP41
                      serial: FXLH2015150025
                      type: ap
                    inventory_duplicated:
                    - mac: 5c5b35000012
                      magic: DVH4VSNMSZPDXBR
                      model: AP41
                      serial: FXLH2015150027
                      type: ap
                    reason:
                    - belongs to another org ('e2f543f7-d6e1-409f-a565-e77a1f098d3b' (other) != '0de5d6fc-219a-414d-a840-67d6b919ad8f' (you))
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    added:
                    - 6JG8E-PTFV2-A9Z2N
                    duplicated:
                    - DVH4V-SNMSZ-PDXBR
                    error:
                    - PO1025335ohoh
                    inventory_added:
                    - mac: 5c5b35000018
                      magic: 6JG8EPTFV2A9Z2N
                      model: AP41
                      serial: FXLH2015150025
                      type: ap
                    inventory_duplicated:
                    - mac: 5c5b35000012
                      magic: DVH4VSNMSZPDXBR
                      model: AP41
                      serial: FXLH2015150027
                      type: ap
                    reason:
                    - belongs to another org ('e2f543f7-d6e1-409f-a565-e77a1f098d3b' (other) != '0de5d6fc-219a-414d-a840-67d6b919ad8f' (you))
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_inventory'
                - description: Result of adding device claim codes to organization inventory
                  examples:
                  - added:
                    - 6JG8E-PTFV2-A9Z2N
                    duplicated:
                    - DVH4V-SNMSZ-PDXBR
                    error:
                    - PO1025335ohoh
                    inventory_added:
                    - mac: 5c5b35000018
                      magic: 6JG8EPTFV2A9Z2N
                      model: AP41
                      serial: FXLH2015150025
                      type: ap
                    inventory_duplicated:
                    - mac: 5c5b35000012
                      magic: DVH4VSNMSZPDXBR
                      model: AP41
                      serial: FXLH2015150027
                      type: ap
                    reason:
                    - belongs to another org ('e2f543f7-d6e1-409f-a565-e77a1f098d3b' (other) != '0de5d6fc-219a-414d-a840-67d6b919ad8f' (you))
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    added:
                    - 6JG8E-PTFV2-A9Z2N
                    duplicated:
                    - DVH4V-SNMSZ-PDXBR
                    error:
                    - PO1025335ohoh
                    inventory_added:
                    - mac: 5c5b35000018
                      magic: 6JG8EPTFV2A9Z2N
                      model: AP41
                      serial: FXLH2015150025
                      type: ap
                    inventory_duplicated:
                    - mac: 5c5b35000012
                      magic: DVH4VSNMSZPDXBR
                      model: AP41
                      serial: FXLH2015150027
                      type: ap
                    reason:
                    - belongs to another org ('e2f543f7-d6e1-409f-a565-e77a1f098d3b' (other) != '0de5d6fc-219a-414d-a840-67d6b919ad8f' (you))
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs Inventory
      summary: updateOrgInventoryAssignment
      description: Update inventory assignment for one or more devices, such as assigning them to a site, unassigning them, or deleting inventory records by MAC address or serial number.
      operationId: updateOrgInventoryAssignment
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/inventory_update'
              - examples:
                - '{"disable_auto_config":false,"macs":["5c5b350e0001"],"no_reassign":false,"op":"assign","site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b"}'
                - '{"macs":["5c5b350e0001"],"op":"delete","serials":["FXLH2015150025","FXLH2015150026"]}'
              contentMediaType: application/json
            examples:
              assign:
                value:
                  disable_auto_config: false
                  macs:
                  - 5c5b350e0001
                  no_reassign: false
                  op: assign
                  site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
              delete:
                value:
                  macs:
                  - 5c5b350e0001
                  op: delete
                  serials:
                  - FXLH2015150025
                  - FXLH2015150026
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_org_inventory_change'
                - description: Result of an organization inventory assignment or deletion operation
                  examples:
                  - '{"error":[],"op":"assign","reason":[],"success":["5c5b350e0001"]}'
                  - '{"error":["FXLH2015150026"],"op":"delete","reason":[],"success":["FXLH2015150025","5c5b350e0001"]}'
                  - '{"error":["5c5b350e0001"],"op":"upgrade_to_mist","reason":["already managed"],"success":["c15353123096"]}'
                contentMediaType: application/json
              examples:
                Assign:
                  value:
                    error: []
                    op: assign
                    reason: []
                    success:
                    - 5c5b350e0001
                Delete:
                  value:
                    error:
                    - FXLH2015150026
                    op: delete
                    reason: []
                    success:
                    - FXLH2015150025
                    - 5c5b350e0001
                Error:
                  value:
                    error:
                    - 5c5b350e0001
                    op: upgrade_to_mist
                    reason:
                    - already managed
                    success:
                    - c15353123096
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_org_inventory_change'
                - description: Result of an organization inventory assignment or deletion operation
                  examples:
                  - '{"error":[],"op":"assign","reason":[],"success":["5c5b350e0001"]}'
                  - '{"error":["FXLH2015150026"],"op":"delete","reason":[],"success":["FXLH2015150025","5c5b350e0001"]}'
                  - '{"error":["5c5b350e0001"],"op":"upgrade_to_mist","reason":["already managed"],"success":["c15353123096"]}'
                contentMediaType: application/vnd.api+json
              examples:
                Assign:
                  value:
                    error: []
                    op: assign
                    reason: []
                    success:
                    - 5c5b350e0001
                Delete:
                  value:
                    error:
                    - FXLH2015150026
                    op: delete
                    reason: []
                    success:
                    - FXLH2015150025
                    - 5c5b350e0001
                Error:
                  value:
                    error:
                    - 5c5b350e0001
                    op: upgrade_to_mist
                    reason:
                    - already managed
                    success:
                    - c15353123096
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/inventory/count:
    get:
      tags:
      - Orgs Inventory
      summary: countOrgInventory
      description: Count organization inventory records, optionally grouped by `distinct` and filtered by device type, site, model, version, and status.
      operationId: countOrgInventory
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `model`, `status`, `site_id`, `sku`, `version`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/inventory_count_distinct'
          - description: 'Field used to group this count response. enum: `model`, `status`, `site_id`, `sku`, `version`'
      - name: type
        in: query
        description: 'Filter results by type. enum: `ap`, `gateway`, `switch`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/device_type_default_ap'
          - description: 'Filter results by type. enum: `ap`, `gateway`, `switch`'
      - name: site_id
        in: query
        description: Filter results by site identifier
        style: form
        explode: true
        schema:
          type: string
      - name: model
        in: query
        description: Filter results by device model. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - AP45,BT11
      - name: version
        in: query
        description: Filter results by software version
        style: form
        explode: true
        schema:
          type: string
      - name: status
        in: query
        description: 'Filter results by status. enum: `connected`, `disconnected`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/device_status_filter'
          - description: 'Filter results by status. enum: `connected`, `disconnected`'
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/inventory/create_ha_cluster:
    post:
      tags:
      - Orgs Inventory
      summary: createOrgGatewayHaCluster
      description: Create a gateway HA cluster from unassigned gateway inventory nodes and assign the cluster to the specified site.
      operationId: createOrgGatewayHaCluster
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ha_cluster_config'
              - examples:
                - disable_auto_config: true
                  mist_configured: true
                  nodes:
                  - mac: aff827549235
                  - mac: 8396cd006c8c
                  site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
              contentMediaType: application/json
            examples:
              Example:
                value:
                  disable_auto_config: true
                  mist_configured: true
                  nodes:
                  - mac: aff827549235
                  - mac: 8396cd006c8c
                  site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/inventory/delete_ha_cluster:
    post:
      tags:
      - Orgs Inventory
      summary: deleteOrgGatewayHaCluster
      description: >-
        Delete HA Cluster


        After HA cluster deleted, both of the nodes will be unassigned.
      operationId: deleteOrgGatewayHaCluster
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ha_cluster_delete'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/inventory/reevaluate_auto_assignment:
    post:
      tags:
      - Orgs Inventory
      summary: reevaluateOrgAutoAssignment
      description: Re-run organization inventory auto-assignment rules against devices that are eligible for automatic site assignment.
      operationId: reevaluateOrgAutoAssignment
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/inventory/replace:
    post:
      tags:
      - Orgs Inventory
      summary: replaceOrgDevices
      description: >-
        It’s a common request we get from the customers. When a AP HW has problem and need a replacement, they would want to copy the existing attributes (Device Config) of this old AP to the new one. It can be done by providing the MAC of a device that’s currently in the inventory but not assigned. The Device replaced will become unassigned.


        This API also supports replacement of Mist Edges. This API copies device agnostic attributes from old Mist edge to new one.

        Mist manufactured Mist Edges will be reset to factory settings but will still be in Inventory.Brownfield or VM’s will be

        deleted from Inventory


        **Note:** For Gateway devices only like-for-like replacements (can only replace a SRX320 with a SRX320 and not some other model) are allowed.
      operationId: replaceOrgDevices
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/replace_device'
              - description: Request Body
                examples:
                - discard: []
                  inventory_mac: 5c5b35000301
                  mac: 5c5b35000101
                  site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
              contentMediaType: application/json
            examples:
              Example:
                value:
                  discard: []
                  inventory_mac: 5c5b35000301
                  mac: 5c5b35000101
                  site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_org_inventory_change'
                - description: Result of an organization inventory assignment or deletion operation
                  examples:
                  - '{"error":[],"op":"assign","reason":[],"success":["5c5b350e0001"]}'
                  - '{"error":["FXLH2015150026"],"op":"delete","reason":[],"success":["FXLH2015150025","5c5b350e0001"]}'
                  - '{"error":["5c5b350e0001"],"op":"upgrade_to_mist","reason":["already managed"],"success":["c15353123096"]}'
                contentMediaType: application/json
              examples:
                Assign:
                  value:
                    error: []
                    op: assign
                    reason: []
                    success:
                    - 5c5b350e0001
                Delete:
                  value:
                    error:
                    - FXLH2015150026
                    op: delete
                    reason: []
                    success:
                    - FXLH2015150025
                    - 5c5b350e0001
                Error:
                  value:
                    error:
                    - 5c5b350e0001
                    op: upgrade_to_mist
                    reason:
                    - already managed
                    success:
                    - c15353123096
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_org_inventory_change'
                - description: Result of an organization inventory assignment or deletion operation
                  examples:
                  - '{"error":[],"op":"assign","reason":[],"success":["5c5b350e0001"]}'
                  - '{"error":["FXLH2015150026"],"op":"delete","reason":[],"success":["FXLH2015150025","5c5b350e0001"]}'
                  - '{"error":["5c5b350e0001"],"op":"upgrade_to_mist","reason":["already managed"],"success":["c15353123096"]}'
                contentMediaType: application/vnd.api+json
              examples:
                Assign:
                  value:
                    error: []
                    op: assign
                    reason: []
                    success:
                    - 5c5b350e0001
                Delete:
                  value:
                    error:
                    - FXLH2015150026
                    op: delete
                    reason: []
                    success:
                    - FXLH2015150025
                    - 5c5b350e0001
                Error:
                  value:
                    error:
                    - 5c5b350e0001
                    op: upgrade_to_mist
                    reason:
                    - already managed
                    success:
                    - c15353123096
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/inventory/search:
    get:
      tags:
      - Orgs Inventory
      summary: searchOrgInventory
      description: Search organization inventory records with filters for type, MAC address, model, name, site, serial number, Virtual Chassis master state, SKU, version, status, and text.
      operationId: searchOrgInventory
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: type
        in: query
        description: 'Filter results by type. enum: `ap`, `gateway`, `switch`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/device_type_default_ap'
          - description: 'Filter results by type. enum: `ap`, `gateway`, `switch`'
      - name: mac
        in: query
        description: Filter by MAC address. Partial matches may use `*` wildcards (e.g. `*5b35*` matches `5c5b350e0001` and `5c5b35000301`). Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b350e0001,*5b35*
          - 5c5b350e0001
          - '*5b35*'
        examples:
          Untitled Example1:
            value: 5c5b350e0001,*5b35*
          Untitled Example2:
            value: 5c5b350e0001
          Untitled Example3:
            value: '*5b35*'
      - name: model
        in: query
        description: Partial / full Device model. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `AP4*` and `*P4*` match `AP43`). Suffix-only wildcards (e.g. `*43`) are not supported. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - AP43,AP4*
          - AP43
          - AP4*
          - '*P4*'
        examples:
          Untitled Example1:
            value: AP43,AP4*
          Untitled Example2:
            value: AP43
          Untitled Example3:
            value: AP4*
          Untitled Example4:
            value: '*P4*'
      - name: name
        in: query
        description: Device name. Always a partial match (e.g. `london` will match `london-1`, `london-2`, `my-london-device`...). Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - name-a,name-b
          - london
        examples:
          Untitled Example1:
            value: name-a,name-b
          Untitled Example2:
            value: london
      - name: site_id
        in: query
        description: Filter inventory results by site identifier. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 4ac1dcf4-9d8b-7211-65c4-057819f0862b
        examples:
          Untitled Example2:
            value: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
      - name: serial
        in: query
        description: Device serial number. Partial match allowed with wildcard * (e.g. `*123*` will match `AB123CD`, `12345`, `XY123`). Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - AB123CD,*123*
          - AB123CD
          - '*123*'
        examples:
          Untitled Example1:
            value: AB123CD,*123*
          Untitled Example2:
            value: AB123CD
          Untitled Example3:
            value: '*123*'
      - name: magic
        in: query
        description: Device claim code (magic). Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - WVTFBLTNPXD23H2
      - name: master
        in: query
        description: Filter inventory results by whether the device is the Virtual Chassis master
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 'true'
      - name: sku
        in: query
        description: Device SKU. Partial match allowed with wildcard * (e.g. `*2300*` will match `EX2300-F-12P`). Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - EX2300-F-12P,*2300*
          - EX2300-F-12P
          - '*2300*'
        examples:
          Untitled Example1:
            value: EX2300-F-12P,*2300*
          Untitled Example2:
            value: EX2300-F-12P
          Untitled Example3:
            value: '*2300*'
      - name: version
        in: query
        description: Device version. Partial match allowed with wildcard * (e.g. `2R3` will match `21.2R3-S3.5`). Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 21.2R3-S3.5,*2R3*
          - 21.2R3-S3.5
          - '*2R3*'
        examples:
          Untitled Example1:
            value: 21.2R3-S3.5,*2R3*
          Untitled Example2:
            value: 21.2R3-S3.5
          Untitled Example3:
            value: '*2R3*'
      - name: status
        in: query
        description: 'Device status. enum: `connected`, `disconnected`. Accepts multiple comma-separated values.'
        style: form
        explode: true
        schema:
          type: string
          examples:
          - connected,disconnected
      - name: text
        in: query
        description: Wildcards for name, mac, serial
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/inventory_search'
                - description: Paginated inventory search response
                  examples:
                  - limit: 1000
                    results:
                    - mac: f01c2df166e0
                      magic: WVTFBLTNPXD23H2
                      master: true
                      members:
                      - mac: f01c2df166e0
                        model: EX4300-48P
                        serial: PD3714460200
                      model: EX4300-48P
                      name: mist-wa-ex4300-VC
                      org_id: 9b853544-51e4-45fb-81ac-a442e4a111d0
                      serial: PD3714460200
                      site_id: 01dc141d-b6af-4baa-b00f-0e31ef954c4f
                      sku: EX4300-48P
                      status: disconnected
                      type: switch
                      vc_mac: f01c2df166e0
                      version: 21.4R3.5
                    total: 1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    limit: 1000
                    results:
                    - mac: f01c2df166e0
                      magic: WVTFBLTNPXD23H2
                      master: true
                      members:
                      - mac: f01c2df166e0
                        model: EX4300-48P
                        serial: PD3714460200
                      model: EX4300-48P
                      name: mist-wa-ex4300-VC
                      org_id: 9b853544-51e4-45fb-81ac-a442e4a111d0
                      serial: PD3714460200
                      site_id: 01dc141d-b6af-4baa-b00f-0e31ef954c4f
                      sku: EX4300-48P
                      status: disconnected
                      type: switch
                      vc_mac: f01c2df166e0
                      version: 21.4R3.5
                    total: 1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/inventory_search'
                - description: Paginated inventory search response
                  examples:
                  - limit: 1000
                    results:
                    - mac: f01c2df166e0
                      magic: WVTFBLTNPXD23H2
                      master: true
                      members:
                      - mac: f01c2df166e0
                        model: EX4300-48P
                        serial: PD3714460200
                      model: EX4300-48P
                      name: mist-wa-ex4300-VC
                      org_id: 9b853544-51e4-45fb-81ac-a442e4a111d0
                      serial: PD3714460200
                      site_id: 01dc141d-b6af-4baa-b00f-0e31ef954c4f
                      sku: EX4300-48P
                      status: disconnected
                      type: switch
                      vc_mac: f01c2df166e0
                      version: 21.4R3.5
                    total: 1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    limit: 1000
                    results:
                    - mac: f01c2df166e0
                      magic: WVTFBLTNPXD23H2
                      master: true
                      members:
                      - mac: f01c2df166e0
                        model: EX4300-48P
                        serial: PD3714460200
                      model: EX4300-48P
                      name: mist-wa-ex4300-VC
                      org_id: 9b853544-51e4-45fb-81ac-a442e4a111d0
                      serial: PD3714460200
                      site_id: 01dc141d-b6af-4baa-b00f-0e31ef954c4f
                      sku: EX4300-48P
                      status: disconnected
                      type: switch
                      vc_mac: f01c2df166e0
                      version: 21.4R3.5
                    total: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/setting/jse/info:
    get:
      tags:
      - Orgs Integration JSE
      summary: getOrgJseInfo
      description: Return the JSE organizations associated with the configured account. Use the returned organization names when selecting JSE provider options for secure edge tunnels.
      operationId: getOrgJseInfo
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/account_jse_info'
                - description: Linked Juniper Security Exchange account information
                  examples:
                  - cloud_name: devcentral.juniperclouds.net
                    org_names:
                    - Mist-Sys
                    - Mist-Eng
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    cloud_name: devcentral.juniperclouds.net
                    org_names:
                    - Mist-Sys
                    - Mist-Eng
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/account_jse_info'
                - description: Linked Juniper Security Exchange account information
                  examples:
                  - cloud_name: devcentral.juniperclouds.net
                    org_names:
                    - Mist-Sys
                    - Mist-Eng
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    cloud_name: devcentral.juniperclouds.net
                    org_names:
                    - Mist-Sys
                    - Mist-Eng
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/setting/jse/setup:
    delete:
      tags:
      - Orgs Integration JSE
      summary: deleteOrgJseIntegration
      description: Remove the JSE integration configuration from the organization.
      operationId: deleteOrgJseIntegration
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs Integration JSE
      summary: getOrgJseIntegration
      description: Return the JSE integration configuration, including the cloud hostname, integration username, and associated JSE organization names.
      operationId: getOrgJseIntegration
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/account_jse_info'
                - description: Linked Juniper Security Exchange account information
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/account_jse_info'
                - description: Linked Juniper Security Exchange account information
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs Integration JSE
      summary: setupOrgJseIntegration
      description: Configure the JSE integration with the JSE cloud hostname and integration-user credentials. In JSE, use a custom role with read access to `service_location` and read-write access to site and IPsec profile APIs, then create and activate the integration user and service locations.
      operationId: setupOrgJseIntegration
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/account_jse_config'
              - examples:
                - cloud_name: devcentral.juniperclouds.net
                  password: foryoureyesonly
                  username: john@abc.com
              contentMediaType: application/json
            examples:
              Example:
                value:
                  cloud_name: devcentral.juniperclouds.net
                  password: foryoureyesonly
                  username: john@abc.com
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/account_jse_info'
                - description: Linked Juniper Security Exchange account information
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/account_jse_info'
                - description: Linked Juniper Security Exchange account information
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/aamwprofiles:
    get:
      tags:
      - Orgs Advanced Anti Malware Profiles
      summary: listOrgAAMWProfiles
      description: List organization-level Advanced Anti Malware profiles that define Sky ATP file verdict handling for this organization.
      operationId: listOrgAAMWProfiles
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/aamw_profile'
                description: List of Advanced Anti Malware profiles
                examples:
                - - categories:
                    - category: executable
                      hash_lookup_only: false
                    fallback_action: block
                    file_action: block
                    name: aamw-custom
                    verdict_threshold: 8
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - categories:
                    - category: executable
                      hash_lookup_only: false
                    fallback_action: block
                    file_action: block
                    name: aamw-custom
                    verdict_threshold: 8
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/aamw_profile'
                description: List of Advanced Anti Malware profiles
                examples:
                - - categories:
                    - category: executable
                      hash_lookup_only: false
                    fallback_action: block
                    file_action: block
                    name: aamw-custom
                    verdict_threshold: 8
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - categories:
                    - category: executable
                      hash_lookup_only: false
                    fallback_action: block
                    file_action: block
                    name: aamw-custom
                    verdict_threshold: 8
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs Advanced Anti Malware Profiles
      summary: createOrgAAMWProfile
      description: Create an organization-level Advanced Anti Malware profile with Sky ATP verdict threshold, fallback action, file action, and file-category rules.
      operationId: createOrgAAMWProfile
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/aamw_profile'
              - description: Request Body
                examples:
                - categories:
                  - category: executable
                    hash_lookup_only: false
                  fallback_action: block
                  file_action: block
                  name: aamw-custom
                  verdict_threshold: 8
              contentMediaType: application/json
            examples:
              Example:
                value:
                  categories:
                  - category: executable
                    hash_lookup_only: false
                  fallback_action: block
                  file_action: block
                  name: aamw-custom
                  verdict_threshold: 8
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aamw_profile'
                - description: Advanced Anti Malware profile that controls Sky ATP file verdict handling
                  examples:
                  - categories:
                    - category: executable
                      hash_lookup_only: false
                    fallback_action: block
                    file_action: block
                    name: aamw-custom
                    verdict_threshold: 8
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    categories:
                    - category: executable
                      hash_lookup_only: false
                    fallback_action: block
                    file_action: block
                    name: aamw-custom
                    verdict_threshold: 8
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aamw_profile'
                - description: Advanced Anti Malware profile that controls Sky ATP file verdict handling
                  examples:
                  - categories:
                    - category: executable
                      hash_lookup_only: false
                    fallback_action: block
                    file_action: block
                    name: aamw-custom
                    verdict_threshold: 8
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    categories:
                    - category: executable
                      hash_lookup_only: false
                    fallback_action: block
                    file_action: block
                    name: aamw-custom
                    verdict_threshold: 8
            application/vnd.json+api:
              schema:
                allOf:
                - $ref: '#/components/schemas/aamw_profile'
                - description: Advanced Anti Malware profile that controls Sky ATP file verdict handling
                  examples:
                  - aamwprofile_id: 000000ab-00ab-00ab-00ab-0000000000ab
                    account_id: iojzXIJWEuiD73ZvydOfg
                    admin_id: 000000ab-00ab-00ab-00ab-0000000000ab
                    created_at: 2023-01-01T12:00:00Z
                    description: Example AAMW Profile Description
                    name: Example AAMW Profile
                    updated_at: 2023-01-01T12:00:00Z
                contentMediaType: application/vnd.json+api
              examples:
                Example:
                  value:
                    aamwprofile_id: 000000ab-00ab-00ab-00ab-0000000000ab
                    account_id: iojzXIJWEuiD73ZvydOfg
                    admin_id: 000000ab-00ab-00ab-00ab-0000000000ab
                    created_at: 2023-01-01T12:00:00Z
                    description: Example AAMW Profile Description
                    name: Example AAMW Profile
                    updated_at: 2023-01-01T12:00:00Z
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/aamwprofiles/{aamwprofile_id}:
    delete:
      tags:
      - Orgs Advanced Anti Malware Profiles
      summary: deleteOrgAAMWProfile
      description: Delete an Advanced Anti Malware profile from this organization.
      operationId: deleteOrgAAMWProfile
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: aamwprofile_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs Advanced Anti Malware Profiles
      summary: getOrgAAMWProfile
      description: Return an organization Advanced Anti Malware profile, including verdict threshold, actions, and file-category rules.
      operationId: getOrgAAMWProfile
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: aamwprofile_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aamw_profile'
                - description: Advanced Anti Malware profile that controls Sky ATP file verdict handling
                  examples:
                  - categories:
                    - category: executable
                      hash_lookup_only: false
                    fallback_action: block
                    file_action: block
                    name: aamw-custom
                    verdict_threshold: 8
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    categories:
                    - category: executable
                      hash_lookup_only: false
                    fallback_action: block
                    file_action: block
                    name: aamw-custom
                    verdict_threshold: 8
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aamw_profile'
                - description: Advanced Anti Malware profile that controls Sky ATP file verdict handling
                  examples:
                  - categories:
                    - category: executable
                      hash_lookup_only: false
                    fallback_action: block
                    file_action: block
                    name: aamw-custom
                    verdict_threshold: 8
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    categories:
                    - category: executable
                      hash_lookup_only: false
                    fallback_action: block
                    file_action: block
                    name: aamw-custom
                    verdict_threshold: 8
            application/vnd.json+api:
              schema:
                allOf:
                - $ref: '#/components/schemas/aamw_profile'
                - description: Advanced Anti Malware profile that controls Sky ATP file verdict handling
                  examples:
                  - aamwprofile_id: 000000ab-00ab-00ab-00ab-0000000000ab
                    account_id: iojzXIJWEuiD73ZvydOfg
                    admin_id: 000000ab-00ab-00ab-00ab-0000000000ab
                    created_at: 2023-01-01T12:00:00Z
                    description: Example AAMW Profile Description
                    name: Example AAMW Profile
                    updated_at: 2023-01-01T12:00:00Z
                contentMediaType: application/vnd.json+api
              examples:
                Example:
                  value:
                    aamwprofile_id: 000000ab-00ab-00ab-00ab-0000000000ab
                    account_id: iojzXIJWEuiD73ZvydOfg
                    admin_id: 000000ab-00ab-00ab-00ab-0000000000ab
                    created_at: 2023-01-01T12:00:00Z
                    description: Example AAMW Profile Description
                    name: Example AAMW Profile
                    updated_at: 2023-01-01T12:00:00Z
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs Advanced Anti Malware Profiles
      summary: updateOrgAAMWProfile
      description: Update an organization Advanced Anti Malware profile's Sky ATP verdict threshold, actions, or file-category rules.
      operationId: updateOrgAAMWProfile
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: aamwprofile_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/aamw_profile'
              - description: Request Body
                examples:
                - categories:
                  - category: executable
                    hash_lookup_only: false
                  fallback_action: block
                  file_action: block
                  name: aamw-custom
                  verdict_threshold: 8
              contentMediaType: application/json
            examples:
              Example:
                value:
                  categories:
                  - category: executable
                    hash_lookup_only: false
                  fallback_action: block
                  file_action: block
                  name: aamw-custom
                  verdict_threshold: 8
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aamw_profile'
                - description: Advanced Anti Malware profile that controls Sky ATP file verdict handling
                  examples:
                  - categories:
                    - category: executable
                      hash_lookup_only: false
                    fallback_action: block
                    file_action: block
                    name: aamw-custom
                    verdict_threshold: 8
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    categories:
                    - category: executable
                      hash_lookup_only: false
                    fallback_action: block
                    file_action: block
                    name: aamw-custom
                    verdict_threshold: 8
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aamw_profile'
                - description: Advanced Anti Malware profile that controls Sky ATP file verdict handling
                  examples:
                  - categories:
                    - category: executable
                      hash_lookup_only: false
                    fallback_action: block
                    file_action: block
                    name: aamw-custom
                    verdict_threshold: 8
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    categories:
                    - category: executable
                      hash_lookup_only: false
                    fallback_action: block
                    file_action: block
                    name: aamw-custom
                    verdict_threshold: 8
            application/vnd.json+api:
              schema:
                allOf:
                - $ref: '#/components/schemas/aamw_profile'
                - description: Advanced Anti Malware profile that controls Sky ATP file verdict handling
                  examples:
                  - aamwprofile_id: 000000ab-00ab-00ab-00ab-0000000000ab
                    account_id: iojzXIJWEuiD73ZvydOfg
                    admin_id: 000000ab-00ab-00ab-00ab-0000000000ab
                    created_at: 2023-01-01T12:00:00Z
                    description: Example AAMW Profile Description
                    name: Example AAMW Profile
                    updated_at: 2023-01-01T12:00:00Z
                contentMediaType: application/vnd.json+api
              examples:
                Example:
                  value:
                    aamwprofile_id: 000000ab-00ab-00ab-00ab-0000000000ab
                    account_id: iojzXIJWEuiD73ZvydOfg
                    admin_id: 000000ab-00ab-00ab-00ab-0000000000ab
                    created_at: 2023-01-01T12:00:00Z
                    description: Example AAMW Profile Description
                    name: Example AAMW Profile
                    updated_at: 2023-01-01T12:00:00Z
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/setting/skyatp/secintel_allowlist:
    put:
      tags:
      - Orgs Integration SkyATP
      summary: udpateOrgAtpAllowedList
      description: Update the Sky ATP SecIntel allowlist with domain and IP address entries for the organization.
      operationId: udpateOrgAtpAllowedList
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/skyatp_list'
              - examples:
                - domains:
                  - comment: restricted
                    value: unsafe.xxx
                  ips:
                  - comment: nas
                    value: 10.1.3.5
              contentMediaType: application/json
            examples:
              Example:
                value:
                  domains:
                  - comment: restricted
                    value: unsafe.xxx
                  ips:
                  - comment: nas
                    value: 10.1.3.5
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/skyatp_list'
                - description: Sky ATP SecIntel allowlist or blocklist entries
                  examples:
                  - domains:
                    - comment: restricted
                      value: unsafe.xxx
                    ips:
                    - comment: nas
                      value: 10.1.3.5
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    domains:
                    - comment: restricted
                      value: unsafe.xxx
                    ips:
                    - comment: nas
                      value: 10.1.3.5
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/skyatp_list'
                - description: Sky ATP SecIntel allowlist or blocklist entries
                  examples:
                  - domains:
                    - comment: restricted
                      value: unsafe.xxx
                    ips:
                    - comment: nas
                      value: 10.1.3.5
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    domains:
                    - comment: restricted
                      value: unsafe.xxx
                    ips:
                    - comment: nas
                      value: 10.1.3.5
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/setting/skyatp/secintel_blocklist:
    put:
      tags:
      - Orgs Integration SkyATP
      summary: udpateOrgAtpBlockedList
      description: Update the Sky ATP SecIntel blocklist with domain and IP address entries for the organization.
      operationId: udpateOrgAtpBlockedList
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/skyatp_list'
              - examples:
                - domains:
                  - comment: restricted
                    value: unsafe.xxx
                  ips:
                  - comment: nas
                    value: 10.1.3.5
              contentMediaType: application/json
            examples:
              Example:
                value:
                  domains:
                  - comment: restricted
                    value: unsafe.xxx
                  ips:
                  - comment: nas
                    value: 10.1.3.5
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/skyatp_list'
                - description: Sky ATP SecIntel allowlist or blocklist entries
                  examples:
                  - domains:
                    - comment: restricted
                      value: unsafe.xxx
                    ips:
                    - comment: nas
                      value: 10.1.3.5
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    domains:
                    - comment: restricted
                      value: unsafe.xxx
                    ips:
                    - comment: nas
                      value: 10.1.3.5
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/skyatp_list'
                - description: Sky ATP SecIntel allowlist or blocklist entries
                  examples:
                  - domains:
                    - comment: restricted
                      value: unsafe.xxx
                    ips:
                    - comment: nas
                      value: 10.1.3.5
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    domains:
                    - comment: restricted
                      value: unsafe.xxx
                    ips:
                    - comment: nas
                      value: 10.1.3.5
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/setting/skyatp/setup:
    delete:
      tags:
      - Orgs Integration SkyATP
      summary: deleteOrgSkyAtpIntegration
      description: Remove the Sky ATP integration configuration from the organization.
      operationId: deleteOrgSkyAtpIntegration
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs Integration SkyATP
      summary: getOrgSkyAtpIntegration
      description: Return the Sky ATP integration configuration, including linked realm information and generated SecIntel allowlist and blocklist URLs.
      operationId: getOrgSkyAtpIntegration
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/account_skyatp_data'
                - description: Sky ATP SecIntel feed data and generated list URLs
                  examples:
                  - Example:
                      value:
                        secintel:
                          third_party_threat_feeds:
                          - block_list
                        secintel_allowlist_url: https://papi.s3.amazonaws.com/secintel_allowlist/xxx...
                        secintel_blocklist_url: https://papi.s3.amazonaws.com/secintel_blocklist/xxx...
                contentMediaType: application/json
              example:
                Example:
                  value:
                    secintel:
                      third_party_threat_feeds:
                      - block_list
                    secintel_allowlist_url: https://papi.s3.amazonaws.com/secintel_allowlist/xxx...
                    secintel_blocklist_url: https://papi.s3.amazonaws.com/secintel_blocklist/xxx...
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/account_skyatp_data'
                - description: Sky ATP SecIntel feed data and generated list URLs
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs Integration SkyATP
      summary: setupOrgAtpIntegration
      description: Configure the Sky ATP integration by linking or creating the Sky ATP realm with the supplied cloud, realm, username, and password. The integration enables Security Intelligence and Advanced Anti-Malware features, with SecIntel configuration for command-and-control, DNS feeds, infected hosts, blocklists, and allowlists.
      operationId: setupOrgAtpIntegration
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/account_skyatp_config'
              - examples:
                - cloud_name: www.amerskyatp.com
                  password: foryoureyesonly
                  realm: mist-team
                  username: john@abc.com
              contentMediaType: application/json
            examples:
              Example:
                value:
                  cloud_name: www.amerskyatp.com
                  password: foryoureyesonly
                  realm: mist-team
                  username: john@abc.com
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/account_skyatp_data'
                - description: Sky ATP SecIntel feed data and generated list URLs
                  examples:
                  - Example:
                      value:
                        secintel:
                          third_party_threat_feeds:
                          - block_list
                        secintel_allowlist_url: https://papi.s3.amazonaws.com/secintel_allowlist/xxx...
                        secintel_blocklist_url: https://papi.s3.amazonaws.com/secintel_blocklist/xxx...
                contentMediaType: application/json
              example:
                Example:
                  value:
                    secintel:
                      third_party_threat_feeds:
                      - block_list
                    secintel_allowlist_url: https://papi.s3.amazonaws.com/secintel_allowlist/xxx...
                    secintel_blocklist_url: https://papi.s3.amazonaws.com/secintel_blocklist/xxx...
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/account_skyatp_data'
                - description: Sky ATP SecIntel feed data and generated list URLs
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs Integration SkyATP
      summary: udpateOrgAtpIntegration
      description: Update Sky ATP SecIntel feed configuration, including the third-party threat feeds enabled for the organization.
      operationId: udpateOrgAtpIntegration
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/account_skyatp_data'
              - examples:
                - secintel:
                    third_party_threat_feeds:
                    - block_list
              contentMediaType: application/json
            examples:
              Example:
                value:
                  secintel:
                    third_party_threat_feeds:
                    - block_list
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/account_skyatp_info'
                - description: Linked Sky ATP account and realm information
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/account_skyatp_info'
                - description: Linked Sky ATP account and realm information
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/jsi/devices:
    get:
      tags:
      - Orgs JSI
      summary: listOrgJsiDevices
      description: List organization devices connected to Juniper Support Insights (JSI), optionally filtered by model, serial number, or MAC address.
      operationId: listOrgJsiDevices
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      - name: model
        in: query
        description: Filter results by device model
        style: form
        explode: true
        schema:
          type: string
          examples:
          - AP43
      - name: serial
        in: query
        description: Filter results by device serial number
        style: form
        explode: true
        schema:
          type: string
          examples:
          - FXLH2015150025
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b350e0001
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/jse_device'
                description: JSE devices returned for an organization
                examples:
                - - ext_ip: 73.92.124.103
                    last_seen: 1654636867
                    mac: c15353123096
                    model: EX2300-C-12P
                    serial: DGCOO0015
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - ext_ip: 73.92.124.103
                    last_seen: 1654636867
                    mac: c15353123096
                    model: EX2300-C-12P
                    serial: DGCOO0015
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/jse_device'
                description: JSE devices returned for an organization
                examples:
                - - ext_ip: 73.92.124.103
                    last_seen: 1654636867
                    mac: c15353123096
                    model: EX2300-C-12P
                    serial: DGCOO0015
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - ext_ip: 73.92.124.103
                    last_seen: 1654636867
                    mac: c15353123096
                    model: EX2300-C-12P
                    serial: DGCOO0015
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/jsi/devices/outbound_ssh_cmd:
    get:
      tags:
      - Orgs JSI
      summary: adoptOrgJsiDevice
      description: Return the outbound SSH registration command used to onboard Junos devices to Juniper Support Insights (JSI).
      operationId: adoptOrgJsiDevice
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_device_config_cmd'
                - description: Device configuration command response
                  examples:
                  - cmd: >-
                      set system services ssh...

                      ...

                      set system services outbound-ssh client mist ...
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    cmd: >-
                      set system services ssh...

                      ...

                      set system services outbound-ssh client mist ...
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_device_config_cmd'
                - description: Device configuration command response
                  examples:
                  - cmd: >-
                      set system services ssh...

                      ...

                      set system services outbound-ssh client mist ...
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    cmd: >-
                      set system services ssh...

                      ...

                      set system services outbound-ssh client mist ...
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/jsi/devices/{device_mac}/shell:
    post:
      tags:
      - Orgs JSI
      summary: createOrgJsiDeviceShellSession
      description: Create a WebSocket-backed shell session for a JSI-connected device identified by MAC address.
      operationId: createOrgJsiDeviceShellSession
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session_with_url'
                - description: Response containing a WebSocket session handle and connection URL
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session_with_url'
                - description: Response containing a WebSocket session handle and connection URL
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/jsi/inventory:
    get:
      tags:
      - Orgs JSI
      summary: listOrgJsiPastPurchases
      description: "This gets all devices purchased from the accounts associated with the Org \n  * Fetch Install base devices for all linked accounts and associated account of the linked accounts. \n  * The primary and the associated account ids will be queries from SFDC by passing the linked account \n  * Returns only the device centric details of the Install base device. No customer specific information will be returned."
      operationId: listOrgJsiPastPurchases
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      - name: model
        in: query
        description: Filter results by one or more device models. Supports comma-separated values
        style: form
        explode: true
        schema:
          type: string
          examples:
          - AP43
      - name: serial
        in: query
        description: Filter results by device serial number
        style: form
        explode: true
        schema:
          type: string
          examples:
          - FXLH2015150025
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/js_inventory_item'
                description: JSI inventory items returned for an organization
                examples:
                - - device_name: name1
                    end_of_sale_time: 1561507200
                    eos_time: 1672012800
                    master: true
                    model: EX2300-24MP
                    org_id: 6e843b41-f953-4af9-80e5-e1a70f65754a
                    serial: XN3123300095
                    sku: EX2300
                    status: connected
                    suggested_version: Latest 21.4R3-Sx
                    type: switch
                    version: 23.4R2-S4.11
                    version_eos_time: 1672012800
                    version_time: 1561507200
                    warranty: Enhanced Hardware Warranty
                    warranty_time: 1672012800
                    warranty_type: Enhanced Hardware Warranty
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - device_name: name1
                    end_of_sale_time: 1561507200
                    eos_time: 1672012800
                    master: true
                    model: EX2300-24MP
                    org_id: 6e843b41-f953-4af9-80e5-e1a70f65754a
                    serial: XN3123300095
                    sku: EX2300
                    status: connected
                    suggested_version: Latest 21.4R3-Sx
                    type: switch
                    version: 23.4R2-S4.11
                    version_eos_time: 1672012800
                    version_time: 1561507200
                    warranty: Enhanced Hardware Warranty
                    warranty_time: 1672012800
                    warranty_type: Enhanced Hardware Warranty
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/js_inventory_item'
                description: JSI inventory items returned for an organization
                examples:
                - - device_name: name1
                    end_of_sale_time: 1561507200
                    eos_time: 1672012800
                    master: true
                    model: EX2300-24MP
                    org_id: 6e843b41-f953-4af9-80e5-e1a70f65754a
                    serial: XN3123300095
                    sku: EX2300
                    status: connected
                    suggested_version: Latest 21.4R3-Sx
                    type: switch
                    version: 23.4R2-S4.11
                    version_eos_time: 1672012800
                    version_time: 1561507200
                    warranty: Enhanced Hardware Warranty
                    warranty_time: 1672012800
                    warranty_type: Enhanced Hardware Warranty
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - device_name: name1
                    end_of_sale_time: 1561507200
                    eos_time: 1672012800
                    master: true
                    model: EX2300-24MP
                    org_id: 6e843b41-f953-4af9-80e5-e1a70f65754a
                    serial: XN3123300095
                    sku: EX2300
                    status: connected
                    suggested_version: Latest 21.4R3-Sx
                    type: switch
                    version: 23.4R2-S4.11
                    version_eos_time: 1672012800
                    version_time: 1561507200
                    warranty: Enhanced Hardware Warranty
                    warranty_time: 1672012800
                    warranty_type: Enhanced Hardware Warranty
        '400':
          description: Bad Request - no Juniper Account Linked
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_detail_string'
                - description: Response containing a human-readable detail message
                  examples:
                  - detail: no juniper account linked
                contentMediaType: application/json
              examples:
                No Juniper Account Linked:
                  value:
                    detail: no juniper account linked
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_detail_string'
                - description: Response containing a human-readable detail message
                  examples:
                  - detail: no juniper account linked
                contentMediaType: application/vnd.api+json
              examples:
                No Juniper Account Linked:
                  value:
                    detail: no juniper account linked
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/jsi/inventory/count:
    get:
      tags:
      - Orgs JSI
      summary: countOrgJsiAssetsAndContracts
      description: Count devices purchased from the accounts associated with the Org
      operationId: countOrgJsiAssetsAndContracts
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `account_id`, `claimed`, `has_support`, `end_of_sale_time`, `eos_time`, `version_time`, `model`, `sku`, `status`, `type`, `version`, `warranty_type`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/jsi_inventory_count_distinct'
          - description: 'Field used to group this count response. enum: `account_id`, `claimed`, `has_support`, `end_of_sale_time`, `eos_time`, `version_time`, `model`, `sku`, `status`, `type`, `version`, `warranty_type`'
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Request - no Juniper Account Linked
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_detail_string'
                - description: Response containing a human-readable detail message
                  examples:
                  - detail: no juniper account linked
                contentMediaType: application/json
              examples:
                No Juniper Account Linked:
                  value:
                    detail: no juniper account linked
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_detail_string'
                - description: Response containing a human-readable detail message
                  examples:
                  - detail: no juniper account linked
                contentMediaType: application/vnd.api+json
              examples:
                No Juniper Account Linked:
                  value:
                    detail: no juniper account linked
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/jsi/inventory/search:
    get:
      tags:
      - Orgs JSI
      summary: searchOrgJsiAssetsAndContracts
      description: "This gets all devices purchased from the accounts associated with the Org \n  * Fetch Install base devices for all linked accounts and associated account of the linked accounts. \n  * The primary and the associated account ids will be queries from SFDC by passing the linked account \n  * Returns only the device centric details of the Install base device. No customer specific information will be returned."
      operationId: searchOrgJsiAssetsAndContracts
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: claimed
        in: query
        description: Device claim status, `true` for claimed devices, `false` for all devices. Accepts multiple comma-separated boolean values.
        style: form
        explode: true
        schema:
          type: boolean
          examples:
          - 'true'
        examples:
          Untitled Example2:
            value: true
      - name: model
        in: query
        description: Filter results by device model. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - QFX10000-36Q,QFX10000-30C
          - AP43
        examples:
          Untitled Example1:
            value: QFX10000-36Q,QFX10000-30C
          Untitled Example2:
            value: AP43
      - name: serial
        in: query
        description: Filter results by device serial number. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - ACNP4666,ACNP6969
          - FXLH2015150025
        examples:
          Untitled Example1:
            value: ACNP4666,ACNP6969
          Untitled Example2:
            value: FXLH2015150025
      - name: sku
        in: query
        description: Filter results by SKU. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - QFX10000-36Q,QFX10000-30C
          - EX2300
        examples:
          Untitled Example1:
            value: QFX10000-36Q,QFX10000-30C
          Untitled Example2:
            value: EX2300
      - name: status
        in: query
        description: 'Device status. enum: `all`, `connected`, `disconnected`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/device_status'
          - description: 'Device status. enum: `all`, `connected`, `disconnected`'
      - name: warranty_type
        in: query
        description: Device warranty type used to filter Juniper Support Insight inventory
        style: form
        explode: true
        schema:
          type: string
      - name: end_of_sale_after
        in: query
        description: Filter devices with End Of Sale date after this date
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 2024-01-01
      - name: end_of_sale_before
        in: query
        description: Filter devices with End Of Sale date before this date
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 2025-12-31
      - name: eos_after
        in: query
        description: Filter devices with End Of Support date after this date
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 2024-01-01
      - name: eos_before
        in: query
        description: Filter devices with End Of Support date before this date
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 2025-12-31
      - name: version_eos_after
        in: query
        description: Filter devices with OS Version End Of Support date after this date
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 2024-01-01
      - name: version_eos_before
        in: query
        description: Filter devices with OS Version End Of Support date before this date
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 2025-12-31
      - name: contract_end_before
        in: query
        description: Filter results by service contract end date before this date
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 2025-12-31
      - name: contract_end_after
        in: query
        description: Filter results by service contract end date after this date
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 2024-01-01
      - name: contract_type
        in: query
        description: Filter results by contract type
        style: form
        explode: true
        schema:
          type: string
      - name: contract_sku
        in: query
        description: Filter results by contract SKU
        style: form
        explode: true
        schema:
          type: string
      - name: end_of_service_time
        in: query
        description: Filter results by end of service time
        style: form
        explode: true
        schema:
          type: string
      - name: support_contract_status
        in: query
        description: Filter results by service contract status
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/support_contract_status'
          - description: Filter results by service contract status
      - name: has_support
        in: query
        description: Indicates if the device is covered under active support contract. Accepts multiple comma-separated boolean values.
        style: form
        explode: true
        schema:
          type: boolean
          examples:
          - 'true'
        examples:
          Untitled Example2:
            value: true
      - name: sirt_id
        in: query
        description: To get the onboarded devices that are affected by the SIRT ID
        style: form
        explode: true
        schema:
          type: string
          examples:
          - JSA12345
      - name: pbn_id
        in: query
        description: To get the onboarded devices that are affected by the PBN ID
        style: form
        explode: true
        schema:
          type: string
          examples:
          - PBN67890
      - name: text
        in: query
        description: Wildcard text search across `account_id`, `contract_id`, `contract_reseller`, `contract_sku`, `device_name`, `distributor`, `ia_address`, `ia_country`, `ia_region`, `ia_zip_postal`, `model`, `serial`, `sku`, `status`, `suggested_version`, `version`, `warranty`
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/js_inventory_search'
                - description: Paginated JSI inventory search response
                  examples:
                  - end: 1748023308
                    limit: 1000
                    results:
                    - availability: Yes
                      claimed: true
                      contract_end_date: 2028-10-01
                      contract_id: 324343-234
                      contract_reseller: Reseller1
                      contract_sku: EX2300-24MP-AFO
                      contract_start_date: 2022-09-01
                      contract_type: Maintenance
                      current_contract_flag: No Contract
                      device_name: name1
                      distributor: Dist
                      end_of_sale_time: 1561507200
                      end_of_service_time: 1661507200
                      eol_psn: TSB18097
                      eos_time: 1672012800
                      has_support: true
                      ia_address: Address1
                      ia_country: United States
                      ia_region: Rhode Island
                      ia_zip_postal: 02865-3749
                      master: true
                      model: EX2300-24MP
                      org_id: 6e843b41-f953-4af9-80e5-e1a70f65754a
                      serial: XN3123300095
                      service_contract_no: '16036705'
                      service_contract_type: MS
                      service_decline_flag: No
                      service_eligible: Yes
                      ship_date_calc: 2022-08-31
                      sku: EX2300
                      status: connected
                      suggested_version: Latest 21.4R3-Sx
                      support_contract_status: Active
                      type: switch
                      version: 23.4R2-S4.11
                      version_description: ''
                      version_eos_time: 1672012800
                      version_time: 1561507200
                      warranty: Enhanced Hardware Warranty
                      warranty_end: 2042-11-28
                      warranty_start: 2022-09-01
                      warranty_time: 1672012800
                      warranty_type: WTY00002
                    start: 1748019708
                    total: 1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1748023308
                    limit: 1000
                    results:
                    - availability: Yes
                      claimed: true
                      contract_end_date: 2028-10-01
                      contract_id: 324343-234
                      contract_reseller: Reseller1
                      contract_sku: EX2300-24MP-AFO
                      contract_start_date: 2022-09-01
                      contract_type: Maintenance
                      current_contract_flag: No Contract
                      device_name: name1
                      distributor: Dist
                      end_of_sale_time: 1561507200
                      end_of_service_time: 1661507200
                      eol_psn: TSB18097
                      eos_time: 1672012800
                      has_support: true
                      ia_address: Address1
                      ia_country: United States
                      ia_region: Rhode Island
                      ia_zip_postal: 02865-3749
                      master: true
                      model: EX2300-24MP
                      org_id: 6e843b41-f953-4af9-80e5-e1a70f65754a
                      serial: XN3123300095
                      service_contract_no: '16036705'
                      service_contract_type: MS
                      service_decline_flag: No
                      service_eligible: Yes
                      ship_date_calc: 2022-08-31
                      sku: EX2300
                      status: connected
                      suggested_version: Latest 21.4R3-Sx
                      support_contract_status: Active
                      type: switch
                      version: 23.4R2-S4.11
                      version_description: ''
                      version_eos_time: 1672012800
                      version_time: 1561507200
                      warranty: Enhanced Hardware Warranty
                      warranty_end: 2042-11-28
                      warranty_start: 2022-09-01
                      warranty_time: 1672012800
                      warranty_type: WTY00002
                    start: 1748019708
                    total: 1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/js_inventory_search'
                - description: Paginated JSI inventory search response
                  examples:
                  - end: 1748023308
                    limit: 1000
                    results:
                    - availability: Yes
                      claimed: true
                      contract_end_date: 2028-10-01
                      contract_id: 324343-234
                      contract_reseller: Reseller1
                      contract_sku: EX2300-24MP-AFO
                      contract_start_date: 2022-09-01
                      contract_type: Maintenance
                      current_contract_flag: No Contract
                      device_name: name1
                      distributor: Dist
                      end_of_sale_time: 1561507200
                      end_of_service_time: 1661507200
                      eol_psn: TSB18097
                      eos_time: 1672012800
                      has_support: true
                      ia_address: Address1
                      ia_country: United States
                      ia_region: Rhode Island
                      ia_zip_postal: 02865-3749
                      master: true
                      model: EX2300-24MP
                      org_id: 6e843b41-f953-4af9-80e5-e1a70f65754a
                      serial: XN3123300095
                      service_contract_no: '16036705'
                      service_contract_type: MS
                      service_decline_flag: No
                      service_eligible: Yes
                      ship_date_calc: 2022-08-31
                      sku: EX2300
                      status: connected
                      suggested_version: Latest 21.4R3-Sx
                      support_contract_status: Active
                      type: switch
                      version: 23.4R2-S4.11
                      version_description: ''
                      version_eos_time: 1672012800
                      version_time: 1561507200
                      warranty: Enhanced Hardware Warranty
                      warranty_end: 2042-11-28
                      warranty_start: 2022-09-01
                      warranty_time: 1672012800
                      warranty_type: WTY00002
                    start: 1748019708
                    total: 1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1748023308
                    limit: 1000
                    results:
                    - availability: Yes
                      claimed: true
                      contract_end_date: 2028-10-01
                      contract_id: 324343-234
                      contract_reseller: Reseller1
                      contract_sku: EX2300-24MP-AFO
                      contract_start_date: 2022-09-01
                      contract_type: Maintenance
                      current_contract_flag: No Contract
                      device_name: name1
                      distributor: Dist
                      end_of_sale_time: 1561507200
                      end_of_service_time: 1661507200
                      eol_psn: TSB18097
                      eos_time: 1672012800
                      has_support: true
                      ia_address: Address1
                      ia_country: United States
                      ia_region: Rhode Island
                      ia_zip_postal: 02865-3749
                      master: true
                      model: EX2300-24MP
                      org_id: 6e843b41-f953-4af9-80e5-e1a70f65754a
                      serial: XN3123300095
                      service_contract_no: '16036705'
                      service_contract_type: MS
                      service_decline_flag: No
                      service_eligible: Yes
                      ship_date_calc: 2022-08-31
                      sku: EX2300
                      status: connected
                      suggested_version: Latest 21.4R3-Sx
                      support_contract_status: Active
                      type: switch
                      version: 23.4R2-S4.11
                      version_description: ''
                      version_eos_time: 1672012800
                      version_time: 1561507200
                      warranty: Enhanced Hardware Warranty
                      warranty_end: 2042-11-28
                      warranty_start: 2022-09-01
                      warranty_time: 1672012800
                      warranty_type: WTY00002
                    start: 1748019708
                    total: 1
        '400':
          description: Bad Request - no Juniper Account Linked
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_detail_string'
                - description: Response containing a human-readable detail message
                  examples:
                  - detail: no juniper account linked
                contentMediaType: application/json
              examples:
                No Juniper Account Linked:
                  value:
                    detail: no juniper account linked
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_detail_string'
                - description: Response containing a human-readable detail message
                  examples:
                  - detail: no juniper account linked
                contentMediaType: application/vnd.api+json
              examples:
                No Juniper Account Linked:
                  value:
                    detail: no juniper account linked
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/jsi/pbn/count:
    get:
      tags:
      - Orgs JSI
      summary: countOrgJsiPbn
      description: Get count of PBN advisories grouped by specified field
      operationId: countOrgJsiPbn
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field to group by enum: `versions`, `models`, `customer_risk`, `bug_type`'
        required: true
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/count_pbn_distinct'
          - description: 'Field to group by enum: `versions`, `models`, `customer_risk`, `bug_type`'
            examples:
            - versions
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/jsi/pbn/search:
    get:
      tags:
      - Orgs JSI
      summary: searchOrgJsiPbn
      description: Text search for PBN (Problem Bug Notification) advisories. Search can be done on versions, models, customer_risk, id, and bug_type fields.
      operationId: searchOrgJsiPbn
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: versions
        in: query
        description: Software versions affected by the PBN
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 20.4R3
      - name: models
        in: query
        description: Models affected by the PBN
        style: form
        explode: true
        schema:
          type: string
      - name: customer_risk
        in: query
        description: 'Filter results by customer risk. enum: `Critical`, `Major`, `Minor`'
        style: form
        explode: true
        schema:
          type: string
      - name: id
        in: query
        description: ID of the PBN
        style: form
        explode: true
        schema:
          type: string
          examples:
          - '1403338'
      - name: bug_type
        in: query
        description: Filter results by bug type
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/jsi_pbn_bug_type'
          - description: Filter results by bug type
      - name: text
        in: query
        description: Wildcard search across `versions`, `models`, `customer_risk`, `id`, `bug_type`
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/jsi_pbn_search'
                - description: Juniper Security Intelligence PBN search response with result metadata
                  examples:
                  - end: 1753415677
                    limit: 1
                    next: /api/v1/orgs/bf105f5e-2490-453b-9dc0-81224ca295cf/jsi/pbn/search?end=1753415677&limit=1&search_after=%5B%221403338%22%5D&start=1753412077
                    results:
                    - bug_type: Day-1
                      customer_risk: Major
                      id: '1403338'
                      introduced_in: ''
                      models:
                      - MX10008
                      - vMX
                      product_family:
                      - EX2200
                      - QFX5210
                      release_notes: In aggregated interfaces and STP (Spanning Tree Protocol) scenario, the STP does not work.
                      restoration: ''
                      title: The STP does not work when aggregated interfaces number is "ae1000"
                      versions:
                      - 23.4R2-S1.1
                      workaround: Use the 'ae' number from 0 to 999 in QFX5000 and 0 to 479 in other QFXs / EX under STP.
                      workaround_provided: yes
                    start: 1753412077
                    total: 604
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1753415677
                    limit: 1
                    next: /api/v1/orgs/bf105f5e-2490-453b-9dc0-81224ca295cf/jsi/pbn/search?end=1753415677&limit=1&search_after=%5B%221403338%22%5D&start=1753412077
                    results:
                    - bug_type: Day-1
                      customer_risk: Major
                      id: '1403338'
                      introduced_in: ''
                      models:
                      - MX10008
                      - vMX
                      product_family:
                      - EX2200
                      - QFX5210
                      release_notes: In aggregated interfaces and STP (Spanning Tree Protocol) scenario, the STP does not work.
                      restoration: ''
                      title: The STP does not work when aggregated interfaces number is "ae1000"
                      versions:
                      - 23.4R2-S1.1
                      workaround: Use the 'ae' number from 0 to 999 in QFX5000 and 0 to 479 in other QFXs / EX under STP.
                      workaround_provided: yes
                    start: 1753412077
                    total: 604
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/jsi_pbn_search'
                - description: Juniper Security Intelligence PBN search response with result metadata
                  examples:
                  - end: 1753415677
                    limit: 1
                    next: /api/v1/orgs/bf105f5e-2490-453b-9dc0-81224ca295cf/jsi/pbn/search?end=1753415677&limit=1&search_after=%5B%221403338%22%5D&start=1753412077
                    results:
                    - bug_type: Day-1
                      customer_risk: Major
                      id: '1403338'
                      introduced_in: ''
                      models:
                      - MX10008
                      - vMX
                      product_family:
                      - EX2200
                      - QFX5210
                      release_notes: In aggregated interfaces and STP (Spanning Tree Protocol) scenario, the STP does not work.
                      restoration: ''
                      title: The STP does not work when aggregated interfaces number is "ae1000"
                      versions:
                      - 23.4R2-S1.1
                      workaround: Use the 'ae' number from 0 to 999 in QFX5000 and 0 to 479 in other QFXs / EX under STP.
                      workaround_provided: yes
                    start: 1753412077
                    total: 604
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1753415677
                    limit: 1
                    next: /api/v1/orgs/bf105f5e-2490-453b-9dc0-81224ca295cf/jsi/pbn/search?end=1753415677&limit=1&search_after=%5B%221403338%22%5D&start=1753412077
                    results:
                    - bug_type: Day-1
                      customer_risk: Major
                      id: '1403338'
                      introduced_in: ''
                      models:
                      - MX10008
                      - vMX
                      product_family:
                      - EX2200
                      - QFX5210
                      release_notes: In aggregated interfaces and STP (Spanning Tree Protocol) scenario, the STP does not work.
                      restoration: ''
                      title: The STP does not work when aggregated interfaces number is "ae1000"
                      versions:
                      - 23.4R2-S1.1
                      workaround: Use the 'ae' number from 0 to 999 in QFX5000 and 0 to 479 in other QFXs / EX under STP.
                      workaround_provided: yes
                    start: 1753412077
                    total: 604
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/jsi/sirt/count:
    get:
      tags:
      - Orgs JSI
      summary: countOrgJsiSirt
      description: Get count of SIRT advisories grouped by specified field
      operationId: countOrgJsiSirt
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field to group by. enum: `jsa_updated_date`, `models`, `severity`, `versions`'
        required: true
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/count_sirt_distinct'
          - description: 'Field to group by. enum: `jsa_updated_date`, `models`, `severity`, `versions`'
            examples:
            - versions
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/jsi/sirt/search:
    get:
      tags:
      - Orgs JSI
      summary: searchOrgJsiSirt
      description: Search and get all the SIRT for the onboarded devices. Search can be done on severity, id, updated_after, updated_before, published_after, published_before, models, versions, and text fields.
      operationId: searchOrgJsiSirt
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: severity
        in: query
        description: Filter results by SIRT severity
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/jsi_sirt_severity'
          - description: Filter results by SIRT severity
      - name: id
        in: query
        description: JSA number
        style: form
        explode: true
        schema:
          type: string
          examples:
          - JSA100053
      - name: updated_after
        in: query
        description: JSA Updated date to be filtered after this date
        style: form
        explode: true
        schema:
          type: string
      - name: updated_before
        in: query
        description: JSA Updated date to be filtered before this date
        style: form
        explode: true
        schema:
          type: string
      - name: published_after
        in: query
        description: JSA Published date to be filtered after this date
        style: form
        explode: true
        schema:
          type: string
      - name: published_before
        in: query
        description: JSA Published date to be filtered before this date
        style: form
        explode: true
        schema:
          type: string
      - name: models
        in: query
        description: Models affected by the SIRT
        style: form
        explode: true
        schema:
          type: string
      - name: versions
        in: query
        description: Software versions affected by the SIRT
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 20.4R3
      - name: text
        in: query
        description: Wildcard search across `versions`, `models`, `severity`, `id`
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/jsi_sirt_search'
                - description: Juniper Security Intelligence SIRT search response with result metadata
                  examples:
                  - end: 1753411849
                    limit: 1
                    next: /api/v1/orgs/bf105f5e-2490-453b-9dc0-81224ca295cf/jsi/sirt/search?end=1753411849&limit=1&search_after=%5B%22JSA100053%22%5D&start=1753408249
                    results:
                    - cvss_score: 6.5
                      id: JSA100053
                      models:
                      - MX10008
                      - vMX
                      problem: >
                        An Improper Handling of Length Parameter Inconsistency vulnerability in the routing protocol daemon (rpd).
                      published_date: 1752019200
                      release_notes: An Improper Handling of Length Parameter Inconsistency vulnerability in the routing protocol daemon (rpd).
                      severity: Medium
                      solution: 'false'
                      title: 'Junos OS and Junos OS Evolved: In an EVPN environment, receipt of a specifically malformed BGP update causes RPD crash'
                      updated_date: 1752019200
                      versions:
                      - 23.4R2-S1.1
                      workaround: ''
                    start: 1753408249
                    total: 14
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1753411849
                    limit: 1
                    next: /api/v1/orgs/bf105f5e-2490-453b-9dc0-81224ca295cf/jsi/sirt/search?end=1753411849&limit=1&search_after=%5B%22JSA100053%22%5D&start=1753408249
                    results:
                    - cvss_score: 6.5
                      id: JSA100053
                      models:
                      - MX10008
                      - vMX
                      problem: >
                        An Improper Handling of Length Parameter Inconsistency vulnerability in the routing protocol daemon (rpd).
                      published_date: 1752019200
                      release_notes: An Improper Handling of Length Parameter Inconsistency vulnerability in the routing protocol daemon (rpd).
                      severity: Medium
                      solution: 'false'
                      title: 'Junos OS and Junos OS Evolved: In an EVPN environment, receipt of a specifically malformed BGP update causes RPD crash'
                      updated_date: 1752019200
                      versions:
                      - 23.4R2-S1.1
                      workaround: ''
                    start: 1753408249
                    total: 14
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/jsi_sirt_search'
                - description: Juniper Security Intelligence SIRT search response with result metadata
                  examples:
                  - end: 1753411849
                    limit: 1
                    next: /api/v1/orgs/bf105f5e-2490-453b-9dc0-81224ca295cf/jsi/sirt/search?end=1753411849&limit=1&search_after=%5B%22JSA100053%22%5D&start=1753408249
                    results:
                    - cvss_score: 6.5
                      id: JSA100053
                      models:
                      - MX10008
                      - vMX
                      problem: >
                        An Improper Handling of Length Parameter Inconsistency vulnerability in the routing protocol daemon (rpd).
                      published_date: 1752019200
                      release_notes: An Improper Handling of Length Parameter Inconsistency vulnerability in the routing protocol daemon (rpd).
                      severity: Medium
                      solution: 'false'
                      title: 'Junos OS and Junos OS Evolved: In an EVPN environment, receipt of a specifically malformed BGP update causes RPD crash'
                      updated_date: 1752019200
                      versions:
                      - 23.4R2-S1.1
                      workaround: ''
                    start: 1753408249
                    total: 14
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1753411849
                    limit: 1
                    next: /api/v1/orgs/bf105f5e-2490-453b-9dc0-81224ca295cf/jsi/sirt/search?end=1753411849&limit=1&search_after=%5B%22JSA100053%22%5D&start=1753408249
                    results:
                    - cvss_score: 6.5
                      id: JSA100053
                      models:
                      - MX10008
                      - vMX
                      problem: >
                        An Improper Handling of Length Parameter Inconsistency vulnerability in the routing protocol daemon (rpd).
                      published_date: 1752019200
                      release_notes: An Improper Handling of Length Parameter Inconsistency vulnerability in the routing protocol daemon (rpd).
                      severity: Medium
                      solution: 'false'
                      title: 'Junos OS and Junos OS Evolved: In an EVPN environment, receipt of a specifically malformed BGP update causes RPD crash'
                      updated_date: 1752019200
                      versions:
                      - 23.4R2-S1.1
                      workaround: ''
                    start: 1753408249
                    total: 14
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/claim:
    post:
      tags:
      - Orgs Licenses
      summary: claimOrgLicense
      description: Synchronously claims licenses and/or inventory devices from an activation code. All inventory devices are claimed immediately during the request.
      operationId: claimOrgLicense
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/claim_activation'
              - description: Request Body
                examples:
                - code: ZHT3K-H36DT-MG85D-M61AC
                  type: all
              contentMediaType: application/json
            examples:
              Example:
                value:
                  code: ZHT3K-H36DT-MG85D-M61AC
                  type: all
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_claim_license'
                - description: Result of claiming licenses or activation codes
                  examples:
                  - inventory_added:
                    - mac: 5c5b35000018
                      magic: 6JG8EPTFV2A9Z2N
                      model: AP41
                      serial: FXLH2015150025
                      type: ap
                    inventory_duplicated:
                    - mac: 5c5b35000012
                      magic: DVH4VSNMSZPDXBR
                      model: AP41
                      serial: FXLH2015150027
                      type: ap
                    inventory_pending:
                    - mac: 5c5b35000012
                    license_added:
                    - end: 1520380800
                      quantity: 180
                      start: 1504828800
                      type: SUB-MAN
                    - end: 1520380800
                      quantity: 120
                      start: 1504828800
                      type: SUB-LOC
                    license_duplicated:
                    - end: 1520380800
                      quantity: 180
                      start: 1504828800
                      type: SUB-MAN
                    license_error:
                    - order: '00000464'
                      reason: ''
                contentMediaType: application/json
              examples:
                Licenses Successfully Claimed And Applied:
                  value:
                    inventory_added:
                    - mac: 5c5b35000018
                      magic: 6JG8EPTFV2A9Z2N
                      model: AP41
                      serial: FXLH2015150025
                      type: ap
                    inventory_duplicated:
                    - mac: 5c5b35000012
                      magic: DVH4VSNMSZPDXBR
                      model: AP41
                      serial: FXLH2015150027
                      type: ap
                    inventory_pending:
                    - mac: 5c5b35000012
                    license_added:
                    - end: 1520380800
                      quantity: 180
                      start: 1504828800
                      type: SUB-MAN
                    - end: 1520380800
                      quantity: 120
                      start: 1504828800
                      type: SUB-LOC
                    license_duplicated:
                    - end: 1520380800
                      quantity: 180
                      start: 1504828800
                      type: SUB-MAN
                    license_error:
                    - order: '00000464'
                      reason: ''
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_claim_license'
                - description: Result of claiming licenses or activation codes
                  examples:
                  - inventory_added:
                    - mac: 5c5b35000018
                      magic: 6JG8EPTFV2A9Z2N
                      model: AP41
                      serial: FXLH2015150025
                      type: ap
                    inventory_duplicated:
                    - mac: 5c5b35000012
                      magic: DVH4VSNMSZPDXBR
                      model: AP41
                      serial: FXLH2015150027
                      type: ap
                    inventory_pending:
                    - mac: 5c5b35000012
                    license_added:
                    - end: 1520380800
                      quantity: 180
                      start: 1504828800
                      type: SUB-MAN
                    - end: 1520380800
                      quantity: 120
                      start: 1504828800
                      type: SUB-LOC
                    license_duplicated:
                    - end: 1520380800
                      quantity: 180
                      start: 1504828800
                      type: SUB-MAN
                    license_error:
                    - order: '00000464'
                      reason: ''
                contentMediaType: application/vnd.api+json
              examples:
                Licenses Successfully Claimed And Applied:
                  value:
                    inventory_added:
                    - mac: 5c5b35000018
                      magic: 6JG8EPTFV2A9Z2N
                      model: AP41
                      serial: FXLH2015150025
                      type: ap
                    inventory_duplicated:
                    - mac: 5c5b35000012
                      magic: DVH4VSNMSZPDXBR
                      model: AP41
                      serial: FXLH2015150027
                      type: ap
                    inventory_pending:
                    - mac: 5c5b35000012
                    license_added:
                    - end: 1520380800
                      quantity: 180
                      start: 1504828800
                      type: SUB-MAN
                    - end: 1520380800
                      quantity: 120
                      start: 1504828800
                      type: SUB-LOC
                    license_duplicated:
                    - end: 1520380800
                      quantity: 180
                      start: 1504828800
                      type: SUB-MAN
                    license_error:
                    - order: '00000464'
                      reason: ''
        '400':
          description: Invalid key (or already used)
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/claim/status:
    get:
      tags:
      - Orgs Licenses
      summary: GetOrgLicenseAsyncClaimStatus
      description: Return processing status for an asynchronous organization license claim, optionally including per-device license details.
      operationId: GetOrgLicenseAsyncClaimStatus
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: detail
        in: query
        description: Whether to include license details in the claim status response
        style: form
        explode: true
        schema:
          type: boolean
          examples:
          - true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_async_license'
                - description: Asynchronous license claim progress response
                  examples:
                  - completed:
                    - '000000000022'
                    - '000000000011'
                    details:
                    - mac: '000000000022'
                      status: added
                      timestamp: 1709598053
                    failed: 0
                    incompleted: []
                    processed: 2
                    scheduled_at: 1709598052
                    status: done
                    succeed: 2
                    timestamp: 1709598053
                    total: 2
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    completed:
                    - '000000000022'
                    - '000000000011'
                    details:
                    - mac: '000000000022'
                      status: added
                      timestamp: 1709598053
                    failed: 0
                    incompleted: []
                    processed: 2
                    scheduled_at: 1709598052
                    status: done
                    succeed: 2
                    timestamp: 1709598053
                    total: 2
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_async_license'
                - description: Asynchronous license claim progress response
                  examples:
                  - completed:
                    - '000000000022'
                    - '000000000011'
                    details:
                    - mac: '000000000022'
                      status: added
                      timestamp: 1709598053
                    failed: 0
                    incompleted: []
                    processed: 2
                    scheduled_at: 1709598052
                    status: done
                    succeed: 2
                    timestamp: 1709598053
                    total: 2
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    completed:
                    - '000000000022'
                    - '000000000011'
                    details:
                    - mac: '000000000022'
                      status: added
                      timestamp: 1709598053
                    failed: 0
                    incompleted: []
                    processed: 2
                    scheduled_at: 1709598052
                    status: done
                    succeed: 2
                    timestamp: 1709598053
                    total: 2
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/claims:
    get:
      tags:
      - Orgs Licenses
      summary: listOrgAsyncClaims
      description: List all async inventory claim jobs for the organization, optionally including per-device details per claim.
      operationId: listOrgAsyncClaims
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: detail
        in: query
        description: Whether to include per-device detail in each claim record
        style: form
        explode: true
        schema:
          type: boolean
          examples:
          - true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_async_claims_list'
                - description: List of async inventory claim jobs for the organization
                  examples:
                  - '{"claims":[{"claim_id":"8e2a0c6f-6f3c-4c4e-9c72-8c5b1c1b6b9b","completed":["000000000022","000000000011"],"failed":0,"incompleted":[],"org_id":"44fe2c6b-7d7d-46e6-8d4f-5ce6a7c6b01a","processed":2,"scheduled_at":1709598052,"status":"done","succeed":2,"timestamp":1709598053,"total":2},{"claim_id":"3a7b6c1e-4e5a-4eaa-9c7f-9a9c62b7f402","completed":["000000000044"],"failed":0,"incompleted":["000000000033"],"org_id":"44fe2c6b-7d7d-46e6-8d4f-5ce6a7c6b01a","processed":1,"scheduled_at":1709598070,"status":"ongoing","succeed":1,"timestamp":1709598075,"total":2}]}'
                  - '{"claims":[{"claim_id":"8e2a0c6f-6f3c-4c4e-9c72-8c5b1c1b6b9b","completed":["000000000022","000000000011"],"details":[{"mac":"000000000022","status":"added","timestamp":1709598053},{"mac":"000000000011","status":"added","timestamp":1709598053}],"failed":0,"incompleted":[],"org_id":"44fe2c6b-7d7d-46e6-8d4f-5ce6a7c6b01a","processed":2,"scheduled_at":1709598052,"status":"done","succeed":2,"timestamp":1709598053,"total":2}]}'
                contentMediaType: application/json
              examples:
                Detail False:
                  value:
                    claims:
                    - claim_id: 8e2a0c6f-6f3c-4c4e-9c72-8c5b1c1b6b9b
                      completed:
                      - '000000000022'
                      - '000000000011'
                      failed: 0
                      incompleted: []
                      org_id: 44fe2c6b-7d7d-46e6-8d4f-5ce6a7c6b01a
                      processed: 2
                      scheduled_at: 1709598052
                      status: done
                      succeed: 2
                      timestamp: 1709598053
                      total: 2
                    - claim_id: 3a7b6c1e-4e5a-4eaa-9c7f-9a9c62b7f402
                      completed:
                      - '000000000044'
                      failed: 0
                      incompleted:
                      - '000000000033'
                      org_id: 44fe2c6b-7d7d-46e6-8d4f-5ce6a7c6b01a
                      processed: 1
                      scheduled_at: 1709598070
                      status: ongoing
                      succeed: 1
                      timestamp: 1709598075
                      total: 2
                Detail True:
                  value:
                    claims:
                    - claim_id: 8e2a0c6f-6f3c-4c4e-9c72-8c5b1c1b6b9b
                      completed:
                      - '000000000022'
                      - '000000000011'
                      details:
                      - mac: '000000000022'
                        status: added
                        timestamp: 1709598053
                      - mac: '000000000011'
                        status: added
                        timestamp: 1709598053
                      failed: 0
                      incompleted: []
                      org_id: 44fe2c6b-7d7d-46e6-8d4f-5ce6a7c6b01a
                      processed: 2
                      scheduled_at: 1709598052
                      status: done
                      succeed: 2
                      timestamp: 1709598053
                      total: 2
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_async_claims_list'
                - description: List of async inventory claim jobs for the organization
                  examples:
                  - '{"claims":[{"claim_id":"8e2a0c6f-6f3c-4c4e-9c72-8c5b1c1b6b9b","completed":["000000000022","000000000011"],"failed":0,"incompleted":[],"org_id":"44fe2c6b-7d7d-46e6-8d4f-5ce6a7c6b01a","processed":2,"scheduled_at":1709598052,"status":"done","succeed":2,"timestamp":1709598053,"total":2},{"claim_id":"3a7b6c1e-4e5a-4eaa-9c7f-9a9c62b7f402","completed":["000000000044"],"failed":0,"incompleted":["000000000033"],"org_id":"44fe2c6b-7d7d-46e6-8d4f-5ce6a7c6b01a","processed":1,"scheduled_at":1709598070,"status":"ongoing","succeed":1,"timestamp":1709598075,"total":2}]}'
                  - '{"claims":[{"claim_id":"8e2a0c6f-6f3c-4c4e-9c72-8c5b1c1b6b9b","completed":["000000000022","000000000011"],"details":[{"mac":"000000000022","status":"added","timestamp":1709598053},{"mac":"000000000011","status":"added","timestamp":1709598053}],"failed":0,"incompleted":[],"org_id":"44fe2c6b-7d7d-46e6-8d4f-5ce6a7c6b01a","processed":2,"scheduled_at":1709598052,"status":"done","succeed":2,"timestamp":1709598053,"total":2}]}'
                contentMediaType: application/vnd.api+json
              examples:
                Detail False:
                  value:
                    claims:
                    - claim_id: 8e2a0c6f-6f3c-4c4e-9c72-8c5b1c1b6b9b
                      completed:
                      - '000000000022'
                      - '000000000011'
                      failed: 0
                      incompleted: []
                      org_id: 44fe2c6b-7d7d-46e6-8d4f-5ce6a7c6b01a
                      processed: 2
                      scheduled_at: 1709598052
                      status: done
                      succeed: 2
                      timestamp: 1709598053
                      total: 2
                    - claim_id: 3a7b6c1e-4e5a-4eaa-9c7f-9a9c62b7f402
                      completed:
                      - '000000000044'
                      failed: 0
                      incompleted:
                      - '000000000033'
                      org_id: 44fe2c6b-7d7d-46e6-8d4f-5ce6a7c6b01a
                      processed: 1
                      scheduled_at: 1709598070
                      status: ongoing
                      succeed: 1
                      timestamp: 1709598075
                      total: 2
                Detail True:
                  value:
                    claims:
                    - claim_id: 8e2a0c6f-6f3c-4c4e-9c72-8c5b1c1b6b9b
                      completed:
                      - '000000000022'
                      - '000000000011'
                      details:
                      - mac: '000000000022'
                        status: added
                        timestamp: 1709598053
                      - mac: '000000000011'
                        status: added
                        timestamp: 1709598053
                      failed: 0
                      incompleted: []
                      org_id: 44fe2c6b-7d7d-46e6-8d4f-5ce6a7c6b01a
                      processed: 2
                      scheduled_at: 1709598052
                      status: done
                      succeed: 2
                      timestamp: 1709598053
                      total: 2
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs Licenses
      summary: createOrgAsyncClaim
      description: >-
        Schedules an async claim for inventory devices. Inventory claiming is queued and processed in the background; the response returns immediately with a `claim_id` for polling. Licenses (if `type=all`) are still claimed synchronously during the request.


        Use `GET /api/v1/orgs/{org_id}/claims/{claim_id}` to poll the result.
      operationId: createOrgAsyncClaim
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/claim_activation_async'
              - description: Request Body
                examples:
                - code: ZHT3K-H36DT-MG85D-M61AC
                  type: inventory
              contentMediaType: application/json
            examples:
              Example:
                value:
                  code: ZHT3K-H36DT-MG85D-M61AC
                  type: inventory
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_async_claim_create'
                - description: Response to an async inventory claim request
                  examples:
                  - claim_id: 8e2a0c6f-6f3c-4c4e-9c72-8c5b1c1b6b9b
                    inventory_pending:
                    - mac: 5c5b35000012
                    - mac: 5c5b35000018
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    claim_id: 8e2a0c6f-6f3c-4c4e-9c72-8c5b1c1b6b9b
                    inventory_pending:
                    - mac: 5c5b35000012
                    - mac: 5c5b35000018
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_async_claim_create'
                - description: Response to an async inventory claim request
                  examples:
                  - claim_id: 8e2a0c6f-6f3c-4c4e-9c72-8c5b1c1b6b9b
                    inventory_pending:
                    - mac: 5c5b35000012
                    - mac: 5c5b35000018
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    claim_id: 8e2a0c6f-6f3c-4c4e-9c72-8c5b1c1b6b9b
                    inventory_pending:
                    - mac: 5c5b35000012
                    - mac: 5c5b35000018
        '400':
          description: Invalid key (or already used)
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/claims/{claim_id}:
    get:
      tags:
      - Orgs Licenses
      summary: getOrgAsyncClaimStatus
      description: Return the processing status for a specific async inventory claim job, optionally including per-device details.
      operationId: getOrgAsyncClaimStatus
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: claim_id
        in: path
        description: Unique identifier of the async claim job
        required: true
        schema:
          type: string
          contentEncoding: uuid
      - name: detail
        in: query
        description: Whether to include per-device detail in the claim status response
        style: form
        explode: true
        schema:
          type: boolean
          examples:
          - true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_async_claim_status'
                - description: Async inventory claim job status
                  examples:
                  - claim_id: 8e2a0c6f-6f3c-4c4e-9c72-8c5b1c1b6b9b
                    completed:
                    - '000000000022'
                    - '000000000011'
                    details:
                    - mac: '000000000022'
                      status: added
                      timestamp: 1709598053
                    - mac: '000000000011'
                      status: added
                      timestamp: 1709598053
                    failed: 0
                    incompleted: []
                    org_id: 44fe2c6b-7d7d-46e6-8d4f-5ce6a7c6b01a
                    processed: 2
                    scheduled_at: 1709598052
                    status: done
                    succeed: 2
                    timestamp: 1709598053
                    total: 2
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    claim_id: 8e2a0c6f-6f3c-4c4e-9c72-8c5b1c1b6b9b
                    completed:
                    - '000000000022'
                    - '000000000011'
                    details:
                    - mac: '000000000022'
                      status: added
                      timestamp: 1709598053
                    - mac: '000000000011'
                      status: added
                      timestamp: 1709598053
                    failed: 0
                    incompleted: []
                    org_id: 44fe2c6b-7d7d-46e6-8d4f-5ce6a7c6b01a
                    processed: 2
                    scheduled_at: 1709598052
                    status: done
                    succeed: 2
                    timestamp: 1709598053
                    total: 2
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_async_claim_status'
                - description: Async inventory claim job status
                  examples:
                  - claim_id: 8e2a0c6f-6f3c-4c4e-9c72-8c5b1c1b6b9b
                    completed:
                    - '000000000022'
                    - '000000000011'
                    details:
                    - mac: '000000000022'
                      status: added
                      timestamp: 1709598053
                    - mac: '000000000011'
                      status: added
                      timestamp: 1709598053
                    failed: 0
                    incompleted: []
                    org_id: 44fe2c6b-7d7d-46e6-8d4f-5ce6a7c6b01a
                    processed: 2
                    scheduled_at: 1709598052
                    status: done
                    succeed: 2
                    timestamp: 1709598053
                    total: 2
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    claim_id: 8e2a0c6f-6f3c-4c4e-9c72-8c5b1c1b6b9b
                    completed:
                    - '000000000022'
                    - '000000000011'
                    details:
                    - mac: '000000000022'
                      status: added
                      timestamp: 1709598053
                    - mac: '000000000011'
                      status: added
                      timestamp: 1709598053
                    failed: 0
                    incompleted: []
                    org_id: 44fe2c6b-7d7d-46e6-8d4f-5ce6a7c6b01a
                    processed: 2
                    scheduled_at: 1709598052
                    status: done
                    succeed: 2
                    timestamp: 1709598053
                    total: 2
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/licenses:
    get:
      tags:
      - Orgs Licenses
      summary: getOrgLicensesSummary
      description: Return the organization license entitlement, subscription, amendment, consumption, and available-license summary.
      operationId: getOrgLicensesSummary
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/license'
                - description: Organization license entitlement, subscription, and usage summary
                  examples:
                  - amendments:
                    - created_time: 1644684842
                      end_time: 1744156799
                      id: ff0a14f6-1234-5678-90ab-c8e64d4bc6c6
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1632873600
                      subscription_id: VNA-000000af
                      type: SUB-VNA
                    - created_time: 1644684842
                      end_time: 1744156799
                      id: c1c28812-1234-5678-90ab-dc95680da61e
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1632873600
                      subscription_id: MAN-000008be
                      type: SUB-MAN
                    - created_time: 1644684842
                      end_time: 1744243199
                      id: 96c0a41f-1234-5678-90ab-afe74817e9fd
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1586476800
                      subscription_id: EX24-000000bc
                      type: SUB-EX24
                    entitled:
                      SUB-ENG: 26
                      SUB-EX24: 9
                      SUB-MAN: 26
                      SUB-VNA: 26
                    licenses:
                    - created_time: 1555353534
                      end_time: 1586822399
                      id: 693a41a6-1234-5678-90ab-f53dbd3a31c0
                      modified_time: 1555353534
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 0
                      start_time: 1555286400
                      subscription_id: VNA-000000aa
                      type: SUB-VNA
                    - created_time: 1576132516
                      end_time: 1586822399
                      id: 656607cf-1234-5678-90ab-fc9035614ea5
                      modified_time: 1576132516
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 8
                      remaining_quantity: 0
                      start_time: 1576022400
                      subscription_id: VNA-000000ab
                      type: SUB-VNA
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: db50d0bc-1234-5678-90ab-e439958cb06b
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: MAN-000000ac
                      type: SUB-MAN
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: 2ff9e84a-1234-5678-90ab-fb9ec0726e01
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: ENG-000000ad
                      type: SUB-ENG
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: 16df7ea6-1234-5678-90ab-78018cd4024d
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: VNA-000000ae
                      type: SUB-VNA
                    - created_time: 1586237081
                      end_time: 1744243199
                      id: 1b6f68d5-1234-5678-90ab-70d3e6d18c73
                      modified_time: 1586237081
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: VNA-000000af
                      type: SUB-VNA
                    - created_time: 1586237097
                      end_time: 1744243199
                      id: 1375c9bf-1234-5678-90ab-9c636708c89e
                      modified_time: 1586237097
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: MAN-000000ba
                      type: SUB-MAN
                    - created_time: 1586237137
                      end_time: 1744243199
                      id: 5974e979-1234-5678-90ab-438f833ec1c9
                      modified_time: 1586237137
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: ENG-000000bb
                      type: SUB-ENG
                    - created_time: 1629947267
                      end_time: 1744243199
                      id: 340a9cb3-1234-5678-90ab-b009344dbf3c
                      modified_time: 1629947267
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 10
                      remaining_quantity: 9
                      start_time: 1586476800
                      subscription_id: EX24-000000bc
                      type: SUB-EX24
                    - created_time: 1632941870
                      end_time: 1744156799
                      id: 9b599b0f-1234-5678-90ab-406081b58e7f
                      modified_time: 1632941870
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 10
                      remaining_quantity: 10
                      start_time: 1632873600
                      subscription_id: ENG-000000bd
                      type: SUB-ENG
                    - created_time: 1632941882
                      end_time: 1744156799
                      id: d6d8ead3-1234-5678-90ab-98badeac7287
                      modified_time: 1632941882
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 11
                      remaining_quantity: 9
                      start_time: 1632873600
                      subscription_id: MAN-000008be
                      type: SUB-MAN
                    summary:
                      SUB-ENG: 18
                      SUB-EX24: 3
                      SUB-MAN: 22
                      SUB-VNA: 20
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    amendments:
                    - created_time: 1644684842
                      end_time: 1744156799
                      id: ff0a14f6-1234-5678-90ab-c8e64d4bc6c6
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1632873600
                      subscription_id: VNA-000000af
                      type: SUB-VNA
                    - created_time: 1644684842
                      end_time: 1744156799
                      id: c1c28812-1234-5678-90ab-dc95680da61e
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1632873600
                      subscription_id: MAN-000008be
                      type: SUB-MAN
                    - created_time: 1644684842
                      end_time: 1744243199
                      id: 96c0a41f-1234-5678-90ab-afe74817e9fd
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1586476800
                      subscription_id: EX24-000000bc
                      type: SUB-EX24
                    entitled:
                      SUB-ENG: 26
                      SUB-EX24: 9
                      SUB-MAN: 26
                      SUB-VNA: 26
                    licenses:
                    - created_time: 1555353534
                      end_time: 1586822399
                      id: 693a41a6-1234-5678-90ab-f53dbd3a31c0
                      modified_time: 1555353534
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 0
                      start_time: 1555286400
                      subscription_id: VNA-000000aa
                      type: SUB-VNA
                    - created_time: 1576132516
                      end_time: 1586822399
                      id: 656607cf-1234-5678-90ab-fc9035614ea5
                      modified_time: 1576132516
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 8
                      remaining_quantity: 0
                      start_time: 1576022400
                      subscription_id: VNA-000000ab
                      type: SUB-VNA
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: db50d0bc-1234-5678-90ab-e439958cb06b
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: MAN-000000ac
                      type: SUB-MAN
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: 2ff9e84a-1234-5678-90ab-fb9ec0726e01
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: ENG-000000ad
                      type: SUB-ENG
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: 16df7ea6-1234-5678-90ab-78018cd4024d
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: VNA-000000ae
                      type: SUB-VNA
                    - created_time: 1586237081
                      end_time: 1744243199
                      id: 1b6f68d5-1234-5678-90ab-70d3e6d18c73
                      modified_time: 1586237081
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: VNA-000000af
                      type: SUB-VNA
                    - created_time: 1586237097
                      end_time: 1744243199
                      id: 1375c9bf-1234-5678-90ab-9c636708c89e
                      modified_time: 1586237097
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: MAN-000000ba
                      type: SUB-MAN
                    - created_time: 1586237137
                      end_time: 1744243199
                      id: 5974e979-1234-5678-90ab-438f833ec1c9
                      modified_time: 1586237137
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: ENG-000000bb
                      type: SUB-ENG
                    - created_time: 1629947267
                      end_time: 1744243199
                      id: 340a9cb3-1234-5678-90ab-b009344dbf3c
                      modified_time: 1629947267
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 10
                      remaining_quantity: 9
                      start_time: 1586476800
                      subscription_id: EX24-000000bc
                      type: SUB-EX24
                    - created_time: 1632941870
                      end_time: 1744156799
                      id: 9b599b0f-1234-5678-90ab-406081b58e7f
                      modified_time: 1632941870
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 10
                      remaining_quantity: 10
                      start_time: 1632873600
                      subscription_id: ENG-000000bd
                      type: SUB-ENG
                    - created_time: 1632941882
                      end_time: 1744156799
                      id: d6d8ead3-1234-5678-90ab-98badeac7287
                      modified_time: 1632941882
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 11
                      remaining_quantity: 9
                      start_time: 1632873600
                      subscription_id: MAN-000008be
                      type: SUB-MAN
                    summary:
                      SUB-ENG: 18
                      SUB-EX24: 3
                      SUB-MAN: 22
                      SUB-VNA: 20
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/license'
                - description: Organization license entitlement, subscription, and usage summary
                  examples:
                  - amendments:
                    - created_time: 1644684842
                      end_time: 1744156799
                      id: ff0a14f6-1234-5678-90ab-c8e64d4bc6c6
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1632873600
                      subscription_id: VNA-000000af
                      type: SUB-VNA
                    - created_time: 1644684842
                      end_time: 1744156799
                      id: c1c28812-1234-5678-90ab-dc95680da61e
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1632873600
                      subscription_id: MAN-000008be
                      type: SUB-MAN
                    - created_time: 1644684842
                      end_time: 1744243199
                      id: 96c0a41f-1234-5678-90ab-afe74817e9fd
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1586476800
                      subscription_id: EX24-000000bc
                      type: SUB-EX24
                    entitled:
                      SUB-ENG: 26
                      SUB-EX24: 9
                      SUB-MAN: 26
                      SUB-VNA: 26
                    licenses:
                    - created_time: 1555353534
                      end_time: 1586822399
                      id: 693a41a6-1234-5678-90ab-f53dbd3a31c0
                      modified_time: 1555353534
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 0
                      start_time: 1555286400
                      subscription_id: VNA-000000aa
                      type: SUB-VNA
                    - created_time: 1576132516
                      end_time: 1586822399
                      id: 656607cf-1234-5678-90ab-fc9035614ea5
                      modified_time: 1576132516
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 8
                      remaining_quantity: 0
                      start_time: 1576022400
                      subscription_id: VNA-000000ab
                      type: SUB-VNA
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: db50d0bc-1234-5678-90ab-e439958cb06b
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: MAN-000000ac
                      type: SUB-MAN
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: 2ff9e84a-1234-5678-90ab-fb9ec0726e01
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: ENG-000000ad
                      type: SUB-ENG
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: 16df7ea6-1234-5678-90ab-78018cd4024d
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: VNA-000000ae
                      type: SUB-VNA
                    - created_time: 1586237081
                      end_time: 1744243199
                      id: 1b6f68d5-1234-5678-90ab-70d3e6d18c73
                      modified_time: 1586237081
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: VNA-000000af
                      type: SUB-VNA
                    - created_time: 1586237097
                      end_time: 1744243199
                      id: 1375c9bf-1234-5678-90ab-9c636708c89e
                      modified_time: 1586237097
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: MAN-000000ba
                      type: SUB-MAN
                    - created_time: 1586237137
                      end_time: 1744243199
                      id: 5974e979-1234-5678-90ab-438f833ec1c9
                      modified_time: 1586237137
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: ENG-000000bb
                      type: SUB-ENG
                    - created_time: 1629947267
                      end_time: 1744243199
                      id: 340a9cb3-1234-5678-90ab-b009344dbf3c
                      modified_time: 1629947267
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 10
                      remaining_quantity: 9
                      start_time: 1586476800
                      subscription_id: EX24-000000bc
                      type: SUB-EX24
                    - created_time: 1632941870
                      end_time: 1744156799
                      id: 9b599b0f-1234-5678-90ab-406081b58e7f
                      modified_time: 1632941870
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 10
                      remaining_quantity: 10
                      start_time: 1632873600
                      subscription_id: ENG-000000bd
                      type: SUB-ENG
                    - created_time: 1632941882
                      end_time: 1744156799
                      id: d6d8ead3-1234-5678-90ab-98badeac7287
                      modified_time: 1632941882
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 11
                      remaining_quantity: 9
                      start_time: 1632873600
                      subscription_id: MAN-000008be
                      type: SUB-MAN
                    summary:
                      SUB-ENG: 18
                      SUB-EX24: 3
                      SUB-MAN: 22
                      SUB-VNA: 20
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    amendments:
                    - created_time: 1644684842
                      end_time: 1744156799
                      id: ff0a14f6-1234-5678-90ab-c8e64d4bc6c6
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1632873600
                      subscription_id: VNA-000000af
                      type: SUB-VNA
                    - created_time: 1644684842
                      end_time: 1744156799
                      id: c1c28812-1234-5678-90ab-dc95680da61e
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1632873600
                      subscription_id: MAN-000008be
                      type: SUB-MAN
                    - created_time: 1644684842
                      end_time: 1744243199
                      id: 96c0a41f-1234-5678-90ab-afe74817e9fd
                      modified_time: 1644684842
                      quantity: -1
                      start_time: 1586476800
                      subscription_id: EX24-000000bc
                      type: SUB-EX24
                    entitled:
                      SUB-ENG: 26
                      SUB-EX24: 9
                      SUB-MAN: 26
                      SUB-VNA: 26
                    licenses:
                    - created_time: 1555353534
                      end_time: 1586822399
                      id: 693a41a6-1234-5678-90ab-f53dbd3a31c0
                      modified_time: 1555353534
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 0
                      start_time: 1555286400
                      subscription_id: VNA-000000aa
                      type: SUB-VNA
                    - created_time: 1576132516
                      end_time: 1586822399
                      id: 656607cf-1234-5678-90ab-fc9035614ea5
                      modified_time: 1576132516
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 8
                      remaining_quantity: 0
                      start_time: 1576022400
                      subscription_id: VNA-000000ab
                      type: SUB-VNA
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: db50d0bc-1234-5678-90ab-e439958cb06b
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: MAN-000000ac
                      type: SUB-MAN
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: 2ff9e84a-1234-5678-90ab-fb9ec0726e01
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: ENG-000000ad
                      type: SUB-ENG
                    - created_time: 1579204568
                      end_time: 1730764800
                      id: 16df7ea6-1234-5678-90ab-78018cd4024d
                      modified_time: 1579204568
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 2
                      remaining_quantity: 2
                      start_time: 1572998400
                      subscription_id: VNA-000000ae
                      type: SUB-VNA
                    - created_time: 1586237081
                      end_time: 1744243199
                      id: 1b6f68d5-1234-5678-90ab-70d3e6d18c73
                      modified_time: 1586237081
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: VNA-000000af
                      type: SUB-VNA
                    - created_time: 1586237097
                      end_time: 1744243199
                      id: 1375c9bf-1234-5678-90ab-9c636708c89e
                      modified_time: 1586237097
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: MAN-000000ba
                      type: SUB-MAN
                    - created_time: 1586237137
                      end_time: 1744243199
                      id: 5974e979-1234-5678-90ab-438f833ec1c9
                      modified_time: 1586237137
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 14
                      remaining_quantity: 14
                      start_time: 1586563200
                      subscription_id: ENG-000000bb
                      type: SUB-ENG
                    - created_time: 1629947267
                      end_time: 1744243199
                      id: 340a9cb3-1234-5678-90ab-b009344dbf3c
                      modified_time: 1629947267
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 10
                      remaining_quantity: 9
                      start_time: 1586476800
                      subscription_id: EX24-000000bc
                      type: SUB-EX24
                    - created_time: 1632941870
                      end_time: 1744156799
                      id: 9b599b0f-1234-5678-90ab-406081b58e7f
                      modified_time: 1632941870
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 10
                      remaining_quantity: 10
                      start_time: 1632873600
                      subscription_id: ENG-000000bd
                      type: SUB-ENG
                    - created_time: 1632941882
                      end_time: 1744156799
                      id: d6d8ead3-1234-5678-90ab-98badeac7287
                      modified_time: 1632941882
                      order_id: '00000000'
                      org_id: 9777c1a0-1234-5678-90ab-02e208b2d34f
                      quantity: 11
                      remaining_quantity: 9
                      start_time: 1632873600
                      subscription_id: MAN-000008be
                      type: SUB-MAN
                    summary:
                      SUB-ENG: 18
                      SUB-EX24: 3
                      SUB-MAN: 22
                      SUB-VNA: 20
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs Licenses
      summary: moveOrDeleteOrgLicenseToAnotherOrg
      description: "Move, Undo Move or Delete Org License to Another Org\nIf the admin has admin privilege against the `org_id` and `dst_org_id`, he can move some of the licenses to another Org. Given that: \n1. the specified license is currently active \n2. there’s enough licenses left in the specified license (by subscription_id) \n3. there will still be enough entitled licenses for the type of license after the amendment"
      operationId: moveOrDeleteOrgLicenseToAnotherOrg
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/org_license_action'
              - description: Request Body
                examples:
                - '{"notes":"customer notes","op":"annotate","subscription_id":"SUB-000144"}'
                - '{"op":"delete","subscription_id":"SUB-0000144"}'
                - '{"dst_org_id":"3eff35f7-c218-894e-bca2-24e5325601cc","op":"amend","quantity":10,"subscription_id":"SUB-0000144"}'
                - '{"amendment_id":"2b9116ab-cd1e-e897-6e08-31fccd88e792","op":"unamend"}'
              contentMediaType: application/json
            examples:
              annotate:
                value:
                  notes: customer notes
                  op: annotate
                  subscription_id: SUB-000144
              delete:
                value:
                  op: delete
                  subscription_id: SUB-0000144
              move:
                value:
                  dst_org_id: 3eff35f7-c218-894e-bca2-24e5325601cc
                  op: amend
                  quantity: 10
                  subscription_id: SUB-0000144
              undo_move:
                value:
                  amendment_id: 2b9116ab-cd1e-e897-6e08-31fccd88e792
                  op: unamend
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/licenses/usages:
    get:
      tags:
      - Orgs Licenses
      summary: getOrgLicensesBySite
      description: >-
        Get Licenses Usage by Sites

        This shows license usage (i.e. needed) based on the features enabled for the site.
      operationId: getOrgLicensesBySite
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                uniqueItems: true
                type: array
                items:
                  $ref: '#/components/schemas/license_usage_org'
                description: Organization license usage records returned by a usage response
                examples:
                - - fully_loaded:
                      SUB-LOC: 30
                      SUB-MAN: 80
                    num_devices: 80
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    usages:
                      SUB-LOC: 30
                      SUB-MAN: 60
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - fully_loaded:
                      SUB-LOC: 30
                      SUB-MAN: 80
                    num_devices: 80
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    usages:
                      SUB-LOC: 30
                      SUB-MAN: 60
            application/vnd.api+json:
              schema:
                uniqueItems: true
                type: array
                items:
                  $ref: '#/components/schemas/license_usage_org'
                description: Organization license usage records returned by a usage response
                examples:
                - - fully_loaded:
                      SUB-LOC: 30
                      SUB-MAN: 80
                    num_devices: 80
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    usages:
                      SUB-LOC: 30
                      SUB-MAN: 60
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - fully_loaded:
                      SUB-LOC: 30
                      SUB-MAN: 80
                    num_devices: 80
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    usages:
                      SUB-LOC: 30
                      SUB-MAN: 60
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/setting/{app_name}/link_accounts:
    get:
      tags:
      - Orgs Linked Applications
      summary: getOrgOauthAppLinkedStatus
      description: Return linked-account status for the specified organization OAuth application and the authorization URL used to start account linking.
      operationId: getOrgOauthAppLinkedStatus
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: app_name
        in: path
        description: OAuth application name
        required: true
        schema:
          allOf:
          - $ref: '#/components/schemas/oauth_app_name'
          - description: OAuth application name
      - name: forward
        in: query
        description: Mist portal url to which backend needs to redirect after successful OAuth authorization. **Required** to get the `authorization_url`
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/account_oauth_info'
                - description: OAuth-linked application account status and authorization details
                  examples:
                  - '{"accounts":[{"account_id":"ae9dee49-69e7-4710-a114-5b827a777738","last_status":"success","last_sync":1665465339000,"linked_by":"Testname1","linked_timestamp":1728275689.284758,"name":"Test Company1 Ltd"},{"account_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","error":"Get token failed, please re-link crowdstrike","last_status":"failed","last_sync":1234567890123,"linked_by":"Testname2","linked_timestamp":1728275689.284758,"name":"Test Company2 Ltd"}],"linked":true}'
                  - '{"accounts":[{"error":"OAuth token refresh failed, please re-link your account","instance_url":"junipertest.jamfcloud.com","last_status":"failed","last_sync":1665465339000,"linked_by":"Testname1","name":"Test Company1 Ltd","smartgroup_name":"CompliantGroup1"}],"linked":true}'
                  - '{"accounts":[{"account_id":"7f80cd00-40b1-49e5-b2cb-9386d89af0d6","client_id":"3e408b13255844149f2830e8609fe8f3","instance_url":"https://a0020372.mobicontrol.cloud","last_status":"success","last_sync":1665465339000,"linked_by":"User1","linked_timestamp":1702284364,"name":"Company1 Ltd."},{"account_id":"80364a28-7ccc-4746-b110-ecf3dfd3a359","client_id":"e81cfb1980454b4bb6109c74136ca528","error":"Get token failed, please re-link MobiControl account","instance_url":"https://a0032314.mobicontrol.cloud","last_status":"failed","last_sync":1234567890123,"linked_by":"User2","linked_timestamp":1702284364,"name":"Company2 Ltd."}],"linked":true}'
                  - '{"accounts":[{"account_id":"00fd8b39-cf92-4b43-a2ff-a461b48e7059","instance_url":"usea1-015.sentinelone.net","last_status":"success","last_sync":1234567891,"linked_by":"user1@test.com","linked_timestamp":1234567891,"name":"company1"},{"account_id":"00fd8b39-cf92-4b43-a2ff-a461b48e7060","error":"Get token failed, please re-link SentinelOne account","instance_url":"usea1-017.sentinelone.net","last_status":"failed","last_sync":1234567800,"linked_by":"user2@test.com","linked_timestamp":1234567891,"name":"company2"}],"linked":true}'
                  - '{"accounts":[{"account_id":"f43ea4c4-8a97-4159-9214-112a8c7b8f22","instance_url":"as800.airwatchportals.com","last_status":"success","last_sync":1665465339000,"linked_by":"Testname1","linked_timestamp":1702284364,"name":"Test Company1 Ltd","webhook_auth_type":"Basic","webhook_enabled":true,"webhook_password":"password_1234","webhook_url":"https://websync.nac-staging.mistsys.com/v1/S_41b2525af1d8dcbe9005/f43ea4c48f22/vmware/mdm","webhook_username":"username_1234"},{"account_id":"m56ea4c4-8a10-4189-9214-113a8c7b8m82","error":"Get token failed, please re-link VMware","instance_url":"as561.airwatchportals.com","last_status":"failed","last_sync":1234567890123,"linked_by":"Testname2","linked_timestamp":1702284364,"name":"Test Company2 Ltd","webhook_auth_type":"Basic","webhook_enabled":true,"webhook_password":"password_1234","webhook_url":"https://websync.nac-staging.mistsys.com/v1/S_41b2525af1d8dcbe9005/f43ea4c48f22/vmware/mdm","webhook_username":"username_1234"}],"linked":true}'
                  - '{"accounts":[{"account_id":"80364a28-7ccc-4746-b110-ecf3dfd3a359","cloud_name":"zdxcloud.net","key_id":"K35vrZcK3JvrZc","webhook_url":"https://webhook.url/xxx","zdx_org_id":"123456"}],"linked":true}'
                  - '{"accounts":[{"account_id":"KkEM7orQSIWHZNFzwMLuRA","company":"Test Company1 Ltd","last_status":"success","last_sync":1665465339,"linked_by":"Testname1","max_daily_api_requests":1500},{"account_id":"kojzWgIJQ0ujR73VvydOdg","company":"Test Company2 Ltd","error":"OAuth token refresh failed, please re-link your account","errors":["OAuth token refresh failed, please re-link your account","API daily rate limit reached for your account"],"last_status":"failed","last_sync":1665465346,"linked_by":"Testname2","max_daily_api_requests":5000},{"account_id":"iojzXIJWEuiD73ZvydOfg","company":"Test Company3 Ltd","last_status":"failed","last_sync":1665465538,"linked_by":"Testname3","max_daily_api_requests":3500}],"authorization_url":"https://zoom.us/oauth/authorize?response_type=code&client_id=YDyajBmJREjwkyb3TPAbA&redirect_uri=https%3A%2F%2Fapi.local%2Fapi%2Fv1%2Forg%2Fb4e16c72-d50e-4c03-a952-a3217e231e2c%2Foauth2%2Fapp%2Fzoom%2Fcallback&state=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2NDk3NjE0MDQsImZvcndhcmQiOiJodHRwczovL2NsaWVudGZvcndhcmR1cmwuY29tIn0.RIE4XTU5kpF4nKIy7_enJ0PpOCyTTp6DLm9PZsdncpI","linked":true}'
                contentMediaType: application/json
              examples:
                Crowdstrike:
                  value:
                    accounts:
                    - account_id: ae9dee49-69e7-4710-a114-5b827a777738
                      last_status: success
                      last_sync: 1665465339000
                      linked_by: Testname1
                      linked_timestamp: 1728275689.284758
                      name: Test Company1 Ltd
                    - account_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      error: Get token failed, please re-link crowdstrike
                      last_status: failed
                      last_sync: 1234567890123
                      linked_by: Testname2
                      linked_timestamp: 1728275689.284758
                      name: Test Company2 Ltd
                    linked: true
                Jamf:
                  value:
                    accounts:
                    - error: OAuth token refresh failed, please re-link your account
                      instance_url: junipertest.jamfcloud.com
                      last_status: failed
                      last_sync: 1665465339000
                      linked_by: Testname1
                      name: Test Company1 Ltd
                      smartgroup_name: CompliantGroup1
                    linked: true
                Mobicontrol:
                  value:
                    accounts:
                    - account_id: 7f80cd00-40b1-49e5-b2cb-9386d89af0d6
                      client_id: 3e408b13255844149f2830e8609fe8f3
                      instance_url: https://a0020372.mobicontrol.cloud
                      last_status: success
                      last_sync: 1665465339000
                      linked_by: User1
                      linked_timestamp: 1702284364
                      name: Company1 Ltd.
                    - account_id: 80364a28-7ccc-4746-b110-ecf3dfd3a359
                      client_id: e81cfb1980454b4bb6109c74136ca528
                      error: Get token failed, please re-link MobiControl account
                      instance_url: https://a0032314.mobicontrol.cloud
                      last_status: failed
                      last_sync: 1234567890123
                      linked_by: User2
                      linked_timestamp: 1702284364
                      name: Company2 Ltd.
                    linked: true
                SentinelOne:
                  value:
                    accounts:
                    - account_id: 00fd8b39-cf92-4b43-a2ff-a461b48e7059
                      instance_url: usea1-015.sentinelone.net
                      last_status: success
                      last_sync: 1234567891
                      linked_by: user1@test.com
                      linked_timestamp: 1234567891
                      name: company1
                    - account_id: 00fd8b39-cf92-4b43-a2ff-a461b48e7060
                      error: Get token failed, please re-link SentinelOne account
                      instance_url: usea1-017.sentinelone.net
                      last_status: failed
                      last_sync: 1234567800
                      linked_by: user2@test.com
                      linked_timestamp: 1234567891
                      name: company2
                    linked: true
                Vmware:
                  value:
                    accounts:
                    - account_id: f43ea4c4-8a97-4159-9214-112a8c7b8f22
                      instance_url: as800.airwatchportals.com
                      last_status: success
                      last_sync: 1665465339000
                      linked_by: Testname1
                      linked_timestamp: 1702284364
                      name: Test Company1 Ltd
                      webhook_auth_type: Basic
                      webhook_enabled: true
                      webhook_password: password_1234
                      webhook_url: https://websync.nac-staging.mistsys.com/v1/S_41b2525af1d8dcbe9005/f43ea4c48f22/vmware/mdm
                      webhook_username: username_1234
                    - account_id: m56ea4c4-8a10-4189-9214-113a8c7b8m82
                      error: Get token failed, please re-link VMware
                      instance_url: as561.airwatchportals.com
                      last_status: failed
                      last_sync: 1234567890123
                      linked_by: Testname2
                      linked_timestamp: 1702284364
                      name: Test Company2 Ltd
                      webhook_auth_type: Basic
                      webhook_enabled: true
                      webhook_password: password_1234
                      webhook_url: https://websync.nac-staging.mistsys.com/v1/S_41b2525af1d8dcbe9005/f43ea4c48f22/vmware/mdm
                      webhook_username: username_1234
                    linked: true
                ZDX:
                  value:
                    accounts:
                    - account_id: 80364a28-7ccc-4746-b110-ecf3dfd3a359
                      cloud_name: zdxcloud.net
                      key_id: K35vrZcK3JvrZc
                      webhook_url: https://webhook.url/xxx
                      zdx_org_id: '123456'
                    linked: true
                Zoom:
                  value:
                    accounts:
                    - account_id: KkEM7orQSIWHZNFzwMLuRA
                      company: Test Company1 Ltd
                      last_status: success
                      last_sync: 1665465339
                      linked_by: Testname1
                      max_daily_api_requests: 1500
                    - account_id: kojzWgIJQ0ujR73VvydOdg
                      company: Test Company2 Ltd
                      error: OAuth token refresh failed, please re-link your account
                      errors:
                      - OAuth token refresh failed, please re-link your account
                      - API daily rate limit reached for your account
                      last_status: failed
                      last_sync: 1665465346
                      linked_by: Testname2
                      max_daily_api_requests: 5000
                    - account_id: iojzXIJWEuiD73ZvydOfg
                      company: Test Company3 Ltd
                      last_status: failed
                      last_sync: 1665465538
                      linked_by: Testname3
                      max_daily_api_requests: 3500
                    authorization_url: https://zoom.us/oauth/authorize?response_type=code&client_id=YDyajBmJREjwkyb3TPAbA&redirect_uri=https%3A%2F%2Fapi.local%2Fapi%2Fv1%2Forg%2Fb4e16c72-d50e-4c03-a952-a3217e231e2c%2Foauth2%2Fapp%2Fzoom%2Fcallback&state=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2NDk3NjE0MDQsImZvcndhcmQiOiJodHRwczovL2NsaWVudGZvcndhcmR1cmwuY29tIn0.RIE4XTU5kpF4nKIy7_enJ0PpOCyTTp6DLm9PZsdncpI
                    linked: true
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/account_oauth_info'
                - description: OAuth-linked application account status and authorization details
                  examples:
                  - '{"accounts":[{"account_id":"ae9dee49-69e7-4710-a114-5b827a777738","last_status":"success","last_sync":1665465339000,"linked_by":"Testname1","linked_timestamp":1728275689.284758,"name":"Test Company1 Ltd"},{"account_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","error":"Get token failed, please re-link crowdstrike","last_status":"failed","last_sync":1234567890123,"linked_by":"Testname2","linked_timestamp":1728275689.284758,"name":"Test Company2 Ltd"}],"linked":true}'
                  - '{"accounts":[{"error":"OAuth token refresh failed, please re-link your account","instance_url":"junipertest.jamfcloud.com","last_status":"failed","last_sync":1665465339000,"linked_by":"Testname1","name":"Test Company1 Ltd","smartgroup_name":"CompliantGroup1"}],"linked":true}'
                  - '{"accounts":[{"account_id":"7f80cd00-40b1-49e5-b2cb-9386d89af0d6","client_id":"3e408b13255844149f2830e8609fe8f3","instance_url":"https://a0020372.mobicontrol.cloud","last_status":"success","last_sync":1665465339000,"linked_by":"User1","linked_timestamp":1702284364,"name":"Company1 Ltd."},{"account_id":"80364a28-7ccc-4746-b110-ecf3dfd3a359","client_id":"e81cfb1980454b4bb6109c74136ca528","error":"Get token failed, please re-link MobiControl account","instance_url":"https://a0032314.mobicontrol.cloud","last_status":"failed","last_sync":1234567890123,"linked_by":"User2","linked_timestamp":1702284364,"name":"Company2 Ltd."}],"linked":true}'
                  - '{"accounts":[{"account_id":"00fd8b39-cf92-4b43-a2ff-a461b48e7059","instance_url":"usea1-015.sentinelone.net","last_status":"success","last_sync":1234567891,"linked_by":"user1@test.com","linked_timestamp":1234567891,"name":"company1"},{"account_id":"00fd8b39-cf92-4b43-a2ff-a461b48e7060","error":"Get token failed, please re-link SentinelOne account","instance_url":"usea1-017.sentinelone.net","last_status":"failed","last_sync":1234567800,"linked_by":"user2@test.com","linked_timestamp":1234567891,"name":"company2"}],"linked":true}'
                  - '{"accounts":[{"account_id":"f43ea4c4-8a97-4159-9214-112a8c7b8f22","instance_url":"as800.airwatchportals.com","last_status":"success","last_sync":1665465339000,"linked_by":"Testname1","linked_timestamp":1702284364,"name":"Test Company1 Ltd","webhook_auth_type":"Basic","webhook_enabled":true,"webhook_password":"password_1234","webhook_url":"https://websync.nac-staging.mistsys.com/v1/S_41b2525af1d8dcbe9005/f43ea4c48f22/vmware/mdm","webhook_username":"username_1234"},{"account_id":"m56ea4c4-8a10-4189-9214-113a8c7b8m82","error":"Get token failed, please re-link VMware","instance_url":"as561.airwatchportals.com","last_status":"failed","last_sync":1234567890123,"linked_by":"Testname2","linked_timestamp":1702284364,"name":"Test Company2 Ltd","webhook_auth_type":"Basic","webhook_enabled":true,"webhook_password":"password_1234","webhook_url":"https://websync.nac-staging.mistsys.com/v1/S_41b2525af1d8dcbe9005/f43ea4c48f22/vmware/mdm","webhook_username":"username_1234"}],"linked":true}'
                  - '{"accounts":[{"account_id":"80364a28-7ccc-4746-b110-ecf3dfd3a359","cloud_name":"zdxcloud.net","key_id":"K35vrZcK3JvrZc","webhook_url":"https://webhook.url/xxx","zdx_org_id":"123456"}],"linked":true}'
                  - '{"accounts":[{"account_id":"KkEM7orQSIWHZNFzwMLuRA","company":"Test Company1 Ltd","last_status":"success","last_sync":1665465339,"linked_by":"Testname1","max_daily_api_requests":1500},{"account_id":"kojzWgIJQ0ujR73VvydOdg","company":"Test Company2 Ltd","error":"OAuth token refresh failed, please re-link your account","errors":["OAuth token refresh failed, please re-link your account","API daily rate limit reached for your account"],"last_status":"failed","last_sync":1665465346,"linked_by":"Testname2","max_daily_api_requests":5000},{"account_id":"iojzXIJWEuiD73ZvydOfg","company":"Test Company3 Ltd","last_status":"failed","last_sync":1665465538,"linked_by":"Testname3","max_daily_api_requests":3500}],"authorization_url":"https://zoom.us/oauth/authorize?response_type=code&client_id=YDyajBmJREjwkyb3TPAbA&redirect_uri=https%3A%2F%2Fapi.local%2Fapi%2Fv1%2Forg%2Fb4e16c72-d50e-4c03-a952-a3217e231e2c%2Foauth2%2Fapp%2Fzoom%2Fcallback&state=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2NDk3NjE0MDQsImZvcndhcmQiOiJodHRwczovL2NsaWVudGZvcndhcmR1cmwuY29tIn0.RIE4XTU5kpF4nKIy7_enJ0PpOCyTTp6DLm9PZsdncpI","linked":true}'
                contentMediaType: application/vnd.api+json
              examples:
                Crowdstrike:
                  value:
                    accounts:
                    - account_id: ae9dee49-69e7-4710-a114-5b827a777738
                      last_status: success
                      last_sync: 1665465339000
                      linked_by: Testname1
                      linked_timestamp: 1728275689.284758
                      name: Test Company1 Ltd
                    - account_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      error: Get token failed, please re-link crowdstrike
                      last_status: failed
                      last_sync: 1234567890123
                      linked_by: Testname2
                      linked_timestamp: 1728275689.284758
                      name: Test Company2 Ltd
                    linked: true
                Jamf:
                  value:
                    accounts:
                    - error: OAuth token refresh failed, please re-link your account
                      instance_url: junipertest.jamfcloud.com
                      last_status: failed
                      last_sync: 1665465339000
                      linked_by: Testname1
                      name: Test Company1 Ltd
                      smartgroup_name: CompliantGroup1
                    linked: true
                Mobicontrol:
                  value:
                    accounts:
                    - account_id: 7f80cd00-40b1-49e5-b2cb-9386d89af0d6
                      client_id: 3e408b13255844149f2830e8609fe8f3
                      instance_url: https://a0020372.mobicontrol.cloud
                      last_status: success
                      last_sync: 1665465339000
                      linked_by: User1
                      linked_timestamp: 1702284364
                      name: Company1 Ltd.
                    - account_id: 80364a28-7ccc-4746-b110-ecf3dfd3a359
                      client_id: e81cfb1980454b4bb6109c74136ca528
                      error: Get token failed, please re-link MobiControl account
                      instance_url: https://a0032314.mobicontrol.cloud
                      last_status: failed
                      last_sync: 1234567890123
                      linked_by: User2
                      linked_timestamp: 1702284364
                      name: Company2 Ltd.
                    linked: true
                SentinelOne:
                  value:
                    accounts:
                    - account_id: 00fd8b39-cf92-4b43-a2ff-a461b48e7059
                      instance_url: usea1-015.sentinelone.net
                      last_status: success
                      last_sync: 1234567891
                      linked_by: user1@test.com
                      linked_timestamp: 1234567891
                      name: company1
                    - account_id: 00fd8b39-cf92-4b43-a2ff-a461b48e7060
                      error: Get token failed, please re-link SentinelOne account
                      instance_url: usea1-017.sentinelone.net
                      last_status: failed
                      last_sync: 1234567800
                      linked_by: user2@test.com
                      linked_timestamp: 1234567891
                      name: company2
                    linked: true
                Vmware:
                  value:
                    accounts:
                    - account_id: f43ea4c4-8a97-4159-9214-112a8c7b8f22
                      instance_url: as800.airwatchportals.com
                      last_status: success
                      last_sync: 1665465339000
                      linked_by: Testname1
                      linked_timestamp: 1702284364
                      name: Test Company1 Ltd
                      webhook_auth_type: Basic
                      webhook_enabled: true
                      webhook_password: password_1234
                      webhook_url: https://websync.nac-staging.mistsys.com/v1/S_41b2525af1d8dcbe9005/f43ea4c48f22/vmware/mdm
                      webhook_username: username_1234
                    - account_id: m56ea4c4-8a10-4189-9214-113a8c7b8m82
                      error: Get token failed, please re-link VMware
                      instance_url: as561.airwatchportals.com
                      last_status: failed
                      last_sync: 1234567890123
                      linked_by: Testname2
                      linked_timestamp: 1702284364
                      name: Test Company2 Ltd
                      webhook_auth_type: Basic
                      webhook_enabled: true
                      webhook_password: password_1234
                      webhook_url: https://websync.nac-staging.mistsys.com/v1/S_41b2525af1d8dcbe9005/f43ea4c48f22/vmware/mdm
                      webhook_username: username_1234
                    linked: true
                ZDX:
                  value:
                    accounts:
                    - account_id: 80364a28-7ccc-4746-b110-ecf3dfd3a359
                      cloud_name: zdxcloud.net
                      key_id: K35vrZcK3JvrZc
                      webhook_url: https://webhook.url/xxx
                      zdx_org_id: '123456'
                    linked: true
                Zoom:
                  value:
                    accounts:
                    - account_id: KkEM7orQSIWHZNFzwMLuRA
                      company: Test Company1 Ltd
                      last_status: success
                      last_sync: 1665465339
                      linked_by: Testname1
                      max_daily_api_requests: 1500
                    - account_id: kojzWgIJQ0ujR73VvydOdg
                      company: Test Company2 Ltd
                      error: OAuth token refresh failed, please re-link your account
                      errors:
                      - OAuth token refresh failed, please re-link your account
                      - API daily rate limit reached for your account
                      last_status: failed
                      last_sync: 1665465346
                      linked_by: Testname2
                      max_daily_api_requests: 5000
                    - account_id: iojzXIJWEuiD73ZvydOfg
                      company: Test Company3 Ltd
                      last_status: failed
                      last_sync: 1665465538
                      linked_by: Testname3
                      max_daily_api_requests: 3500
                    authorization_url: https://zoom.us/oauth/authorize?response_type=code&client_id=YDyajBmJREjwkyb3TPAbA&redirect_uri=https%3A%2F%2Fapi.local%2Fapi%2Fv1%2Forg%2Fb4e16c72-d50e-4c03-a952-a3217e231e2c%2Foauth2%2Fapp%2Fzoom%2Fcallback&state=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2NDk3NjE0MDQsImZvcndhcmQiOiJodHRwczovL2NsaWVudGZvcndhcmR1cmwuY29tIn0.RIE4XTU5kpF4nKIy7_enJ0PpOCyTTp6DLm9PZsdncpI
                    linked: true
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs Linked Applications
      summary: addOrgOauthAppAccounts
      description: Add a linked account for the specified OAuth application using the app-specific account configuration payload.
      operationId: addOrgOauthAppAccounts
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: app_name
        in: path
        description: OAuth application name
        required: true
        schema:
          allOf:
          - $ref: '#/components/schemas/oauth_app_name'
          - description: OAuth application name
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/account_oauth_add'
              - {}
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/account_oauth_info'
                - description: OAuth-linked application account status and authorization details
                  examples:
                  - '{"accounts":[{"account_id":"ae9dee49-69e7-4710-a114-5b827a777738","last_status":"success","last_sync":1665465339000,"linked_by":"Testname1","linked_timestamp":1728275689.284758,"name":"Test Company1 Ltd"},{"account_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","error":"Get token failed, please re-link crowdstrike","last_status":"failed","last_sync":1234567890123,"linked_by":"Testname2","linked_timestamp":1728275689.284758,"name":"Test Company2 Ltd"}],"linked":true}'
                  - '{"accounts":[{"error":"OAuth token refresh failed, please re-link your account","instance_url":"junipertest.jamfcloud.com","last_status":"failed","last_sync":1665465339000,"linked_by":"Testname1","name":"Test Company1 Ltd","smartgroup_name":"CompliantGroup1"}],"linked":true}'
                  - '{"accounts":[{"account_id":"7f80cd00-40b1-49e5-b2cb-9386d89af0d6","client_id":"3e408b13255844149f2830e8609fe8f3","instance_url":"https://a0020372.mobicontrol.cloud","last_status":"success","last_sync":1665465339000,"linked_by":"User1","linked_timestamp":1702284364,"name":"Company1 Ltd."},{"account_id":"80364a28-7ccc-4746-b110-ecf3dfd3a359","client_id":"e81cfb1980454b4bb6109c74136ca528","error":"Get token failed, please re-link MobiControl account","instance_url":"https://a0032314.mobicontrol.cloud","last_status":"failed","last_sync":1234567890123,"linked_by":"User2","linked_timestamp":1702284364,"name":"Company2 Ltd."}],"linked":true}'
                  - '{"accounts":[{"account_id":"00fd8b39-cf92-4b43-a2ff-a461b48e7059","instance_url":"usea1-015.sentinelone.net","last_status":"success","last_sync":1234567891,"linked_by":"user1@test.com","linked_timestamp":1234567891,"name":"company1"},{"account_id":"00fd8b39-cf92-4b43-a2ff-a461b48e7060","error":"Get token failed, please re-link SentinelOne account","instance_url":"usea1-017.sentinelone.net","last_status":"failed","last_sync":1234567800,"linked_by":"user2@test.com","linked_timestamp":1234567891,"name":"company2"}],"linked":true}'
                  - '{"accounts":[{"account_id":"f43ea4c4-8a97-4159-9214-112a8c7b8f22","instance_url":"as800.airwatchportals.com","last_status":"success","last_sync":1665465339000,"linked_by":"Testname1","linked_timestamp":1702284364,"name":"Test Company1 Ltd","webhook_auth_type":"Basic","webhook_enabled":true,"webhook_password":"password_1234","webhook_url":"https://websync.nac-staging.mistsys.com/v1/S_41b2525af1d8dcbe9005/f43ea4c48f22/vmware/mdm","webhook_username":"username_1234"},{"account_id":"m56ea4c4-8a10-4189-9214-113a8c7b8m82","error":"Get token failed, please re-link VMware","instance_url":"as561.airwatchportals.com","last_status":"failed","last_sync":1234567890123,"linked_by":"Testname2","linked_timestamp":1702284364,"name":"Test Company2 Ltd","webhook_auth_type":"Basic","webhook_enabled":true,"webhook_password":"password_1234","webhook_url":"https://websync.nac-staging.mistsys.com/v1/S_41b2525af1d8dcbe9005/f43ea4c48f22/vmware/mdm","webhook_username":"username_1234"}],"linked":true}'
                  - '{"accounts":[{"account_id":"80364a28-7ccc-4746-b110-ecf3dfd3a359","cloud_name":"zdxcloud.net","key_id":"K35vrZcK3JvrZc","webhook_url":"https://webhook.url/xxx","zdx_org_id":"123456"}],"linked":true}'
                  - '{"accounts":[{"account_id":"KkEM7orQSIWHZNFzwMLuRA","company":"Test Company1 Ltd","last_status":"success","last_sync":1665465339,"linked_by":"Testname1","max_daily_api_requests":1500},{"account_id":"kojzWgIJQ0ujR73VvydOdg","company":"Test Company2 Ltd","error":"OAuth token refresh failed, please re-link your account","errors":["OAuth token refresh failed, please re-link your account","API daily rate limit reached for your account"],"last_status":"failed","last_sync":1665465346,"linked_by":"Testname2","max_daily_api_requests":5000},{"account_id":"iojzXIJWEuiD73ZvydOfg","company":"Test Company3 Ltd","last_status":"failed","last_sync":1665465538,"linked_by":"Testname3","max_daily_api_requests":3500}],"authorization_url":"https://zoom.us/oauth/authorize?response_type=code&client_id=YDyajBmJREjwkyb3TPAbA&redirect_uri=https%3A%2F%2Fapi.local%2Fapi%2Fv1%2Forg%2Fb4e16c72-d50e-4c03-a952-a3217e231e2c%2Foauth2%2Fapp%2Fzoom%2Fcallback&state=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2NDk3NjE0MDQsImZvcndhcmQiOiJodHRwczovL2NsaWVudGZvcndhcmR1cmwuY29tIn0.RIE4XTU5kpF4nKIy7_enJ0PpOCyTTp6DLm9PZsdncpI","linked":true}'
                contentMediaType: application/json
              examples:
                Crowdstrike:
                  value:
                    accounts:
                    - account_id: ae9dee49-69e7-4710-a114-5b827a777738
                      last_status: success
                      last_sync: 1665465339000
                      linked_by: Testname1
                      linked_timestamp: 1728275689.284758
                      name: Test Company1 Ltd
                    - account_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      error: Get token failed, please re-link crowdstrike
                      last_status: failed
                      last_sync: 1234567890123
                      linked_by: Testname2
                      linked_timestamp: 1728275689.284758
                      name: Test Company2 Ltd
                    linked: true
                Jamf:
                  value:
                    accounts:
                    - error: OAuth token refresh failed, please re-link your account
                      instance_url: junipertest.jamfcloud.com
                      last_status: failed
                      last_sync: 1665465339000
                      linked_by: Testname1
                      name: Test Company1 Ltd
                      smartgroup_name: CompliantGroup1
                    linked: true
                Mobicontrol:
                  value:
                    accounts:
                    - account_id: 7f80cd00-40b1-49e5-b2cb-9386d89af0d6
                      client_id: 3e408b13255844149f2830e8609fe8f3
                      instance_url: https://a0020372.mobicontrol.cloud
                      last_status: success
                      last_sync: 1665465339000
                      linked_by: User1
                      linked_timestamp: 1702284364
                      name: Company1 Ltd.
                    - account_id: 80364a28-7ccc-4746-b110-ecf3dfd3a359
                      client_id: e81cfb1980454b4bb6109c74136ca528
                      error: Get token failed, please re-link MobiControl account
                      instance_url: https://a0032314.mobicontrol.cloud
                      last_status: failed
                      last_sync: 1234567890123
                      linked_by: User2
                      linked_timestamp: 1702284364
                      name: Company2 Ltd.
                    linked: true
                SentinelOne:
                  value:
                    accounts:
                    - account_id: 00fd8b39-cf92-4b43-a2ff-a461b48e7059
                      instance_url: usea1-015.sentinelone.net
                      last_status: success
                      last_sync: 1234567891
                      linked_by: user1@test.com
                      linked_timestamp: 1234567891
                      name: company1
                    - account_id: 00fd8b39-cf92-4b43-a2ff-a461b48e7060
                      error: Get token failed, please re-link SentinelOne account
                      instance_url: usea1-017.sentinelone.net
                      last_status: failed
                      last_sync: 1234567800
                      linked_by: user2@test.com
                      linked_timestamp: 1234567891
                      name: company2
                    linked: true
                Vmware:
                  value:
                    accounts:
                    - account_id: f43ea4c4-8a97-4159-9214-112a8c7b8f22
                      instance_url: as800.airwatchportals.com
                      last_status: success
                      last_sync: 1665465339000
                      linked_by: Testname1
                      linked_timestamp: 1702284364
                      name: Test Company1 Ltd
                      webhook_auth_type: Basic
                      webhook_enabled: true
                      webhook_password: password_1234
                      webhook_url: https://websync.nac-staging.mistsys.com/v1/S_41b2525af1d8dcbe9005/f43ea4c48f22/vmware/mdm
                      webhook_username: username_1234
                    - account_id: m56ea4c4-8a10-4189-9214-113a8c7b8m82
                      error: Get token failed, please re-link VMware
                      instance_url: as561.airwatchportals.com
                      last_status: failed
                      last_sync: 1234567890123
                      linked_by: Testname2
                      linked_timestamp: 1702284364
                      name: Test Company2 Ltd
                      webhook_auth_type: Basic
                      webhook_enabled: true
                      webhook_password: password_1234
                      webhook_url: https://websync.nac-staging.mistsys.com/v1/S_41b2525af1d8dcbe9005/f43ea4c48f22/vmware/mdm
                      webhook_username: username_1234
                    linked: true
                ZDX:
                  value:
                    accounts:
                    - account_id: 80364a28-7ccc-4746-b110-ecf3dfd3a359
                      cloud_name: zdxcloud.net
                      key_id: K35vrZcK3JvrZc
                      webhook_url: https://webhook.url/xxx
                      zdx_org_id: '123456'
                    linked: true
                Zoom:
                  value:
                    accounts:
                    - account_id: KkEM7orQSIWHZNFzwMLuRA
                      company: Test Company1 Ltd
                      last_status: success
                      last_sync: 1665465339
                      linked_by: Testname1
                      max_daily_api_requests: 1500
                    - account_id: kojzWgIJQ0ujR73VvydOdg
                      company: Test Company2 Ltd
                      error: OAuth token refresh failed, please re-link your account
                      errors:
                      - OAuth token refresh failed, please re-link your account
                      - API daily rate limit reached for your account
                      last_status: failed
                      last_sync: 1665465346
                      linked_by: Testname2
                      max_daily_api_requests: 5000
                    - account_id: iojzXIJWEuiD73ZvydOfg
                      company: Test Company3 Ltd
                      last_status: failed
                      last_sync: 1665465538
                      linked_by: Testname3
                      max_daily_api_requests: 3500
                    authorization_url: https://zoom.us/oauth/authorize?response_type=code&client_id=YDyajBmJREjwkyb3TPAbA&redirect_uri=https%3A%2F%2Fapi.local%2Fapi%2Fv1%2Forg%2Fb4e16c72-d50e-4c03-a952-a3217e231e2c%2Foauth2%2Fapp%2Fzoom%2Fcallback&state=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2NDk3NjE0MDQsImZvcndhcmQiOiJodHRwczovL2NsaWVudGZvcndhcmR1cmwuY29tIn0.RIE4XTU5kpF4nKIy7_enJ0PpOCyTTp6DLm9PZsdncpI
                    linked: true
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/account_oauth_info'
                - description: OAuth-linked application account status and authorization details
                  examples:
                  - '{"accounts":[{"account_id":"ae9dee49-69e7-4710-a114-5b827a777738","last_status":"success","last_sync":1665465339000,"linked_by":"Testname1","linked_timestamp":1728275689.284758,"name":"Test Company1 Ltd"},{"account_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","error":"Get token failed, please re-link crowdstrike","last_status":"failed","last_sync":1234567890123,"linked_by":"Testname2","linked_timestamp":1728275689.284758,"name":"Test Company2 Ltd"}],"linked":true}'
                  - '{"accounts":[{"error":"OAuth token refresh failed, please re-link your account","instance_url":"junipertest.jamfcloud.com","last_status":"failed","last_sync":1665465339000,"linked_by":"Testname1","name":"Test Company1 Ltd","smartgroup_name":"CompliantGroup1"}],"linked":true}'
                  - '{"accounts":[{"account_id":"7f80cd00-40b1-49e5-b2cb-9386d89af0d6","client_id":"3e408b13255844149f2830e8609fe8f3","instance_url":"https://a0020372.mobicontrol.cloud","last_status":"success","last_sync":1665465339000,"linked_by":"User1","linked_timestamp":1702284364,"name":"Company1 Ltd."},{"account_id":"80364a28-7ccc-4746-b110-ecf3dfd3a359","client_id":"e81cfb1980454b4bb6109c74136ca528","error":"Get token failed, please re-link MobiControl account","instance_url":"https://a0032314.mobicontrol.cloud","last_status":"failed","last_sync":1234567890123,"linked_by":"User2","linked_timestamp":1702284364,"name":"Company2 Ltd."}],"linked":true}'
                  - '{"accounts":[{"account_id":"00fd8b39-cf92-4b43-a2ff-a461b48e7059","instance_url":"usea1-015.sentinelone.net","last_status":"success","last_sync":1234567891,"linked_by":"user1@test.com","linked_timestamp":1234567891,"name":"company1"},{"account_id":"00fd8b39-cf92-4b43-a2ff-a461b48e7060","error":"Get token failed, please re-link SentinelOne account","instance_url":"usea1-017.sentinelone.net","last_status":"failed","last_sync":1234567800,"linked_by":"user2@test.com","linked_timestamp":1234567891,"name":"company2"}],"linked":true}'
                  - '{"accounts":[{"account_id":"f43ea4c4-8a97-4159-9214-112a8c7b8f22","instance_url":"as800.airwatchportals.com","last_status":"success","last_sync":1665465339000,"linked_by":"Testname1","linked_timestamp":1702284364,"name":"Test Company1 Ltd","webhook_auth_type":"Basic","webhook_enabled":true,"webhook_password":"password_1234","webhook_url":"https://websync.nac-staging.mistsys.com/v1/S_41b2525af1d8dcbe9005/f43ea4c48f22/vmware/mdm","webhook_username":"username_1234"},{"account_id":"m56ea4c4-8a10-4189-9214-113a8c7b8m82","error":"Get token failed, please re-link VMware","instance_url":"as561.airwatchportals.com","last_status":"failed","last_sync":1234567890123,"linked_by":"Testname2","linked_timestamp":1702284364,"name":"Test Company2 Ltd","webhook_auth_type":"Basic","webhook_enabled":true,"webhook_password":"password_1234","webhook_url":"https://websync.nac-staging.mistsys.com/v1/S_41b2525af1d8dcbe9005/f43ea4c48f22/vmware/mdm","webhook_username":"username_1234"}],"linked":true}'
                  - '{"accounts":[{"account_id":"80364a28-7ccc-4746-b110-ecf3dfd3a359","cloud_name":"zdxcloud.net","key_id":"K35vrZcK3JvrZc","webhook_url":"https://webhook.url/xxx","zdx_org_id":"123456"}],"linked":true}'
                  - '{"accounts":[{"account_id":"KkEM7orQSIWHZNFzwMLuRA","company":"Test Company1 Ltd","last_status":"success","last_sync":1665465339,"linked_by":"Testname1","max_daily_api_requests":1500},{"account_id":"kojzWgIJQ0ujR73VvydOdg","company":"Test Company2 Ltd","error":"OAuth token refresh failed, please re-link your account","errors":["OAuth token refresh failed, please re-link your account","API daily rate limit reached for your account"],"last_status":"failed","last_sync":1665465346,"linked_by":"Testname2","max_daily_api_requests":5000},{"account_id":"iojzXIJWEuiD73ZvydOfg","company":"Test Company3 Ltd","last_status":"failed","last_sync":1665465538,"linked_by":"Testname3","max_daily_api_requests":3500}],"authorization_url":"https://zoom.us/oauth/authorize?response_type=code&client_id=YDyajBmJREjwkyb3TPAbA&redirect_uri=https%3A%2F%2Fapi.local%2Fapi%2Fv1%2Forg%2Fb4e16c72-d50e-4c03-a952-a3217e231e2c%2Foauth2%2Fapp%2Fzoom%2Fcallback&state=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2NDk3NjE0MDQsImZvcndhcmQiOiJodHRwczovL2NsaWVudGZvcndhcmR1cmwuY29tIn0.RIE4XTU5kpF4nKIy7_enJ0PpOCyTTp6DLm9PZsdncpI","linked":true}'
                contentMediaType: application/vnd.api+json
              examples:
                Crowdstrike:
                  value:
                    accounts:
                    - account_id: ae9dee49-69e7-4710-a114-5b827a777738
                      last_status: success
                      last_sync: 1665465339000
                      linked_by: Testname1
                      linked_timestamp: 1728275689.284758
                      name: Test Company1 Ltd
                    - account_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      error: Get token failed, please re-link crowdstrike
                      last_status: failed
                      last_sync: 1234567890123
                      linked_by: Testname2
                      linked_timestamp: 1728275689.284758
                      name: Test Company2 Ltd
                    linked: true
                Jamf:
                  value:
                    accounts:
                    - error: OAuth token refresh failed, please re-link your account
                      instance_url: junipertest.jamfcloud.com
                      last_status: failed
                      last_sync: 1665465339000
                      linked_by: Testname1
                      name: Test Company1 Ltd
                      smartgroup_name: CompliantGroup1
                    linked: true
                Mobicontrol:
                  value:
                    accounts:
                    - account_id: 7f80cd00-40b1-49e5-b2cb-9386d89af0d6
                      client_id: 3e408b13255844149f2830e8609fe8f3
                      instance_url: https://a0020372.mobicontrol.cloud
                      last_status: success
                      last_sync: 1665465339000
                      linked_by: User1
                      linked_timestamp: 1702284364
                      name: Company1 Ltd.
                    - account_id: 80364a28-7ccc-4746-b110-ecf3dfd3a359
                      client_id: e81cfb1980454b4bb6109c74136ca528
                      error: Get token failed, please re-link MobiControl account
                      instance_url: https://a0032314.mobicontrol.cloud
                      last_status: failed
                      last_sync: 1234567890123
                      linked_by: User2
                      linked_timestamp: 1702284364
                      name: Company2 Ltd.
                    linked: true
                SentinelOne:
                  value:
                    accounts:
                    - account_id: 00fd8b39-cf92-4b43-a2ff-a461b48e7059
                      instance_url: usea1-015.sentinelone.net
                      last_status: success
                      last_sync: 1234567891
                      linked_by: user1@test.com
                      linked_timestamp: 1234567891
                      name: company1
                    - account_id: 00fd8b39-cf92-4b43-a2ff-a461b48e7060
                      error: Get token failed, please re-link SentinelOne account
                      instance_url: usea1-017.sentinelone.net
                      last_status: failed
                      last_sync: 1234567800
                      linked_by: user2@test.com
                      linked_timestamp: 1234567891
                      name: company2
                    linked: true
                Vmware:
                  value:
                    accounts:
                    - account_id: f43ea4c4-8a97-4159-9214-112a8c7b8f22
                      instance_url: as800.airwatchportals.com
                      last_status: success
                      last_sync: 1665465339000
                      linked_by: Testname1
                      linked_timestamp: 1702284364
                      name: Test Company1 Ltd
                      webhook_auth_type: Basic
                      webhook_enabled: true
                      webhook_password: password_1234
                      webhook_url: https://websync.nac-staging.mistsys.com/v1/S_41b2525af1d8dcbe9005/f43ea4c48f22/vmware/mdm
                      webhook_username: username_1234
                    - account_id: m56ea4c4-8a10-4189-9214-113a8c7b8m82
                      error: Get token failed, please re-link VMware
                      instance_url: as561.airwatchportals.com
                      last_status: failed
                      last_sync: 1234567890123
                      linked_by: Testname2
                      linked_timestamp: 1702284364
                      name: Test Company2 Ltd
                      webhook_auth_type: Basic
                      webhook_enabled: true
                      webhook_password: password_1234
                      webhook_url: https://websync.nac-staging.mistsys.com/v1/S_41b2525af1d8dcbe9005/f43ea4c48f22/vmware/mdm
                      webhook_username: username_1234
                    linked: true
                ZDX:
                  value:
                    accounts:
                    - account_id: 80364a28-7ccc-4746-b110-ecf3dfd3a359
                      cloud_name: zdxcloud.net
                      key_id: K35vrZcK3JvrZc
                      webhook_url: https://webhook.url/xxx
                      zdx_org_id: '123456'
                    linked: true
                Zoom:
                  value:
                    accounts:
                    - account_id: KkEM7orQSIWHZNFzwMLuRA
                      company: Test Company1 Ltd
                      last_status: success
                      last_sync: 1665465339
                      linked_by: Testname1
                      max_daily_api_requests: 1500
                    - account_id: kojzWgIJQ0ujR73VvydOdg
                      company: Test Company2 Ltd
                      error: OAuth token refresh failed, please re-link your account
                      errors:
                      - OAuth token refresh failed, please re-link your account
                      - API daily rate limit reached for your account
                      last_status: failed
                      last_sync: 1665465346
                      linked_by: Testname2
                      max_daily_api_requests: 5000
                    - account_id: iojzXIJWEuiD73ZvydOfg
                      company: Test Company3 Ltd
                      last_status: failed
                      last_sync: 1665465538
                      linked_by: Testname3
                      max_daily_api_requests: 3500
                    authorization_url: https://zoom.us/oauth/authorize?response_type=code&client_id=YDyajBmJREjwkyb3TPAbA&redirect_uri=https%3A%2F%2Fapi.local%2Fapi%2Fv1%2Forg%2Fb4e16c72-d50e-4c03-a952-a3217e231e2c%2Foauth2%2Fapp%2Fzoom%2Fcallback&state=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2NDk3NjE0MDQsImZvcndhcmQiOiJodHRwczovL2NsaWVudGZvcndhcmR1cmwuY29tIn0.RIE4XTU5kpF4nKIy7_enJ0PpOCyTTp6DLm9PZsdncpI
                    linked: true
        '400':
          description: Unsuccessful
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/setting/{app_name}/link_accounts/{account_id}:
    delete:
      tags:
      - Orgs Linked Applications
      summary: deleteOrgOauthAppAuthorization
      description: Remove a linked account authorization for the specified OAuth application and account ID.
      operationId: deleteOrgOauthAppAuthorization
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: app_name
        in: path
        description: OAuth application name
        required: true
        schema:
          allOf:
          - $ref: '#/components/schemas/oauth_app_name'
          - description: OAuth application name
      - name: account_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          examples:
          - iojzXIJWEuiD73ZvydOfg
      responses:
        '200':
          description: Successful
          headers: {}
          content: {}
        '400':
          description: Unsuccessful
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs Linked Applications
      summary: updateOrgOauthAppAccount
      description: Update app-specific settings for a linked OAuth application account, such as Zoom or Teams guest redaction settings or a Zoom daily API request quota.
      operationId: updateOrgOauthAppAccount
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: app_name
        in: path
        description: OAuth application name
        required: true
        schema:
          allOf:
          - $ref: '#/components/schemas/oauth_app_name'
          - description: OAuth application name
      - name: account_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          examples:
          - iojzXIJWEuiD73ZvydOfg
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/account_oauth_config'
              - examples:
                - account_id: iojzXIJWEuiD73ZvydOfg
                  max_daily_api_requests: 5000
              contentMediaType: application/json
            examples:
              Example:
                value:
                  account_id: iojzXIJWEuiD73ZvydOfg
                  max_daily_api_requests: 5000
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/logs:
    get:
      tags:
      - Orgs Logs
      summary: listOrgAuditLogsLegacy
      description: Get List of change logs for the current Org
      operationId: listOrgAuditLogsLegacy
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: site_id
        in: query
        description: Filter results by site identifier. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002
          - 4ac1dcf4-9d8b-7211-65c4-057819f0862b
        examples:
          Untitled Example1:
            value: 00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002
          Untitled Example2:
            value: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
      - name: admin_name
        in: query
        description: Filter results by one or more administrator names or email addresses. Supports comma-separated values
        style: form
        explode: true
        schema:
          type: string
          examples:
          - John Doe
      - name: message
        in: query
        description: Filter results by one or more message text values. Supports comma-separated values
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Created a new site
      - name: sort
        in: query
        description: 'Field used to sort results; a leading `-` indicates descending order. enum: `-timestamp`, `admin_id`, `site_id`, `timestamp`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/list_org_logs_sort'
          - description: 'Field used to sort results; a leading `-` indicates descending order. enum: `-timestamp`, `admin_id`, `site_id`, `timestamp`'
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_log_search'
                - description: Paginated response for audit log search results
                  examples:
                  - end: 1428954000
                    limit: 100
                    results:
                    - admin_id: 72bfa2bd-e58a-4670-9d20-a1468f7a6f58
                      admin_name: test@mistsys.com
                      id: c6f9347b-b0a4-4a23-b927-fa9249f2ffb2
                      message: TEST AUDIT
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      timestamp: 1431382121
                    start: 1428939600
                    total: 135
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1428954000
                    limit: 100
                    results:
                    - admin_id: 72bfa2bd-e58a-4670-9d20-a1468f7a6f58
                      admin_name: test@mistsys.com
                      id: c6f9347b-b0a4-4a23-b927-fa9249f2ffb2
                      message: TEST AUDIT
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      timestamp: 1431382121
                    start: 1428939600
                    total: 135
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_log_search'
                - description: Paginated response for audit log search results
                  examples:
                  - end: 1428954000
                    limit: 100
                    results:
                    - admin_id: 72bfa2bd-e58a-4670-9d20-a1468f7a6f58
                      admin_name: test@mistsys.com
                      id: c6f9347b-b0a4-4a23-b927-fa9249f2ffb2
                      message: TEST AUDIT
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      timestamp: 1431382121
                    start: 1428939600
                    total: 135
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1428954000
                    limit: 100
                    results:
                    - admin_id: 72bfa2bd-e58a-4670-9d20-a1468f7a6f58
                      admin_name: test@mistsys.com
                      id: c6f9347b-b0a4-4a23-b927-fa9249f2ffb2
                      message: TEST AUDIT
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      timestamp: 1431382121
                    start: 1428939600
                    total: 135
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: true
    parameters: []
  /api/v1/orgs/{org_id}/logs/count:
    get:
      tags:
      - Orgs Logs
      summary: countOrgAuditLogs
      description: Count organization audit log records, optionally grouped by `distinct` and filtered by administrator, site, message text, and time range.
      operationId: countOrgAuditLogs
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `admin_id`, `admin_name`, `message`, `site_id`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/org_logs_count_distinct'
          - description: 'Field used to group this count response. enum: `admin_id`, `admin_name`, `message`, `site_id`'
      - name: admin_id
        in: query
        description: Filter audit log results by administrator identifier
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 4ac1dcf4-9d8b-7211-65c4-057819f0862b
      - name: admin_name
        in: query
        description: Filter audit log results by one or more administrator names. Supports comma-separated values
        style: form
        explode: true
        schema:
          type: string
          examples:
          - John Doe
      - name: site_id
        in: query
        description: Filter results by site identifier
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 4ac1dcf4-9d8b-7211-65c4-057819f0862b
      - name: message
        in: query
        description: Filter log results by message text
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Created a new site
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/logs/search:
    get:
      tags:
      - Orgs Logs
      summary: listOrgAuditLogs
      description: Get a list of change logs for the current Org
      operationId: listOrgAuditLogs
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: site_id
        in: query
        description: Filter results by site identifier. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002
          - 4ac1dcf4-9d8b-7211-65c4-057819f0862b
        examples:
          Untitled Example1:
            value: 00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002
          Untitled Example2:
            value: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
      - name: admin_name
        in: query
        description: Filter results by one or more administrator names or email addresses. Supports comma-separated values
        style: form
        explode: true
        schema:
          type: string
          examples:
          - John Doe
      - name: message
        in: query
        description: Filter results by one or more message text values. Supports comma-separated values
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Created a new site
      - name: sort
        in: query
        description: 'Field used to sort results; a leading `-` indicates descending order. enum: `-timestamp`, `admin_id`, `site_id`, `timestamp`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/list_org_logs_sort'
          - description: 'Field used to sort results; a leading `-` indicates descending order. enum: `-timestamp`, `admin_id`, `site_id`, `timestamp`'
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_log_search'
                - description: Paginated response for audit log search results
                  examples:
                  - end: 1428954000
                    limit: 100
                    results:
                    - admin_id: 72bfa2bd-e58a-4670-9d20-a1468f7a6f58
                      admin_name: test@mistsys.com
                      id: c6f9347b-b0a4-4a23-b927-fa9249f2ffb2
                      message: TEST AUDIT
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      timestamp: 1431382121
                    start: 1428939600
                    total: 135
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1428954000
                    limit: 100
                    results:
                    - admin_id: 72bfa2bd-e58a-4670-9d20-a1468f7a6f58
                      admin_name: test@mistsys.com
                      id: c6f9347b-b0a4-4a23-b927-fa9249f2ffb2
                      message: TEST AUDIT
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      timestamp: 1431382121
                    start: 1428939600
                    total: 135
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_log_search'
                - description: Paginated response for audit log search results
                  examples:
                  - end: 1428954000
                    limit: 100
                    results:
                    - admin_id: 72bfa2bd-e58a-4670-9d20-a1468f7a6f58
                      admin_name: test@mistsys.com
                      id: c6f9347b-b0a4-4a23-b927-fa9249f2ffb2
                      message: TEST AUDIT
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      timestamp: 1431382121
                    start: 1428939600
                    total: 135
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1428954000
                    limit: 100
                    results:
                    - admin_id: 72bfa2bd-e58a-4670-9d20-a1468f7a6f58
                      admin_name: test@mistsys.com
                      id: c6f9347b-b0a4-4a23-b927-fa9249f2ffb2
                      message: TEST AUDIT
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      timestamp: 1431382121
                    start: 1428939600
                    total: 135
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/troubleshoot:
    get:
      tags:
      - Orgs Marvis
      summary: troubleshootOrg
      description: >-
        Troubleshoot sites, devices, clients, and wired clients for maximum of last 7 days from current time. See search APIs for device information:

        - [search Device]($e/Orgs%20Devices/searchOrgDevices)

        - [search Wireless Client]($e/Orgs%20Clients%20-%20Wireless/searchOrgWirelessClients)

        - [search Wired Client]($e/Orgs%20Clients%20-%20Wired/searchOrgWiredClients)

        - [search Wan Client]($e/Orgs%20Clients%20-%20Wan/searchOrgWanClients)


        **NOTE**: requires Marvis subscription license
      operationId: troubleshootOrg
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mac
        in: query
        description: '**required** when troubleshooting device or a client'
        style: form
        explode: true
        schema:
          type: string
      - name: site_id
        in: query
        description: '**required** when troubleshooting site'
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: uuid
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: type
        in: query
        description: 'When troubleshooting site, type of network to troubleshoot. enum: `wan`, `wired`, `wireless`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/troubleshoot_type'
          - description: 'When troubleshooting site, type of network to troubleshoot. enum: `wan`, `wired`, `wireless`'
      responses:
        '200':
          description: Troubleshoot Response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_troubleshoot'
                - description: Organization troubleshooting response for the requested time window
                  examples:
                  - end: 1655151856
                    results:
                    - category: client
                      reason: slow association
                      recommendation: Ensure the IP helper-address is configured on the VLAN interface.
                      text: Clients of the AP had slow association 8% of the time on Bhavabhi and 5 GHz. ...
                    start: 1655065456
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1655151856
                    results:
                    - category: client
                      reason: slow association
                      recommendation: Ensure the IP helper-address is configured on the VLAN interface.
                      text: Clients of the AP had slow association 8% of the time on Bhavabhi and 5 GHz. ...
                    start: 1655065456
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_troubleshoot'
                - description: Organization troubleshooting response for the requested time window
                  examples:
                  - end: 1655151856
                    results:
                    - category: client
                      reason: slow association
                      recommendation: Ensure the IP helper-address is configured on the VLAN interface.
                      text: Clients of the AP had slow association 8% of the time on Bhavabhi and 5 GHz. ...
                    start: 1655065456
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1655151856
                    results:
                    - category: client
                      reason: slow association
                      recommendation: Ensure the IP helper-address is configured on the VLAN interface.
                      text: Clients of the AP had slow association 8% of the time on Bhavabhi and 5 GHz. ...
                    start: 1655065456
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/maps/import:
    post:
      tags:
      - Orgs Maps
      summary: importOrgMaps
      description: >-
        Import data from files is a multipart POST which has a file, an optional json, and an optional csv, to create floorplan, assign matching inventory to specific site, place ap if name or mac matches


        ### CSV File Format

        ```csv

        Vendor AP name,Mist AP Mac

        US Office AP-2 - 5c:5b:35:00:00:02,5c5b35000002

        ```
      operationId: importOrgMaps
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              type: object
              properties:
                auto_deviceprofile_assignment:
                  type: boolean
                  description: Whether to auto assign device to deviceprofile by name
                  examples:
                  - true
                csv:
                  type: string
                  description: Optional AP name-mapping CSV file
                  contentEncoding: base64
                file:
                  type: string
                  description: Ekahau or iBwave floorplan file to import
                  contentEncoding: base64
                json:
                  allOf:
                  - $ref: '#/components/schemas/map_org_import_file_json2'
                  - description: Import options for the organization map file
              contentMediaType: multipart/form-data
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_map_import'
                - description: Result of importing map files and matching AP placements
                  examples:
                  - '{"aps":[{"action":"assigned-placed","floorplan_id":"6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9","height":3,"mac":"5c5b35000001","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","orientation":45}],"floorplans":[{"action":"imported","id":"cbdb7f0b-3be0-4872-88f9-58790b509c23","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","name":"map1"}],"site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","summary":{"num_ap_assigned":1,"num_inv_assigned":1,"num_map_assigned":1}}'
                  - '{"aps":[{"action":"assigned-named-placed","floorplan_id":"6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9","mac":"5c5b35000001","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","orientation":45}],"floorplans":[{"action":"imported","id":"cbdb7f0b-3be0-4872-88f9-58790b509c23","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","name":"map1"}],"site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","summary":{"num_ap_assigned":1,"num_inv_assigned":1,"num_map_assigned":1}}'
                  - '{"aps":[{"action":"placed","floorplan_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","height":3,"mac":"5c5b35000001","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","orientation":45}],"floorplans":[{"action":"imported","id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","name":"map1"}],"site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","summary":{"num_ap_assigned":1,"num_inv_assigned":1,"num_map_assigned":1}}'
                contentMediaType: application/json
              examples:
                Assigned And Placed:
                  value:
                    aps:
                    - action: assigned-placed
                      floorplan_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                      height: 3
                      mac: 5c5b35000001
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      orientation: 45
                    floorplans:
                    - action: imported
                      id: cbdb7f0b-3be0-4872-88f9-58790b509c23
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      name: map1
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    summary:
                      num_ap_assigned: 1
                      num_inv_assigned: 1
                      num_map_assigned: 1
                Assigned Named And Placed:
                  value:
                    aps:
                    - action: assigned-named-placed
                      floorplan_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                      mac: 5c5b35000001
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      orientation: 45
                    floorplans:
                    - action: imported
                      id: cbdb7f0b-3be0-4872-88f9-58790b509c23
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      name: map1
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    summary:
                      num_ap_assigned: 1
                      num_inv_assigned: 1
                      num_map_assigned: 1
                Placed:
                  value:
                    aps:
                    - action: placed
                      floorplan_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      height: 3
                      mac: 5c5b35000001
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      orientation: 45
                    floorplans:
                    - action: imported
                      id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      name: map1
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    summary:
                      num_ap_assigned: 1
                      num_inv_assigned: 1
                      num_map_assigned: 1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_map_import'
                - description: Result of importing map files and matching AP placements
                  examples:
                  - '{"aps":[{"action":"assigned-placed","floorplan_id":"6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9","height":3,"mac":"5c5b35000001","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","orientation":45}],"floorplans":[{"action":"imported","id":"cbdb7f0b-3be0-4872-88f9-58790b509c23","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","name":"map1"}],"site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","summary":{"num_ap_assigned":1,"num_inv_assigned":1,"num_map_assigned":1}}'
                  - '{"aps":[{"action":"assigned-named-placed","floorplan_id":"6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9","mac":"5c5b35000001","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","orientation":45}],"floorplans":[{"action":"imported","id":"cbdb7f0b-3be0-4872-88f9-58790b509c23","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","name":"map1"}],"site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","summary":{"num_ap_assigned":1,"num_inv_assigned":1,"num_map_assigned":1}}'
                  - '{"aps":[{"action":"placed","floorplan_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","height":3,"mac":"5c5b35000001","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","orientation":45}],"floorplans":[{"action":"imported","id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","name":"map1"}],"site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","summary":{"num_ap_assigned":1,"num_inv_assigned":1,"num_map_assigned":1}}'
                contentMediaType: application/vnd.api+json
              examples:
                Assigned And Placed:
                  value:
                    aps:
                    - action: assigned-placed
                      floorplan_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                      height: 3
                      mac: 5c5b35000001
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      orientation: 45
                    floorplans:
                    - action: imported
                      id: cbdb7f0b-3be0-4872-88f9-58790b509c23
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      name: map1
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    summary:
                      num_ap_assigned: 1
                      num_inv_assigned: 1
                      num_map_assigned: 1
                Assigned Named And Placed:
                  value:
                    aps:
                    - action: assigned-named-placed
                      floorplan_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                      mac: 5c5b35000001
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      orientation: 45
                    floorplans:
                    - action: imported
                      id: cbdb7f0b-3be0-4872-88f9-58790b509c23
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      name: map1
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    summary:
                      num_ap_assigned: 1
                      num_inv_assigned: 1
                      num_map_assigned: 1
                Placed:
                  value:
                    aps:
                    - action: placed
                      floorplan_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      height: 3
                      mac: 5c5b35000001
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      orientation: 45
                    floorplans:
                    - action: imported
                      id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      name: map1
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    summary:
                      num_ap_assigned: 1
                      num_inv_assigned: 1
                      num_map_assigned: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/sites/{site_name}/maps/import:
    post:
      tags:
      - Orgs Maps
      summary: importOrgMapToSite
      description: Import floorplan data into a site from a multipart upload. The upload includes an Ekahau or iBwave floorplan file, optional import options JSON, and optional AP name-mapping CSV; matching inventory can be assigned to the site and APs placed when names or MAC addresses match.
      operationId: importOrgMapToSite
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: site_name
        in: path
        description: ''
        required: true
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              type: object
              properties:
                auto_deviceprofile_assignment:
                  type: boolean
                  description: Whether to auto assign device to deviceprofile by name
                  examples:
                  - true
                csv:
                  type: string
                  description: Optional AP name-mapping CSV file
                  contentEncoding: base64
                file:
                  type: string
                  description: Ekahau or iBwave floorplan file to import
                  contentEncoding: base64
                json:
                  allOf:
                  - $ref: '#/components/schemas/map_import_json1'
                  - description: Import options for the site map file
              contentMediaType: multipart/form-data
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_map_import'
                - description: Result of importing map files and matching AP placements
                  examples:
                  - '{"aps":[{"action":"assigned-placed","floorplan_id":"6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9","height":3,"mac":"5c5b35000001","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","orientation":45}],"floorplans":[{"action":"imported","id":"cbdb7f0b-3be0-4872-88f9-58790b509c23","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","name":"map1"}],"site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","summary":{"num_ap_assigned":1,"num_inv_assigned":1,"num_map_assigned":1}}'
                  - '{"aps":[{"action":"assigned-named-placed","floorplan_id":"6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9","mac":"5c5b35000001","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","orientation":45}],"floorplans":[{"action":"imported","id":"cbdb7f0b-3be0-4872-88f9-58790b509c23","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","name":"map1"}],"site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","summary":{"num_ap_assigned":1,"num_inv_assigned":1,"num_map_assigned":1}}'
                  - '{"aps":[{"action":"placed","floorplan_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","height":3,"mac":"5c5b35000001","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","orientation":45}],"floorplans":[{"action":"imported","id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","name":"map1"}],"site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","summary":{"num_ap_assigned":1,"num_inv_assigned":1,"num_map_assigned":1}}'
                contentMediaType: application/json
              examples:
                Assigned And Placed:
                  value:
                    aps:
                    - action: assigned-placed
                      floorplan_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                      height: 3
                      mac: 5c5b35000001
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      orientation: 45
                    floorplans:
                    - action: imported
                      id: cbdb7f0b-3be0-4872-88f9-58790b509c23
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      name: map1
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    summary:
                      num_ap_assigned: 1
                      num_inv_assigned: 1
                      num_map_assigned: 1
                Assigned Named And Placed:
                  value:
                    aps:
                    - action: assigned-named-placed
                      floorplan_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                      mac: 5c5b35000001
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      orientation: 45
                    floorplans:
                    - action: imported
                      id: cbdb7f0b-3be0-4872-88f9-58790b509c23
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      name: map1
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    summary:
                      num_ap_assigned: 1
                      num_inv_assigned: 1
                      num_map_assigned: 1
                Placed:
                  value:
                    aps:
                    - action: placed
                      floorplan_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      height: 3
                      mac: 5c5b35000001
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      orientation: 45
                    floorplans:
                    - action: imported
                      id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      name: map1
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    summary:
                      num_ap_assigned: 1
                      num_inv_assigned: 1
                      num_map_assigned: 1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_map_import'
                - description: Result of importing map files and matching AP placements
                  examples:
                  - '{"aps":[{"action":"assigned-placed","floorplan_id":"6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9","height":3,"mac":"5c5b35000001","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","orientation":45}],"floorplans":[{"action":"imported","id":"cbdb7f0b-3be0-4872-88f9-58790b509c23","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","name":"map1"}],"site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","summary":{"num_ap_assigned":1,"num_inv_assigned":1,"num_map_assigned":1}}'
                  - '{"aps":[{"action":"assigned-named-placed","floorplan_id":"6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9","mac":"5c5b35000001","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","orientation":45}],"floorplans":[{"action":"imported","id":"cbdb7f0b-3be0-4872-88f9-58790b509c23","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","name":"map1"}],"site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","summary":{"num_ap_assigned":1,"num_inv_assigned":1,"num_map_assigned":1}}'
                  - '{"aps":[{"action":"placed","floorplan_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","height":3,"mac":"5c5b35000001","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","orientation":45}],"floorplans":[{"action":"imported","id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","name":"map1"}],"site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","summary":{"num_ap_assigned":1,"num_inv_assigned":1,"num_map_assigned":1}}'
                contentMediaType: application/vnd.api+json
              examples:
                Assigned And Placed:
                  value:
                    aps:
                    - action: assigned-placed
                      floorplan_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                      height: 3
                      mac: 5c5b35000001
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      orientation: 45
                    floorplans:
                    - action: imported
                      id: cbdb7f0b-3be0-4872-88f9-58790b509c23
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      name: map1
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    summary:
                      num_ap_assigned: 1
                      num_inv_assigned: 1
                      num_map_assigned: 1
                Assigned Named And Placed:
                  value:
                    aps:
                    - action: assigned-named-placed
                      floorplan_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                      mac: 5c5b35000001
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      orientation: 45
                    floorplans:
                    - action: imported
                      id: cbdb7f0b-3be0-4872-88f9-58790b509c23
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      name: map1
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    summary:
                      num_ap_assigned: 1
                      num_inv_assigned: 1
                      num_map_assigned: 1
                Placed:
                  value:
                    aps:
                    - action: placed
                      floorplan_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      height: 3
                      mac: 5c5b35000001
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      orientation: 45
                    floorplans:
                    - action: imported
                      id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      name: map1
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    summary:
                      num_ap_assigned: 1
                      num_inv_assigned: 1
                      num_map_assigned: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/mxclusters:
    get:
      tags:
      - Orgs MxClusters
      summary: listOrgMxEdgeClusters
      description: List Mist Edge clusters in the organization, which group one or more Mist Edge devices for tunneling, RadSec, and related edge services.
      operationId: listOrgMxEdgeClusters
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/mxcluster'
                description: List of Mist Edge clusters
                examples:
                - - created_time: 0
                    for_site: true
                    id: 467f6eca-6276-4993-bfeb-53cbbbba6f78
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    radsec:
                      acct_servers:
                      - host: string
                        port: 1813
                        secret: string
                      auth_servers:
                      - host: string
                        port: 1812
                        secret: string
                      enabled: true
                      server_selection: ordered
                    radsec_tls:
                      keypair: string
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    tunterm_ap_subnets:
                    - string
                    tunterm_dhcpd_config:
                      enabled: false
                      property1:
                        enabled: false
                        servers:
                        - string
                        type: relay
                      property2:
                        enabled: false
                        servers:
                        - string
                        type: relay
                      servers:
                      - string
                      type: relay
                    tunterm_extra_routes:
                      property1:
                        via: string
                      property2:
                        via: string
                    tunterm_hosts:
                    - string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 0
                    for_site: true
                    id: 467f6eca-6276-4993-bfeb-53cbbbba6f78
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    radsec:
                      acct_servers:
                      - host: string
                        port: 1813
                        secret: string
                      auth_servers:
                      - host: string
                        port: 1812
                        secret: string
                      enabled: true
                      server_selection: ordered
                    radsec_tls:
                      keypair: string
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    tunterm_ap_subnets:
                    - string
                    tunterm_dhcpd_config:
                      enabled: false
                      property1:
                        enabled: false
                        servers:
                        - string
                        type: relay
                      property2:
                        enabled: false
                        servers:
                        - string
                        type: relay
                      servers:
                      - string
                      type: relay
                    tunterm_extra_routes:
                      property1:
                        via: string
                      property2:
                        via: string
                    tunterm_hosts:
                    - string
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/mxcluster'
                description: List of Mist Edge clusters
                examples:
                - - created_time: 0
                    for_site: true
                    id: 467f6eca-6276-4993-bfeb-53cbbbba6f78
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    radsec:
                      acct_servers:
                      - host: string
                        port: 1813
                        secret: string
                      auth_servers:
                      - host: string
                        port: 1812
                        secret: string
                      enabled: true
                      server_selection: ordered
                    radsec_tls:
                      keypair: string
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    tunterm_ap_subnets:
                    - string
                    tunterm_dhcpd_config:
                      enabled: false
                      property1:
                        enabled: false
                        servers:
                        - string
                        type: relay
                      property2:
                        enabled: false
                        servers:
                        - string
                        type: relay
                      servers:
                      - string
                      type: relay
                    tunterm_extra_routes:
                      property1:
                        via: string
                      property2:
                        via: string
                    tunterm_hosts:
                    - string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 0
                    for_site: true
                    id: 467f6eca-6276-4993-bfeb-53cbbbba6f78
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    radsec:
                      acct_servers:
                      - host: string
                        port: 1813
                        secret: string
                      auth_servers:
                      - host: string
                        port: 1812
                        secret: string
                      enabled: true
                      server_selection: ordered
                    radsec_tls:
                      keypair: string
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    tunterm_ap_subnets:
                    - string
                    tunterm_dhcpd_config:
                      enabled: false
                      property1:
                        enabled: false
                        servers:
                        - string
                        type: relay
                      property2:
                        enabled: false
                        servers:
                        - string
                        type: relay
                      servers:
                      - string
                      type: relay
                    tunterm_extra_routes:
                      property1:
                        via: string
                      property2:
                        via: string
                    tunterm_hosts:
                    - string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs MxClusters
      summary: createOrgMxEdgeCluster
      description: >-
        Create a Mist Edge cluster with tunnel termination, RadSec, NAC,

        and management settings.



        **Note**: It is not recommended to combine multiple roles (tunnel termination, RadSec, NAC) on the same Mist Edge cluster
      operationId: createOrgMxEdgeCluster
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/mxcluster'
              - description: Request Body
                examples:
                - name: string
                  radsec:
                    auth_servers:
                    - host: string
                      port: 0
                    enabled: true
                  tunterm_ap_subnets:
                  - string
                  tunterm_hosts:
                  - string
              contentMediaType: application/json
            examples:
              Example:
                value:
                  name: string
                  radsec:
                    auth_servers:
                    - host: string
                      port: 0
                    enabled: true
                  tunterm_ap_subnets:
                  - string
                  tunterm_hosts:
                  - string
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mxcluster'
                - description: Mist Edge cluster that groups one or more Mist Edge devices for tunneling, RadSec, and related edge services
                  examples:
                  - created_time: 0
                    for_site: true
                    id: 468f6eca-6276-4993-bfeb-53cbbbba6f68
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    radsec:
                      acct_servers:
                      - host: string
                        port: 1813
                        secret: string
                      auth_servers:
                      - host: string
                        port: 1812
                        secret: string
                      enabled: true
                      server_selection: ordered
                    radsec_tls:
                      keypair: string
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    tunterm_ap_subnets:
                    - string
                    tunterm_dhcpd_config:
                      enabled: false
                      property1:
                        enabled: false
                        servers:
                        - string
                        type: relay
                      property2:
                        enabled: false
                        servers:
                        - string
                        type: relay
                      servers:
                      - string
                      type: relay
                    tunterm_extra_routes:
                      property1:
                        via: string
                      property2:
                        via: string
                    tunterm_hosts:
                    - string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    for_site: true
                    id: 468f6eca-6276-4993-bfeb-53cbbbba6f68
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    radsec:
                      acct_servers:
                      - host: string
                        port: 1813
                        secret: string
                      auth_servers:
                      - host: string
                        port: 1812
                        secret: string
                      enabled: true
                      server_selection: ordered
                    radsec_tls:
                      keypair: string
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    tunterm_ap_subnets:
                    - string
                    tunterm_dhcpd_config:
                      enabled: false
                      property1:
                        enabled: false
                        servers:
                        - string
                        type: relay
                      property2:
                        enabled: false
                        servers:
                        - string
                        type: relay
                      servers:
                      - string
                      type: relay
                    tunterm_extra_routes:
                      property1:
                        via: string
                      property2:
                        via: string
                    tunterm_hosts:
                    - string
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mxcluster'
                - description: Mist Edge cluster that groups one or more Mist Edge devices for tunneling, RadSec, and related edge services
                  examples:
                  - created_time: 0
                    for_site: true
                    id: 468f6eca-6276-4993-bfeb-53cbbbba6f68
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    radsec:
                      acct_servers:
                      - host: string
                        port: 1813
                        secret: string
                      auth_servers:
                      - host: string
                        port: 1812
                        secret: string
                      enabled: true
                      server_selection: ordered
                    radsec_tls:
                      keypair: string
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    tunterm_ap_subnets:
                    - string
                    tunterm_dhcpd_config:
                      enabled: false
                      property1:
                        enabled: false
                        servers:
                        - string
                        type: relay
                      property2:
                        enabled: false
                        servers:
                        - string
                        type: relay
                      servers:
                      - string
                      type: relay
                    tunterm_extra_routes:
                      property1:
                        via: string
                      property2:
                        via: string
                    tunterm_hosts:
                    - string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    for_site: true
                    id: 468f6eca-6276-4993-bfeb-53cbbbba6f68
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    radsec:
                      acct_servers:
                      - host: string
                        port: 1813
                        secret: string
                      auth_servers:
                      - host: string
                        port: 1812
                        secret: string
                      enabled: true
                      server_selection: ordered
                    radsec_tls:
                      keypair: string
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    tunterm_ap_subnets:
                    - string
                    tunterm_dhcpd_config:
                      enabled: false
                      property1:
                        enabled: false
                        servers:
                        - string
                        type: relay
                      property2:
                        enabled: false
                        servers:
                        - string
                        type: relay
                      servers:
                      - string
                      type: relay
                    tunterm_extra_routes:
                      property1:
                        via: string
                      property2:
                        via: string
                    tunterm_hosts:
                    - string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/mxclusters/{mxcluster_id}:
    delete:
      tags:
      - Orgs MxClusters
      summary: deleteOrgMxEdgeCluster
      description: Delete a Mist Edge cluster by cluster ID, removing its cluster configuration from the organization.
      operationId: deleteOrgMxEdgeCluster
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mxcluster_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs MxClusters
      summary: getOrgMxEdgeCluster
      description: Retrieve configuration details for a specific Mist Edge cluster, including tunneling, RadSec, NAC, and management settings.
      operationId: getOrgMxEdgeCluster
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mxcluster_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mxcluster'
                - description: Mist Edge cluster that groups one or more Mist Edge devices for tunneling, RadSec, and related edge services
                  examples:
                  - created_time: 0
                    for_site: true
                    id: 468f6eca-6276-4993-bfeb-53cbbbba6f68
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    radsec:
                      acct_servers:
                      - host: string
                        port: 1813
                        secret: string
                      auth_servers:
                      - host: string
                        port: 1812
                        secret: string
                      enabled: true
                      server_selection: ordered
                    radsec_tls:
                      keypair: string
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    tunterm_ap_subnets:
                    - string
                    tunterm_dhcpd_config:
                      enabled: false
                      property1:
                        enabled: false
                        servers:
                        - string
                        type: relay
                      property2:
                        enabled: false
                        servers:
                        - string
                        type: relay
                      servers:
                      - string
                      type: relay
                    tunterm_extra_routes:
                      property1:
                        via: string
                      property2:
                        via: string
                    tunterm_hosts:
                    - string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    for_site: true
                    id: 468f6eca-6276-4993-bfeb-53cbbbba6f68
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    radsec:
                      acct_servers:
                      - host: string
                        port: 1813
                        secret: string
                      auth_servers:
                      - host: string
                        port: 1812
                        secret: string
                      enabled: true
                      server_selection: ordered
                    radsec_tls:
                      keypair: string
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    tunterm_ap_subnets:
                    - string
                    tunterm_dhcpd_config:
                      enabled: false
                      property1:
                        enabled: false
                        servers:
                        - string
                        type: relay
                      property2:
                        enabled: false
                        servers:
                        - string
                        type: relay
                      servers:
                      - string
                      type: relay
                    tunterm_extra_routes:
                      property1:
                        via: string
                      property2:
                        via: string
                    tunterm_hosts:
                    - string
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mxcluster'
                - description: Mist Edge cluster that groups one or more Mist Edge devices for tunneling, RadSec, and related edge services
                  examples:
                  - created_time: 0
                    for_site: true
                    id: 468f6eca-6276-4993-bfeb-53cbbbba6f68
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    radsec:
                      acct_servers:
                      - host: string
                        port: 1813
                        secret: string
                      auth_servers:
                      - host: string
                        port: 1812
                        secret: string
                      enabled: true
                      server_selection: ordered
                    radsec_tls:
                      keypair: string
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    tunterm_ap_subnets:
                    - string
                    tunterm_dhcpd_config:
                      enabled: false
                      property1:
                        enabled: false
                        servers:
                        - string
                        type: relay
                      property2:
                        enabled: false
                        servers:
                        - string
                        type: relay
                      servers:
                      - string
                      type: relay
                    tunterm_extra_routes:
                      property1:
                        via: string
                      property2:
                        via: string
                    tunterm_hosts:
                    - string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    for_site: true
                    id: 468f6eca-6276-4993-bfeb-53cbbbba6f68
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    radsec:
                      acct_servers:
                      - host: string
                        port: 1813
                        secret: string
                      auth_servers:
                      - host: string
                        port: 1812
                        secret: string
                      enabled: true
                      server_selection: ordered
                    radsec_tls:
                      keypair: string
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    tunterm_ap_subnets:
                    - string
                    tunterm_dhcpd_config:
                      enabled: false
                      property1:
                        enabled: false
                        servers:
                        - string
                        type: relay
                      property2:
                        enabled: false
                        servers:
                        - string
                        type: relay
                      servers:
                      - string
                      type: relay
                    tunterm_extra_routes:
                      property1:
                        via: string
                      property2:
                        via: string
                    tunterm_hosts:
                    - string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs MxClusters
      summary: updateOrgMxEdgeCluster
      description: Update a Mist Edge cluster's tunneling, RadSec, NAC, and management settings.
      operationId: updateOrgMxEdgeCluster
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mxcluster_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/mxcluster'
              - description: Request Body
                examples:
                - name: string
                  radsec:
                    auth_servers:
                    - host: string
                      port: 0
                    enabled: true
                  tunterm_ap_subnets:
                  - string
                  tunterm_hosts:
                  - string
              contentMediaType: application/json
            examples:
              Example:
                value:
                  name: string
                  radsec:
                    auth_servers:
                    - host: string
                      port: 0
                    enabled: true
                  tunterm_ap_subnets:
                  - string
                  tunterm_hosts:
                  - string
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mxcluster'
                - description: Mist Edge cluster that groups one or more Mist Edge devices for tunneling, RadSec, and related edge services
                  examples:
                  - created_time: 0
                    for_site: true
                    id: 468f6eca-6276-4993-bfeb-53cbbbba6f68
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    radsec:
                      acct_servers:
                      - host: string
                        port: 1813
                        secret: string
                      auth_servers:
                      - host: string
                        port: 1812
                        secret: string
                      enabled: true
                      server_selection: ordered
                    radsec_tls:
                      keypair: string
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    tunterm_ap_subnets:
                    - string
                    tunterm_dhcpd_config:
                      enabled: false
                      property1:
                        enabled: false
                        servers:
                        - string
                        type: relay
                      property2:
                        enabled: false
                        servers:
                        - string
                        type: relay
                      servers:
                      - string
                      type: relay
                    tunterm_extra_routes:
                      property1:
                        via: string
                      property2:
                        via: string
                    tunterm_hosts:
                    - string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    for_site: true
                    id: 468f6eca-6276-4993-bfeb-53cbbbba6f68
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    radsec:
                      acct_servers:
                      - host: string
                        port: 1813
                        secret: string
                      auth_servers:
                      - host: string
                        port: 1812
                        secret: string
                      enabled: true
                      server_selection: ordered
                    radsec_tls:
                      keypair: string
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    tunterm_ap_subnets:
                    - string
                    tunterm_dhcpd_config:
                      enabled: false
                      property1:
                        enabled: false
                        servers:
                        - string
                        type: relay
                      property2:
                        enabled: false
                        servers:
                        - string
                        type: relay
                      servers:
                      - string
                      type: relay
                    tunterm_extra_routes:
                      property1:
                        via: string
                      property2:
                        via: string
                    tunterm_hosts:
                    - string
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mxcluster'
                - description: Mist Edge cluster that groups one or more Mist Edge devices for tunneling, RadSec, and related edge services
                  examples:
                  - created_time: 0
                    for_site: true
                    id: 468f6eca-6276-4993-bfeb-53cbbbba6f68
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    radsec:
                      acct_servers:
                      - host: string
                        port: 1813
                        secret: string
                      auth_servers:
                      - host: string
                        port: 1812
                        secret: string
                      enabled: true
                      server_selection: ordered
                    radsec_tls:
                      keypair: string
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    tunterm_ap_subnets:
                    - string
                    tunterm_dhcpd_config:
                      enabled: false
                      property1:
                        enabled: false
                        servers:
                        - string
                        type: relay
                      property2:
                        enabled: false
                        servers:
                        - string
                        type: relay
                      servers:
                      - string
                      type: relay
                    tunterm_extra_routes:
                      property1:
                        via: string
                      property2:
                        via: string
                    tunterm_hosts:
                    - string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    for_site: true
                    id: 468f6eca-6276-4993-bfeb-53cbbbba6f68
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    radsec:
                      acct_servers:
                      - host: string
                        port: 1813
                        secret: string
                      auth_servers:
                      - host: string
                        port: 1812
                        secret: string
                      enabled: true
                      server_selection: ordered
                    radsec_tls:
                      keypair: string
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    tunterm_ap_subnets:
                    - string
                    tunterm_dhcpd_config:
                      enabled: false
                      property1:
                        enabled: false
                        servers:
                        - string
                        type: relay
                      property2:
                        enabled: false
                        servers:
                        - string
                        type: relay
                      servers:
                      - string
                      type: relay
                    tunterm_extra_routes:
                      property1:
                        via: string
                      property2:
                        via: string
                    tunterm_hosts:
                    - string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/mxedges:
    get:
      tags:
      - Orgs MxEdges
      summary: listOrgMxEdges
      description: List Mist Edge appliances in the organization, optionally filtering for org-level, site-level, or all Mist Edges with `for_site`.
      operationId: listOrgMxEdges
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: for_site
        in: query
        description: 'Filter for org/site level Mist Edges. enum: `any`, `false`, `true`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/mxedge_for_site'
          - description: 'Filter for org/site level Mist Edges. enum: `any`, `false`, `true`'
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/mxedge'
                description: List of Mist Edge appliances
                examples:
                - - cpu_stat:
                      cpus:
                        cpu0:
                          idle: 79
                          interrupt: 0
                          system: 4
                          usage: 20
                          user: 16
                        cpu1:
                          idle: 93
                          interrupt: 0
                          system: 4
                          usage: 6
                          user: 1
                      idle: 87
                      interrupt: 0
                      system: 5
                      usage: 12
                      user: 7
                    ext_ip: 116.187.144.16
                    id: 387804a7-3474-85ce-15a2-f9a9684c9c90
                    ip_stat:
                      ip: 172.16.5.3
                      ips:
                        ens192: 172.16.5.3/24,fe81::20c:29ff:fef8:d18e/64
                    lag_stat:
                      lag0:
                        active_ports:
                        - '0'
                        - '1'
                    last_seen: 1547437078
                    magic: ExNpT5gi-ADR8WTFd4EiQPY3cP5WdSoD
                    memory_stats:
                      active: 1061085184
                      available: 4124860416
                      buffers: 789495808
                      cached: 718016512
                      free: 2818838528
                      inactive: 458158080
                      swap_cached: 0
                      swap_free: 8161062912
                      swap_total: 8161062912
                      total: 7947616256
                      usage: 65
                    model: ME-S2019
                    mxagent_registered: false
                    mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4
                    name: Guest
                    num_tunnels: 31
                    port_stat:
                      eth0:
                        full_duplex: true
                        lldp_stats:
                          mgmt_addr: 122.16.3.11
                          port_desc: GigabitEthernet4/0/16
                          port_id: "\x05Gi4/0/16"
                          system_desc: Cisco IOS Software
                          system_name: ME-DC2-DIS-SW
                        rx_bytes: 2056
                        rx_errors: 0
                        rx_pkts: 670
                        speed: 1000
                        tx_bytes: 2056
                        tx_pkts: 670
                        up: true
                      eth1:
                        up: false
                      module:
                        up: false
                    status: connected
                    tunterm_registered: false
                    tunterm_stat:
                      monitoring_failed: false
                    uptime: 884221
                    version: 0.1.2
                    virtualization_type: VirtualizationVMware
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - cpu_stat:
                      cpus:
                        cpu0:
                          idle: 79
                          interrupt: 0
                          system: 4
                          usage: 20
                          user: 16
                        cpu1:
                          idle: 93
                          interrupt: 0
                          system: 4
                          usage: 6
                          user: 1
                      idle: 87
                      interrupt: 0
                      system: 5
                      usage: 12
                      user: 7
                    ext_ip: 116.187.144.16
                    id: 387804a7-3474-85ce-15a2-f9a9684c9c90
                    ip_stat:
                      ip: 172.16.5.3
                      ips:
                        ens192: 172.16.5.3/24,fe81::20c:29ff:fef8:d18e/64
                    lag_stat:
                      lag0:
                        active_ports:
                        - '0'
                        - '1'
                    last_seen: 1547437078
                    magic: ExNpT5gi-ADR8WTFd4EiQPY3cP5WdSoD
                    memory_stats:
                      active: 1061085184
                      available: 4124860416
                      buffers: 789495808
                      cached: 718016512
                      free: 2818838528
                      inactive: 458158080
                      swap_cached: 0
                      swap_free: 8161062912
                      swap_total: 8161062912
                      total: 7947616256
                      usage: 65
                    model: ME-S2019
                    mxagent_registered: false
                    mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4
                    name: Guest
                    num_tunnels: 31
                    port_stat:
                      eth0:
                        full_duplex: true
                        lldp_stats:
                          mgmt_addr: 122.16.3.11
                          port_desc: GigabitEthernet4/0/16
                          port_id: "\x05Gi4/0/16"
                          system_desc: Cisco IOS Software
                          system_name: ME-DC2-DIS-SW
                        rx_bytes: 2056
                        rx_errors: 0
                        rx_pkts: 670
                        speed: 1000
                        tx_bytes: 2056
                        tx_pkts: 670
                        up: true
                      eth1:
                        up: false
                      module:
                        up: false
                    status: connected
                    tunterm_registered: false
                    tunterm_stat:
                      monitoring_failed: false
                    uptime: 884221
                    version: 0.1.2
                    virtualization_type: VirtualizationVMware
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/mxedge'
                description: List of Mist Edge appliances
                examples:
                - - cpu_stat:
                      cpus:
                        cpu0:
                          idle: 79
                          interrupt: 0
                          system: 4
                          usage: 20
                          user: 16
                        cpu1:
                          idle: 93
                          interrupt: 0
                          system: 4
                          usage: 6
                          user: 1
                      idle: 87
                      interrupt: 0
                      system: 5
                      usage: 12
                      user: 7
                    ext_ip: 116.187.144.16
                    id: 387804a7-3474-85ce-15a2-f9a9684c9c90
                    ip_stat:
                      ip: 172.16.5.3
                      ips:
                        ens192: 172.16.5.3/24,fe81::20c:29ff:fef8:d18e/64
                    lag_stat:
                      lag0:
                        active_ports:
                        - '0'
                        - '1'
                    last_seen: 1547437078
                    magic: ExNpT5gi-ADR8WTFd4EiQPY3cP5WdSoD
                    memory_stats:
                      active: 1061085184
                      available: 4124860416
                      buffers: 789495808
                      cached: 718016512
                      free: 2818838528
                      inactive: 458158080
                      swap_cached: 0
                      swap_free: 8161062912
                      swap_total: 8161062912
                      total: 7947616256
                      usage: 65
                    model: ME-S2019
                    mxagent_registered: false
                    mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4
                    name: Guest
                    num_tunnels: 31
                    port_stat:
                      eth0:
                        full_duplex: true
                        lldp_stats:
                          mgmt_addr: 122.16.3.11
                          port_desc: GigabitEthernet4/0/16
                          port_id: "\x05Gi4/0/16"
                          system_desc: Cisco IOS Software
                          system_name: ME-DC2-DIS-SW
                        rx_bytes: 2056
                        rx_errors: 0
                        rx_pkts: 670
                        speed: 1000
                        tx_bytes: 2056
                        tx_pkts: 670
                        up: true
                      eth1:
                        up: false
                      module:
                        up: false
                    status: connected
                    tunterm_registered: false
                    tunterm_stat:
                      monitoring_failed: false
                    uptime: 884221
                    version: 0.1.2
                    virtualization_type: VirtualizationVMware
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - cpu_stat:
                      cpus:
                        cpu0:
                          idle: 79
                          interrupt: 0
                          system: 4
                          usage: 20
                          user: 16
                        cpu1:
                          idle: 93
                          interrupt: 0
                          system: 4
                          usage: 6
                          user: 1
                      idle: 87
                      interrupt: 0
                      system: 5
                      usage: 12
                      user: 7
                    ext_ip: 116.187.144.16
                    id: 387804a7-3474-85ce-15a2-f9a9684c9c90
                    ip_stat:
                      ip: 172.16.5.3
                      ips:
                        ens192: 172.16.5.3/24,fe81::20c:29ff:fef8:d18e/64
                    lag_stat:
                      lag0:
                        active_ports:
                        - '0'
                        - '1'
                    last_seen: 1547437078
                    magic: ExNpT5gi-ADR8WTFd4EiQPY3cP5WdSoD
                    memory_stats:
                      active: 1061085184
                      available: 4124860416
                      buffers: 789495808
                      cached: 718016512
                      free: 2818838528
                      inactive: 458158080
                      swap_cached: 0
                      swap_free: 8161062912
                      swap_total: 8161062912
                      total: 7947616256
                      usage: 65
                    model: ME-S2019
                    mxagent_registered: false
                    mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4
                    name: Guest
                    num_tunnels: 31
                    port_stat:
                      eth0:
                        full_duplex: true
                        lldp_stats:
                          mgmt_addr: 122.16.3.11
                          port_desc: GigabitEthernet4/0/16
                          port_id: "\x05Gi4/0/16"
                          system_desc: Cisco IOS Software
                          system_name: ME-DC2-DIS-SW
                        rx_bytes: 2056
                        rx_errors: 0
                        rx_pkts: 670
                        speed: 1000
                        tx_bytes: 2056
                        tx_pkts: 670
                        up: true
                      eth1:
                        up: false
                      module:
                        up: false
                    status: connected
                    tunterm_registered: false
                    tunterm_stat:
                      monitoring_failed: false
                    uptime: 884221
                    version: 0.1.2
                    virtualization_type: VirtualizationVMware
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs MxEdges
      summary: createOrgMxEdge
      description: Create a Mist Edge appliance configuration in the organization, including cluster assignment, management, services, and tunnel termination settings.
      operationId: createOrgMxEdge
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/mxedge'
              - description: Request Body
                examples:
                - model: ME-100
                  mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4
                  mxedge_mgmt: {}
                  name: Guest
                  ntp_servers: []
                  oob_ip_config: {}
                  services:
                  - tunterm
                  tunterm_ip_config:
                    gateway: 10.2.1.254
                    ip: 10.2.1.1
                    netmask: 255.255.255.0
                  tunterm_port_config:
                    downstream_ports:
                    - '0'
                    - '1'
                    - '2'
                    - '3'
                    separate_upstream_downstream: true
                    upstream_port_vlan_id: 1
                    upstream_ports:
                    - '0'
                    - '1'
                    - '2'
                    - '3'
                  tunterm_switch_config:
                    '0':
                      port_vlan_id: 1
                      vlan_ids:
                      - 5
                      - 2
                      - 3
                    enabled: true
              contentMediaType: application/json
            examples:
              Example:
                value:
                  model: ME-100
                  mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4
                  mxedge_mgmt: {}
                  name: Guest
                  ntp_servers: []
                  oob_ip_config: {}
                  services:
                  - tunterm
                  tunterm_ip_config:
                    gateway: 10.2.1.254
                    ip: 10.2.1.1
                    netmask: 255.255.255.0
                  tunterm_port_config:
                    downstream_ports:
                    - '0'
                    - '1'
                    - '2'
                    - '3'
                    separate_upstream_downstream: true
                    upstream_port_vlan_id: 1
                    upstream_ports:
                    - '0'
                    - '1'
                    - '2'
                    - '3'
                  tunterm_switch_config:
                    '0':
                      port_vlan_id: 1
                      vlan_ids:
                      - 5
                      - 2
                      - 3
                    enabled: true
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mxedge'
                - description: Mist Edge appliance configuration and registration state
                  examples:
                  - id: 95ddd29a-6a3c-929e-a431-51a5b09f36a6
                    magic: L-NpT5gi-ADR8WTFd4EiQPY3cP5WdSoD
                    model: ME-100
                    mxagent_registered: true
                    mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4
                    mxedge_mgmt:
                      mist_password: MIST_PASSWORD
                      root_password: ROOT_PASSWORD
                    name: Guest
                    ntp_servers: []
                    oob_ip_config:
                      dns:
                      - 8.8.8.8
                      - 4.4.4.4
                      gateway: 10.2.1.254
                      ip: 10.2.1.10
                      netmask: 255.255.255.0
                      type: static
                    tunterm_dhcpd_config:
                      '2':
                        enabled: true
                        servers:
                        - 11.2.3.44
                      enabled: false
                      servers:
                      - 11.2.3.4
                    tunterm_extra_routes:
                      11.0.0.0/8:
                        via: 10.3.3.1
                    tunterm_ip_config:
                      gateway: 10.2.1.254
                      ip: 10.2.1.1
                      netmask: 255.255.255.0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    id: 95ddd29a-6a3c-929e-a431-51a5b09f36a6
                    magic: L-NpT5gi-ADR8WTFd4EiQPY3cP5WdSoD
                    model: ME-100
                    mxagent_registered: true
                    mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4
                    mxedge_mgmt:
                      mist_password: MIST_PASSWORD
                      root_password: ROOT_PASSWORD
                    name: Guest
                    ntp_servers: []
                    oob_ip_config:
                      dns:
                      - 8.8.8.8
                      - 4.4.4.4
                      gateway: 10.2.1.254
                      ip: 10.2.1.10
                      netmask: 255.255.255.0
                      type: static
                    tunterm_dhcpd_config:
                      '2':
                        enabled: true
                        servers:
                        - 11.2.3.44
                      enabled: false
                      servers:
                      - 11.2.3.4
                    tunterm_extra_routes:
                      11.0.0.0/8:
                        via: 10.3.3.1
                    tunterm_ip_config:
                      gateway: 10.2.1.254
                      ip: 10.2.1.1
                      netmask: 255.255.255.0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mxedge'
                - description: Mist Edge appliance configuration and registration state
                  examples:
                  - id: 95ddd29a-6a3c-929e-a431-51a5b09f36a6
                    magic: L-NpT5gi-ADR8WTFd4EiQPY3cP5WdSoD
                    model: ME-100
                    mxagent_registered: true
                    mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4
                    mxedge_mgmt:
                      mist_password: MIST_PASSWORD
                      root_password: ROOT_PASSWORD
                    name: Guest
                    ntp_servers: []
                    oob_ip_config:
                      dns:
                      - 8.8.8.8
                      - 4.4.4.4
                      gateway: 10.2.1.254
                      ip: 10.2.1.10
                      netmask: 255.255.255.0
                      type: static
                    tunterm_dhcpd_config:
                      '2':
                        enabled: true
                        servers:
                        - 11.2.3.44
                      enabled: false
                      servers:
                      - 11.2.3.4
                    tunterm_extra_routes:
                      11.0.0.0/8:
                        via: 10.3.3.1
                    tunterm_ip_config:
                      gateway: 10.2.1.254
                      ip: 10.2.1.1
                      netmask: 255.255.255.0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    id: 95ddd29a-6a3c-929e-a431-51a5b09f36a6
                    magic: L-NpT5gi-ADR8WTFd4EiQPY3cP5WdSoD
                    model: ME-100
                    mxagent_registered: true
                    mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4
                    mxedge_mgmt:
                      mist_password: MIST_PASSWORD
                      root_password: ROOT_PASSWORD
                    name: Guest
                    ntp_servers: []
                    oob_ip_config:
                      dns:
                      - 8.8.8.8
                      - 4.4.4.4
                      gateway: 10.2.1.254
                      ip: 10.2.1.10
                      netmask: 255.255.255.0
                      type: static
                    tunterm_dhcpd_config:
                      '2':
                        enabled: true
                        servers:
                        - 11.2.3.44
                      enabled: false
                      servers:
                      - 11.2.3.4
                    tunterm_extra_routes:
                      11.0.0.0/8:
                        via: 10.3.3.1
                    tunterm_ip_config:
                      gateway: 10.2.1.254
                      ip: 10.2.1.1
                      netmask: 255.255.255.0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/mxedges/assign:
    post:
      tags:
      - Orgs MxEdges
      summary: assignOrgMxEdgeToSite
      description: Assign one or more Mist Edge appliances from the organization to a site by Mist Edge ID and site ID.
      operationId: assignOrgMxEdgeToSite
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/mxedges_assign'
              - description: Request Body
                examples:
                - mxedge_ids:
                  - 387804a7-3474-85ce-15a2-f9a9684c9c90
                  site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
              contentMediaType: application/json
            examples:
              Example:
                value:
                  mxedge_ids:
                  - 387804a7-3474-85ce-15a2-f9a9684c9c90
                  site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
        required: false
      responses:
        '200':
          description: OK - list only devices that has deviceprofile_id changed
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_assign_success'
                - description: Assignment operation success response
                  examples:
                  - success:
                    - 5c5b350e0001
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    success:
                    - 5c5b350e0001
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_assign_success'
                - description: Assignment operation success response
                  examples:
                  - success:
                    - 5c5b350e0001
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    success:
                    - 5c5b350e0001
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/mxedges/claim:
    post:
      tags:
      - Orgs MxEdges
      summary: claimOrgMxEdge
      description: Claim one or more Mist Edge appliances into the organization using their claim codes.
      operationId: claimOrgMxEdge
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              uniqueItems: true
              type: array
              items:
                type: string
              description: Request Body
              examples:
              - - 6JG8E-PTFV2-A9Z2N
                - DVH4V-SNMSZ-PDXBR
              contentMediaType: application/json
            examples:
              Example:
                value:
                - 6JG8E-PTFV2-A9Z2N
                - DVH4V-SNMSZ-PDXBR
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_claim_mx_edge'
                - description: Mist Edge claim response
                  examples:
                  - id: 95ddd29a-6a3c-929e-a431-51a5b09f36a6
                    magic: ExNpT5gi-ADR8WTFd4EiQPY3cP5WdSoD
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    id: 95ddd29a-6a3c-929e-a431-51a5b09f36a6
                    magic: ExNpT5gi-ADR8WTFd4EiQPY3cP5WdSoD
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_claim_mx_edge'
                - description: Mist Edge claim response
                  examples:
                  - id: 95ddd29a-6a3c-929e-a431-51a5b09f36a6
                    magic: ExNpT5gi-ADR8WTFd4EiQPY3cP5WdSoD
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    id: 95ddd29a-6a3c-929e-a431-51a5b09f36a6
                    magic: ExNpT5gi-ADR8WTFd4EiQPY3cP5WdSoD
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/mxedges/count:
    get:
      tags:
      - Orgs MxEdges
      summary: countOrgMxEdges
      description: Count organization Mist Edge records, optionally grouped by `distinct` and filtered by Mist Edge, cluster, site, model, distro, tunnel termination version, and time range.
      operationId: countOrgMxEdges
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `distro`, `model`, `mxcluster_id`, `site_id`, `tunterm_version`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/org_mxedge_count_distinct'
          - description: 'Field used to group this count response. enum: `distro`, `model`, `mxcluster_id`, `site_id`, `tunterm_version`'
      - name: mxedge_id
        in: query
        description: Filter results by Mist Edge identifier
        style: form
        explode: true
        schema:
          type: string
      - name: site_id
        in: query
        description: Mist edge site id
        style: form
        explode: true
        schema:
          type: string
      - name: mxcluster_id
        in: query
        description: Mist edge cluster id
        style: form
        explode: true
        schema:
          type: string
      - name: model
        in: query
        description: Filter results by device model
        style: form
        explode: true
        schema:
          type: string
      - name: distro
        in: query
        description: Debian code name (buster, bullseye)
        style: form
        explode: true
        schema:
          type: string
      - name: tunterm_version
        in: query
        description: Filter results by tunnel termination version
        style: form
        explode: true
        schema:
          type: string
      - name: sort
        in: query
        description: Field used to sort results
        style: form
        explode: true
        schema:
          type: string
      - name: stats
        in: query
        description: Whether to return device stats, default is false
        style: form
        explode: true
        schema:
          type: boolean
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/mxedges/events/count:
    get:
      tags:
      - Orgs MxEdges
      summary: countOrgSiteMxEdgeEvents
      description: Count Mist Edge event records across the organization, optionally grouped by `distinct` and filtered by Mist Edge, cluster, event type, service, and time range.
      operationId: countOrgSiteMxEdgeEvents
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `mxcluster_id`, `mxedge_id`, `package`, `type`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/org_mxedge_events_count_distinct'
          - description: 'Field used to group this count response. enum: `mxcluster_id`, `mxedge_id`, `package`, `type`'
      - name: mxedge_id
        in: query
        description: Filter results by Mist Edge identifier
        style: form
        explode: true
        schema:
          type: string
      - name: mxcluster_id
        in: query
        description: Mist edge cluster id
        style: form
        explode: true
        schema:
          type: string
      - name: type
        in: query
        description: See [List Device Events Definitions]($e/Constants%20Events/listDeviceEventsDefinitions)
        style: form
        explode: true
        schema:
          type: string
      - name: service
        in: query
        description: Filter results by service name
        style: form
        explode: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/mxedges/events/search:
    get:
      tags:
      - Orgs MxEdges
      summary: searchOrgMistEdgeEvents
      description: Search Mist Edge event records across the organization with filters for Mist Edge, cluster, event type, service, component, and time range.
      operationId: searchOrgMistEdgeEvents
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mxedge_id
        in: query
        description: Filter results by Mist Edge identifier
        style: form
        explode: true
        schema:
          type: string
      - name: mxcluster_id
        in: query
        description: Mist edge cluster id
        style: form
        explode: true
        schema:
          type: string
      - name: type
        in: query
        description: See [List Device Events Definitions]($e/Constants%20Events/listDeviceEventsDefinitions)
        style: form
        explode: true
        schema:
          type: string
      - name: service
        in: query
        description: Filter results by service name
        style: form
        explode: true
        schema:
          type: string
      - name: component
        in: query
        description: Filter results by component name
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_mxedge_events_search'
                - description: Search response for Mist Edge event records
                  examples:
                  - end: 1694708579
                    limit: 10
                    page: 3
                    results:
                    - mxcluster_id: 2815c917-58e7-472f-a190-bfd44fb58d05
                      mxedge_id: 00000000-0000-0000-1000-020000dc585c
                      org_id: f2695c32-0e83-4936-b1b2-96fc88051213
                      service: tunterm
                      timestamp: 1694678225.927
                      type: ME_SERVICE_STOPPED
                    start: 1694622179
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1694708579
                    limit: 10
                    page: 3
                    results:
                    - mxcluster_id: 2815c917-58e7-472f-a190-bfd44fb58d05
                      mxedge_id: 00000000-0000-0000-1000-020000dc585c
                      org_id: f2695c32-0e83-4936-b1b2-96fc88051213
                      service: tunterm
                      timestamp: 1694678225.927
                      type: ME_SERVICE_STOPPED
                    start: 1694622179
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_mxedge_events_search'
                - description: Search response for Mist Edge event records
                  examples:
                  - end: 1694708579
                    limit: 10
                    page: 3
                    results:
                    - mxcluster_id: 2815c917-58e7-472f-a190-bfd44fb58d05
                      mxedge_id: 00000000-0000-0000-1000-020000dc585c
                      org_id: f2695c32-0e83-4936-b1b2-96fc88051213
                      service: tunterm
                      timestamp: 1694678225.927
                      type: ME_SERVICE_STOPPED
                    start: 1694622179
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1694708579
                    limit: 10
                    page: 3
                    results:
                    - mxcluster_id: 2815c917-58e7-472f-a190-bfd44fb58d05
                      mxedge_id: 00000000-0000-0000-1000-020000dc585c
                      org_id: f2695c32-0e83-4936-b1b2-96fc88051213
                      service: tunterm
                      timestamp: 1694678225.927
                      type: ME_SERVICE_STOPPED
                    start: 1694622179
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/mxedges/search:
    get:
      tags:
      - Orgs MxEdges
      summary: searchOrgMxEdges
      description: Search organization Mist Edge records with filters for hostname, Mist Edge, cluster, site, model, distro, tunnel termination version, and time range.
      operationId: searchOrgMxEdges
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: hostname
        in: query
        description: Partial / full Device hostname. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `my-london*` and `*london*` match `my-london-1`). Suffix-only wildcards (e.g. `*london-1`) are not supported. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - my-london-1,my-london*
          - my-london-1
          - my-london*
          - '*london*'
        examples:
          Untitled Example1:
            value: my-london-1,my-london*
          Untitled Example2:
            value: my-london-1
          Untitled Example3:
            value: my-london*
          Untitled Example4:
            value: '*london*'
      - name: mxedge_id
        in: query
        description: Filter results by Mist Edge identifier. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002
      - name: mxcluster_id
        in: query
        description: Mist edge cluster id. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002
      - name: model
        in: query
        description: Partial / full Device model. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `AP4*` and `*P4*` match `AP43`). Suffix-only wildcards (e.g. `*43`) are not supported. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - AP43,AP4*
          - AP43
          - AP4*
          - '*P4*'
        examples:
          Untitled Example1:
            value: AP43,AP4*
          Untitled Example2:
            value: AP43
          Untitled Example3:
            value: AP4*
          Untitled Example4:
            value: '*P4*'
      - name: distro
        in: query
        description: Debian code name (buster, bullseye)
        style: form
        explode: true
        schema:
          type: string
      - name: tunterm_version
        in: query
        description: Filter results by tunnel termination version
        style: form
        explode: true
        schema:
          type: string
      - name: site_id
        in: query
        description: Mist edge site id
        style: form
        explode: true
        schema:
          type: string
      - name: stats
        in: query
        description: Whether to return device stats, default is false
        style: form
        explode: true
        schema:
          type: boolean
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_mxedge_search'
                - description: Search response for Mist Edge records
                  examples:
                  - end: 1694708579
                    limit: 10
                    results:
                    - distro: buster
                      last_seen: 1695151551.833
                      model: ME-X5
                      mxedge_id: 00000000-0000-0000-1000-d420b0f0025d
                      org_id: 35d96b1a-1a13-4ba8-90f5-1e78dd2a10c5
                      tunterm_version: 0.1.2813
                      uptime: 5662632
                    start: 1694622179
                    total: 2
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1694708579
                    limit: 10
                    results:
                    - distro: buster
                      last_seen: 1695151551.833
                      model: ME-X5
                      mxedge_id: 00000000-0000-0000-1000-d420b0f0025d
                      org_id: 35d96b1a-1a13-4ba8-90f5-1e78dd2a10c5
                      tunterm_version: 0.1.2813
                      uptime: 5662632
                    start: 1694622179
                    total: 2
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_mxedge_search'
                - description: Search response for Mist Edge records
                  examples:
                  - end: 1694708579
                    limit: 10
                    results:
                    - distro: buster
                      last_seen: 1695151551.833
                      model: ME-X5
                      mxedge_id: 00000000-0000-0000-1000-d420b0f0025d
                      org_id: 35d96b1a-1a13-4ba8-90f5-1e78dd2a10c5
                      tunterm_version: 0.1.2813
                      uptime: 5662632
                    start: 1694622179
                    total: 2
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1694708579
                    limit: 10
                    results:
                    - distro: buster
                      last_seen: 1695151551.833
                      model: ME-X5
                      mxedge_id: 00000000-0000-0000-1000-d420b0f0025d
                      org_id: 35d96b1a-1a13-4ba8-90f5-1e78dd2a10c5
                      tunterm_version: 0.1.2813
                      uptime: 5662632
                    start: 1694622179
                    total: 2
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/mxedges/unassign:
    post:
      tags:
      - Orgs MxEdges
      summary: unassignOrgMxEdgeFromSite
      description: Unassign one or more Mist Edge appliances from their current site while keeping them in the organization.
      operationId: unassignOrgMxEdgeFromSite
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/mxedges_unassign'
              - description: Request Body
                examples:
                - mxedge_ids:
                  - 387804a7-3474-85ce-15a2-f9a9684c9c90
              contentMediaType: application/json
            examples:
              Example:
                value:
                  mxedge_ids:
                  - 387804a7-3474-85ce-15a2-f9a9684c9c90
        required: false
      responses:
        '200':
          description: OK - list only devices that has deviceprofile_id changed
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_assign_success'
                - description: Assignment operation success response
                  examples:
                  - success:
                    - 5c5b350e0001
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    success:
                    - 5c5b350e0001
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_assign_success'
                - description: Assignment operation success response
                  examples:
                  - success:
                    - 5c5b350e0001
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    success:
                    - 5c5b350e0001
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/mxedges/versions:
    get:
      tags:
      - Orgs MxEdges
      summary: getOrgMxEdgeUpgradeInfo
      description: Retrieve available Mist Edge package versions by upgrade channel and distro.
      operationId: getOrgMxEdgeUpgradeInfo
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: channel
        in: query
        description: 'Upgrade channel used to filter available versions. enum: `alpha`, `beta`, `stable`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/get_org_mxedge_upgrade_info_channel'
          - description: 'Upgrade channel used to filter available versions. enum: `alpha`, `beta`, `stable`'
      - name: distro
        in: query
        description: Filter results by distro
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                uniqueItems: true
                type: array
                items:
                  $ref: '#/components/schemas/mxedge_upgrade_info_items'
                description: Available Mist Edge upgrade versions by package
                examples:
                - - default: true
                    distro: bullseye
                    package: mxagent
                    version: 2.4.100
                  - distro: bullseye
                    package: tunterm
                    version: 1.0.0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - default: true
                    distro: bullseye
                    package: mxagent
                    version: 2.4.100
                  - distro: bullseye
                    package: tunterm
                    version: 1.0.0
            application/vnd.api+json:
              schema:
                uniqueItems: true
                type: array
                items:
                  $ref: '#/components/schemas/mxedge_upgrade_info_items'
                description: Available Mist Edge upgrade versions by package
                examples:
                - - default: true
                    distro: bullseye
                    package: mxagent
                    version: 2.4.100
                  - distro: bullseye
                    package: tunterm
                    version: 1.0.0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - default: true
                    distro: bullseye
                    package: mxagent
                    version: 2.4.100
                  - distro: bullseye
                    package: tunterm
                    version: 1.0.0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/mxedges/{mxedge_id}:
    delete:
      tags:
      - Orgs MxEdges
      summary: deleteOrgMxEdge
      description: Delete a Mist Edge appliance record from the organization by Mist Edge ID.
      operationId: deleteOrgMxEdge
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mxedge_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs MxEdges
      summary: getOrgMxEdge
      description: Retrieve configuration and registration details for a specific Mist Edge appliance in the organization.
      operationId: getOrgMxEdge
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mxedge_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mxedge'
                - description: Mist Edge appliance configuration and registration state
                  examples:
                  - id: 95ddd29a-6a3c-929e-a431-51a5b09f36a6
                    magic: L-NpT5gi-ADR8WTFd4EiQPY3cP5WdSoD
                    model: ME-100
                    mxagent_registered: true
                    mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4
                    mxedge_mgmt:
                      mist_password: MIST_PASSWORD
                      root_password: ROOT_PASSWORD
                    name: Guest
                    ntp_servers: []
                    oob_ip_config:
                      dns:
                      - 8.8.8.8
                      - 4.4.4.4
                      gateway: 10.2.1.254
                      ip: 10.2.1.10
                      netmask: 255.255.255.0
                      type: static
                    tunterm_dhcpd_config:
                      '2':
                        enabled: true
                        servers:
                        - 11.2.3.44
                      enabled: false
                      servers:
                      - 11.2.3.4
                    tunterm_extra_routes:
                      11.0.0.0/8:
                        via: 10.3.3.1
                    tunterm_ip_config:
                      gateway: 10.2.1.254
                      ip: 10.2.1.1
                      netmask: 255.255.255.0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    id: 95ddd29a-6a3c-929e-a431-51a5b09f36a6
                    magic: L-NpT5gi-ADR8WTFd4EiQPY3cP5WdSoD
                    model: ME-100
                    mxagent_registered: true
                    mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4
                    mxedge_mgmt:
                      mist_password: MIST_PASSWORD
                      root_password: ROOT_PASSWORD
                    name: Guest
                    ntp_servers: []
                    oob_ip_config:
                      dns:
                      - 8.8.8.8
                      - 4.4.4.4
                      gateway: 10.2.1.254
                      ip: 10.2.1.10
                      netmask: 255.255.255.0
                      type: static
                    tunterm_dhcpd_config:
                      '2':
                        enabled: true
                        servers:
                        - 11.2.3.44
                      enabled: false
                      servers:
                      - 11.2.3.4
                    tunterm_extra_routes:
                      11.0.0.0/8:
                        via: 10.3.3.1
                    tunterm_ip_config:
                      gateway: 10.2.1.254
                      ip: 10.2.1.1
                      netmask: 255.255.255.0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mxedge'
                - description: Mist Edge appliance configuration and registration state
                  examples:
                  - id: 95ddd29a-6a3c-929e-a431-51a5b09f36a6
                    magic: L-NpT5gi-ADR8WTFd4EiQPY3cP5WdSoD
                    model: ME-100
                    mxagent_registered: true
                    mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4
                    mxedge_mgmt:
                      mist_password: MIST_PASSWORD
                      root_password: ROOT_PASSWORD
                    name: Guest
                    ntp_servers: []
                    oob_ip_config:
                      dns:
                      - 8.8.8.8
                      - 4.4.4.4
                      gateway: 10.2.1.254
                      ip: 10.2.1.10
                      netmask: 255.255.255.0
                      type: static
                    tunterm_dhcpd_config:
                      '2':
                        enabled: true
                        servers:
                        - 11.2.3.44
                      enabled: false
                      servers:
                      - 11.2.3.4
                    tunterm_extra_routes:
                      11.0.0.0/8:
                        via: 10.3.3.1
                    tunterm_ip_config:
                      gateway: 10.2.1.254
                      ip: 10.2.1.1
                      netmask: 255.255.255.0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    id: 95ddd29a-6a3c-929e-a431-51a5b09f36a6
                    magic: L-NpT5gi-ADR8WTFd4EiQPY3cP5WdSoD
                    model: ME-100
                    mxagent_registered: true
                    mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4
                    mxedge_mgmt:
                      mist_password: MIST_PASSWORD
                      root_password: ROOT_PASSWORD
                    name: Guest
                    ntp_servers: []
                    oob_ip_config:
                      dns:
                      - 8.8.8.8
                      - 4.4.4.4
                      gateway: 10.2.1.254
                      ip: 10.2.1.10
                      netmask: 255.255.255.0
                      type: static
                    tunterm_dhcpd_config:
                      '2':
                        enabled: true
                        servers:
                        - 11.2.3.44
                      enabled: false
                      servers:
                      - 11.2.3.4
                    tunterm_extra_routes:
                      11.0.0.0/8:
                        via: 10.3.3.1
                    tunterm_ip_config:
                      gateway: 10.2.1.254
                      ip: 10.2.1.1
                      netmask: 255.255.255.0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs MxEdges
      summary: updateOrgMxEdge
      description: Update a Mist Edge appliance configuration, including model, name, management IP, services, and tunnel termination settings.
      operationId: updateOrgMxEdge
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mxedge_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/mxedge'
              - description: Request Body
                examples:
                - model: ME-X1
                  name: me-gc1-01
                  oob_ip_config:
                    dns:
                    - 8.8.8.8
                    - 1.1.1.1
                    gateway: 10.3.172.9
                    ip: 10.3.172.201
                    netmask: /24
                    type: static
                  services:
                  - tunterm
                  tunterm_ip_config:
                    gateway: 10.10.172.2
                    ip: 10.10.172.201
                    netmask: /24
                  tunterm_port_config:
                    downstream_ports:
                    - '0'
                    separate_upstream_downstream: true
                    upstream_port_vlan_id: '1010'
                    upstream_ports:
                    - '1'
              contentMediaType: application/json
            examples:
              Example:
                value:
                  model: ME-X1
                  name: me-gc1-01
                  oob_ip_config:
                    dns:
                    - 8.8.8.8
                    - 1.1.1.1
                    gateway: 10.3.172.9
                    ip: 10.3.172.201
                    netmask: /24
                    type: static
                  services:
                  - tunterm
                  tunterm_ip_config:
                    gateway: 10.10.172.2
                    ip: 10.10.172.201
                    netmask: /24
                  tunterm_port_config:
                    downstream_ports:
                    - '0'
                    separate_upstream_downstream: true
                    upstream_port_vlan_id: '1010'
                    upstream_ports:
                    - '1'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mxedge'
                - description: Mist Edge appliance configuration and registration state
                  examples:
                  - id: 95ddd29a-6a3c-929e-a431-51a5b09f36a6
                    magic: L-NpT5gi-ADR8WTFd4EiQPY3cP5WdSoD
                    model: ME-100
                    mxagent_registered: true
                    mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4
                    mxedge_mgmt:
                      mist_password: MIST_PASSWORD
                      root_password: ROOT_PASSWORD
                    name: Guest
                    ntp_servers: []
                    oob_ip_config:
                      dns:
                      - 8.8.8.8
                      - 4.4.4.4
                      gateway: 10.2.1.254
                      ip: 10.2.1.10
                      netmask: 255.255.255.0
                      type: static
                    tunterm_dhcpd_config:
                      '2':
                        enabled: true
                        servers:
                        - 11.2.3.44
                      enabled: false
                      servers:
                      - 11.2.3.4
                    tunterm_extra_routes:
                      11.0.0.0/8:
                        via: 10.3.3.1
                    tunterm_ip_config:
                      gateway: 10.2.1.254
                      ip: 10.2.1.1
                      netmask: 255.255.255.0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    id: 95ddd29a-6a3c-929e-a431-51a5b09f36a6
                    magic: L-NpT5gi-ADR8WTFd4EiQPY3cP5WdSoD
                    model: ME-100
                    mxagent_registered: true
                    mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4
                    mxedge_mgmt:
                      mist_password: MIST_PASSWORD
                      root_password: ROOT_PASSWORD
                    name: Guest
                    ntp_servers: []
                    oob_ip_config:
                      dns:
                      - 8.8.8.8
                      - 4.4.4.4
                      gateway: 10.2.1.254
                      ip: 10.2.1.10
                      netmask: 255.255.255.0
                      type: static
                    tunterm_dhcpd_config:
                      '2':
                        enabled: true
                        servers:
                        - 11.2.3.44
                      enabled: false
                      servers:
                      - 11.2.3.4
                    tunterm_extra_routes:
                      11.0.0.0/8:
                        via: 10.3.3.1
                    tunterm_ip_config:
                      gateway: 10.2.1.254
                      ip: 10.2.1.1
                      netmask: 255.255.255.0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mxedge'
                - description: Mist Edge appliance configuration and registration state
                  examples:
                  - id: 95ddd29a-6a3c-929e-a431-51a5b09f36a6
                    magic: L-NpT5gi-ADR8WTFd4EiQPY3cP5WdSoD
                    model: ME-100
                    mxagent_registered: true
                    mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4
                    mxedge_mgmt:
                      mist_password: MIST_PASSWORD
                      root_password: ROOT_PASSWORD
                    name: Guest
                    ntp_servers: []
                    oob_ip_config:
                      dns:
                      - 8.8.8.8
                      - 4.4.4.4
                      gateway: 10.2.1.254
                      ip: 10.2.1.10
                      netmask: 255.255.255.0
                      type: static
                    tunterm_dhcpd_config:
                      '2':
                        enabled: true
                        servers:
                        - 11.2.3.44
                      enabled: false
                      servers:
                      - 11.2.3.4
                    tunterm_extra_routes:
                      11.0.0.0/8:
                        via: 10.3.3.1
                    tunterm_ip_config:
                      gateway: 10.2.1.254
                      ip: 10.2.1.1
                      netmask: 255.255.255.0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    id: 95ddd29a-6a3c-929e-a431-51a5b09f36a6
                    magic: L-NpT5gi-ADR8WTFd4EiQPY3cP5WdSoD
                    model: ME-100
                    mxagent_registered: true
                    mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4
                    mxedge_mgmt:
                      mist_password: MIST_PASSWORD
                      root_password: ROOT_PASSWORD
                    name: Guest
                    ntp_servers: []
                    oob_ip_config:
                      dns:
                      - 8.8.8.8
                      - 4.4.4.4
                      gateway: 10.2.1.254
                      ip: 10.2.1.10
                      netmask: 255.255.255.0
                      type: static
                    tunterm_dhcpd_config:
                      '2':
                        enabled: true
                        servers:
                        - 11.2.3.44
                      enabled: false
                      servers:
                      - 11.2.3.4
                    tunterm_extra_routes:
                      11.0.0.0/8:
                        via: 10.3.3.1
                    tunterm_ip_config:
                      gateway: 10.2.1.254
                      ip: 10.2.1.1
                      netmask: 255.255.255.0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/mxedges/{mxedge_id}/image/{image_number}:
    delete:
      tags:
      - Orgs MxEdges
      summary: deleteOrgMxEdgeImage
      description: Delete a numbered image attachment from a Mist Edge appliance.
      operationId: deleteOrgMxEdgeImage
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mxedge_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: image_number
        in: path
        description: ''
        required: true
        schema:
          maximum: 3
          minimum: 1
          type: integer
          contentEncoding: int32
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs MxEdges
      summary: addOrgMxEdgeImage
      description: Upload and attach an image file to a Mist Edge appliance. A Mist Edge can have up to three image attachments.
      operationId: addOrgMxEdgeImage
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mxedge_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: image_number
        in: path
        description: ''
        required: true
        schema:
          maximum: 3
          minimum: 1
          type: integer
          contentEncoding: int32
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              required:
              - file
              type: object
              properties:
                file:
                  type: string
                  description: Image file content uploaded as multipart form data
                  contentEncoding: base64
                json:
                  type: string
                  description: Optional JSON metadata submitted with the image upload
              contentMediaType: multipart/form-data
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/mxedges/{mxedge_id}/restart:
    post:
      tags:
      - Orgs MxEdges
      summary: restartOrgMxEdge
      description: Restart the registration workflow for a Mist Edge replacement by disconnecting the currently registered appliance so another Mist Edge can register.
      operationId: restartOrgMxEdge
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mxedge_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/mxedges/{mxedge_id}/services/tunterm/bounce_port:
    post:
      tags:
      - Orgs MxEdges
      summary: bounceOrgMxEdgeDataPorts
      description: Bounce one or more TunTerm data ports on a Mist Edge, optionally setting the hold time between port bounces.
      operationId: bounceOrgMxEdgeDataPorts
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mxedge_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/utils_tunterm_bounce_port'
              - examples:
                - '{"ports":["0","2"]}'
                - '{"hold_time":0,"ports":["string"]}'
              contentMediaType: application/json
            examples:
              Example:
                value:
                  ports:
                  - '0'
                  - '2'
              Example2:
                value:
                  hold_time: 0
                  ports:
                  - string
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/mxedges/{mxedge_id}/services/tunterm/disconnect_aps:
    post:
      tags:
      - Orgs MxEdges
      summary: disconnectOrgMxEdgeTuntermAps
      description: Disconnect specific APs from the Mist Edge TunTerm service by AP MAC address.
      operationId: disconnectOrgMxEdgeTuntermAps
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mxedge_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/mac_addresses'
              - examples:
                - macs:
                  - 5c5b353e4eb1
                  - 5c5b353e4eb2
              contentMediaType: application/json
            examples:
              Example:
                value:
                  macs:
                  - 5c5b353e4eb1
                  - 5c5b353e4eb2
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/mxedges/{mxedge_id}/services/{name}/{action}:
    post:
      tags:
      - Orgs MxEdges
      summary: controlOrgMxEdgeServices
      description: Start, stop, or restart a named Mist Edge service such as `tunterm`, `mxagent`, or `radsecproxy`.
      operationId: controlOrgMxEdgeServices
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mxedge_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: name
        in: path
        description: 'enum: `mxagent`, `mxdas`, `mxnacedge`, `mxocproxy`, `radsecproxy`, `tunterm`'
        required: true
        schema:
          allOf:
          - $ref: '#/components/schemas/mxedge_service_name'
          - description: 'enum: `mxagent`, `mxdas`, `mxnacedge`, `mxocproxy`, `radsecproxy`, `tunterm`'
      - name: action
        in: path
        description: Restart or start or stop
        required: true
        schema:
          allOf:
          - $ref: '#/components/schemas/mxedge_service_action'
          - description: Restart or start or stop
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/mxedges/{mxedge_id}/support:
    post:
      tags:
      - Orgs MxEdges
      summary: uploadOrgMxEdgeSupportFiles
      description: Trigger upload of support files from a Mist Edge for troubleshooting.
      operationId: uploadOrgMxEdgeSupportFiles
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mxedge_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/mxedges/{mxedge_id}/unregister:
    post:
      tags:
      - Orgs MxEdges
      summary: unregisterOrgMxEdge
      description: Unregister a Mist Edge during a replacement workflow by disconnecting the currently registered appliance so another Mist Edge can register.
      operationId: unregisterOrgMxEdge
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mxedge_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/mxedges/{mxedge_id}/vm_params:
    get:
      tags:
      - Orgs MxEdges
      summary: getOrgMxEdgeVmParams
      description: Retrieve VM deployment parameters for a Mist Edge, including model, optional name, and base64 user data.
      operationId: getOrgMxEdgeVmParams
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mxedge_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Mist Edge VM Parameters
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mxedge_vm_params'
                - description: Mist Edge VM parameters
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mxedge_vm_params'
                - description: Mist Edge VM parameters
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/mxtunnels:
    get:
      tags:
      - Orgs MxTunnels
      summary: listOrgMxTunnels
      description: List organization Mist Tunnel configurations used to carry AP user VLANs to Mist Edge clusters.
      operationId: listOrgMxTunnels
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/mxtunnel'
                description: List of Mist Tunnel configurations
                examples:
                - - hello_interval: 60
                    hello_retries: 3
                    ipsec:
                      dns_servers:
                      - 172.16.0.8
                      enabled: true
                      extra_routes:
                      - dest: 172.16.0.0/12
                        next_hop: 172.16.0.1
                      split_tunnel: true
                    mxcluster_ids:
                    - 572586b7-f97b-a22b-526c-8b97a3f609c4
                    name: HQ
                    protocol: udp
                    vlan_ids:
                    - 3
                    - 4
                    - 5
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - hello_interval: 60
                    hello_retries: 3
                    ipsec:
                      dns_servers:
                      - 172.16.0.8
                      enabled: true
                      extra_routes:
                      - dest: 172.16.0.0/12
                        next_hop: 172.16.0.1
                      split_tunnel: true
                    mxcluster_ids:
                    - 572586b7-f97b-a22b-526c-8b97a3f609c4
                    name: HQ
                    protocol: udp
                    vlan_ids:
                    - 3
                    - 4
                    - 5
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/mxtunnel'
                description: List of Mist Tunnel configurations
                examples:
                - - hello_interval: 60
                    hello_retries: 3
                    ipsec:
                      dns_servers:
                      - 172.16.0.8
                      enabled: true
                      extra_routes:
                      - dest: 172.16.0.0/12
                        next_hop: 172.16.0.1
                      split_tunnel: true
                    mxcluster_ids:
                    - 572586b7-f97b-a22b-526c-8b97a3f609c4
                    name: HQ
                    protocol: udp
                    vlan_ids:
                    - 3
                    - 4
                    - 5
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - hello_interval: 60
                    hello_retries: 3
                    ipsec:
                      dns_servers:
                      - 172.16.0.8
                      enabled: true
                      extra_routes:
                      - dest: 172.16.0.0/12
                        next_hop: 172.16.0.1
                      split_tunnel: true
                    mxcluster_ids:
                    - 572586b7-f97b-a22b-526c-8b97a3f609c4
                    name: HQ
                    protocol: udp
                    vlan_ids:
                    - 3
                    - 4
                    - 5
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs MxTunnels
      summary: createOrgMxTunnel
      description: Create an organization Mist Tunnel configuration, including hosting Mist Edge clusters, VLANs, heartbeat settings, and optional IPsec settings.
      operationId: createOrgMxTunnel
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/mxtunnel'
              - description: Request Body
                examples:
                - cluster_ids:
                  - string
                  hello_interval: 60
                  hello_retries: 7
                  ipsec:
                    dns_servers:
                    - string
                    enabled: true
                    extra_routes:
                    - dest: string
                      next_hop: 192.168.0.1
                    split_tunnel: true
                    use_mxedge: true
                  vlan_ids:
                  - 0
              contentMediaType: application/json
            examples:
              Example:
                value:
                  cluster_ids:
                  - string
                  hello_interval: 60
                  hello_retries: 7
                  ipsec:
                    dns_servers:
                    - string
                    enabled: true
                    extra_routes:
                    - dest: string
                      next_hop: 192.168.0.1
                    split_tunnel: true
                    use_mxedge: true
                  vlan_ids:
                  - 0
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mxtunnel'
                - description: Mist Tunnel configuration for tunneling AP user VLANs to Mist Edge clusters
                  examples:
                  - cluster_ids:
                    - string
                    created_time: 0
                    for_site: true
                    hello_interval: 60
                    hello_retries: 7
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      dns_servers:
                      - string
                      enabled: true
                      extra_routes:
                      - dest: string
                        next_hop: 192.168.0.1
                      split_tunnel: true
                      use_mxedge: true
                    modified_time: 0
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    vlan_ids:
                    - 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    cluster_ids:
                    - string
                    created_time: 0
                    for_site: true
                    hello_interval: 60
                    hello_retries: 7
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      dns_servers:
                      - string
                      enabled: true
                      extra_routes:
                      - dest: string
                        next_hop: 192.168.0.1
                      split_tunnel: true
                      use_mxedge: true
                    modified_time: 0
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    vlan_ids:
                    - 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mxtunnel'
                - description: Mist Tunnel configuration for tunneling AP user VLANs to Mist Edge clusters
                  examples:
                  - cluster_ids:
                    - string
                    created_time: 0
                    for_site: true
                    hello_interval: 60
                    hello_retries: 7
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      dns_servers:
                      - string
                      enabled: true
                      extra_routes:
                      - dest: string
                        next_hop: 192.168.0.1
                      split_tunnel: true
                      use_mxedge: true
                    modified_time: 0
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    vlan_ids:
                    - 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    cluster_ids:
                    - string
                    created_time: 0
                    for_site: true
                    hello_interval: 60
                    hello_retries: 7
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      dns_servers:
                      - string
                      enabled: true
                      extra_routes:
                      - dest: string
                        next_hop: 192.168.0.1
                      split_tunnel: true
                      use_mxedge: true
                    modified_time: 0
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    vlan_ids:
                    - 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/mxtunnels/{mxtunnel_id}:
    delete:
      tags:
      - Orgs MxTunnels
      summary: deleteOrgMxTunnel
      description: Delete an organization Mist Tunnel configuration by Mist Tunnel ID.
      operationId: deleteOrgMxTunnel
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mxtunnel_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs MxTunnels
      summary: getOrgMxTunnel
      description: Retrieve configuration details for a specific organization Mist Tunnel, including cluster, VLAN, heartbeat, IPsec, and preemption settings.
      operationId: getOrgMxTunnel
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mxtunnel_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mxtunnel'
                - description: Mist Tunnel configuration for tunneling AP user VLANs to Mist Edge clusters
                  examples:
                  - cluster_ids:
                    - string
                    created_time: 0
                    for_site: true
                    hello_interval: 60
                    hello_retries: 7
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      dns_servers:
                      - string
                      enabled: true
                      extra_routes:
                      - dest: string
                        next_hop: 192.168.0.1
                      split_tunnel: true
                      use_mxedge: true
                    modified_time: 0
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    vlan_ids:
                    - 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    cluster_ids:
                    - string
                    created_time: 0
                    for_site: true
                    hello_interval: 60
                    hello_retries: 7
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      dns_servers:
                      - string
                      enabled: true
                      extra_routes:
                      - dest: string
                        next_hop: 192.168.0.1
                      split_tunnel: true
                      use_mxedge: true
                    modified_time: 0
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    vlan_ids:
                    - 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mxtunnel'
                - description: Mist Tunnel configuration for tunneling AP user VLANs to Mist Edge clusters
                  examples:
                  - cluster_ids:
                    - string
                    created_time: 0
                    for_site: true
                    hello_interval: 60
                    hello_retries: 7
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      dns_servers:
                      - string
                      enabled: true
                      extra_routes:
                      - dest: string
                        next_hop: 192.168.0.1
                      split_tunnel: true
                      use_mxedge: true
                    modified_time: 0
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    vlan_ids:
                    - 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    cluster_ids:
                    - string
                    created_time: 0
                    for_site: true
                    hello_interval: 60
                    hello_retries: 7
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      dns_servers:
                      - string
                      enabled: true
                      extra_routes:
                      - dest: string
                        next_hop: 192.168.0.1
                      split_tunnel: true
                      use_mxedge: true
                    modified_time: 0
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    vlan_ids:
                    - 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs MxTunnels
      summary: updateOrgMxTunnel
      description: Update an organization Mist Tunnel configuration, including cluster membership, VLANs, heartbeat settings, IPsec, and preemption behavior.
      operationId: updateOrgMxTunnel
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mxtunnel_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/mxtunnel'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mxtunnel'
                - description: Mist Tunnel configuration for tunneling AP user VLANs to Mist Edge clusters
                  examples:
                  - cluster_ids:
                    - string
                    created_time: 0
                    for_site: true
                    hello_interval: 60
                    hello_retries: 7
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      dns_servers:
                      - string
                      enabled: true
                      extra_routes:
                      - dest: string
                        next_hop: 192.168.0.1
                      split_tunnel: true
                      use_mxedge: true
                    modified_time: 0
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    vlan_ids:
                    - 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    cluster_ids:
                    - string
                    created_time: 0
                    for_site: true
                    hello_interval: 60
                    hello_retries: 7
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      dns_servers:
                      - string
                      enabled: true
                      extra_routes:
                      - dest: string
                        next_hop: 192.168.0.1
                      split_tunnel: true
                      use_mxedge: true
                    modified_time: 0
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    vlan_ids:
                    - 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mxtunnel'
                - description: Mist Tunnel configuration for tunneling AP user VLANs to Mist Edge clusters
                  examples:
                  - cluster_ids:
                    - string
                    created_time: 0
                    for_site: true
                    hello_interval: 60
                    hello_retries: 7
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      dns_servers:
                      - string
                      enabled: true
                      extra_routes:
                      - dest: string
                        next_hop: 192.168.0.1
                      split_tunnel: true
                      use_mxedge: true
                    modified_time: 0
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    vlan_ids:
                    - 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    cluster_ids:
                    - string
                    created_time: 0
                    for_site: true
                    hello_interval: 60
                    hello_retries: 7
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      dns_servers:
                      - string
                      enabled: true
                      extra_routes:
                      - dest: string
                        next_hop: 192.168.0.1
                      split_tunnel: true
                      use_mxedge: true
                    modified_time: 0
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    vlan_ids:
                    - 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/mist_nac/test_idp:
    post:
      tags:
      - Orgs NAC IDP
      summary: validateOrgIdpCredential
      description: "IDP Credential Validation. The output will be available through websocket. As there can be multiple commands issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n``` json\n{\n    \"subscribe\": \"orgs/{org_id}/mist_nac/test_idp\"\n}\n\n ```\n\n### Response (no idp can be found)\n\n``` json\n{\n    \"event\": \"data\",\n    \"channel\": \"/orgs/{org_id}/mist_nac/test_idp\",\n    \"status\": \n    \"data\": {\n        \"status\": \"failure\",\n        \"error\": \"No matching IDP found\"\n    }\n}\n\n ```\n\n### Response OK\n\n``` json\n{\n    \"event\": \"data\",\n    \"channel\": \"/orgs/{org_id}/mist_nac/test_idp\",\n    \"status\": \n    \"data\": {\n        \"status\": \"success\",\n        \"idp_id\": \"915793c0-1355-4e98-b1c0-23df2227b357\",\n        \"idp_type\": \"ldap\",\n        // more attributes will be added later\n    }\n}\n\n ```\n\n### Response Invalid Credentials\n\n``` json\n{\n    \"event\": \"data\",\n    \"channel\": \"/orgs/{org_id}/mist_nac/test_idp\",\n    \"status\": \n    \"data\": {\n        \"status\": \"failure\",\n        \"error\": \"Invalid Credentials\",\n        \"idp_id\": \"915793c0-1355-4e98-b1c0-23df2227b357\",\n        \"idp_type\": \"ldap\",\n    }\n}\n\n ```"
      operationId: validateOrgIdpCredential
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/username_password'
              - examples:
                - password: xxxxxx
                  username: suriyas@juniper.net
              contentMediaType: application/json
            examples:
              Example:
                value:
                  password: xxxxxx
                  username: suriyas@juniper.net
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/insights/fingerprints/count:
    get:
      tags:
      - Sites NAC Fingerprints
      summary: countSiteClientFingerprints
      description: Count Client Fingerprints
      operationId: countSiteClientFingerprints
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `family`, `model`, `os`, `os_type`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/fingerprints_count_distinct'
          - description: 'Field used to group this count response. enum: `family`, `model`, `os`, `os_type`'
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/insights/fingerprints/search:
    get:
      tags:
      - Sites NAC Fingerprints
      summary: searchSiteClientFingerprints
      description: Search Client Fingerprints
      operationId: searchSiteClientFingerprints
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: family
        in: query
        description: Device Category of the client device
        style: form
        explode: true
        schema:
          type: string
          examples:
          - EX Series Switch
      - name: client_type
        in: query
        description: 'Filter results by client type. enum: `wireless`, `wired`, `vty`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/nac_access_type'
          - description: 'Filter results by client type. enum: `wireless`, `wired`, `vty`'
            examples:
            - wired
      - name: model
        in: query
        description: Filter results by device model
        style: form
        explode: true
        schema:
          type: string
          examples:
          - ex4100-f-12p
      - name: mfg
        in: query
        description: Manufacturer name of the client device
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Juniper Networks, Inc.
      - name: os
        in: query
        description: Operating System name and version of the client device
        style: form
        explode: true
        schema:
          type: string
          examples:
          - JUNOS 22.3R1.12
      - name: os_type
        in: query
        description: Operating system name of the client device
        style: form
        explode: true
        schema:
          type: string
          examples:
          - JUNOS
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - d420b080516d
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: interval
        in: query
        description: Aggregation works by giving a time range plus interval (e.g. 1d, 1h, 10m) where aggregation function would be applied to.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order.
        style: form
        explode: true
        schema:
          type: string
          default: wxid
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/fingerprint_search_result'
                - description: Search response for client device fingerprint records
                  examples:
                  - end: 1735678700
                    limit: 10
                    results:
                    - family: Apple
                      mac: d420b080516e
                      mfg: Apple, Inc.
                      model: Unknown
                      org_id: bb2fb165-0931-49c7-a1b8-9b5814326b7d
                      os: iOS 18.1.1
                      os_type: iOS
                      random_mac: true
                      site_id: 441a1214-6928-442a-8e92-e1d34b8ec6a6
                      timestamp: 1735678662.58
                    - family: EX Series Switch
                      mac: d420b080516d
                      mfg: Juniper Networks, Inc.
                      model: ex4100-f-12p
                      org_id: b6bc08f3-60a3-402b-8f0d-caf9132a1e9a
                      os: JUNOS 22.3R1.12
                      os_type: JUNOS
                      random_mac: false
                      site_id: 441a1214-6928-442a-8e92-e1d34b8ec6a6
                      timestamp: 1735669092.932
                    start: 1735678650
                    total: 2
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1735678700
                    limit: 10
                    results:
                    - family: Apple
                      mac: d420b080516e
                      mfg: Apple, Inc.
                      model: Unknown
                      org_id: bb2fb165-0931-49c7-a1b8-9b5814326b7d
                      os: iOS 18.1.1
                      os_type: iOS
                      random_mac: true
                      site_id: 441a1214-6928-442a-8e92-e1d34b8ec6a6
                      timestamp: 1735678662.58
                    - family: EX Series Switch
                      mac: d420b080516d
                      mfg: Juniper Networks, Inc.
                      model: ex4100-f-12p
                      org_id: b6bc08f3-60a3-402b-8f0d-caf9132a1e9a
                      os: JUNOS 22.3R1.12
                      os_type: JUNOS
                      random_mac: false
                      site_id: 441a1214-6928-442a-8e92-e1d34b8ec6a6
                      timestamp: 1735669092.932
                    start: 1735678650
                    total: 2
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/fingerprint_search_result'
                - description: Search response for client device fingerprint records
                  examples:
                  - end: 1735678700
                    limit: 10
                    results:
                    - family: Apple
                      mac: d420b080516e
                      mfg: Apple, Inc.
                      model: Unknown
                      org_id: bb2fb165-0931-49c7-a1b8-9b5814326b7d
                      os: iOS 18.1.1
                      os_type: iOS
                      random_mac: true
                      site_id: 441a1214-6928-442a-8e92-e1d34b8ec6a6
                      timestamp: 1735678662.58
                    - family: EX Series Switch
                      mac: d420b080516d
                      mfg: Juniper Networks, Inc.
                      model: ex4100-f-12p
                      org_id: b6bc08f3-60a3-402b-8f0d-caf9132a1e9a
                      os: JUNOS 22.3R1.12
                      os_type: JUNOS
                      random_mac: false
                      site_id: 441a1214-6928-442a-8e92-e1d34b8ec6a6
                      timestamp: 1735669092.932
                    start: 1735678650
                    total: 2
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1735678700
                    limit: 10
                    results:
                    - family: Apple
                      mac: d420b080516e
                      mfg: Apple, Inc.
                      model: Unknown
                      org_id: bb2fb165-0931-49c7-a1b8-9b5814326b7d
                      os: iOS 18.1.1
                      os_type: iOS
                      random_mac: true
                      site_id: 441a1214-6928-442a-8e92-e1d34b8ec6a6
                      timestamp: 1735678662.58
                    - family: EX Series Switch
                      mac: d420b080516d
                      mfg: Juniper Networks, Inc.
                      model: ex4100-f-12p
                      org_id: b6bc08f3-60a3-402b-8f0d-caf9132a1e9a
                      os: JUNOS 22.3R1.12
                      os_type: JUNOS
                      random_mac: false
                      site_id: 441a1214-6928-442a-8e92-e1d34b8ec6a6
                      timestamp: 1735669092.932
                    start: 1735678650
                    total: 2
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/nactags:
    get:
      tags:
      - Orgs NAC Tags
      summary: listOrgNacTags
      description: List organization NAC tags, optionally filtering by tag type, name, or match attribute.
      operationId: listOrgNacTags
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: type
        in: query
        description: 'Filter results by type. enum: `egress_vlan_names`, `gbp_tag`, `match`, `radius_attrs`, `radius_group`, `radius_vendor_attrs`, `redirect_nacportal_id`, `session_timeout`, `username_attr`, `vlan`. Accepts multiple comma-separated values.'
        style: form
        explode: true
        schema:
          type: string
          examples:
          - match,vlan
      - name: name
        in: query
        description: Filter results by name. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - name-a,name-b
      - name: match
        in: query
        description: 'if `type`==`match`, Type of NAC Tag. enum: `cert_cn`, `cert_eku`, `cert_issuer`, `cert_san`, `cert_serial`, `cert_sub`, `cert_template`, `client_mac`, `edr_status`, `gbp_tag`, `hostname`, `idp_role`, `ingress_vlan`, `mdm_status`, `nas_ip`, `radius_group`, `realm`, `ssid`, `user_name`, `usermac_label`. Accepts multiple comma-separated values.'
        style: form
        explode: true
        schema:
          type: string
          examples:
          - ssid,idp_role
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/nac_tag'
                description: List of NAC tags
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/nac_tag'
                description: List of NAC tags
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs NAC Tags
      summary: createOrgNacTag
      description: Create a NAC tag used either as rule-matching criteria or as a result attribute returned when NAC allows access.
      operationId: createOrgNacTag
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/nac_tag'
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/nac_tag'
                - description: NAC tag used as a rule-matching classifier or as a result attribute for allowed users
                  examples:
                  - '{"egress_vlan_names":["1vlan-30","1vlan-20","2vlan10"],"name":"trunk_ap","type":"egress_vlan_names"}'
                  - '{"match":"cert_cn","name":"staff","type":"match","values":["john","staff*"]}'
                  - '{"match":"cert_eku","name":"EKU-Match","type":"match","values":["1.3.6.1.4.1.54321.10.1","1.3.6.1.4.1.54321.20.2"]}'
                  - '{"match":"cert_issuer","name":"issuer1","type":"match","values":["/C=CN/ST=defy/L=defy/O=defy/OU=defy/CN=defy"]}'
                  - '{"match":"cert_san","name":"san1","type":"match","values":["henry1@defy.com"]}'
                  - '{"match":"cert_serial","name":"serial1","type":"match","values":["6a524ab782fb468c00c59f51cff00268d95533b8"]}'
                  - '{"match":"cert_sub","name":"subject1","type":"match","values":["/C=CN/ST=defy/O=defy/OU=defy/CN=steve"]}'
                  - '{"match":"cert_template","name":"templ1","type":"match","values":["1.3.6.1.4.1.311.21.8.4200806.605933.871088.11229391.9863893.29.13545645.4807979","1.3.6.1.4.1.311.21.8.3285427.4093958.2707341.9961608.11572555.6.4903431.2258457"]}'
                  - '{"match":"client_mac","name":"cameras","type":"match","values":["010203040506","abcdef*"]}'
                  - '{"match":"edr_status","match_all":false,"name":"edr_health","type":"match","values":["sentinelone_healthy","sentinelone_infected","crowdstrike_low","crowdstrike_medium","crowdstrike_high","crowdstrike_critical","crowdstrike_informational","unknown"]}'
                  - '{"match":"hostname","name":"hostname1","type":"match","values":["CP*","USR*"]}'
                  - '{"name":"VIP_group","radius_group":"VIP","type":"radius_group"}'
                  - '{"match":"realm","name":"defy","type":"match","values":["defy.com"]}'
                  - '{"match":"idp_role","name":"VIP","type":"match","values":["vip"]}'
                  - '{"match":"user_name","name":"admins","type":"match","values":["bob","steve"]}'
                  - '{"name":"guest_vlan","type":"vlan","vlan":"30"}'
                  - '{"name":"custom_attrs","radius_attrs":["Idle-Timeout=600","Termination-Action=RADIUS-Request"],"type":"radius_attrs"}'
                  - '{"name":"custom_radius_vendor_attrs","radius_vendor_attrs":["PaloAlto-Admin-Role=superuser","PaloAlto-Panorama-Admin-Role=administrator"],"type":"radius_vendor_attrs"}'
                  - '{"name":"timeout","session_timeout":86400,"type":"session_timeout"}'
                  - '{"allow_usermac_override":true,"name":"username_attr","type":"username_attr","username_attr":"automatic"}'
                contentMediaType: application/json
              examples:
                Egress Vlan Names:
                  value:
                    egress_vlan_names:
                    - 1vlan-30
                    - 1vlan-20
                    - 2vlan10
                    name: trunk_ap
                    type: egress_vlan_names
                Matches Cert CN:
                  value:
                    match: cert_cn
                    name: staff
                    type: match
                    values:
                    - john
                    - staff*
                Matches Cert EKU:
                  value:
                    match: cert_eku
                    name: EKU-Match
                    type: match
                    values:
                    - 1.3.6.1.4.1.54321.10.1
                    - 1.3.6.1.4.1.54321.20.2
                Matches Cert Issuer:
                  value:
                    match: cert_issuer
                    name: issuer1
                    type: match
                    values:
                    - /C=CN/ST=defy/L=defy/O=defy/OU=defy/CN=defy
                Matches Cert SAN:
                  value:
                    match: cert_san
                    name: san1
                    type: match
                    values:
                    - henry1@defy.com
                Matches Cert Serial:
                  value:
                    match: cert_serial
                    name: serial1
                    type: match
                    values:
                    - 6a524ab782fb468c00c59f51cff00268d95533b8
                Matches Cert Sub:
                  value:
                    match: cert_sub
                    name: subject1
                    type: match
                    values:
                    - /C=CN/ST=defy/O=defy/OU=defy/CN=steve
                Matches Cert Template:
                  value:
                    match: cert_template
                    name: templ1
                    type: match
                    values:
                    - 1.3.6.1.4.1.311.21.8.4200806.605933.871088.11229391.9863893.29.13545645.4807979
                    - 1.3.6.1.4.1.311.21.8.3285427.4093958.2707341.9961608.11572555.6.4903431.2258457
                Matches Client Mac:
                  value:
                    match: client_mac
                    name: cameras
                    type: match
                    values:
                    - '010203040506'
                    - abcdef*
                Matches EDR Status:
                  value:
                    match: edr_status
                    match_all: false
                    name: edr_health
                    type: match
                    values:
                    - sentinelone_healthy
                    - sentinelone_infected
                    - crowdstrike_low
                    - crowdstrike_medium
                    - crowdstrike_high
                    - crowdstrike_critical
                    - crowdstrike_informational
                    - unknown
                Matches Hostname:
                  value:
                    match: hostname
                    name: hostname1
                    type: match
                    values:
                    - CP*
                    - USR*
                Matches Radius Group:
                  value:
                    name: VIP_group
                    radius_group: VIP
                    type: radius_group
                Matches Realm:
                  value:
                    match: realm
                    name: defy
                    type: match
                    values:
                    - defy.com
                Matches Role:
                  value:
                    match: idp_role
                    name: VIP
                    type: match
                    values:
                    - vip
                Matches Username:
                  value:
                    match: user_name
                    name: admins
                    type: match
                    values:
                    - bob
                    - steve
                Matches Vlan:
                  value:
                    name: guest_vlan
                    type: vlan
                    vlan: '30'
                Radius Attrs:
                  value:
                    name: custom_attrs
                    radius_attrs:
                    - Idle-Timeout=600
                    - Termination-Action=RADIUS-Request
                    type: radius_attrs
                Radius Vendor Attrs:
                  value:
                    name: custom_radius_vendor_attrs
                    radius_vendor_attrs:
                    - PaloAlto-Admin-Role=superuser
                    - PaloAlto-Panorama-Admin-Role=administrator
                    type: radius_vendor_attrs
                Session Timeout:
                  value:
                    name: timeout
                    session_timeout: 86400
                    type: session_timeout
                Username Attr:
                  value:
                    allow_usermac_override: true
                    name: username_attr
                    type: username_attr
                    username_attr: automatic
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/nac_tag'
                - description: NAC tag used as a rule-matching classifier or as a result attribute for allowed users
                  examples:
                  - '{"egress_vlan_names":["1vlan-30","1vlan-20","2vlan10"],"name":"trunk_ap","type":"egress_vlan_names"}'
                  - '{"match":"cert_cn","name":"staff","type":"match","values":["john","staff*"]}'
                  - '{"match":"cert_issuer","name":"issuer1","type":"match","values":["/C=CN/ST=defy/L=defy/O=defy/OU=defy/CN=defy"]}'
                  - '{"match":"cert_san","name":"san1","type":"match","values":["henry1@defy.com"]}'
                  - '{"match":"cert_serial","name":"serial1","type":"match","values":["6a524ab782fb468c00c59f51cff00268d95533b8"]}'
                  - '{"match":"cert_sub","name":"subject1","type":"match","values":["/C=CN/ST=defy/O=defy/OU=defy/CN=steve"]}'
                  - '{"match":"cert_template","name":"templ1","type":"match","values":["1.3.6.1.4.1.311.21.8.4200806.605933.871088.11229391.9863893.29.13545645.4807979","1.3.6.1.4.1.311.21.8.3285427.4093958.2707341.9961608.11572555.6.4903431.2258457"]}'
                  - '{"match":"client_mac","name":"cameras","type":"match","values":["010203040506","abcdef*"]}'
                  - '{"match":"hostname","name":"hostname1","type":"match","values":["CP*","USR*"]}'
                  - '{"name":"VIP_group","radius_group":"VIP","type":"radius_group"}'
                  - '{"match":"realm","name":"defy","type":"match","values":["defy.com"]}'
                  - '{"match":"idp_role","name":"VIP","type":"match","values":["vip"]}'
                  - '{"match":"user_name","name":"admins","type":"match","values":["bob","steve"]}'
                  - '{"name":"guest_vlan","type":"vlan","vlan":"30"}'
                  - '{"name":"custom_attrs","radius_attrs":["Idle-Timeout=600","Termination-Action=RADIUS-Request"],"type":"radius_attrs"}'
                  - '{"name":"custom_radius_vendor_attrs","radius_vendor_attrs":["PaloAlto-Admin-Role=superuser","PaloAlto-Panorama-Admin-Role=administrator"],"type":"radius_vendor_attrs"}'
                  - '{"name":"timeout","session_timeout":86400,"type":"session_timeout"}'
                  - '{"allow_usermac_override":true,"name":"username_attr","type":"username_attr","username_attr":"automatic"}'
                contentMediaType: application/vnd.api+json
              examples:
                Egress Vlan Names:
                  value:
                    egress_vlan_names:
                    - 1vlan-30
                    - 1vlan-20
                    - 2vlan10
                    name: trunk_ap
                    type: egress_vlan_names
                Matches Cert CN:
                  value:
                    match: cert_cn
                    name: staff
                    type: match
                    values:
                    - john
                    - staff*
                Matches Cert Issuer:
                  value:
                    match: cert_issuer
                    name: issuer1
                    type: match
                    values:
                    - /C=CN/ST=defy/L=defy/O=defy/OU=defy/CN=defy
                Matches Cert SAN:
                  value:
                    match: cert_san
                    name: san1
                    type: match
                    values:
                    - henry1@defy.com
                Matches Cert Serial:
                  value:
                    match: cert_serial
                    name: serial1
                    type: match
                    values:
                    - 6a524ab782fb468c00c59f51cff00268d95533b8
                Matches Cert Sub:
                  value:
                    match: cert_sub
                    name: subject1
                    type: match
                    values:
                    - /C=CN/ST=defy/O=defy/OU=defy/CN=steve
                Matches Cert Template:
                  value:
                    match: cert_template
                    name: templ1
                    type: match
                    values:
                    - 1.3.6.1.4.1.311.21.8.4200806.605933.871088.11229391.9863893.29.13545645.4807979
                    - 1.3.6.1.4.1.311.21.8.3285427.4093958.2707341.9961608.11572555.6.4903431.2258457
                Matches Client Mac:
                  value:
                    match: client_mac
                    name: cameras
                    type: match
                    values:
                    - '010203040506'
                    - abcdef*
                Matches Hostname:
                  value:
                    match: hostname
                    name: hostname1
                    type: match
                    values:
                    - CP*
                    - USR*
                Matches Radius Group:
                  value:
                    name: VIP_group
                    radius_group: VIP
                    type: radius_group
                Matches Realm:
                  value:
                    match: realm
                    name: defy
                    type: match
                    values:
                    - defy.com
                Matches Role:
                  value:
                    match: idp_role
                    name: VIP
                    type: match
                    values:
                    - vip
                Matches Username:
                  value:
                    match: user_name
                    name: admins
                    type: match
                    values:
                    - bob
                    - steve
                Matches Vlan:
                  value:
                    name: guest_vlan
                    type: vlan
                    vlan: '30'
                Radius Attrs:
                  value:
                    name: custom_attrs
                    radius_attrs:
                    - Idle-Timeout=600
                    - Termination-Action=RADIUS-Request
                    type: radius_attrs
                Radius Vendor Attrs:
                  value:
                    name: custom_radius_vendor_attrs
                    radius_vendor_attrs:
                    - PaloAlto-Admin-Role=superuser
                    - PaloAlto-Panorama-Admin-Role=administrator
                    type: radius_vendor_attrs
                Session Timeout:
                  value:
                    name: timeout
                    session_timeout: 86400
                    type: session_timeout
                Username Attr:
                  value:
                    allow_usermac_override: true
                    name: username_attr
                    type: username_attr
                    username_attr: automatic
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/nactags/{nactag_id}:
    delete:
      tags:
      - Orgs NAC Tags
      summary: deleteOrgNacTag
      description: Delete an organization NAC tag by tag ID so it can no longer be used by NAC rules.
      operationId: deleteOrgNacTag
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: nactag_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs NAC Tags
      summary: getOrgNacTag
      description: Retrieve configuration details for a specific NAC tag, including type, match values, RADIUS attributes, VLAN or session results, and portal redirection settings.
      operationId: getOrgNacTag
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: nactag_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/nac_tag'
                - description: NAC tag used as a rule-matching classifier or as a result attribute for allowed users
                  examples:
                  - '{"egress_vlan_names":["1vlan-30","1vlan-20","2vlan10"],"name":"trunk_ap","type":"egress_vlan_names"}'
                  - '{"match":"cert_cn","name":"staff","type":"match","values":["john","staff*"]}'
                  - '{"match":"cert_eku","name":"EKU-Match","type":"match","values":["1.3.6.1.4.1.54321.10.1","1.3.6.1.4.1.54321.20.2"]}'
                  - '{"match":"cert_issuer","name":"issuer1","type":"match","values":["/C=CN/ST=defy/L=defy/O=defy/OU=defy/CN=defy"]}'
                  - '{"match":"cert_san","name":"san1","type":"match","values":["henry1@defy.com"]}'
                  - '{"match":"cert_serial","name":"serial1","type":"match","values":["6a524ab782fb468c00c59f51cff00268d95533b8"]}'
                  - '{"match":"cert_sub","name":"subject1","type":"match","values":["/C=CN/ST=defy/O=defy/OU=defy/CN=steve"]}'
                  - '{"match":"cert_template","name":"templ1","type":"match","values":["1.3.6.1.4.1.311.21.8.4200806.605933.871088.11229391.9863893.29.13545645.4807979","1.3.6.1.4.1.311.21.8.3285427.4093958.2707341.9961608.11572555.6.4903431.2258457"]}'
                  - '{"match":"client_mac","name":"cameras","type":"match","values":["010203040506","abcdef*"]}'
                  - '{"match":"edr_status","match_all":false,"name":"edr_health","type":"match","values":["sentinelone_healthy","sentinelone_infected","crowdstrike_low","crowdstrike_medium","crowdstrike_high","crowdstrike_critical","crowdstrike_informational","unknown"]}'
                  - '{"match":"hostname","name":"hostname1","type":"match","values":["CP*","USR*"]}'
                  - '{"name":"VIP_group","radius_group":"VIP","type":"radius_group"}'
                  - '{"match":"realm","name":"defy","type":"match","values":["defy.com"]}'
                  - '{"match":"idp_role","name":"VIP","type":"match","values":["vip"]}'
                  - '{"match":"user_name","name":"admins","type":"match","values":["bob","steve"]}'
                  - '{"name":"guest_vlan","type":"vlan","vlan":"30"}'
                  - '{"name":"custom_attrs","radius_attrs":["Idle-Timeout=600","Termination-Action=RADIUS-Request"],"type":"radius_attrs"}'
                  - '{"name":"custom_radius_vendor_attrs","radius_vendor_attrs":["PaloAlto-Admin-Role=superuser","PaloAlto-Panorama-Admin-Role=administrator"],"type":"radius_vendor_attrs"}'
                  - '{"name":"timeout","session_timeout":86400,"type":"session_timeout"}'
                  - '{"allow_usermac_override":true,"name":"username_attr","type":"username_attr","username_attr":"automatic"}'
                contentMediaType: application/json
              examples:
                Egress Vlan Names:
                  value:
                    egress_vlan_names:
                    - 1vlan-30
                    - 1vlan-20
                    - 2vlan10
                    name: trunk_ap
                    type: egress_vlan_names
                Matches Cert CN:
                  value:
                    match: cert_cn
                    name: staff
                    type: match
                    values:
                    - john
                    - staff*
                Matches Cert EKU:
                  value:
                    match: cert_eku
                    name: EKU-Match
                    type: match
                    values:
                    - 1.3.6.1.4.1.54321.10.1
                    - 1.3.6.1.4.1.54321.20.2
                Matches Cert Issuer:
                  value:
                    match: cert_issuer
                    name: issuer1
                    type: match
                    values:
                    - /C=CN/ST=defy/L=defy/O=defy/OU=defy/CN=defy
                Matches Cert SAN:
                  value:
                    match: cert_san
                    name: san1
                    type: match
                    values:
                    - henry1@defy.com
                Matches Cert Serial:
                  value:
                    match: cert_serial
                    name: serial1
                    type: match
                    values:
                    - 6a524ab782fb468c00c59f51cff00268d95533b8
                Matches Cert Sub:
                  value:
                    match: cert_sub
                    name: subject1
                    type: match
                    values:
                    - /C=CN/ST=defy/O=defy/OU=defy/CN=steve
                Matches Cert Template:
                  value:
                    match: cert_template
                    name: templ1
                    type: match
                    values:
                    - 1.3.6.1.4.1.311.21.8.4200806.605933.871088.11229391.9863893.29.13545645.4807979
                    - 1.3.6.1.4.1.311.21.8.3285427.4093958.2707341.9961608.11572555.6.4903431.2258457
                Matches Client Mac:
                  value:
                    match: client_mac
                    name: cameras
                    type: match
                    values:
                    - '010203040506'
                    - abcdef*
                Matches EDR Status:
                  value:
                    match: edr_status
                    match_all: false
                    name: edr_health
                    type: match
                    values:
                    - sentinelone_healthy
                    - sentinelone_infected
                    - crowdstrike_low
                    - crowdstrike_medium
                    - crowdstrike_high
                    - crowdstrike_critical
                    - crowdstrike_informational
                    - unknown
                Matches Hostname:
                  value:
                    match: hostname
                    name: hostname1
                    type: match
                    values:
                    - CP*
                    - USR*
                Matches Radius Group:
                  value:
                    name: VIP_group
                    radius_group: VIP
                    type: radius_group
                Matches Realm:
                  value:
                    match: realm
                    name: defy
                    type: match
                    values:
                    - defy.com
                Matches Role:
                  value:
                    match: idp_role
                    name: VIP
                    type: match
                    values:
                    - vip
                Matches Username:
                  value:
                    match: user_name
                    name: admins
                    type: match
                    values:
                    - bob
                    - steve
                Matches Vlan:
                  value:
                    name: guest_vlan
                    type: vlan
                    vlan: '30'
                Radius Attrs:
                  value:
                    name: custom_attrs
                    radius_attrs:
                    - Idle-Timeout=600
                    - Termination-Action=RADIUS-Request
                    type: radius_attrs
                Radius Vendor Attrs:
                  value:
                    name: custom_radius_vendor_attrs
                    radius_vendor_attrs:
                    - PaloAlto-Admin-Role=superuser
                    - PaloAlto-Panorama-Admin-Role=administrator
                    type: radius_vendor_attrs
                Session Timeout:
                  value:
                    name: timeout
                    session_timeout: 86400
                    type: session_timeout
                Username Attr:
                  value:
                    allow_usermac_override: true
                    name: username_attr
                    type: username_attr
                    username_attr: automatic
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/nac_tag'
                - description: NAC tag used as a rule-matching classifier or as a result attribute for allowed users
                  examples:
                  - '{"egress_vlan_names":["1vlan-30","1vlan-20","2vlan10"],"name":"trunk_ap","type":"egress_vlan_names"}'
                  - '{"match":"cert_cn","name":"staff","type":"match","values":["john","staff*"]}'
                  - '{"match":"cert_issuer","name":"issuer1","type":"match","values":["/C=CN/ST=defy/L=defy/O=defy/OU=defy/CN=defy"]}'
                  - '{"match":"cert_san","name":"san1","type":"match","values":["henry1@defy.com"]}'
                  - '{"match":"cert_serial","name":"serial1","type":"match","values":["6a524ab782fb468c00c59f51cff00268d95533b8"]}'
                  - '{"match":"cert_sub","name":"subject1","type":"match","values":["/C=CN/ST=defy/O=defy/OU=defy/CN=steve"]}'
                  - '{"match":"cert_template","name":"templ1","type":"match","values":["1.3.6.1.4.1.311.21.8.4200806.605933.871088.11229391.9863893.29.13545645.4807979","1.3.6.1.4.1.311.21.8.3285427.4093958.2707341.9961608.11572555.6.4903431.2258457"]}'
                  - '{"match":"client_mac","name":"cameras","type":"match","values":["010203040506","abcdef*"]}'
                  - '{"match":"hostname","name":"hostname1","type":"match","values":["CP*","USR*"]}'
                  - '{"name":"VIP_group","radius_group":"VIP","type":"radius_group"}'
                  - '{"match":"realm","name":"defy","type":"match","values":["defy.com"]}'
                  - '{"match":"idp_role","name":"VIP","type":"match","values":["vip"]}'
                  - '{"match":"user_name","name":"admins","type":"match","values":["bob","steve"]}'
                  - '{"name":"guest_vlan","type":"vlan","vlan":"30"}'
                  - '{"name":"custom_attrs","radius_attrs":["Idle-Timeout=600","Termination-Action=RADIUS-Request"],"type":"radius_attrs"}'
                  - '{"name":"custom_radius_vendor_attrs","radius_vendor_attrs":["PaloAlto-Admin-Role=superuser","PaloAlto-Panorama-Admin-Role=administrator"],"type":"radius_vendor_attrs"}'
                  - '{"name":"timeout","session_timeout":86400,"type":"session_timeout"}'
                  - '{"allow_usermac_override":true,"name":"username_attr","type":"username_attr","username_attr":"automatic"}'
                contentMediaType: application/vnd.api+json
              examples:
                Egress Vlan Names:
                  value:
                    egress_vlan_names:
                    - 1vlan-30
                    - 1vlan-20
                    - 2vlan10
                    name: trunk_ap
                    type: egress_vlan_names
                Matches Cert CN:
                  value:
                    match: cert_cn
                    name: staff
                    type: match
                    values:
                    - john
                    - staff*
                Matches Cert Issuer:
                  value:
                    match: cert_issuer
                    name: issuer1
                    type: match
                    values:
                    - /C=CN/ST=defy/L=defy/O=defy/OU=defy/CN=defy
                Matches Cert SAN:
                  value:
                    match: cert_san
                    name: san1
                    type: match
                    values:
                    - henry1@defy.com
                Matches Cert Serial:
                  value:
                    match: cert_serial
                    name: serial1
                    type: match
                    values:
                    - 6a524ab782fb468c00c59f51cff00268d95533b8
                Matches Cert Sub:
                  value:
                    match: cert_sub
                    name: subject1
                    type: match
                    values:
                    - /C=CN/ST=defy/O=defy/OU=defy/CN=steve
                Matches Cert Template:
                  value:
                    match: cert_template
                    name: templ1
                    type: match
                    values:
                    - 1.3.6.1.4.1.311.21.8.4200806.605933.871088.11229391.9863893.29.13545645.4807979
                    - 1.3.6.1.4.1.311.21.8.3285427.4093958.2707341.9961608.11572555.6.4903431.2258457
                Matches Client Mac:
                  value:
                    match: client_mac
                    name: cameras
                    type: match
                    values:
                    - '010203040506'
                    - abcdef*
                Matches Hostname:
                  value:
                    match: hostname
                    name: hostname1
                    type: match
                    values:
                    - CP*
                    - USR*
                Matches Radius Group:
                  value:
                    name: VIP_group
                    radius_group: VIP
                    type: radius_group
                Matches Realm:
                  value:
                    match: realm
                    name: defy
                    type: match
                    values:
                    - defy.com
                Matches Role:
                  value:
                    match: idp_role
                    name: VIP
                    type: match
                    values:
                    - vip
                Matches Username:
                  value:
                    match: user_name
                    name: admins
                    type: match
                    values:
                    - bob
                    - steve
                Matches Vlan:
                  value:
                    name: guest_vlan
                    type: vlan
                    vlan: '30'
                Radius Attrs:
                  value:
                    name: custom_attrs
                    radius_attrs:
                    - Idle-Timeout=600
                    - Termination-Action=RADIUS-Request
                    type: radius_attrs
                Radius Vendor Attrs:
                  value:
                    name: custom_radius_vendor_attrs
                    radius_vendor_attrs:
                    - PaloAlto-Admin-Role=superuser
                    - PaloAlto-Panorama-Admin-Role=administrator
                    type: radius_vendor_attrs
                Session Timeout:
                  value:
                    name: timeout
                    session_timeout: 86400
                    type: session_timeout
                Username Attr:
                  value:
                    allow_usermac_override: true
                    name: username_attr
                    type: username_attr
                    username_attr: automatic
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs NAC Tags
      summary: updateOrgNacTag
      description: Update a NAC tag, including matcher values or result attributes such as RADIUS attributes, VLAN, session timeout, username attribute, or portal redirection.
      operationId: updateOrgNacTag
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: nactag_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/nac_tag'
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/nac_tag'
                - description: NAC tag used as a rule-matching classifier or as a result attribute for allowed users
                  examples:
                  - '{"egress_vlan_names":["1vlan-30","1vlan-20","2vlan10"],"name":"trunk_ap","type":"egress_vlan_names"}'
                  - '{"match":"cert_cn","name":"staff","type":"match","values":["john","staff*"]}'
                  - '{"match":"cert_eku","name":"EKU-Match","type":"match","values":["1.3.6.1.4.1.54321.10.1","1.3.6.1.4.1.54321.20.2"]}'
                  - '{"match":"cert_issuer","name":"issuer1","type":"match","values":["/C=CN/ST=defy/L=defy/O=defy/OU=defy/CN=defy"]}'
                  - '{"match":"cert_san","name":"san1","type":"match","values":["henry1@defy.com"]}'
                  - '{"match":"cert_serial","name":"serial1","type":"match","values":["6a524ab782fb468c00c59f51cff00268d95533b8"]}'
                  - '{"match":"cert_sub","name":"subject1","type":"match","values":["/C=CN/ST=defy/O=defy/OU=defy/CN=steve"]}'
                  - '{"match":"cert_template","name":"templ1","type":"match","values":["1.3.6.1.4.1.311.21.8.4200806.605933.871088.11229391.9863893.29.13545645.4807979","1.3.6.1.4.1.311.21.8.3285427.4093958.2707341.9961608.11572555.6.4903431.2258457"]}'
                  - '{"match":"client_mac","name":"cameras","type":"match","values":["010203040506","abcdef*"]}'
                  - '{"match":"edr_status","match_all":false,"name":"edr_health","type":"match","values":["sentinelone_healthy","sentinelone_infected","crowdstrike_low","crowdstrike_medium","crowdstrike_high","crowdstrike_critical","crowdstrike_informational","unknown"]}'
                  - '{"match":"hostname","name":"hostname1","type":"match","values":["CP*","USR*"]}'
                  - '{"name":"VIP_group","radius_group":"VIP","type":"radius_group"}'
                  - '{"match":"realm","name":"defy","type":"match","values":["defy.com"]}'
                  - '{"match":"idp_role","name":"VIP","type":"match","values":["vip"]}'
                  - '{"match":"user_name","name":"admins","type":"match","values":["bob","steve"]}'
                  - '{"name":"guest_vlan","type":"vlan","vlan":"30"}'
                  - '{"name":"custom_attrs","radius_attrs":["Idle-Timeout=600","Termination-Action=RADIUS-Request"],"type":"radius_attrs"}'
                  - '{"name":"custom_radius_vendor_attrs","radius_vendor_attrs":["PaloAlto-Admin-Role=superuser","PaloAlto-Panorama-Admin-Role=administrator"],"type":"radius_vendor_attrs"}'
                  - '{"name":"timeout","session_timeout":86400,"type":"session_timeout"}'
                  - '{"allow_usermac_override":true,"name":"username_attr","type":"username_attr","username_attr":"automatic"}'
                contentMediaType: application/json
              examples:
                Egress Vlan Names:
                  value:
                    egress_vlan_names:
                    - 1vlan-30
                    - 1vlan-20
                    - 2vlan10
                    name: trunk_ap
                    type: egress_vlan_names
                Matches Cert CN:
                  value:
                    match: cert_cn
                    name: staff
                    type: match
                    values:
                    - john
                    - staff*
                Matches Cert EKU:
                  value:
                    match: cert_eku
                    name: EKU-Match
                    type: match
                    values:
                    - 1.3.6.1.4.1.54321.10.1
                    - 1.3.6.1.4.1.54321.20.2
                Matches Cert Issuer:
                  value:
                    match: cert_issuer
                    name: issuer1
                    type: match
                    values:
                    - /C=CN/ST=defy/L=defy/O=defy/OU=defy/CN=defy
                Matches Cert SAN:
                  value:
                    match: cert_san
                    name: san1
                    type: match
                    values:
                    - henry1@defy.com
                Matches Cert Serial:
                  value:
                    match: cert_serial
                    name: serial1
                    type: match
                    values:
                    - 6a524ab782fb468c00c59f51cff00268d95533b8
                Matches Cert Sub:
                  value:
                    match: cert_sub
                    name: subject1
                    type: match
                    values:
                    - /C=CN/ST=defy/O=defy/OU=defy/CN=steve
                Matches Cert Template:
                  value:
                    match: cert_template
                    name: templ1
                    type: match
                    values:
                    - 1.3.6.1.4.1.311.21.8.4200806.605933.871088.11229391.9863893.29.13545645.4807979
                    - 1.3.6.1.4.1.311.21.8.3285427.4093958.2707341.9961608.11572555.6.4903431.2258457
                Matches Client Mac:
                  value:
                    match: client_mac
                    name: cameras
                    type: match
                    values:
                    - '010203040506'
                    - abcdef*
                Matches EDR Status:
                  value:
                    match: edr_status
                    match_all: false
                    name: edr_health
                    type: match
                    values:
                    - sentinelone_healthy
                    - sentinelone_infected
                    - crowdstrike_low
                    - crowdstrike_medium
                    - crowdstrike_high
                    - crowdstrike_critical
                    - crowdstrike_informational
                    - unknown
                Matches Hostname:
                  value:
                    match: hostname
                    name: hostname1
                    type: match
                    values:
                    - CP*
                    - USR*
                Matches Radius Group:
                  value:
                    name: VIP_group
                    radius_group: VIP
                    type: radius_group
                Matches Realm:
                  value:
                    match: realm
                    name: defy
                    type: match
                    values:
                    - defy.com
                Matches Role:
                  value:
                    match: idp_role
                    name: VIP
                    type: match
                    values:
                    - vip
                Matches Username:
                  value:
                    match: user_name
                    name: admins
                    type: match
                    values:
                    - bob
                    - steve
                Matches Vlan:
                  value:
                    name: guest_vlan
                    type: vlan
                    vlan: '30'
                Radius Attrs:
                  value:
                    name: custom_attrs
                    radius_attrs:
                    - Idle-Timeout=600
                    - Termination-Action=RADIUS-Request
                    type: radius_attrs
                Radius Vendor Attrs:
                  value:
                    name: custom_radius_vendor_attrs
                    radius_vendor_attrs:
                    - PaloAlto-Admin-Role=superuser
                    - PaloAlto-Panorama-Admin-Role=administrator
                    type: radius_vendor_attrs
                Session Timeout:
                  value:
                    name: timeout
                    session_timeout: 86400
                    type: session_timeout
                Username Attr:
                  value:
                    allow_usermac_override: true
                    name: username_attr
                    type: username_attr
                    username_attr: automatic
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/nac_tag'
                - description: NAC tag used as a rule-matching classifier or as a result attribute for allowed users
                  examples:
                  - '{"egress_vlan_names":["1vlan-30","1vlan-20","2vlan10"],"name":"trunk_ap","type":"egress_vlan_names"}'
                  - '{"match":"cert_cn","name":"staff","type":"match","values":["john","staff*"]}'
                  - '{"match":"cert_issuer","name":"issuer1","type":"match","values":["/C=CN/ST=defy/L=defy/O=defy/OU=defy/CN=defy"]}'
                  - '{"match":"cert_san","name":"san1","type":"match","values":["henry1@defy.com"]}'
                  - '{"match":"cert_serial","name":"serial1","type":"match","values":["6a524ab782fb468c00c59f51cff00268d95533b8"]}'
                  - '{"match":"cert_sub","name":"subject1","type":"match","values":["/C=CN/ST=defy/O=defy/OU=defy/CN=steve"]}'
                  - '{"match":"cert_template","name":"templ1","type":"match","values":["1.3.6.1.4.1.311.21.8.4200806.605933.871088.11229391.9863893.29.13545645.4807979","1.3.6.1.4.1.311.21.8.3285427.4093958.2707341.9961608.11572555.6.4903431.2258457"]}'
                  - '{"match":"client_mac","name":"cameras","type":"match","values":["010203040506","abcdef*"]}'
                  - '{"match":"hostname","name":"hostname1","type":"match","values":["CP*","USR*"]}'
                  - '{"name":"VIP_group","radius_group":"VIP","type":"radius_group"}'
                  - '{"match":"realm","name":"defy","type":"match","values":["defy.com"]}'
                  - '{"match":"idp_role","name":"VIP","type":"match","values":["vip"]}'
                  - '{"match":"user_name","name":"admins","type":"match","values":["bob","steve"]}'
                  - '{"name":"guest_vlan","type":"vlan","vlan":"30"}'
                  - '{"name":"custom_attrs","radius_attrs":["Idle-Timeout=600","Termination-Action=RADIUS-Request"],"type":"radius_attrs"}'
                  - '{"name":"custom_radius_vendor_attrs","radius_vendor_attrs":["PaloAlto-Admin-Role=superuser","PaloAlto-Panorama-Admin-Role=administrator"],"type":"radius_vendor_attrs"}'
                  - '{"name":"timeout","session_timeout":86400,"type":"session_timeout"}'
                  - '{"allow_usermac_override":true,"name":"username_attr","type":"username_attr","username_attr":"automatic"}'
                contentMediaType: application/vnd.api+json
              examples:
                Egress Vlan Names:
                  value:
                    egress_vlan_names:
                    - 1vlan-30
                    - 1vlan-20
                    - 2vlan10
                    name: trunk_ap
                    type: egress_vlan_names
                Matches Cert CN:
                  value:
                    match: cert_cn
                    name: staff
                    type: match
                    values:
                    - john
                    - staff*
                Matches Cert Issuer:
                  value:
                    match: cert_issuer
                    name: issuer1
                    type: match
                    values:
                    - /C=CN/ST=defy/L=defy/O=defy/OU=defy/CN=defy
                Matches Cert SAN:
                  value:
                    match: cert_san
                    name: san1
                    type: match
                    values:
                    - henry1@defy.com
                Matches Cert Serial:
                  value:
                    match: cert_serial
                    name: serial1
                    type: match
                    values:
                    - 6a524ab782fb468c00c59f51cff00268d95533b8
                Matches Cert Sub:
                  value:
                    match: cert_sub
                    name: subject1
                    type: match
                    values:
                    - /C=CN/ST=defy/O=defy/OU=defy/CN=steve
                Matches Cert Template:
                  value:
                    match: cert_template
                    name: templ1
                    type: match
                    values:
                    - 1.3.6.1.4.1.311.21.8.4200806.605933.871088.11229391.9863893.29.13545645.4807979
                    - 1.3.6.1.4.1.311.21.8.3285427.4093958.2707341.9961608.11572555.6.4903431.2258457
                Matches Client Mac:
                  value:
                    match: client_mac
                    name: cameras
                    type: match
                    values:
                    - '010203040506'
                    - abcdef*
                Matches Hostname:
                  value:
                    match: hostname
                    name: hostname1
                    type: match
                    values:
                    - CP*
                    - USR*
                Matches Radius Group:
                  value:
                    name: VIP_group
                    radius_group: VIP
                    type: radius_group
                Matches Realm:
                  value:
                    match: realm
                    name: defy
                    type: match
                    values:
                    - defy.com
                Matches Role:
                  value:
                    match: idp_role
                    name: VIP
                    type: match
                    values:
                    - vip
                Matches Username:
                  value:
                    match: user_name
                    name: admins
                    type: match
                    values:
                    - bob
                    - steve
                Matches Vlan:
                  value:
                    name: guest_vlan
                    type: vlan
                    vlan: '30'
                Radius Attrs:
                  value:
                    name: custom_attrs
                    radius_attrs:
                    - Idle-Timeout=600
                    - Termination-Action=RADIUS-Request
                    type: radius_attrs
                Radius Vendor Attrs:
                  value:
                    name: custom_radius_vendor_attrs
                    radius_vendor_attrs:
                    - PaloAlto-Admin-Role=superuser
                    - PaloAlto-Panorama-Admin-Role=administrator
                    type: radius_vendor_attrs
                Session Timeout:
                  value:
                    name: timeout
                    session_timeout: 86400
                    type: session_timeout
                Username Attr:
                  value:
                    allow_usermac_override: true
                    name: username_attr
                    type: username_attr
                    username_attr: automatic
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/nacportals:
    get:
      tags:
      - Orgs NAC Portals
      summary: listOrgNacPortals
      description: List NAC portal configurations in the organization for guest portal, guest admin, or Marvis Client onboarding workflows.
      operationId: listOrgNacPortals
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/nac_portal'
                description: List of NAC portal configurations
                examples:
                - - access_type: wireless
                    additional_cacerts:
                    - >-
                      -----BEGIN CERTIFICATE-----

                      MIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE

                      -----END CERTIFICATE-----
                    cert_expire_time: 365
                    enable_location: false
                    enable_telemetry: true
                    expiry_notification_time: 2
                    name: get-wifi
                    notify_expiry: true
                    ssid: Corp
                    sso:
                      idp_cert: >-
                        -----BEGIN CERTIFICATE-----

                        MIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE

                        -----END CERTIFICATE-----
                      idp_sign_algo: sha256
                      idp_sso_url: https://yourorg.onelogin.com/trust/saml2/http-post/sso/138130
                      issuer: https://app.onelogin.com/saml/metadata/138130
                      nameid_format: email
                      sso_role_matching:
                      - assigned: user
                        match: Student
                      use_sso_role_for_cert: true
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - access_type: wireless
                    additional_cacerts:
                    - >-
                      -----BEGIN CERTIFICATE-----

                      MIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE

                      -----END CERTIFICATE-----
                    cert_expire_time: 365
                    enable_location: false
                    enable_telemetry: true
                    expiry_notification_time: 2
                    name: get-wifi
                    notify_expiry: true
                    ssid: Corp
                    sso:
                      idp_cert: >-
                        -----BEGIN CERTIFICATE-----

                        MIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE

                        -----END CERTIFICATE-----
                      idp_sign_algo: sha256
                      idp_sso_url: https://yourorg.onelogin.com/trust/saml2/http-post/sso/138130
                      issuer: https://app.onelogin.com/saml/metadata/138130
                      nameid_format: email
                      sso_role_matching:
                      - assigned: user
                        match: Student
                      use_sso_role_for_cert: true
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/nac_portal'
                description: List of NAC portal configurations
                examples:
                - - access_type: wireless
                    additional_cacerts:
                    - >-
                      -----BEGIN CERTIFICATE-----

                      MIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE

                      -----END CERTIFICATE-----
                    cert_expire_time: 365
                    enable_location: false
                    enable_telemetry: true
                    expiry_notification_time: 2
                    name: get-wifi
                    notify_expiry: true
                    ssid: Corp
                    sso:
                      idp_cert: >-
                        -----BEGIN CERTIFICATE-----

                        MIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE

                        -----END CERTIFICATE-----
                      idp_sign_algo: sha256
                      idp_sso_url: https://yourorg.onelogin.com/trust/saml2/http-post/sso/138130
                      issuer: https://app.onelogin.com/saml/metadata/138130
                      nameid_format: email
                      sso_role_matching:
                      - assigned: user
                        match: Student
                      use_sso_role_for_cert: true
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - access_type: wireless
                    additional_cacerts:
                    - >-
                      -----BEGIN CERTIFICATE-----

                      MIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE

                      -----END CERTIFICATE-----
                    cert_expire_time: 365
                    enable_location: false
                    enable_telemetry: true
                    expiry_notification_time: 2
                    name: get-wifi
                    notify_expiry: true
                    ssid: Corp
                    sso:
                      idp_cert: >-
                        -----BEGIN CERTIFICATE-----

                        MIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE

                        -----END CERTIFICATE-----
                      idp_sign_algo: sha256
                      idp_sso_url: https://yourorg.onelogin.com/trust/saml2/http-post/sso/138130
                      issuer: https://app.onelogin.com/saml/metadata/138130
                      nameid_format: email
                      sso_role_matching:
                      - assigned: user
                        match: Student
                      use_sso_role_for_cert: true
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs NAC Portals
      summary: createOrgNacPortal
      description: Create a NAC portal configuration for guest access, guest administration, or Marvis Client certificate onboarding.
      operationId: createOrgNacPortal
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/nac_portal'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/nac_portal'
                - description: NAC portal configuration for 802.1X onboarding, guest access, or Marvis client certificate provisioning
                  examples:
                  - access_type: wireless
                    cert_expire_time: 365
                    enable_location: false
                    enable_telemetry: true
                    expiry_notification_time: 2
                    name: get-wifi
                    notify_expiry: true
                    ssid: Corp
                    sso:
                      idp_cert: >-
                        -----BEGIN CERTIFICATE-----

                        MIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE

                        -----END CERTIFICATE-----
                      idp_sign_algo: sha256
                      idp_sso_url: https://yourorg.onelogin.com/trust/saml2/http-post/sso/138130
                      issuer: https://app.onelogin.com/saml/metadata/138130
                      nameid_format: email
                      sso_role_matching:
                      - assigned: user
                        match: Student
                      use_sso_role_for_cert: true
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    access_type: wireless
                    cert_expire_time: 365
                    enable_location: false
                    enable_telemetry: true
                    expiry_notification_time: 2
                    name: get-wifi
                    notify_expiry: true
                    ssid: Corp
                    sso:
                      idp_cert: >-
                        -----BEGIN CERTIFICATE-----

                        MIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE

                        -----END CERTIFICATE-----
                      idp_sign_algo: sha256
                      idp_sso_url: https://yourorg.onelogin.com/trust/saml2/http-post/sso/138130
                      issuer: https://app.onelogin.com/saml/metadata/138130
                      nameid_format: email
                      sso_role_matching:
                      - assigned: user
                        match: Student
                      use_sso_role_for_cert: true
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/nac_portal'
                - description: NAC portal configuration for 802.1X onboarding, guest access, or Marvis client certificate provisioning
                  examples:
                  - access_type: wireless
                    cert_expire_time: 365
                    enable_location: false
                    enable_telemetry: true
                    expiry_notification_time: 2
                    name: get-wifi
                    notify_expiry: true
                    ssid: Corp
                    sso:
                      idp_cert: >-
                        -----BEGIN CERTIFICATE-----

                        MIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE

                        -----END CERTIFICATE-----
                      idp_sign_algo: sha256
                      idp_sso_url: https://yourorg.onelogin.com/trust/saml2/http-post/sso/138130
                      issuer: https://app.onelogin.com/saml/metadata/138130
                      nameid_format: email
                      sso_role_matching:
                      - assigned: user
                        match: Student
                      use_sso_role_for_cert: true
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    access_type: wireless
                    cert_expire_time: 365
                    enable_location: false
                    enable_telemetry: true
                    expiry_notification_time: 2
                    name: get-wifi
                    notify_expiry: true
                    ssid: Corp
                    sso:
                      idp_cert: >-
                        -----BEGIN CERTIFICATE-----

                        MIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE

                        -----END CERTIFICATE-----
                      idp_sign_algo: sha256
                      idp_sso_url: https://yourorg.onelogin.com/trust/saml2/http-post/sso/138130
                      issuer: https://app.onelogin.com/saml/metadata/138130
                      nameid_format: email
                      sso_role_matching:
                      - assigned: user
                        match: Student
                      use_sso_role_for_cert: true
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/nacportals/{nacportal_id}:
    delete:
      tags:
      - Orgs NAC Portals
      summary: deleteOrgNacPortal
      description: Delete an organization NAC portal configuration by NAC portal ID.
      operationId: deleteOrgNacPortal
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: nacportal_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs NAC Portals
      summary: getOrgNacPortal
      description: Retrieve configuration details for a specific NAC portal, including portal type, SSID, SSO, guest portal, certificate, and template settings.
      operationId: getOrgNacPortal
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: nacportal_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/nac_portal'
                - description: NAC portal configuration for 802.1X onboarding, guest access, or Marvis client certificate provisioning
                  examples:
                  - access_type: wireless
                    cert_expire_time: 365
                    enable_location: false
                    enable_telemetry: true
                    expiry_notification_time: 2
                    name: get-wifi
                    notify_expiry: true
                    ssid: Corp
                    sso:
                      idp_cert: >-
                        -----BEGIN CERTIFICATE-----

                        MIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE

                        -----END CERTIFICATE-----
                      idp_sign_algo: sha256
                      idp_sso_url: https://yourorg.onelogin.com/trust/saml2/http-post/sso/138130
                      issuer: https://app.onelogin.com/saml/metadata/138130
                      nameid_format: email
                      sso_role_matching:
                      - assigned: user
                        match: Student
                      use_sso_role_for_cert: true
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    access_type: wireless
                    cert_expire_time: 365
                    enable_location: false
                    enable_telemetry: true
                    expiry_notification_time: 2
                    name: get-wifi
                    notify_expiry: true
                    ssid: Corp
                    sso:
                      idp_cert: >-
                        -----BEGIN CERTIFICATE-----

                        MIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE

                        -----END CERTIFICATE-----
                      idp_sign_algo: sha256
                      idp_sso_url: https://yourorg.onelogin.com/trust/saml2/http-post/sso/138130
                      issuer: https://app.onelogin.com/saml/metadata/138130
                      nameid_format: email
                      sso_role_matching:
                      - assigned: user
                        match: Student
                      use_sso_role_for_cert: true
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/nac_portal'
                - description: NAC portal configuration for 802.1X onboarding, guest access, or Marvis client certificate provisioning
                  examples:
                  - access_type: wireless
                    cert_expire_time: 365
                    enable_location: false
                    enable_telemetry: true
                    expiry_notification_time: 2
                    name: get-wifi
                    notify_expiry: true
                    ssid: Corp
                    sso:
                      idp_cert: >-
                        -----BEGIN CERTIFICATE-----

                        MIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE

                        -----END CERTIFICATE-----
                      idp_sign_algo: sha256
                      idp_sso_url: https://yourorg.onelogin.com/trust/saml2/http-post/sso/138130
                      issuer: https://app.onelogin.com/saml/metadata/138130
                      nameid_format: email
                      sso_role_matching:
                      - assigned: user
                        match: Student
                      use_sso_role_for_cert: true
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    access_type: wireless
                    cert_expire_time: 365
                    enable_location: false
                    enable_telemetry: true
                    expiry_notification_time: 2
                    name: get-wifi
                    notify_expiry: true
                    ssid: Corp
                    sso:
                      idp_cert: >-
                        -----BEGIN CERTIFICATE-----

                        MIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE

                        -----END CERTIFICATE-----
                      idp_sign_algo: sha256
                      idp_sso_url: https://yourorg.onelogin.com/trust/saml2/http-post/sso/138130
                      issuer: https://app.onelogin.com/saml/metadata/138130
                      nameid_format: email
                      sso_role_matching:
                      - assigned: user
                        match: Student
                      use_sso_role_for_cert: true
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs NAC Portals
      summary: updateOrgNacPortal
      description: Update a NAC portal configuration, including portal type, SSID, SSO, guest portal, certificate, and template settings.
      operationId: updateOrgNacPortal
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: nacportal_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/nac_portal'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/nac_portal'
                - description: NAC portal configuration for 802.1X onboarding, guest access, or Marvis client certificate provisioning
                  examples:
                  - access_type: wireless
                    cert_expire_time: 365
                    enable_location: false
                    enable_telemetry: true
                    expiry_notification_time: 2
                    name: get-wifi
                    notify_expiry: true
                    ssid: Corp
                    sso:
                      idp_cert: >-
                        -----BEGIN CERTIFICATE-----

                        MIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE

                        -----END CERTIFICATE-----
                      idp_sign_algo: sha256
                      idp_sso_url: https://yourorg.onelogin.com/trust/saml2/http-post/sso/138130
                      issuer: https://app.onelogin.com/saml/metadata/138130
                      nameid_format: email
                      sso_role_matching:
                      - assigned: user
                        match: Student
                      use_sso_role_for_cert: true
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    access_type: wireless
                    cert_expire_time: 365
                    enable_location: false
                    enable_telemetry: true
                    expiry_notification_time: 2
                    name: get-wifi
                    notify_expiry: true
                    ssid: Corp
                    sso:
                      idp_cert: >-
                        -----BEGIN CERTIFICATE-----

                        MIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE

                        -----END CERTIFICATE-----
                      idp_sign_algo: sha256
                      idp_sso_url: https://yourorg.onelogin.com/trust/saml2/http-post/sso/138130
                      issuer: https://app.onelogin.com/saml/metadata/138130
                      nameid_format: email
                      sso_role_matching:
                      - assigned: user
                        match: Student
                      use_sso_role_for_cert: true
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/nac_portal'
                - description: NAC portal configuration for 802.1X onboarding, guest access, or Marvis client certificate provisioning
                  examples:
                  - access_type: wireless
                    cert_expire_time: 365
                    enable_location: false
                    enable_telemetry: true
                    expiry_notification_time: 2
                    name: get-wifi
                    notify_expiry: true
                    ssid: Corp
                    sso:
                      idp_cert: >-
                        -----BEGIN CERTIFICATE-----

                        MIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE

                        -----END CERTIFICATE-----
                      idp_sign_algo: sha256
                      idp_sso_url: https://yourorg.onelogin.com/trust/saml2/http-post/sso/138130
                      issuer: https://app.onelogin.com/saml/metadata/138130
                      nameid_format: email
                      sso_role_matching:
                      - assigned: user
                        match: Student
                      use_sso_role_for_cert: true
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    access_type: wireless
                    cert_expire_time: 365
                    enable_location: false
                    enable_telemetry: true
                    expiry_notification_time: 2
                    name: get-wifi
                    notify_expiry: true
                    ssid: Corp
                    sso:
                      idp_cert: >-
                        -----BEGIN CERTIFICATE-----

                        MIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE

                        -----END CERTIFICATE-----
                      idp_sign_algo: sha256
                      idp_sso_url: https://yourorg.onelogin.com/trust/saml2/http-post/sso/138130
                      issuer: https://app.onelogin.com/saml/metadata/138130
                      nameid_format: email
                      sso_role_matching:
                      - assigned: user
                        match: Student
                      use_sso_role_for_cert: true
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/nacportals/{nacportal_id}/failures:
    get:
      tags:
      - Orgs NAC Portals
      summary: listOrgNacPortalSsoLatestFailures
      description: List recent SAML SSO failures for a NAC portal within a selected time range.
      operationId: listOrgNacPortalSsoLatestFailures
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: nacportal_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_sso_failure_search'
                - description: Response containing recent SSO authentication failure records
                  examples:
                  - results:
                    - detail: string
                      saml_assertion_xml: string
                      timestamp: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    results:
                    - detail: string
                      saml_assertion_xml: string
                      timestamp: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_sso_failure_search'
                - description: Response containing recent SSO authentication failure records
                  examples:
                  - results:
                    - detail: string
                      saml_assertion_xml: string
                      timestamp: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    results:
                    - detail: string
                      saml_assertion_xml: string
                      timestamp: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/nacportals/{nacportal_id}/portal_image:
    delete:
      tags:
      - Orgs NAC Portals
      summary: deleteOrgNacPortalImage
      description: Delete the custom background image for a NAC portal. If no image is configured, the NAC portal uses the default background image.
      operationId: deleteOrgNacPortalImage
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: nacportal_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs NAC Portals
      summary: uploadOrgNacPortalImage
      description: Upload a custom background image for a NAC portal.
      operationId: uploadOrgNacPortalImage
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: nacportal_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              type: object
              properties:
                file:
                  type: string
                  description: Image binary payload to upload for the PSK portal
                  contentEncoding: base64
                json:
                  type: string
                  description: Metadata JSON string describing the PSK portal image upload
              contentMediaType: multipart/form-data
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/nacportals/{nacportal_id}/portal_template:
    put:
      tags:
      - Orgs NAC Portals
      summary: updateOrgNacPortalTemplate
      description: Update visual template settings for a NAC portal, including alignment, primary color, logo, and Powered by visibility.
      operationId: updateOrgNacPortalTemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: nacportal_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/nac_portal_template'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/nacportals/{nacportal_id}/saml_metadata:
    get:
      tags:
      - Orgs NAC Portals
      summary: getOrgNacPortalSamlMetadata
      description: Retrieve SAML service provider metadata for a NAC portal, including ACS URL, entity ID, logout URL, and metadata XML.
      operationId: getOrgNacPortalSamlMetadata
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: nacportal_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/saml_metadata'
                - description: Read-only SAML and SCIM metadata generated for an SSO configuration
                  examples:
                  - acs_url: https://api.mist.com/api/v1/saml/llDfa13f/login
                    entity_id: https://api.mist.com/api/v1/saml/llDfa13f/login
                    logout_url: https://api.mist.com/api/v1/saml/llDfa13f/logout
                    metadata: <?xml version="1.0" encoding="UTF-8"?><md:EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" entityID="https://api.mist.com/api/v1/saml/llDfa13f/login" validUntil="2027-10-12T21:59:01Z" xmlns:ds="http://www.w3.org/2000/09/xmldsig#"><md:SPSSODescriptor AuthnRequestsSigned="false" WantAssertionsSigned="true" protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol"><md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</md:NameIDFormat><md:AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://api.mist.com/api/v1/saml/llDfa13f/login" index="0" isDefault="true"/></md:SPSSODescriptor></md:EntityDescriptor>
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    acs_url: https://api.mist.com/api/v1/saml/llDfa13f/login
                    entity_id: https://api.mist.com/api/v1/saml/llDfa13f/login
                    logout_url: https://api.mist.com/api/v1/saml/llDfa13f/logout
                    metadata: <?xml version="1.0" encoding="UTF-8"?><md:EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" entityID="https://api.mist.com/api/v1/saml/llDfa13f/login" validUntil="2027-10-12T21:59:01Z" xmlns:ds="http://www.w3.org/2000/09/xmldsig#"><md:SPSSODescriptor AuthnRequestsSigned="false" WantAssertionsSigned="true" protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol"><md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</md:NameIDFormat><md:AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://api.mist.com/api/v1/saml/llDfa13f/login" index="0" isDefault="true"/></md:SPSSODescriptor></md:EntityDescriptor>
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/saml_metadata'
                - description: Read-only SAML and SCIM metadata generated for an SSO configuration
                  examples:
                  - acs_url: https://api.mist.com/api/v1/saml/llDfa13f/login
                    entity_id: https://api.mist.com/api/v1/saml/llDfa13f/login
                    logout_url: https://api.mist.com/api/v1/saml/llDfa13f/logout
                    metadata: <?xml version="1.0" encoding="UTF-8"?><md:EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" entityID="https://api.mist.com/api/v1/saml/llDfa13f/login" validUntil="2027-10-12T21:59:01Z" xmlns:ds="http://www.w3.org/2000/09/xmldsig#"><md:SPSSODescriptor AuthnRequestsSigned="false" WantAssertionsSigned="true" protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol"><md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</md:NameIDFormat><md:AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://api.mist.com/api/v1/saml/llDfa13f/login" index="0" isDefault="true"/></md:SPSSODescriptor></md:EntityDescriptor>
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    acs_url: https://api.mist.com/api/v1/saml/llDfa13f/login
                    entity_id: https://api.mist.com/api/v1/saml/llDfa13f/login
                    logout_url: https://api.mist.com/api/v1/saml/llDfa13f/logout
                    metadata: <?xml version="1.0" encoding="UTF-8"?><md:EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" entityID="https://api.mist.com/api/v1/saml/llDfa13f/login" validUntil="2027-10-12T21:59:01Z" xmlns:ds="http://www.w3.org/2000/09/xmldsig#"><md:SPSSODescriptor AuthnRequestsSigned="false" WantAssertionsSigned="true" protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol"><md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</md:NameIDFormat><md:AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://api.mist.com/api/v1/saml/llDfa13f/login" index="0" isDefault="true"/></md:SPSSODescriptor></md:EntityDescriptor>
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/nacportals/{nacportal_id}/saml_metadata.xml:
    get:
      tags:
      - Orgs NAC Portals
      summary: downloadOrgNacPortalSamlMetadata
      description: >-
        Download NAC portal SAML service provider metadata as an XML document.


        Example of metadata.xml:

        ```xml

        <?xml version="1.0" encoding="UTF-8"?><md:EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" entityID="https://api.mist.com/api/v1/saml/5hdF5g/login" validUntil="2027-10-12T21:59:01Z" xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
            <md:SPSSODescriptor AuthnRequestsSigned="false" WantAssertionsSigned="true" protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol">
                <md:SingleLogoutService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://api.mist.com/api/v1/saml/5hdF5g/logout" />
                <md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</md:NameIDFormat>
                <md:AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://api.mist.com/api/v1/saml/5hdF5g/login" index="0" isDefault="true"/>
                <md:AttributeConsumingService index="0">
                    <md:ServiceName xml:lang="en-US">Mist</md:ServiceName>
                    <md:RequestedAttribute Name="Role" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic" isRequired="true"/>
                    <md:RequestedAttribute Name="FirstName" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic" isRequired="false"/>
                    <md:RequestedAttribute Name="LastName" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic" isRequired="false"/>
                </md:AttributeConsumingService>
            </md:SPSSODescriptor>
        </md:EntityDescriptor>

        ```
      operationId: downloadOrgNacPortalSamlMetadata
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: nacportal_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: string
                description: File
                contentEncoding: base64
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                type: string
                description: File
                contentEncoding: base64
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/setting/mist_nac_crls:
    get:
      tags:
      - Orgs NAC CRL
      summary: getOrgNacCrl
      description: List uploaded NAC CRL files for the organization, including file IDs, issuer names, upload timestamps, and download URLs.
      operationId: getOrgNacCrl
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_nac_crl_files'
                - description: Response containing uploaded NAC CRL file metadata
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_nac_crl_files'
                - description: Response containing uploaded NAC CRL file metadata
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs NAC CRL
      summary: importOrgNacCrl
      description: Upload a NAC Certificate Revocation List (CRL) file in PEM or DER format. This multipart request supports one CRL file per issuer; uploading another file for the same issuer replaces the existing file.
      operationId: importOrgNacCrl
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              type: object
              properties:
                file:
                  type: string
                  description: a PEM or DER formatted CRL file
                  contentEncoding: base64
                json:
                  type: string
                  description: a JSON string with "name" field for CRL file issuer (optional)
              contentMediaType: multipart/form-data
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/nac_crl_file'
                - description: Metadata for an uploaded NAC CRL file
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/nac_crl_file'
                - description: Metadata for an uploaded NAC CRL file
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/setting/mist_nac_crls/{naccrl_id}:
    delete:
      tags:
      - Orgs NAC CRL
      summary: deleteOrgNacCrl
      description: Delete an uploaded NAC CRL file identified by the file ID assigned when the CRL was uploaded.
      operationId: deleteOrgNacCrl
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: naccrl_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/stats:
    get:
      tags:
      - Orgs Stats
      summary: getOrgStats
      description: Return an organization statistics summary, including device, inventory, and site counts, connected and disconnected device counts, organization group membership, and SLE summaries.
      operationId: getOrgStats
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/stats_org'
                - description: Organization statistics summary returned by the org stats endpoint
                  examples:
                  - alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    num_devices: 0
                    num_devices_connected: 0
                    num_devices_disconnected: 0
                    num_inventory: 0
                    num_sites: 0
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 0
                    sle:
                    - path: string
                      user_minutes:
                        ok: 0
                        total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    num_devices: 0
                    num_devices_connected: 0
                    num_devices_disconnected: 0
                    num_inventory: 0
                    num_sites: 0
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 0
                    sle:
                    - path: string
                      user_minutes:
                        ok: 0
                        total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/stats_org'
                - description: Organization statistics summary returned by the org stats endpoint
                  examples:
                  - alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    num_devices: 0
                    num_devices_connected: 0
                    num_devices_disconnected: 0
                    num_inventory: 0
                    num_sites: 0
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 0
                    sle:
                    - path: string
                      user_minutes:
                        ok: 0
                        total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    allow_mist: true
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    num_devices: 0
                    num_devices_connected: 0
                    num_devices_disconnected: 0
                    num_inventory: 0
                    num_sites: 0
                    orggroup_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    session_expiry: 0
                    sle:
                    - path: string
                      user_minutes:
                        ok: 0
                        total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/stats/assets:
    get:
      tags:
      - Orgs Stats - Assets
      summary: listOrgAssetsStats
      description: List BLE asset location and advertisement statistics for the organization over an optional time window, including map coordinates, RSSI, zones, and iBeacon or Eddystone fields.
      operationId: listOrgAssetsStats
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/stats_asset'
                description: Asset statistics returned by the request
                examples:
                - - _ttl: 86400
                    battery_voltage: 3370
                    by: asset
                    device_id: 00000000-0000-0000-1000-5c5b35000001
                    device_name: BLE Device
                    eddystone_uid_instance: 5c5b35000001
                    eddystone_uid_namespace: 2818e3868dec25629ede
                    eddystone_url_url: https://www.abc.com
                    ibeacon_major: 13
                    ibeacon_minor: 138
                    ibeacon_uuid: f3f17139-704a-f03a-2786-0400279e37c3
                    id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                    last_seen: 1480716946
                    mac: 4a0222000e31
                    manufacture: Asset Manufacturer Name
                    map_id: 63eda950-c6da-11e4-a628-60f81dd250cc
                    mfg_company_id: 935
                    mfg_data: 648520a1020000
                    name: Asset Name
                    rssi: -45
                    rssizones:
                    - id: 478f6eca-6276-4993-bfeb-5bcbbbbacf08
                      since: 0
                    service_packets:
                    - data: '640'
                      last_rx_time: 1645855923
                      rx_cnt: 213065
                      uuid: 00003e10-0000-1000-8000-00805f9b34fb
                    temperature: 23.5
                    x: 51
                    y: 29
                    zones:
                    - id: 477f6eca-6276-4993-bfeb-5ccbbbbadf08
                      since: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - _ttl: 86400
                    battery_voltage: 3370
                    by: asset
                    device_id: 00000000-0000-0000-1000-5c5b35000001
                    device_name: BLE Device
                    eddystone_uid_instance: 5c5b35000001
                    eddystone_uid_namespace: 2818e3868dec25629ede
                    eddystone_url_url: https://www.abc.com
                    ibeacon_major: 13
                    ibeacon_minor: 138
                    ibeacon_uuid: f3f17139-704a-f03a-2786-0400279e37c3
                    id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                    last_seen: 1480716946
                    mac: 4a0222000e31
                    manufacture: Asset Manufacturer Name
                    map_id: 63eda950-c6da-11e4-a628-60f81dd250cc
                    mfg_company_id: 935
                    mfg_data: 648520a1020000
                    name: Asset Name
                    rssi: -45
                    rssizones:
                    - id: 478f6eca-6276-4993-bfeb-5bcbbbbacf08
                      since: 0
                    service_packets:
                    - data: '640'
                      last_rx_time: 1645855923
                      rx_cnt: 213065
                      uuid: 00003e10-0000-1000-8000-00805f9b34fb
                    temperature: 23.5
                    x: 51
                    y: 29
                    zones:
                    - id: 477f6eca-6276-4993-bfeb-5ccbbbbadf08
                      since: 0
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/stats_asset'
                description: Asset statistics returned by the request
                examples:
                - - _ttl: 86400
                    battery_voltage: 3370
                    by: asset
                    device_id: 00000000-0000-0000-1000-5c5b35000001
                    device_name: BLE Device
                    eddystone_uid_instance: 5c5b35000001
                    eddystone_uid_namespace: 2818e3868dec25629ede
                    eddystone_url_url: https://www.abc.com
                    ibeacon_major: 13
                    ibeacon_minor: 138
                    ibeacon_uuid: f3f17139-704a-f03a-2786-0400279e37c3
                    id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                    last_seen: 1480716946
                    mac: 4a0222000e31
                    manufacture: Asset Manufacturer Name
                    map_id: 63eda950-c6da-11e4-a628-60f81dd250cc
                    mfg_company_id: 935
                    mfg_data: 648520a1020000
                    name: Asset Name
                    rssi: -45
                    rssizones:
                    - id: 478f6eca-6276-4993-bfeb-5bcbbbbacf08
                      since: 0
                    service_packets:
                    - data: '640'
                      last_rx_time: 1645855923
                      rx_cnt: 213065
                      uuid: 00003e10-0000-1000-8000-00805f9b34fb
                    temperature: 23.5
                    x: 51
                    y: 29
                    zones:
                    - id: 477f6eca-6276-4993-bfeb-5ccbbbbadf08
                      since: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - _ttl: 86400
                    battery_voltage: 3370
                    by: asset
                    device_id: 00000000-0000-0000-1000-5c5b35000001
                    device_name: BLE Device
                    eddystone_uid_instance: 5c5b35000001
                    eddystone_uid_namespace: 2818e3868dec25629ede
                    eddystone_url_url: https://www.abc.com
                    ibeacon_major: 13
                    ibeacon_minor: 138
                    ibeacon_uuid: f3f17139-704a-f03a-2786-0400279e37c3
                    id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                    last_seen: 1480716946
                    mac: 4a0222000e31
                    manufacture: Asset Manufacturer Name
                    map_id: 63eda950-c6da-11e4-a628-60f81dd250cc
                    mfg_company_id: 935
                    mfg_data: 648520a1020000
                    name: Asset Name
                    rssi: -45
                    rssizones:
                    - id: 478f6eca-6276-4993-bfeb-5bcbbbbacf08
                      since: 0
                    service_packets:
                    - data: '640'
                      last_rx_time: 1645855923
                      rx_cnt: 213065
                      uuid: 00003e10-0000-1000-8000-00805f9b34fb
                    temperature: 23.5
                    x: 51
                    y: 29
                    zones:
                    - id: 477f6eca-6276-4993-bfeb-5ccbbbbadf08
                      since: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/stats/assets/count:
    get:
      tags:
      - Orgs Stats - Assets
      summary: countOrgAssetsByDistanceField
      description: Count organization asset statistics grouped by a distinct asset attribute, such as MAC address, site, map, iBeacon UUID, iBeacon major, or iBeacon minor.
      operationId: countOrgAssetsByDistanceField
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `ibeacon_major`, `ibeacon_minor`, `ibeacon_uuid`, `mac`, `map_id`, `site_id`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/org_asset_count_distinct'
          - description: 'Field used to group this count response. enum: `ibeacon_major`, `ibeacon_minor`, `ibeacon_uuid`, `mac`, `map_id`, `site_id`'
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/stats/assets/search:
    get:
      tags:
      - Orgs Stats - Assets
      summary: searchOrgAssets
      description: Search BLE asset statistics with filters for site, MAC address, asset name, map, iBeacon or Eddystone identifiers, reporting AP MAC address, RSSI, beam, and time range. Supports pagination and sorting.
      operationId: searchOrgAssets
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: site_id
        in: query
        description: Filter results by site identifier
        style: form
        explode: true
        schema:
          type: string
      - name: mac
        in: query
        description: Filter results by MAC address. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b53010101,5c5b53020202
      - name: device_name
        in: query
        description: Filter asset results by reporting device name
        style: form
        explode: true
        schema:
          type: string
      - name: name
        in: query
        description: Filter results by name. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - name-a,name-b
      - name: map_id
        in: query
        description: Filter results by map identifier
        style: form
        explode: true
        schema:
          type: string
      - name: ibeacon_uuid
        in: query
        description: Filter asset results by iBeacon UUID. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002
      - name: ibeacon_major
        in: query
        description: Filter asset results by iBeacon major value. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 59788,902
      - name: ibeacon_minor
        in: query
        description: Filter asset results by iBeacon minor value. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 8385,4432
      - name: eddystone_uid_namespace
        in: query
        description: Filter asset results by Eddystone UID namespace
        style: form
        explode: true
        schema:
          type: string
      - name: eddystone_uid_instance
        in: query
        description: Filter asset results by Eddystone UID instance
        style: form
        explode: true
        schema:
          type: string
      - name: eddystone_url
        in: query
        description: Filter asset results by Eddystone URL
        style: form
        explode: true
        schema:
          type: string
      - name: ap_mac
        in: query
        description: Filter asset results by reporting AP MAC address. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b53010101,5c5b53020202
      - name: beam
        in: query
        description: Filter asset results by beam value. Accepts multiple comma-separated integer values.
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: rssi
        in: query
        description: Filter asset results by RSSI value. Accepts multiple comma-separated integer values.
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_stats_assets'
                - description: Paginated response for asset statistics search results
                  examples:
                  - end: 0
                    limit: 0
                    next: string
                    results:
                    - battery_voltage: 0
                      eddystone_uid_instance: string
                      eddystone_uid_namespace: string
                      eddystone_url_url: string
                      ibeacon_major: 1
                      ibeacon_minor: 1
                      ibeacon_uuid: 1f89bc00-d0af-481b-82fe-a6629259a39f
                      last_seen: 0
                      mac: string
                      map_id: 09d2b626-2e4e-45ef-a3c4-e6aeb6c83db1
                      name: string
                      rssizones:
                      - id: 476f6eca-6276-4993-bfeb-5dcbbbbaef08
                        since: 0
                      x: 0
                      y: 0
                      zones:
                      - id: 475f6eca-6276-4993-bfeb-5ecbbbbf6f08
                        since: 0
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 0
                    limit: 0
                    next: string
                    results:
                    - battery_voltage: 0
                      eddystone_uid_instance: string
                      eddystone_uid_namespace: string
                      eddystone_url_url: string
                      ibeacon_major: 1
                      ibeacon_minor: 1
                      ibeacon_uuid: 1f89bc00-d0af-481b-82fe-a6629259a39f
                      last_seen: 0
                      mac: string
                      map_id: 09d2b626-2e4e-45ef-a3c4-e6aeb6c83db1
                      name: string
                      rssizones:
                      - id: 476f6eca-6276-4993-bfeb-5dcbbbbaef08
                        since: 0
                      x: 0
                      y: 0
                      zones:
                      - id: 475f6eca-6276-4993-bfeb-5ecbbbbf6f08
                        since: 0
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_stats_assets'
                - description: Paginated response for asset statistics search results
                  examples:
                  - end: 0
                    limit: 0
                    next: string
                    results:
                    - battery_voltage: 0
                      eddystone_uid_instance: string
                      eddystone_uid_namespace: string
                      eddystone_url_url: string
                      ibeacon_major: 1
                      ibeacon_minor: 1
                      ibeacon_uuid: 1f89bc00-d0af-481b-82fe-a6629259a39f
                      last_seen: 0
                      mac: string
                      map_id: 09d2b626-2e4e-45ef-a3c4-e6aeb6c83db1
                      name: string
                      rssizones:
                      - id: 476f6eca-6276-4993-bfeb-5dcbbbbaef08
                        since: 0
                      x: 0
                      y: 0
                      zones:
                      - id: 475f6eca-6276-4993-bfeb-5ecbbbbf6f08
                        since: 0
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 0
                    limit: 0
                    next: string
                    results:
                    - battery_voltage: 0
                      eddystone_uid_instance: string
                      eddystone_uid_namespace: string
                      eddystone_url_url: string
                      ibeacon_major: 1
                      ibeacon_minor: 1
                      ibeacon_uuid: 1f89bc00-d0af-481b-82fe-a6629259a39f
                      last_seen: 0
                      mac: string
                      map_id: 09d2b626-2e4e-45ef-a3c4-e6aeb6c83db1
                      name: string
                      rssizones:
                      - id: 476f6eca-6276-4993-bfeb-5dcbbbbaef08
                        since: 0
                      x: 0
                      y: 0
                      zones:
                      - id: 475f6eca-6276-4993-bfeb-5ecbbbbf6f08
                        since: 0
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/stats/bgp_peers/count:
    get:
      tags:
      - Orgs Stats - BGP Peers
      summary: countOrgBgpStats
      description: Count by Distinct Attributes of Org BGP Stats
      operationId: countOrgBgpStats
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: state
        in: query
        description: Filter peer results by state
        style: form
        explode: true
        schema:
          type: string
          examples:
          - established
      - name: distinct
        in: query
        description: Field used to group this count response
        style: form
        explode: true
        schema:
          type: string
          examples:
          - site_id
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/stats/bgp_peers/search:
    get:
      tags:
      - Orgs Stats - BGP Peers
      summary: searchOrgBgpStats
      description: Search Org BGP Stats
      operationId: searchOrgBgpStats
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mac
        in: query
        description: Filter results by MAC address. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b53010101,5c5b53020202
      - name: neighbor_mac
        in: query
        description: Filter peer results by neighbor MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: site_id
        in: query
        description: Filter results by site identifier
        style: form
        explode: true
        schema:
          type: string
      - name: vrf_name
        in: query
        description: Filter peer results by VRF name. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - default,vpn_OrgOverlay
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_search_bgps'
                - description: Paginated response for BGP peer statistics search results
                  examples:
                  - end: 0
                    limit: 0
                    results:
                    - evpn_overlay: true
                      for_overlay: true
                      local_as: 65000
                      mac: 020001c04668
                      neighbor: 15.8.3.5
                      neighbor_as: 65000
                      neighbor_mac: 020001c04600
                      node: node0
                      org_id: 0c160b7f-1027-4cd1-923b-744534c4b070
                      rx_pkts: 63366
                      rx_routes: 60
                      site_id: 725a8d34-a126-4f2c-b990-d1219421cb75
                      state: established
                      timestamp: 1666251056.07
                      tx_pkts: 1735
                      tx_routes: 60
                      up: true
                      uptime: 31355
                      vrf_name: default
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 0
                    limit: 0
                    results:
                    - evpn_overlay: true
                      for_overlay: true
                      local_as: 65000
                      mac: 020001c04668
                      neighbor: 15.8.3.5
                      neighbor_as: 65000
                      neighbor_mac: 020001c04600
                      node: node0
                      org_id: 0c160b7f-1027-4cd1-923b-744534c4b070
                      rx_pkts: 63366
                      rx_routes: 60
                      site_id: 725a8d34-a126-4f2c-b990-d1219421cb75
                      state: established
                      timestamp: 1666251056.07
                      tx_pkts: 1735
                      tx_routes: 60
                      up: true
                      uptime: 31355
                      vrf_name: default
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_search_bgps'
                - description: Paginated response for BGP peer statistics search results
                  examples:
                  - end: 0
                    limit: 0
                    results:
                    - evpn_overlay: true
                      for_overlay: true
                      local_as: 65000
                      mac: 020001c04668
                      neighbor: 15.8.3.5
                      neighbor_as: 65000
                      neighbor_mac: 020001c04600
                      node: node0
                      org_id: 0c160b7f-1027-4cd1-923b-744534c4b070
                      rx_pkts: 63366
                      rx_routes: 60
                      site_id: 725a8d34-a126-4f2c-b990-d1219421cb75
                      state: established
                      timestamp: 1666251056.07
                      tx_pkts: 1735
                      tx_routes: 60
                      up: true
                      uptime: 31355
                      vrf_name: default
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 0
                    limit: 0
                    results:
                    - evpn_overlay: true
                      for_overlay: true
                      local_as: 65000
                      mac: 020001c04668
                      neighbor: 15.8.3.5
                      neighbor_as: 65000
                      neighbor_mac: 020001c04600
                      node: node0
                      org_id: 0c160b7f-1027-4cd1-923b-744534c4b070
                      rx_pkts: 63366
                      rx_routes: 60
                      site_id: 725a8d34-a126-4f2c-b990-d1219421cb75
                      state: established
                      timestamp: 1666251056.07
                      tx_pkts: 1735
                      tx_routes: 60
                      up: true
                      uptime: 31355
                      vrf_name: default
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/stats/devices:
    get:
      tags:
      - Orgs Stats - Devices
      summary: listOrgDevicesStats
      description: >-
        Get List of Org Devices stats

        This API renders some high-level device stats, pagination is assumed and returned in response header (as the response is an array)
      operationId: listOrgDevicesStats
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: type
        in: query
        description: 'Filter results by one device type. Use a single value; comma-separated values are not supported. enum: `all`, `ap`, `gateway`, `switch`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/device_enum_with_all'
          - description: 'Filter results by one device type. Use a single value; comma-separated values are not supported. enum: `all`, `ap`, `gateway`, `switch`'
      - name: status
        in: query
        description: 'Filter results by status. enum: `all`, `connected`, `disconnected`. Accepts multiple comma-separated values.'
        style: form
        explode: true
        schema:
          type: string
          examples:
          - disconnected,connected
      - name: site_id
        in: query
        description: Filter results by site identifier. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002
      - name: mac
        in: query
        description: Filter results by MAC address. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b53010101,5c5b53020202
      - name: evpntopo_id
        in: query
        description: Filter results by evpntopo id
        style: form
        explode: true
        schema:
          type: string
      - name: evpn_unused
        in: query
        description: If `evpn_unused`==`true`, find EVPN eligible switches which don’t belong to any EVPN Topology yet
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: List of additional fields requests, comma separated, or `fields=*` for all of them
        style: form
        explode: true
        schema:
          type: string
          examples:
          - field1,field2
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/stats_device'
                description: Device statistics records returned by a stats response
                examples:
                - '[{"auto_upgrade_stat":{"lastcheck":1720594762},"ble_stat":{"beacon_enabled":true,"beacon_rate":4,"eddystone_uid_enabled":false,"eddystone_uid_freq_msec":1000,"eddystone_uid_instance":"5c5b35d0077b","eddystone_uid_namespace":"9777c1a06ef611e68bbf","eddystone_url_enabled":false,"eddystone_url_freq_msec":1000,"eddystone_url_url":"","ibeacon_enabled":false,"ibeacon_freq_msec":1000,"ibeacon_major":894,"ibeacon_minor":9328,"ibeacon_uuid":"af010e2b-f829-4975-b49e-2e896ed1d627","major":894,"minors":[9328,9329,9330,9331,9332,9333,9334,9335,-1],"power":8,"rx_bytes":158500843,"rx_pkts":3549163,"tx_bytes":509640,"tx_pkts":85411,"tx_resets":0,"uuid":"af010e2b-f829-4975-b49e-2e896ed1d627"},"config_reverted":false,"cpu_system":21921854,"cpu_user":7496631,"cpu_util":5,"created_time":1718228350,"env_stat":{"accel_x":-0.092,"accel_y":0.004,"accel_z":-1.02,"ambient_temp":43,"attitude":0,"cpu_temp":53,"humidity":9,"magne_x":0,"magne_y":0,"magne_z":0,"pressure":968,"vcore_voltage":0},"ext_ip":"66.129.234.28","hw_rev":"C02","id":"00000000-0000-0000-1000-5c5b35d0077b","inactive_wired_vlans":[],"ip":"192.168.95.3","ip_stat":{"dhcp_server":"192.168.95.1","dns":["8.8.8.8"],"gateway":"192.168.95.1","ip":"192.168.95.3","ip6":"fe80:0:0:0:5e5b:35ff:fed0:77b","ips":{"vlan1":"192.168.95.3/24,fe80:0:0:0:5e5b:35ff:fed0:77b/64"},"netmask":"255.255.255.0","netmask6":"/64"},"last_seen":1720595866,"last_trouble":{"code":"07","timestamp":1720039666},"lldp_stat":{"chassis_id":"d0:07:ca:f5:21:00","lldp_med_supported":false,"mgmt_addr":"100.123.105.1","mgmt_addrs":["100.123.105.1"],"port_desc":"ge-0/0/4","port_id":"ge-0/0/4","power_allocated":0,"power_draw":0,"power_request_count":0,"power_requested":0,"system_desc":"Juniper Networks, Inc. ex4300-48t internet router, kernel JUNOS 20.4R3-S7.2, Build date: 2023-04-21 19:47:18 UTC Copyright (c) 1996-2023 Juniper Networks, Inc.","system_name":"Phoenix-Switch"},"mac":"5c5b35d0077b","mem_total_kb":505468,"mem_used_kb":202096,"model":"AP43","modified_time":1718530662,"mount":"faceup","name":"Phoenix","notes":"","num_clients":1,"org_id":"af010e2b-f829-4975-b49e-2e896ed1d627","port_stat":{"eth0":{"full_duplex":true,"rx_bytes":1284143195,"rx_errors":0,"rx_peak_bps":17585,"rx_pkts":5199816,"speed":1000,"tx_bytes":1283744961,"tx_peak_bps":26484,"tx_pkts":3990463,"up":true},"eth1":{"full_duplex":false,"rx_bytes":0,"rx_errors":0,"rx_peak_bps":0,"rx_pkts":0,"speed":0,"tx_bytes":0,"tx_peak_bps":0,"tx_pkts":0,"up":false}},"power_budget":8400,"power_constrained":false,"power_src":"DC Input","radio_config":{},"radio_stat":{"band_24":{"bandwidth":20,"channel":11,"mac":"5c5b35dea810","noise_floor":-80,"num_clients":0,"power":17,"rx_bytes":12948211,"rx_pkts":65292,"tx_bytes":19071943,"tx_pkts":76926,"usage":"24","util_all":24,"util_non_wifi":2,"util_rx_in_bss":0,"util_rx_other_bss":17,"util_tx":4,"util_undecodable_wifi":0,"util_unknown_wifi":1},"band_5":{"bandwidth":40,"channel":36,"mac":"5c5b35dea7f0","noise_floor":-90,"num_clients":1,"power":17,"rx_bytes":578362619,"rx_pkts":2687577,"tx_bytes":1199571353,"tx_pkts":2479302,"usage":"5","util_all":13,"util_non_wifi":0,"util_rx_in_bss":0,"util_rx_other_bss":10,"util_tx":1,"util_undecodable_wifi":0,"util_unknown_wifi":1}},"rx_bps":9276,"rx_bytes":591310830,"rx_pkts":2752869,"serial":"A0703200709E6","site_id":"46fc665e-9706-4296-8fe2-78f42f2e67e4","status":"connected","switch_redundancy":{"num_redundant_aps":1},"tx_bps":8067,"tx_bytes":1218643296,"tx_pkts":2556228,"type":"ap","uptime":1593120,"version":"0.14.29313"}]'
                - '[{"arp_table_stats":{"arp_table_count":21,"max_entries_supported":64000},"auto_upgrade_stat":{"lastcheck":1720595477},"cert_expiry":1743292763,"cluster_config":{"configuration":"active-active","control_link_info":{"name":"fxp1","status":"Up"},"ethernet_connection":[{"name":"reth0","status":"Up"},{"name":"reth1","status":"Up"},{"name":"reth2","status":"Down"},{"name":"reth3","status":"Down"},{"name":"reth4","status":"Up"}],"fabric_link_info":{"DataPlaneNotifiedStatus":"Up","Interface":[],"InternalStatus":"Up","State":"Enabled","Status":"Enabled"},"last_status_change_reason":"No failures","operational":"active-active","primary_node_health":"Healthy","redundancy_group_information":[{"Id":0,"MonitoringFailure":"none","Threshold":255},{"Id":1,"MonitoringFailure":"interface-monitoring","Threshold":0},{"Id":2,"MonitoringFailure":"none","Threshold":255}],"secondary_node_health":"Not healthy","status":"Green"},"config_status":"COMMITED","config_timestamp":1720182848,"config_version":1720182848,"cpu2_stat":{"idle":86,"interrupt":0,"load_avg":[0.13,0.17,0.16],"system":5,"user":9},"cpu_stat":{"idle":76,"interrupt":0,"load_avg":[0.18,0.31,0.39],"system":10,"user":14},"created_time":1711756611,"deviceprofile_id":"5e5daedf-e650-4013-b41c-845f0d2b9414","deviceprofile_name":"wan_srx_tor_hub1","dhcpd_stat":{"byod_dc1":{"num_ips":100,"num_leased":0},"corp_dc1":{"num_ips":100,"num_leased":4},"guest_dc1":{"num_ips":241,"num_leased":0},"iot_dc1":{"num_ips":100,"num_leased":0},"mgmt_dc1":{"num_ips":100,"num_leased":2},"teleworker":{"num_ips":140,"num_leased":0}},"ext_ip":"69.196.157.189","fwupdate":{"progress":100,"status":"upgraded","status_id":3037,"timestamp":1718392692.580769,"will_retry":false},"has_pcap":false,"hostname":"wan_srx_tor_hub1-srx","id":"00000000-0000-0000-1000-4db14e107134","if_stat":{"ge-0/0/5.130":{"address_mode":"Unknown","nat_addresses":[],"network_name":"","port_id":"ge-0/0/5","port_usage":"lan","rx_bytes":0,"rx_pkts":0,"tx_bytes":0,"tx_pkts":0,"up":true,"vlan":0},"ge-1/0/5.120":{"address_mode":"Unknown","nat_addresses":[],"network_name":"","port_id":"ge-1/0/5","port_usage":"lan","rx_bytes":0,"rx_pkts":0,"tx_bytes":0,"tx_pkts":0,"up":true,"vlan":0}},"ip":"69.196.157.190","ip_stat":{"gateway":"69.196.157.185","ip":"69.196.157.190","ips":{"vlan1":"69.196.157.190,69.196.157.190"},"netmask":"255.255.255.255"},"is_ha":true,"last_seen":1720598726,"mac":"4db14e107134","mac_table_stats":{"mac_table_count":0,"max_mac_entries_supported":160000},"memory2_stat":{"usage":32},"memory_stat":{"usage":39},"model":"SRX300","modified_time":1720092942,"module2_stat":[{"backup_version":"21.2R3-S7.7","fans":[],"last_seen":1720598717,"mac":"ec38739270c0","model":"SRX300","psus":[{"name":"Power Supply 0","status":"ok"}],"recovery_version":"21.2R3-S7.7","serial":"CV2218AF1505","status":"connected","temperatures":[{"celsius":49,"name":"Routing Engine","status":"ok"},{"celsius":64,"name":"Routing Engine CPU","status":"ok"}],"uptime":580964,"vc_links":[{"neighbor_module_idx":0,"neighbor_port_id":"fxp1","port_id":"fxp1"}],"vc_role":"secondary","vc_state":"active","version":"21.2R3-S6.11"}],"module_stat":[{"backup_version":"21.2R3-S7.7","fans":[],"last_seen":1720598716.999985,"mac":"4db14e107134","model":"SRX300","psus":[{"name":"Power Supply 0","status":"ok"}],"recovery_version":"21.2R3-S7.7","serial":"CV0219AN0335","status":"connected","temperatures":[{"celsius":49,"name":"Routing Engine","status":"ok"},{"celsius":65,"name":"Routing Engine CPU","status":"ok"}],"uptime":1945193,"vc_links":[{"neighbor_module_idx":1,"neighbor_port_id":"fxp1","port_id":"fxp1"}],"vc_role":"primary","vc_state":"active","version":"21.2R3-S6.11"}],"name":"wan_srx_tor_hub1-srx","org_id":"af010e2b-f829-4975-b49e-2e896ed1d627","route_summary_stats":{"fib_routes":0,"max_unicast_routes_supported":1240000,"rib_routes":0,"total_routes":0},"serial":"CV0219AN0335","service_stat":{},"service_status":{"appid_status":"enabled","appid_version":3720,"ewf_status":"disabled","idp_install_result":"successful","idp_install_timestamp":"2024-07-10T06:29:11.708164029Z","idp_status":"disabled","idp_update_timestamp":"2024-07-10T06:28:28.567046244Z"},"site_id":"83c31971-ad70-4419-ae20-7f2b90748986","spu2_stat":[{"spu_cpu":0,"spu_current_session":39,"spu_max_session":32768,"spu_memory":31,"spu_pending_session":0,"spu_uptime":1944572,"spu_valid_session":0}],"spu_stat":[{"spu_cpu":1,"spu_current_session":47,"spu_max_session":32768,"spu_memory":34,"spu_pending_session":0,"spu_uptime":1944572,"spu_valid_session":0}],"status":"connected","tag_id":3550217,"tag_uuid":"af010e2b-f829-4975-b49e-2e896ed1d627","type":"gateway","uptime":581259,"version":"21.2R3-S6.11"}]'
                - '[{"ap_redundancy":{"num_aps":1,"num_aps_with_switch_redundancy":1},"arp_table_stats":{"arp_table_count":16,"max_entries_supported":32000},"auto_upgrade_stat":{"lastcheck":1720600596},"cert_expiry":1743932274,"clients":[{"device_mac":"0912f561b653","mac":"001132f5ad23","port_id":"ge-1/0/11"}],"clients_stats":{"total":{"num_aps":[0,0],"num_wired_clients":13}},"config_status":"COMMITED","config_timestamp":1720552389,"config_version":1720552389,"cpu_stat":{"idle":74,"interrupt":0,"load_avg":[0.8,0.75,0.78],"system":13,"user":13},"created_time":1712346090,"dhcpd_stat":{"ifo":{"num_ips":5,"num_leased":0}},"ext_ip":"153.142.221.41","fw_versions_outofsync":false,"fwupdate":{"progress":100,"status":"upgraded","status_id":3037,"timestamp":1712409702.9714448,"will_retry":false},"has_pcap":true,"hostname":"SW-HLAB-ea2e00","hw_rev":"A","id":"00000000-0000-0000-1000-0912f561b653","if_stat":{"ge-0/0/5.0":{"port_id":"ge-0/0/5","rx_bytes":0,"rx_pkts":78110,"tx_bytes":0,"tx_pkts":61037,"up":true},"ge-1/0/0.0":{"port_id":"ge-1/0/0","rx_bytes":0,"rx_pkts":56415,"tx_bytes":0,"tx_pkts":72209,"up":true},"irb.172":{"ips":["10.3.172.41/24"],"port_id":"irb","rx_bytes":0,"rx_pkts":1291755,"tx_bytes":0,"tx_pkts":990327,"up":true,"vlan":172},"vme.0":{"port_id":"vme","rx_bytes":0,"rx_pkts":0,"tx_bytes":0,"tx_pkts":0,"up":true}},"ip":"10.3.10.10","ip_stat":{"gateway":"10.3.172.9","ip":"10.3.10.10","ips":{"vlan172":"10.3.172.41"},"netmask":"255.255.255.255"},"last_seen":1720601189,"last_trouble":{"code":"103","timestamp":1712412455215},"mac":"0912f561b653","mac_table_stats":{"mac_table_count":58,"max_mac_entries_supported":64000},"memory_stat":{"usage":16},"model":"EX4100-F-12P","modified_time":1720552388,"module_stat":[{"boot_partition":"junos","cpu_stat":{"idle":74,"interrupt":0,"load_avg":[0.8,0.75,0.78],"system":13,"user":13},"fpc_idx":0,"mac":"0912f561b653","memory_stat":{"usage":16},"model":"EX4100-F-12P","pics":[{"index":0,"model_number":"EX4100-F-12P","port_groups":[{"count":12,"type":"GE"}]},{"index":1,"model_number":"EX4100-F-12P","port_groups":[{"count":4,"type":"SFP/SFP+"}]},{"index":2,"model_number":"EX4100-F-12P","port_groups":[{"count":2,"type":"GE"}]}],"poe":{"max_power":180,"power_draw":7.3},"psus":[{"name":"Power Supply 0","status":"ok"},{"name":"Power Supply 1","status":"absent"},{"name":"Power Supply 2","status":"absent"}],"serial":"FJ0324AV0077","temperatures":[{"celsius":51,"name":"Thermal board Sensor 1","status":"ok"},{"celsius":51,"name":"Thermal board Sensor 2","status":"ok"},{"celsius":50,"name":"Thermal board Sensor 3","status":"ok"},{"celsius":57,"name":"PFE Die Sensor","status":"ok"}],"type":"fpc","uptime":1692720,"vc_links":[{"neighbor_module_idx":1,"neighbor_port_id":"vcp-1/1/1","port_id":"vcp-0/1/0"},{"neighbor_module_idx":1,"neighbor_port_id":"vcp-1/1/0","port_id":"vcp-0/1/1"}],"vc_mode":"HiGiG","vc_role":"master","vc_state":"present","version":"22.4R3.25"},{"boot_partition":"junos","cpu_stat":{"idle":79,"interrupt":0,"load_avg":[0.52,0.46,0.46],"system":6,"user":15},"fpc_idx":1,"mac":"485a0deb2380","memory_stat":{"usage":14},"model":"EX4100-F-12P","pics":[{"index":0,"model_number":"EX4100-F-12P","port_groups":[{"count":12,"type":"GE"}]},{"index":1,"model_number":"EX4100-F-12P","port_groups":[{"count":4,"type":"SFP/SFP+"}]},{"index":2,"model_number":"EX4100-F-12P","port_groups":[{"count":2,"type":"GE"}]}],"poe":{"max_power":180,"power_draw":22.1},"psus":[{"name":"Power Supply 0","status":"ok"},{"name":"Power Supply 1","status":"absent"},{"name":"Power Supply 2","status":"absent"}],"serial":"FJ0424AV0101","temperatures":[{"celsius":52,"name":"Thermal board Sensor 1","status":"ok"},{"celsius":53,"name":"Thermal board Sensor 2","status":"ok"},{"celsius":52,"name":"Thermal board Sensor 3","status":"ok"},{"celsius":59,"name":"PFE Die Sensor","status":"ok"}],"type":"fpc","uptime":1692720,"vc_links":[{"neighbor_module_idx":0,"neighbor_port_id":"vcp-0/1/1","port_id":"vcp-1/1/0"},{"neighbor_module_idx":0,"neighbor_port_id":"vcp-0/1/0","port_id":"vcp-1/1/1"}],"vc_mode":"HiGiG","vc_role":"backup","vc_state":"present","version":"22.4R3.25"}],"name":"SW-HLAB-ea2e00","org_id":"c5324060-19da-48fa-af28-2b530bd08765","route_summary_stats":{"fib_routes":7,"max_unicast_routes_supported":32150,"rib_routes":40,"total_routes":3},"serial":"FJ0324AV0077","site_id":"a0e43ffb-94a6-4f27-92aa-9cf832e1143d","status":"connected","tag_id":3564806,"tag_uuid":"507604a4-6b34-449c-acb3-87955430b006","type":"switch","uptime":1692720,"vc_mac":"0912f561b653","vc_setup_info":{"config_type":"nonprovisioned","err_missing_dev_id_fpc":false},"version":"22.4R3.25"}]'
                contentMediaType: application/json
              examples:
                Access Point Stats:
                  value:
                  - auto_upgrade_stat:
                      lastcheck: 1720594762
                    ble_stat:
                      beacon_enabled: true
                      beacon_rate: 4
                      eddystone_uid_enabled: false
                      eddystone_uid_freq_msec: 1000
                      eddystone_uid_instance: 5c5b35d0077b
                      eddystone_uid_namespace: 9777c1a06ef611e68bbf
                      eddystone_url_enabled: false
                      eddystone_url_freq_msec: 1000
                      eddystone_url_url: ''
                      ibeacon_enabled: false
                      ibeacon_freq_msec: 1000
                      ibeacon_major: 894
                      ibeacon_minor: 9328
                      ibeacon_uuid: af010e2b-f829-4975-b49e-2e896ed1d627
                      major: 894
                      minors:
                      - 9328
                      - 9329
                      - 9330
                      - 9331
                      - 9332
                      - 9333
                      - 9334
                      - 9335
                      - -1
                      power: 8
                      rx_bytes: 158500843
                      rx_pkts: 3549163
                      tx_bytes: 509640
                      tx_pkts: 85411
                      tx_resets: 0
                      uuid: af010e2b-f829-4975-b49e-2e896ed1d627
                    config_reverted: false
                    cpu_system: 21921854
                    cpu_user: 7496631
                    cpu_util: 5
                    created_time: 1718228350
                    env_stat:
                      accel_x: -0.092
                      accel_y: 0.004
                      accel_z: -1.02
                      ambient_temp: 43
                      attitude: 0
                      cpu_temp: 53
                      humidity: 9
                      magne_x: 0
                      magne_y: 0
                      magne_z: 0
                      pressure: 968
                      vcore_voltage: 0
                    ext_ip: 66.129.234.28
                    hw_rev: C02
                    id: 00000000-0000-0000-1000-5c5b35d0077b
                    inactive_wired_vlans: []
                    ip: 192.168.95.3
                    ip_stat:
                      dhcp_server: 192.168.95.1
                      dns:
                      - 8.8.8.8
                      gateway: 192.168.95.1
                      ip: 192.168.95.3
                      ip6: fe80:0:0:0:5e5b:35ff:fed0:77b
                      ips:
                        vlan1: 192.168.95.3/24,fe80:0:0:0:5e5b:35ff:fed0:77b/64
                      netmask: 255.255.255.0
                      netmask6: /64
                    last_seen: 1720595866
                    last_trouble:
                      code: '07'
                      timestamp: 1720039666
                    lldp_stat:
                      chassis_id: d0:07:ca:f5:21:00
                      lldp_med_supported: false
                      mgmt_addr: 100.123.105.1
                      mgmt_addrs:
                      - 100.123.105.1
                      port_desc: ge-0/0/4
                      port_id: ge-0/0/4
                      power_allocated: 0
                      power_draw: 0
                      power_request_count: 0
                      power_requested: 0
                      system_desc: 'Juniper Networks, Inc. ex4300-48t internet router, kernel JUNOS 20.4R3-S7.2, Build date: 2023-04-21 19:47:18 UTC Copyright (c) 1996-2023 Juniper Networks, Inc.'
                      system_name: Phoenix-Switch
                    mac: 5c5b35d0077b
                    mem_total_kb: 505468
                    mem_used_kb: 202096
                    model: AP43
                    modified_time: 1718530662
                    mount: faceup
                    name: Phoenix
                    notes: ''
                    num_clients: 1
                    org_id: af010e2b-f829-4975-b49e-2e896ed1d627
                    port_stat:
                      eth0:
                        full_duplex: true
                        rx_bytes: 1284143195
                        rx_errors: 0
                        rx_peak_bps: 17585
                        rx_pkts: 5199816
                        speed: 1000
                        tx_bytes: 1283744961
                        tx_peak_bps: 26484
                        tx_pkts: 3990463
                        up: true
                      eth1:
                        full_duplex: false
                        rx_bytes: 0
                        rx_errors: 0
                        rx_peak_bps: 0
                        rx_pkts: 0
                        speed: 0
                        tx_bytes: 0
                        tx_peak_bps: 0
                        tx_pkts: 0
                        up: false
                    power_budget: 8400
                    power_constrained: false
                    power_src: DC Input
                    radio_config: {}
                    radio_stat:
                      band_24:
                        bandwidth: 20
                        channel: 11
                        mac: 5c5b35dea810
                        noise_floor: -80
                        num_clients: 0
                        power: 17
                        rx_bytes: 12948211
                        rx_pkts: 65292
                        tx_bytes: 19071943
                        tx_pkts: 76926
                        usage: '24'
                        util_all: 24
                        util_non_wifi: 2
                        util_rx_in_bss: 0
                        util_rx_other_bss: 17
                        util_tx: 4
                        util_undecodable_wifi: 0
                        util_unknown_wifi: 1
                      band_5:
                        bandwidth: 40
                        channel: 36
                        mac: 5c5b35dea7f0
                        noise_floor: -90
                        num_clients: 1
                        power: 17
                        rx_bytes: 578362619
                        rx_pkts: 2687577
                        tx_bytes: 1199571353
                        tx_pkts: 2479302
                        usage: '5'
                        util_all: 13
                        util_non_wifi: 0
                        util_rx_in_bss: 0
                        util_rx_other_bss: 10
                        util_tx: 1
                        util_undecodable_wifi: 0
                        util_unknown_wifi: 1
                    rx_bps: 9276
                    rx_bytes: 591310830
                    rx_pkts: 2752869
                    serial: A0703200709E6
                    site_id: 46fc665e-9706-4296-8fe2-78f42f2e67e4
                    status: connected
                    switch_redundancy:
                      num_redundant_aps: 1
                    tx_bps: 8067
                    tx_bytes: 1218643296
                    tx_pkts: 2556228
                    type: ap
                    uptime: 1593120
                    version: 0.14.29313
                Gateway Stats:
                  value:
                  - arp_table_stats:
                      arp_table_count: 21
                      max_entries_supported: 64000
                    auto_upgrade_stat:
                      lastcheck: 1720595477
                    cert_expiry: 1743292763
                    cluster_config:
                      configuration: active-active
                      control_link_info:
                        name: fxp1
                        status: Up
                      ethernet_connection:
                      - name: reth0
                        status: Up
                      - name: reth1
                        status: Up
                      - name: reth2
                        status: Down
                      - name: reth3
                        status: Down
                      - name: reth4
                        status: Up
                      fabric_link_info:
                        DataPlaneNotifiedStatus: Up
                        Interface: []
                        InternalStatus: Up
                        State: Enabled
                        Status: Enabled
                      last_status_change_reason: No failures
                      operational: active-active
                      primary_node_health: Healthy
                      redundancy_group_information:
                      - Id: 0
                        MonitoringFailure: none
                        Threshold: 255
                      - Id: 1
                        MonitoringFailure: interface-monitoring
                        Threshold: 0
                      - Id: 2
                        MonitoringFailure: none
                        Threshold: 255
                      secondary_node_health: Not healthy
                      status: Green
                    config_status: COMMITED
                    config_timestamp: 1720182848
                    config_version: 1720182848
                    cpu2_stat:
                      idle: 86
                      interrupt: 0
                      load_avg:
                      - 0.13
                      - 0.17
                      - 0.16
                      system: 5
                      user: 9
                    cpu_stat:
                      idle: 76
                      interrupt: 0
                      load_avg:
                      - 0.18
                      - 0.31
                      - 0.39
                      system: 10
                      user: 14
                    created_time: 1711756611
                    deviceprofile_id: 5e5daedf-e650-4013-b41c-845f0d2b9414
                    deviceprofile_name: wan_srx_tor_hub1
                    dhcpd_stat:
                      byod_dc1:
                        num_ips: 100
                        num_leased: 0
                      corp_dc1:
                        num_ips: 100
                        num_leased: 4
                      guest_dc1:
                        num_ips: 241
                        num_leased: 0
                      iot_dc1:
                        num_ips: 100
                        num_leased: 0
                      mgmt_dc1:
                        num_ips: 100
                        num_leased: 2
                      teleworker:
                        num_ips: 140
                        num_leased: 0
                    ext_ip: 69.196.157.189
                    fwupdate:
                      progress: 100
                      status: upgraded
                      status_id: 3037
                      timestamp: 1718392692.580769
                      will_retry: false
                    has_pcap: false
                    hostname: wan_srx_tor_hub1-srx
                    id: 00000000-0000-0000-1000-4db14e107134
                    if_stat:
                      ge-0/0/5.130:
                        address_mode: Unknown
                        nat_addresses: []
                        network_name: ''
                        port_id: ge-0/0/5
                        port_usage: lan
                        rx_bytes: 0
                        rx_pkts: 0
                        tx_bytes: 0
                        tx_pkts: 0
                        up: true
                        vlan: 0
                      ge-1/0/5.120:
                        address_mode: Unknown
                        nat_addresses: []
                        network_name: ''
                        port_id: ge-1/0/5
                        port_usage: lan
                        rx_bytes: 0
                        rx_pkts: 0
                        tx_bytes: 0
                        tx_pkts: 0
                        up: true
                        vlan: 0
                    ip: 69.196.157.190
                    ip_stat:
                      gateway: 69.196.157.185
                      ip: 69.196.157.190
                      ips:
                        vlan1: 69.196.157.190,69.196.157.190
                      netmask: 255.255.255.255
                    is_ha: true
                    last_seen: 1720598726
                    mac: 4db14e107134
                    mac_table_stats:
                      mac_table_count: 0
                      max_mac_entries_supported: 160000
                    memory2_stat:
                      usage: 32
                    memory_stat:
                      usage: 39
                    model: SRX300
                    modified_time: 1720092942
                    module2_stat:
                    - backup_version: 21.2R3-S7.7
                      fans: []
                      last_seen: 1720598717
                      mac: ec38739270c0
                      model: SRX300
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.2R3-S7.7
                      serial: CV2218AF1505
                      status: connected
                      temperatures:
                      - celsius: 49
                        name: Routing Engine
                        status: ok
                      - celsius: 64
                        name: Routing Engine CPU
                        status: ok
                      uptime: 580964
                      vc_links:
                      - neighbor_module_idx: 0
                        neighbor_port_id: fxp1
                        port_id: fxp1
                      vc_role: secondary
                      vc_state: active
                      version: 21.2R3-S6.11
                    module_stat:
                    - backup_version: 21.2R3-S7.7
                      fans: []
                      last_seen: 1720598716.999985
                      mac: 4db14e107134
                      model: SRX300
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.2R3-S7.7
                      serial: CV0219AN0335
                      status: connected
                      temperatures:
                      - celsius: 49
                        name: Routing Engine
                        status: ok
                      - celsius: 65
                        name: Routing Engine CPU
                        status: ok
                      uptime: 1945193
                      vc_links:
                      - neighbor_module_idx: 1
                        neighbor_port_id: fxp1
                        port_id: fxp1
                      vc_role: primary
                      vc_state: active
                      version: 21.2R3-S6.11
                    name: wan_srx_tor_hub1-srx
                    org_id: af010e2b-f829-4975-b49e-2e896ed1d627
                    route_summary_stats:
                      fib_routes: 0
                      max_unicast_routes_supported: 1240000
                      rib_routes: 0
                      total_routes: 0
                    serial: CV0219AN0335
                    service_stat: {}
                    service_status:
                      appid_status: enabled
                      appid_version: 3720
                      ewf_status: disabled
                      idp_install_result: successful
                      idp_install_timestamp: 2024-07-10T06:29:11.708164029Z
                      idp_status: disabled
                      idp_update_timestamp: 2024-07-10T06:28:28.567046244Z
                    site_id: 83c31971-ad70-4419-ae20-7f2b90748986
                    spu2_stat:
                    - spu_cpu: 0
                      spu_current_session: 39
                      spu_max_session: 32768
                      spu_memory: 31
                      spu_pending_session: 0
                      spu_uptime: 1944572
                      spu_valid_session: 0
                    spu_stat:
                    - spu_cpu: 1
                      spu_current_session: 47
                      spu_max_session: 32768
                      spu_memory: 34
                      spu_pending_session: 0
                      spu_uptime: 1944572
                      spu_valid_session: 0
                    status: connected
                    tag_id: 3550217
                    tag_uuid: af010e2b-f829-4975-b49e-2e896ed1d627
                    type: gateway
                    uptime: 581259
                    version: 21.2R3-S6.11
                Switch Stats:
                  value:
                  - ap_redundancy:
                      num_aps: 1
                      num_aps_with_switch_redundancy: 1
                    arp_table_stats:
                      arp_table_count: 16
                      max_entries_supported: 32000
                    auto_upgrade_stat:
                      lastcheck: 1720600596
                    cert_expiry: 1743932274
                    clients:
                    - device_mac: 0912f561b653
                      mac: 001132f5ad23
                      port_id: ge-1/0/11
                    clients_stats:
                      total:
                        num_aps:
                        - 0
                        - 0
                        num_wired_clients: 13
                    config_status: COMMITED
                    config_timestamp: 1720552389
                    config_version: 1720552389
                    cpu_stat:
                      idle: 74
                      interrupt: 0
                      load_avg:
                      - 0.8
                      - 0.75
                      - 0.78
                      system: 13
                      user: 13
                    created_time: 1712346090
                    dhcpd_stat:
                      ifo:
                        num_ips: 5
                        num_leased: 0
                    ext_ip: 153.142.221.41
                    fw_versions_outofsync: false
                    fwupdate:
                      progress: 100
                      status: upgraded
                      status_id: 3037
                      timestamp: 1712409702.9714448
                      will_retry: false
                    has_pcap: true
                    hostname: SW-HLAB-ea2e00
                    hw_rev: A
                    id: 00000000-0000-0000-1000-0912f561b653
                    if_stat:
                      ge-0/0/5.0:
                        port_id: ge-0/0/5
                        rx_bytes: 0
                        rx_pkts: 78110
                        tx_bytes: 0
                        tx_pkts: 61037
                        up: true
                      ge-1/0/0.0:
                        port_id: ge-1/0/0
                        rx_bytes: 0
                        rx_pkts: 56415
                        tx_bytes: 0
                        tx_pkts: 72209
                        up: true
                      irb.172:
                        ips:
                        - 10.3.172.41/24
                        port_id: irb
                        rx_bytes: 0
                        rx_pkts: 1291755
                        tx_bytes: 0
                        tx_pkts: 990327
                        up: true
                        vlan: 172
                      vme.0:
                        port_id: vme
                        rx_bytes: 0
                        rx_pkts: 0
                        tx_bytes: 0
                        tx_pkts: 0
                        up: true
                    ip: 10.3.10.10
                    ip_stat:
                      gateway: 10.3.172.9
                      ip: 10.3.10.10
                      ips:
                        vlan172: 10.3.172.41
                      netmask: 255.255.255.255
                    last_seen: 1720601189
                    last_trouble:
                      code: '103'
                      timestamp: 1712412455215
                    mac: 0912f561b653
                    mac_table_stats:
                      mac_table_count: 58
                      max_mac_entries_supported: 64000
                    memory_stat:
                      usage: 16
                    model: EX4100-F-12P
                    modified_time: 1720552388
                    module_stat:
                    - boot_partition: junos
                      cpu_stat:
                        idle: 74
                        interrupt: 0
                        load_avg:
                        - 0.8
                        - 0.75
                        - 0.78
                        system: 13
                        user: 13
                      fpc_idx: 0
                      mac: 0912f561b653
                      memory_stat:
                        usage: 16
                      model: EX4100-F-12P
                      pics:
                      - index: 0
                        model_number: EX4100-F-12P
                        port_groups:
                        - count: 12
                          type: GE
                      - index: 1
                        model_number: EX4100-F-12P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      - index: 2
                        model_number: EX4100-F-12P
                        port_groups:
                        - count: 2
                          type: GE
                      poe:
                        max_power: 180
                        power_draw: 7.3
                      psus:
                      - name: Power Supply 0
                        status: ok
                      - name: Power Supply 1
                        status: absent
                      - name: Power Supply 2
                        status: absent
                      serial: FJ0324AV0077
                      temperatures:
                      - celsius: 51
                        name: Thermal board Sensor 1
                        status: ok
                      - celsius: 51
                        name: Thermal board Sensor 2
                        status: ok
                      - celsius: 50
                        name: Thermal board Sensor 3
                        status: ok
                      - celsius: 57
                        name: PFE Die Sensor
                        status: ok
                      type: fpc
                      uptime: 1692720
                      vc_links:
                      - neighbor_module_idx: 1
                        neighbor_port_id: vcp-1/1/1
                        port_id: vcp-0/1/0
                      - neighbor_module_idx: 1
                        neighbor_port_id: vcp-1/1/0
                        port_id: vcp-0/1/1
                      vc_mode: HiGiG
                      vc_role: master
                      vc_state: present
                      version: 22.4R3.25
                    - boot_partition: junos
                      cpu_stat:
                        idle: 79
                        interrupt: 0
                        load_avg:
                        - 0.52
                        - 0.46
                        - 0.46
                        system: 6
                        user: 15
                      fpc_idx: 1
                      mac: 485a0deb2380
                      memory_stat:
                        usage: 14
                      model: EX4100-F-12P
                      pics:
                      - index: 0
                        model_number: EX4100-F-12P
                        port_groups:
                        - count: 12
                          type: GE
                      - index: 1
                        model_number: EX4100-F-12P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      - index: 2
                        model_number: EX4100-F-12P
                        port_groups:
                        - count: 2
                          type: GE
                      poe:
                        max_power: 180
                        power_draw: 22.1
                      psus:
                      - name: Power Supply 0
                        status: ok
                      - name: Power Supply 1
                        status: absent
                      - name: Power Supply 2
                        status: absent
                      serial: FJ0424AV0101
                      temperatures:
                      - celsius: 52
                        name: Thermal board Sensor 1
                        status: ok
                      - celsius: 53
                        name: Thermal board Sensor 2
                        status: ok
                      - celsius: 52
                        name: Thermal board Sensor 3
                        status: ok
                      - celsius: 59
                        name: PFE Die Sensor
                        status: ok
                      type: fpc
                      uptime: 1692720
                      vc_links:
                      - neighbor_module_idx: 0
                        neighbor_port_id: vcp-0/1/1
                        port_id: vcp-1/1/0
                      - neighbor_module_idx: 0
                        neighbor_port_id: vcp-0/1/0
                        port_id: vcp-1/1/1
                      vc_mode: HiGiG
                      vc_role: backup
                      vc_state: present
                      version: 22.4R3.25
                    name: SW-HLAB-ea2e00
                    org_id: c5324060-19da-48fa-af28-2b530bd08765
                    route_summary_stats:
                      fib_routes: 7
                      max_unicast_routes_supported: 32150
                      rib_routes: 40
                      total_routes: 3
                    serial: FJ0324AV0077
                    site_id: a0e43ffb-94a6-4f27-92aa-9cf832e1143d
                    status: connected
                    tag_id: 3564806
                    tag_uuid: 507604a4-6b34-449c-acb3-87955430b006
                    type: switch
                    uptime: 1692720
                    vc_mac: 0912f561b653
                    vc_setup_info:
                      config_type: nonprovisioned
                      err_missing_dev_id_fpc: false
                    version: 22.4R3.25
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/stats_device'
                description: Device statistics records returned by a stats response
                examples:
                - '[{"auto_upgrade_stat":{"lastcheck":1720594762},"ble_stat":{"beacon_enabled":true,"beacon_rate":4,"eddystone_uid_enabled":false,"eddystone_uid_freq_msec":1000,"eddystone_uid_instance":"5c5b35d0077b","eddystone_uid_namespace":"9777c1a06ef611e68bbf","eddystone_url_enabled":false,"eddystone_url_freq_msec":1000,"eddystone_url_url":"","ibeacon_enabled":false,"ibeacon_freq_msec":1000,"ibeacon_major":894,"ibeacon_minor":9328,"ibeacon_uuid":"af010e2b-f829-4975-b49e-2e896ed1d627","major":894,"minors":[9328,9329,9330,9331,9332,9333,9334,9335,-1],"power":8,"rx_bytes":158500843,"rx_pkts":3549163,"tx_bytes":509640,"tx_pkts":85411,"tx_resets":0,"uuid":"af010e2b-f829-4975-b49e-2e896ed1d627"},"config_reverted":false,"cpu_system":21921854,"cpu_user":7496631,"cpu_util":5,"created_time":1718228350,"env_stat":{"accel_x":-0.092,"accel_y":0.004,"accel_z":-1.02,"ambient_temp":43,"attitude":0,"cpu_temp":53,"humidity":9,"magne_x":0,"magne_y":0,"magne_z":0,"pressure":968,"vcore_voltage":0},"ext_ip":"66.129.234.28","hw_rev":"C02","id":"00000000-0000-0000-1000-5c5b35d0077b","inactive_wired_vlans":[],"ip":"192.168.95.3","ip_stat":{"dhcp_server":"192.168.95.1","dns":["8.8.8.8"],"gateway":"192.168.95.1","ip":"192.168.95.3","ip6":"fe80:0:0:0:5e5b:35ff:fed0:77b","ips":{"vlan1":"192.168.95.3/24,fe80:0:0:0:5e5b:35ff:fed0:77b/64"},"netmask":"255.255.255.0","netmask6":"/64"},"last_seen":1720595866,"last_trouble":{"code":"07","timestamp":1720039666},"lldp_stat":{"chassis_id":"d0:07:ca:f5:21:00","lldp_med_supported":false,"mgmt_addr":"100.123.105.1","mgmt_addrs":["100.123.105.1"],"port_desc":"ge-0/0/4","port_id":"ge-0/0/4","power_allocated":0,"power_draw":0,"power_request_count":0,"power_requested":0,"system_desc":"Juniper Networks, Inc. ex4300-48t internet router, kernel JUNOS 20.4R3-S7.2, Build date: 2023-04-21 19:47:18 UTC Copyright (c) 1996-2023 Juniper Networks, Inc.","system_name":"Phoenix-Switch"},"mac":"5c5b35d0077b","mem_total_kb":505468,"mem_used_kb":202096,"model":"AP43","modified_time":1718530662,"mount":"faceup","name":"Phoenix","notes":"","num_clients":1,"org_id":"af010e2b-f829-4975-b49e-2e896ed1d627","port_stat":{"eth0":{"full_duplex":true,"rx_bytes":1284143195,"rx_errors":0,"rx_peak_bps":17585,"rx_pkts":5199816,"speed":1000,"tx_bytes":1283744961,"tx_peak_bps":26484,"tx_pkts":3990463,"up":true},"eth1":{"full_duplex":false,"rx_bytes":0,"rx_errors":0,"rx_peak_bps":0,"rx_pkts":0,"speed":0,"tx_bytes":0,"tx_peak_bps":0,"tx_pkts":0,"up":false}},"power_budget":8400,"power_constrained":false,"power_src":"DC Input","radio_config":{},"radio_stat":{"band_24":{"bandwidth":20,"channel":11,"mac":"5c5b35dea810","noise_floor":-80,"num_clients":0,"power":17,"rx_bytes":12948211,"rx_pkts":65292,"tx_bytes":19071943,"tx_pkts":76926,"usage":"24","util_all":24,"util_non_wifi":2,"util_rx_in_bss":0,"util_rx_other_bss":17,"util_tx":4,"util_undecodable_wifi":0,"util_unknown_wifi":1},"band_5":{"bandwidth":40,"channel":36,"mac":"5c5b35dea7f0","noise_floor":-90,"num_clients":1,"power":17,"rx_bytes":578362619,"rx_pkts":2687577,"tx_bytes":1199571353,"tx_pkts":2479302,"usage":"5","util_all":13,"util_non_wifi":0,"util_rx_in_bss":0,"util_rx_other_bss":10,"util_tx":1,"util_undecodable_wifi":0,"util_unknown_wifi":1}},"rx_bps":9276,"rx_bytes":591310830,"rx_pkts":2752869,"serial":"A0703200709E6","site_id":"46fc665e-9706-4296-8fe2-78f42f2e67e4","status":"connected","switch_redundancy":{"num_redundant_aps":1},"tx_bps":8067,"tx_bytes":1218643296,"tx_pkts":2556228,"type":"ap","uptime":1593120,"version":"0.14.29313"}]'
                - '[{"arp_table_stats":{"arp_table_count":21,"max_entries_supported":64000},"auto_upgrade_stat":{"lastcheck":1720595477},"cert_expiry":1743292763,"cluster_config":{"configuration":"active-active","control_link_info":{"name":"fxp1","status":"Up"},"ethernet_connection":[{"name":"reth0","status":"Up"},{"name":"reth1","status":"Up"},{"name":"reth2","status":"Down"},{"name":"reth3","status":"Down"},{"name":"reth4","status":"Up"}],"fabric_link_info":{"DataPlaneNotifiedStatus":"Up","Interface":[],"InternalStatus":"Up","State":"Enabled","Status":"Enabled"},"last_status_change_reason":"No failures","operational":"active-active","primary_node_health":"Healthy","redundancy_group_information":[{"Id":0,"MonitoringFailure":"none","Threshold":255},{"Id":1,"MonitoringFailure":"interface-monitoring","Threshold":0},{"Id":2,"MonitoringFailure":"none","Threshold":255}],"secondary_node_health":"Not healthy","status":"Green"},"config_status":"COMMITED","config_timestamp":1720182848,"config_version":1720182848,"cpu2_stat":{"idle":86,"interrupt":0,"load_avg":[0.13,0.17,0.16],"system":5,"user":9},"cpu_stat":{"idle":76,"interrupt":0,"load_avg":[0.18,0.31,0.39],"system":10,"user":14},"created_time":1711756611,"deviceprofile_id":"5e5daedf-e650-4013-b41c-845f0d2b9414","deviceprofile_name":"wan_srx_tor_hub1","dhcpd_stat":{"byod_dc1":{"num_ips":100,"num_leased":0},"corp_dc1":{"num_ips":100,"num_leased":4},"guest_dc1":{"num_ips":241,"num_leased":0},"iot_dc1":{"num_ips":100,"num_leased":0},"mgmt_dc1":{"num_ips":100,"num_leased":2},"teleworker":{"num_ips":140,"num_leased":0}},"ext_ip":"69.196.157.189","fwupdate":{"progress":100,"status":"upgraded","status_id":3037,"timestamp":1718392692.580769,"will_retry":false},"has_pcap":false,"hostname":"wan_srx_tor_hub1-srx","id":"00000000-0000-0000-1000-4db14e107134","if_stat":{"ge-0/0/5.130":{"address_mode":"Unknown","nat_addresses":[],"network_name":"","port_id":"ge-0/0/5","port_usage":"lan","rx_bytes":0,"rx_pkts":0,"tx_bytes":0,"tx_pkts":0,"up":true,"vlan":0},"ge-1/0/5.120":{"address_mode":"Unknown","nat_addresses":[],"network_name":"","port_id":"ge-1/0/5","port_usage":"lan","rx_bytes":0,"rx_pkts":0,"tx_bytes":0,"tx_pkts":0,"up":true,"vlan":0}},"ip":"69.196.157.190","ip_stat":{"gateway":"69.196.157.185","ip":"69.196.157.190","ips":{"vlan1":"69.196.157.190,69.196.157.190"},"netmask":"255.255.255.255"},"is_ha":true,"last_seen":1720598726,"mac":"4db14e107134","mac_table_stats":{"mac_table_count":0,"max_mac_entries_supported":160000},"memory2_stat":{"usage":32},"memory_stat":{"usage":39},"model":"SRX300","modified_time":1720092942,"module2_stat":[{"backup_version":"21.2R3-S7.7","fans":[],"last_seen":1720598717,"mac":"ec38739270c0","model":"SRX300","psus":[{"name":"Power Supply 0","status":"ok"}],"recovery_version":"21.2R3-S7.7","serial":"CV2218AF1505","status":"connected","temperatures":[{"celsius":49,"name":"Routing Engine","status":"ok"},{"celsius":64,"name":"Routing Engine CPU","status":"ok"}],"uptime":580964,"vc_links":[{"neighbor_module_idx":0,"neighbor_port_id":"fxp1","port_id":"fxp1"}],"vc_role":"secondary","vc_state":"active","version":"21.2R3-S6.11"}],"module_stat":[{"backup_version":"21.2R3-S7.7","fans":[],"last_seen":1720598716.999985,"mac":"4db14e107134","model":"SRX300","psus":[{"name":"Power Supply 0","status":"ok"}],"recovery_version":"21.2R3-S7.7","serial":"CV0219AN0335","status":"connected","temperatures":[{"celsius":49,"name":"Routing Engine","status":"ok"},{"celsius":65,"name":"Routing Engine CPU","status":"ok"}],"uptime":1945193,"vc_links":[{"neighbor_module_idx":1,"neighbor_port_id":"fxp1","port_id":"fxp1"}],"vc_role":"primary","vc_state":"active","version":"21.2R3-S6.11"}],"name":"wan_srx_tor_hub1-srx","org_id":"af010e2b-f829-4975-b49e-2e896ed1d627","route_summary_stats":{"fib_routes":0,"max_unicast_routes_supported":1240000,"rib_routes":0,"total_routes":0},"serial":"CV0219AN0335","service_stat":{},"service_status":{"appid_status":"enabled","appid_version":3720,"ewf_status":"disabled","idp_install_result":"successful","idp_install_timestamp":"2024-07-10T06:29:11.708164029Z","idp_status":"disabled","idp_update_timestamp":"2024-07-10T06:28:28.567046244Z"},"site_id":"83c31971-ad70-4419-ae20-7f2b90748986","spu2_stat":[{"spu_cpu":0,"spu_current_session":39,"spu_max_session":32768,"spu_memory":31,"spu_pending_session":0,"spu_uptime":1944572,"spu_valid_session":0}],"spu_stat":[{"spu_cpu":1,"spu_current_session":47,"spu_max_session":32768,"spu_memory":34,"spu_pending_session":0,"spu_uptime":1944572,"spu_valid_session":0}],"status":"connected","tag_id":3550217,"tag_uuid":"af010e2b-f829-4975-b49e-2e896ed1d627","type":"gateway","uptime":581259,"version":"21.2R3-S6.11"}]'
                - '[{"ap_redundancy":{"num_aps":1,"num_aps_with_switch_redundancy":1},"arp_table_stats":{"arp_table_count":16,"max_entries_supported":32000},"auto_upgrade_stat":{"lastcheck":1720600596},"cert_expiry":1743932274,"clients":[{"device_mac":"0912f561b653","mac":"001132f5ad23","port_id":"ge-1/0/11"}],"clients_stats":{"total":{"num_aps":[0,0],"num_wired_clients":13}},"config_status":"COMMITED","config_timestamp":1720552389,"config_version":1720552389,"cpu_stat":{"idle":74,"interrupt":0,"load_avg":[0.8,0.75,0.78],"system":13,"user":13},"created_time":1712346090,"dhcpd_stat":{"ifo":{"num_ips":5,"num_leased":0}},"ext_ip":"153.142.221.41","fw_versions_outofsync":false,"fwupdate":{"progress":100,"status":"upgraded","status_id":3037,"timestamp":1712409702.9714448,"will_retry":false},"has_pcap":true,"hostname":"SW-HLAB-ea2e00","hw_rev":"A","id":"00000000-0000-0000-1000-0912f561b653","if_stat":{"ge-0/0/5.0":{"port_id":"ge-0/0/5","rx_bytes":0,"rx_pkts":78110,"tx_bytes":0,"tx_pkts":61037,"up":true},"ge-1/0/0.0":{"port_id":"ge-1/0/0","rx_bytes":0,"rx_pkts":56415,"tx_bytes":0,"tx_pkts":72209,"up":true},"irb.172":{"ips":["10.3.172.41/24"],"port_id":"irb","rx_bytes":0,"rx_pkts":1291755,"tx_bytes":0,"tx_pkts":990327,"up":true,"vlan":172},"vme.0":{"port_id":"vme","rx_bytes":0,"rx_pkts":0,"tx_bytes":0,"tx_pkts":0,"up":true}},"ip":"10.3.10.10","ip_stat":{"gateway":"10.3.172.9","ip":"10.3.10.10","ips":{"vlan172":"10.3.172.41"},"netmask":"255.255.255.255"},"last_seen":1720601189,"last_trouble":{"code":"103","timestamp":1712412455215},"mac":"0912f561b653","mac_table_stats":{"mac_table_count":58,"max_mac_entries_supported":64000},"memory_stat":{"usage":16},"model":"EX4100-F-12P","modified_time":1720552388,"module_stat":[{"boot_partition":"junos","cpu_stat":{"idle":74,"interrupt":0,"load_avg":[0.8,0.75,0.78],"system":13,"user":13},"fpc_idx":0,"mac":"0912f561b653","memory_stat":{"usage":16},"model":"EX4100-F-12P","pics":[{"index":0,"model_number":"EX4100-F-12P","port_groups":[{"count":12,"type":"GE"}]},{"index":1,"model_number":"EX4100-F-12P","port_groups":[{"count":4,"type":"SFP/SFP+"}]},{"index":2,"model_number":"EX4100-F-12P","port_groups":[{"count":2,"type":"GE"}]}],"poe":{"max_power":180,"power_draw":7.3},"psus":[{"name":"Power Supply 0","status":"ok"},{"name":"Power Supply 1","status":"absent"},{"name":"Power Supply 2","status":"absent"}],"serial":"FJ0324AV0077","temperatures":[{"celsius":51,"name":"Thermal board Sensor 1","status":"ok"},{"celsius":51,"name":"Thermal board Sensor 2","status":"ok"},{"celsius":50,"name":"Thermal board Sensor 3","status":"ok"},{"celsius":57,"name":"PFE Die Sensor","status":"ok"}],"type":"fpc","uptime":1692720,"vc_links":[{"neighbor_module_idx":1,"neighbor_port_id":"vcp-1/1/1","port_id":"vcp-0/1/0"},{"neighbor_module_idx":1,"neighbor_port_id":"vcp-1/1/0","port_id":"vcp-0/1/1"}],"vc_mode":"HiGiG","vc_role":"master","vc_state":"present","version":"22.4R3.25"},{"boot_partition":"junos","cpu_stat":{"idle":79,"interrupt":0,"load_avg":[0.52,0.46,0.46],"system":6,"user":15},"fpc_idx":1,"mac":"485a0deb2380","memory_stat":{"usage":14},"model":"EX4100-F-12P","pics":[{"index":0,"model_number":"EX4100-F-12P","port_groups":[{"count":12,"type":"GE"}]},{"index":1,"model_number":"EX4100-F-12P","port_groups":[{"count":4,"type":"SFP/SFP+"}]},{"index":2,"model_number":"EX4100-F-12P","port_groups":[{"count":2,"type":"GE"}]}],"poe":{"max_power":180,"power_draw":22.1},"psus":[{"name":"Power Supply 0","status":"ok"},{"name":"Power Supply 1","status":"absent"},{"name":"Power Supply 2","status":"absent"}],"serial":"FJ0424AV0101","temperatures":[{"celsius":52,"name":"Thermal board Sensor 1","status":"ok"},{"celsius":53,"name":"Thermal board Sensor 2","status":"ok"},{"celsius":52,"name":"Thermal board Sensor 3","status":"ok"},{"celsius":59,"name":"PFE Die Sensor","status":"ok"}],"type":"fpc","uptime":1692720,"vc_links":[{"neighbor_module_idx":0,"neighbor_port_id":"vcp-0/1/1","port_id":"vcp-1/1/0"},{"neighbor_module_idx":0,"neighbor_port_id":"vcp-0/1/0","port_id":"vcp-1/1/1"}],"vc_mode":"HiGiG","vc_role":"backup","vc_state":"present","version":"22.4R3.25"}],"name":"SW-HLAB-ea2e00","org_id":"c5324060-19da-48fa-af28-2b530bd08765","route_summary_stats":{"fib_routes":7,"max_unicast_routes_supported":32150,"rib_routes":40,"total_routes":3},"serial":"FJ0324AV0077","site_id":"a0e43ffb-94a6-4f27-92aa-9cf832e1143d","status":"connected","tag_id":3564806,"tag_uuid":"507604a4-6b34-449c-acb3-87955430b006","type":"switch","uptime":1692720,"vc_mac":"0912f561b653","vc_setup_info":{"config_type":"nonprovisioned","err_missing_dev_id_fpc":false},"version":"22.4R3.25"}]'
                contentMediaType: application/vnd.api+json
              examples:
                Access Point Stats:
                  value:
                  - auto_upgrade_stat:
                      lastcheck: 1720594762
                    ble_stat:
                      beacon_enabled: true
                      beacon_rate: 4
                      eddystone_uid_enabled: false
                      eddystone_uid_freq_msec: 1000
                      eddystone_uid_instance: 5c5b35d0077b
                      eddystone_uid_namespace: 9777c1a06ef611e68bbf
                      eddystone_url_enabled: false
                      eddystone_url_freq_msec: 1000
                      eddystone_url_url: ''
                      ibeacon_enabled: false
                      ibeacon_freq_msec: 1000
                      ibeacon_major: 894
                      ibeacon_minor: 9328
                      ibeacon_uuid: af010e2b-f829-4975-b49e-2e896ed1d627
                      major: 894
                      minors:
                      - 9328
                      - 9329
                      - 9330
                      - 9331
                      - 9332
                      - 9333
                      - 9334
                      - 9335
                      - -1
                      power: 8
                      rx_bytes: 158500843
                      rx_pkts: 3549163
                      tx_bytes: 509640
                      tx_pkts: 85411
                      tx_resets: 0
                      uuid: af010e2b-f829-4975-b49e-2e896ed1d627
                    config_reverted: false
                    cpu_system: 21921854
                    cpu_user: 7496631
                    cpu_util: 5
                    created_time: 1718228350
                    env_stat:
                      accel_x: -0.092
                      accel_y: 0.004
                      accel_z: -1.02
                      ambient_temp: 43
                      attitude: 0
                      cpu_temp: 53
                      humidity: 9
                      magne_x: 0
                      magne_y: 0
                      magne_z: 0
                      pressure: 968
                      vcore_voltage: 0
                    ext_ip: 66.129.234.28
                    hw_rev: C02
                    id: 00000000-0000-0000-1000-5c5b35d0077b
                    inactive_wired_vlans: []
                    ip: 192.168.95.3
                    ip_stat:
                      dhcp_server: 192.168.95.1
                      dns:
                      - 8.8.8.8
                      gateway: 192.168.95.1
                      ip: 192.168.95.3
                      ip6: fe80:0:0:0:5e5b:35ff:fed0:77b
                      ips:
                        vlan1: 192.168.95.3/24,fe80:0:0:0:5e5b:35ff:fed0:77b/64
                      netmask: 255.255.255.0
                      netmask6: /64
                    last_seen: 1720595866
                    last_trouble:
                      code: '07'
                      timestamp: 1720039666
                    lldp_stat:
                      chassis_id: d0:07:ca:f5:21:00
                      lldp_med_supported: false
                      mgmt_addr: 100.123.105.1
                      mgmt_addrs:
                      - 100.123.105.1
                      port_desc: ge-0/0/4
                      port_id: ge-0/0/4
                      power_allocated: 0
                      power_draw: 0
                      power_request_count: 0
                      power_requested: 0
                      system_desc: 'Juniper Networks, Inc. ex4300-48t internet router, kernel JUNOS 20.4R3-S7.2, Build date: 2023-04-21 19:47:18 UTC Copyright (c) 1996-2023 Juniper Networks, Inc.'
                      system_name: Phoenix-Switch
                    mac: 5c5b35d0077b
                    mem_total_kb: 505468
                    mem_used_kb: 202096
                    model: AP43
                    modified_time: 1718530662
                    mount: faceup
                    name: Phoenix
                    notes: ''
                    num_clients: 1
                    org_id: af010e2b-f829-4975-b49e-2e896ed1d627
                    port_stat:
                      eth0:
                        full_duplex: true
                        rx_bytes: 1284143195
                        rx_errors: 0
                        rx_peak_bps: 17585
                        rx_pkts: 5199816
                        speed: 1000
                        tx_bytes: 1283744961
                        tx_peak_bps: 26484
                        tx_pkts: 3990463
                        up: true
                      eth1:
                        full_duplex: false
                        rx_bytes: 0
                        rx_errors: 0
                        rx_peak_bps: 0
                        rx_pkts: 0
                        speed: 0
                        tx_bytes: 0
                        tx_peak_bps: 0
                        tx_pkts: 0
                        up: false
                    power_budget: 8400
                    power_constrained: false
                    power_src: DC Input
                    radio_config: {}
                    radio_stat:
                      band_24:
                        bandwidth: 20
                        channel: 11
                        mac: 5c5b35dea810
                        noise_floor: -80
                        num_clients: 0
                        power: 17
                        rx_bytes: 12948211
                        rx_pkts: 65292
                        tx_bytes: 19071943
                        tx_pkts: 76926
                        usage: '24'
                        util_all: 24
                        util_non_wifi: 2
                        util_rx_in_bss: 0
                        util_rx_other_bss: 17
                        util_tx: 4
                        util_undecodable_wifi: 0
                        util_unknown_wifi: 1
                      band_5:
                        bandwidth: 40
                        channel: 36
                        mac: 5c5b35dea7f0
                        noise_floor: -90
                        num_clients: 1
                        power: 17
                        rx_bytes: 578362619
                        rx_pkts: 2687577
                        tx_bytes: 1199571353
                        tx_pkts: 2479302
                        usage: '5'
                        util_all: 13
                        util_non_wifi: 0
                        util_rx_in_bss: 0
                        util_rx_other_bss: 10
                        util_tx: 1
                        util_undecodable_wifi: 0
                        util_unknown_wifi: 1
                    rx_bps: 9276
                    rx_bytes: 591310830
                    rx_pkts: 2752869
                    serial: A0703200709E6
                    site_id: 46fc665e-9706-4296-8fe2-78f42f2e67e4
                    status: connected
                    switch_redundancy:
                      num_redundant_aps: 1
                    tx_bps: 8067
                    tx_bytes: 1218643296
                    tx_pkts: 2556228
                    type: ap
                    uptime: 1593120
                    version: 0.14.29313
                Gateway Stats:
                  value:
                  - arp_table_stats:
                      arp_table_count: 21
                      max_entries_supported: 64000
                    auto_upgrade_stat:
                      lastcheck: 1720595477
                    cert_expiry: 1743292763
                    cluster_config:
                      configuration: active-active
                      control_link_info:
                        name: fxp1
                        status: Up
                      ethernet_connection:
                      - name: reth0
                        status: Up
                      - name: reth1
                        status: Up
                      - name: reth2
                        status: Down
                      - name: reth3
                        status: Down
                      - name: reth4
                        status: Up
                      fabric_link_info:
                        DataPlaneNotifiedStatus: Up
                        Interface: []
                        InternalStatus: Up
                        State: Enabled
                        Status: Enabled
                      last_status_change_reason: No failures
                      operational: active-active
                      primary_node_health: Healthy
                      redundancy_group_information:
                      - Id: 0
                        MonitoringFailure: none
                        Threshold: 255
                      - Id: 1
                        MonitoringFailure: interface-monitoring
                        Threshold: 0
                      - Id: 2
                        MonitoringFailure: none
                        Threshold: 255
                      secondary_node_health: Not healthy
                      status: Green
                    config_status: COMMITED
                    config_timestamp: 1720182848
                    config_version: 1720182848
                    cpu2_stat:
                      idle: 86
                      interrupt: 0
                      load_avg:
                      - 0.13
                      - 0.17
                      - 0.16
                      system: 5
                      user: 9
                    cpu_stat:
                      idle: 76
                      interrupt: 0
                      load_avg:
                      - 0.18
                      - 0.31
                      - 0.39
                      system: 10
                      user: 14
                    created_time: 1711756611
                    deviceprofile_id: 5e5daedf-e650-4013-b41c-845f0d2b9414
                    deviceprofile_name: wan_srx_tor_hub1
                    dhcpd_stat:
                      byod_dc1:
                        num_ips: 100
                        num_leased: 0
                      corp_dc1:
                        num_ips: 100
                        num_leased: 4
                      guest_dc1:
                        num_ips: 241
                        num_leased: 0
                      iot_dc1:
                        num_ips: 100
                        num_leased: 0
                      mgmt_dc1:
                        num_ips: 100
                        num_leased: 2
                      teleworker:
                        num_ips: 140
                        num_leased: 0
                    ext_ip: 69.196.157.189
                    fwupdate:
                      progress: 100
                      status: upgraded
                      status_id: 3037
                      timestamp: 1718392692.580769
                      will_retry: false
                    has_pcap: false
                    hostname: wan_srx_tor_hub1-srx
                    id: 00000000-0000-0000-1000-4db14e107134
                    if_stat:
                      ge-0/0/5.130:
                        address_mode: Unknown
                        nat_addresses: []
                        network_name: ''
                        port_id: ge-0/0/5
                        port_usage: lan
                        rx_bytes: 0
                        rx_pkts: 0
                        tx_bytes: 0
                        tx_pkts: 0
                        up: true
                        vlan: 0
                      ge-1/0/5.120:
                        address_mode: Unknown
                        nat_addresses: []
                        network_name: ''
                        port_id: ge-1/0/5
                        port_usage: lan
                        rx_bytes: 0
                        rx_pkts: 0
                        tx_bytes: 0
                        tx_pkts: 0
                        up: true
                        vlan: 0
                    ip: 69.196.157.190
                    ip_stat:
                      gateway: 69.196.157.185
                      ip: 69.196.157.190
                      ips:
                        vlan1: 69.196.157.190,69.196.157.190
                      netmask: 255.255.255.255
                    is_ha: true
                    last_seen: 1720598726
                    mac: 4db14e107134
                    mac_table_stats:
                      mac_table_count: 0
                      max_mac_entries_supported: 160000
                    memory2_stat:
                      usage: 32
                    memory_stat:
                      usage: 39
                    model: SRX300
                    modified_time: 1720092942
                    module2_stat:
                    - backup_version: 21.2R3-S7.7
                      fans: []
                      last_seen: 1720598717
                      mac: ec38739270c0
                      model: SRX300
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.2R3-S7.7
                      serial: CV2218AF1505
                      status: connected
                      temperatures:
                      - celsius: 49
                        name: Routing Engine
                        status: ok
                      - celsius: 64
                        name: Routing Engine CPU
                        status: ok
                      uptime: 580964
                      vc_links:
                      - neighbor_module_idx: 0
                        neighbor_port_id: fxp1
                        port_id: fxp1
                      vc_role: secondary
                      vc_state: active
                      version: 21.2R3-S6.11
                    module_stat:
                    - backup_version: 21.2R3-S7.7
                      fans: []
                      last_seen: 1720598716.999985
                      mac: 4db14e107134
                      model: SRX300
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.2R3-S7.7
                      serial: CV0219AN0335
                      status: connected
                      temperatures:
                      - celsius: 49
                        name: Routing Engine
                        status: ok
                      - celsius: 65
                        name: Routing Engine CPU
                        status: ok
                      uptime: 1945193
                      vc_links:
                      - neighbor_module_idx: 1
                        neighbor_port_id: fxp1
                        port_id: fxp1
                      vc_role: primary
                      vc_state: active
                      version: 21.2R3-S6.11
                    name: wan_srx_tor_hub1-srx
                    org_id: af010e2b-f829-4975-b49e-2e896ed1d627
                    route_summary_stats:
                      fib_routes: 0
                      max_unicast_routes_supported: 1240000
                      rib_routes: 0
                      total_routes: 0
                    serial: CV0219AN0335
                    service_stat: {}
                    service_status:
                      appid_status: enabled
                      appid_version: 3720
                      ewf_status: disabled
                      idp_install_result: successful
                      idp_install_timestamp: 2024-07-10T06:29:11.708164029Z
                      idp_status: disabled
                      idp_update_timestamp: 2024-07-10T06:28:28.567046244Z
                    site_id: 83c31971-ad70-4419-ae20-7f2b90748986
                    spu2_stat:
                    - spu_cpu: 0
                      spu_current_session: 39
                      spu_max_session: 32768
                      spu_memory: 31
                      spu_pending_session: 0
                      spu_uptime: 1944572
                      spu_valid_session: 0
                    spu_stat:
                    - spu_cpu: 1
                      spu_current_session: 47
                      spu_max_session: 32768
                      spu_memory: 34
                      spu_pending_session: 0
                      spu_uptime: 1944572
                      spu_valid_session: 0
                    status: connected
                    tag_id: 3550217
                    tag_uuid: af010e2b-f829-4975-b49e-2e896ed1d627
                    type: gateway
                    uptime: 581259
                    version: 21.2R3-S6.11
                Switch Stats:
                  value:
                  - ap_redundancy:
                      num_aps: 1
                      num_aps_with_switch_redundancy: 1
                    arp_table_stats:
                      arp_table_count: 16
                      max_entries_supported: 32000
                    auto_upgrade_stat:
                      lastcheck: 1720600596
                    cert_expiry: 1743932274
                    clients:
                    - device_mac: 0912f561b653
                      mac: 001132f5ad23
                      port_id: ge-1/0/11
                    clients_stats:
                      total:
                        num_aps:
                        - 0
                        - 0
                        num_wired_clients: 13
                    config_status: COMMITED
                    config_timestamp: 1720552389
                    config_version: 1720552389
                    cpu_stat:
                      idle: 74
                      interrupt: 0
                      load_avg:
                      - 0.8
                      - 0.75
                      - 0.78
                      system: 13
                      user: 13
                    created_time: 1712346090
                    dhcpd_stat:
                      ifo:
                        num_ips: 5
                        num_leased: 0
                    ext_ip: 153.142.221.41
                    fw_versions_outofsync: false
                    fwupdate:
                      progress: 100
                      status: upgraded
                      status_id: 3037
                      timestamp: 1712409702.9714448
                      will_retry: false
                    has_pcap: true
                    hostname: SW-HLAB-ea2e00
                    hw_rev: A
                    id: 00000000-0000-0000-1000-0912f561b653
                    if_stat:
                      ge-0/0/5.0:
                        port_id: ge-0/0/5
                        rx_bytes: 0
                        rx_pkts: 78110
                        tx_bytes: 0
                        tx_pkts: 61037
                        up: true
                      ge-1/0/0.0:
                        port_id: ge-1/0/0
                        rx_bytes: 0
                        rx_pkts: 56415
                        tx_bytes: 0
                        tx_pkts: 72209
                        up: true
                      irb.172:
                        ips:
                        - 10.3.172.41/24
                        port_id: irb
                        rx_bytes: 0
                        rx_pkts: 1291755
                        tx_bytes: 0
                        tx_pkts: 990327
                        up: true
                        vlan: 172
                      vme.0:
                        port_id: vme
                        rx_bytes: 0
                        rx_pkts: 0
                        tx_bytes: 0
                        tx_pkts: 0
                        up: true
                    ip: 10.3.10.10
                    ip_stat:
                      gateway: 10.3.172.9
                      ip: 10.3.10.10
                      ips:
                        vlan172: 10.3.172.41
                      netmask: 255.255.255.255
                    last_seen: 1720601189
                    last_trouble:
                      code: '103'
                      timestamp: 1712412455215
                    mac: 0912f561b653
                    mac_table_stats:
                      mac_table_count: 58
                      max_mac_entries_supported: 64000
                    memory_stat:
                      usage: 16
                    model: EX4100-F-12P
                    modified_time: 1720552388
                    module_stat:
                    - boot_partition: junos
                      cpu_stat:
                        idle: 74
                        interrupt: 0
                        load_avg:
                        - 0.8
                        - 0.75
                        - 0.78
                        system: 13
                        user: 13
                      fpc_idx: 0
                      mac: 0912f561b653
                      memory_stat:
                        usage: 16
                      model: EX4100-F-12P
                      pics:
                      - index: 0
                        model_number: EX4100-F-12P
                        port_groups:
                        - count: 12
                          type: GE
                      - index: 1
                        model_number: EX4100-F-12P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      - index: 2
                        model_number: EX4100-F-12P
                        port_groups:
                        - count: 2
                          type: GE
                      poe:
                        max_power: 180
                        power_draw: 7.3
                      psus:
                      - name: Power Supply 0
                        status: ok
                      - name: Power Supply 1
                        status: absent
                      - name: Power Supply 2
                        status: absent
                      serial: FJ0324AV0077
                      temperatures:
                      - celsius: 51
                        name: Thermal board Sensor 1
                        status: ok
                      - celsius: 51
                        name: Thermal board Sensor 2
                        status: ok
                      - celsius: 50
                        name: Thermal board Sensor 3
                        status: ok
                      - celsius: 57
                        name: PFE Die Sensor
                        status: ok
                      type: fpc
                      uptime: 1692720
                      vc_links:
                      - neighbor_module_idx: 1
                        neighbor_port_id: vcp-1/1/1
                        port_id: vcp-0/1/0
                      - neighbor_module_idx: 1
                        neighbor_port_id: vcp-1/1/0
                        port_id: vcp-0/1/1
                      vc_mode: HiGiG
                      vc_role: master
                      vc_state: present
                      version: 22.4R3.25
                    - boot_partition: junos
                      cpu_stat:
                        idle: 79
                        interrupt: 0
                        load_avg:
                        - 0.52
                        - 0.46
                        - 0.46
                        system: 6
                        user: 15
                      fpc_idx: 1
                      mac: 485a0deb2380
                      memory_stat:
                        usage: 14
                      model: EX4100-F-12P
                      pics:
                      - index: 0
                        model_number: EX4100-F-12P
                        port_groups:
                        - count: 12
                          type: GE
                      - index: 1
                        model_number: EX4100-F-12P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      - index: 2
                        model_number: EX4100-F-12P
                        port_groups:
                        - count: 2
                          type: GE
                      poe:
                        max_power: 180
                        power_draw: 22.1
                      psus:
                      - name: Power Supply 0
                        status: ok
                      - name: Power Supply 1
                        status: absent
                      - name: Power Supply 2
                        status: absent
                      serial: FJ0424AV0101
                      temperatures:
                      - celsius: 52
                        name: Thermal board Sensor 1
                        status: ok
                      - celsius: 53
                        name: Thermal board Sensor 2
                        status: ok
                      - celsius: 52
                        name: Thermal board Sensor 3
                        status: ok
                      - celsius: 59
                        name: PFE Die Sensor
                        status: ok
                      type: fpc
                      uptime: 1692720
                      vc_links:
                      - neighbor_module_idx: 0
                        neighbor_port_id: vcp-0/1/1
                        port_id: vcp-1/1/0
                      - neighbor_module_idx: 0
                        neighbor_port_id: vcp-0/1/0
                        port_id: vcp-1/1/1
                      vc_mode: HiGiG
                      vc_role: backup
                      vc_state: present
                      version: 22.4R3.25
                    name: SW-HLAB-ea2e00
                    org_id: c5324060-19da-48fa-af28-2b530bd08765
                    route_summary_stats:
                      fib_routes: 7
                      max_unicast_routes_supported: 32150
                      rib_routes: 40
                      total_routes: 3
                    serial: FJ0324AV0077
                    site_id: a0e43ffb-94a6-4f27-92aa-9cf832e1143d
                    status: connected
                    tag_id: 3564806
                    tag_uuid: 507604a4-6b34-449c-acb3-87955430b006
                    type: switch
                    uptime: 1692720
                    vc_mac: 0912f561b653
                    vc_setup_info:
                      config_type: nonprovisioned
                      err_missing_dev_id_fpc: false
                    version: 22.4R3.25
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/stats/marvisclients/count:
    get:
      tags:
      - Orgs Stats - Marvis Clients
      summary: countOrgMarvisClientsStats
      description: Count Marvis Client stats records by a distinct field.
      operationId: countOrgMarvisClientsStats
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field to count by. enum: `device_id`, `wifi_mac`, `wifi_ip`, `hostname`, `model`, `mfg`, `serial`, `os_type`, `os_version`'
        style: form
        explode: true
        schema:
          type: string
          default: os_type
      - name: device_id
        in: query
        description: Filter by Marvis Client installation device UUID
        style: form
        explode: true
        schema:
          type: string
      - name: wifi_mac
        in: query
        description: Filter by device Wi-Fi MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: wifi_ip
        in: query
        description: Filter by device Wi-Fi IP address
        style: form
        explode: true
        schema:
          type: string
      - name: hostname
        in: query
        description: Filter by device hostname
        style: form
        explode: true
        schema:
          type: string
      - name: model
        in: query
        description: Filter by device model
        style: form
        explode: true
        schema:
          type: string
      - name: mfg
        in: query
        description: Filter by device manufacturer
        style: form
        explode: true
        schema:
          type: string
      - name: serial
        in: query
        description: Filter by device serial number
        style: form
        explode: true
        schema:
          type: string
      - name: os_type
        in: query
        description: Filter by device OS type or platform
        style: form
        explode: true
        schema:
          type: string
      - name: os_version
        in: query
        description: Filter by device OS version
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      responses:
        '200':
          description: Count result
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/stats/marvisclients/search:
    get:
      tags:
      - Orgs Stats - Marvis Clients
      summary: searchOrgMarvisClientsStats
      description: Search Marvis Client stats records across the organization.
      operationId: searchOrgMarvisClientsStats
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: query
        description: Filter by Marvis Client installation device UUID
        style: form
        explode: true
        schema:
          type: string
      - name: wifi_mac
        in: query
        description: Filter by device Wi-Fi MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: wifi_ip
        in: query
        description: Filter by device Wi-Fi IP address
        style: form
        explode: true
        schema:
          type: string
      - name: hostname
        in: query
        description: Filter by device hostname
        style: form
        explode: true
        schema:
          type: string
      - name: model
        in: query
        description: Filter by device model
        style: form
        explode: true
        schema:
          type: string
      - name: mfg
        in: query
        description: Filter by device manufacturer
        style: form
        explode: true
        schema:
          type: string
      - name: serial
        in: query
        description: Filter by device serial number
        style: form
        explode: true
        schema:
          type: string
      - name: os_type
        in: query
        description: Filter by device OS type or platform
        style: form
        explode: true
        schema:
          type: string
      - name: os_version
        in: query
        description: Filter by device OS version
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      responses:
        '200':
          description: Paginated Marvis Client stats search results
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/stats_marvis_clients_search'
                - description: Paginated list of Marvis Client stats records
                  examples:
                  - limit: 100
                    results:
                    - battery_charging: false
                      battery_level: 82
                      cpu_background: 2.1
                      cpu_idle: 78.3
                      cpu_system: 5.4
                      cpu_user: 14.2
                      device_id: 0c2a2c6c-5a95-4956-a02d-e1b39c2e5c6e
                      hostname: my-android-phone
                      location:
                        map_id: b4695157-0d1d-4da0-8f9e-5c38149d8b81
                        site_id: d14f16d8-d14f-11e5-8e81-1258369c38a9
                        timestamp: 1717027100
                        x: 423.5
                        y: 201
                      memory_total: 8589934592
                      memory_usage: 3758096384
                      mfg: Samsung
                      model: Galaxy S23
                      org_id: c168ddee-c14c-11e5-8e81-1258369c38a9
                      os_type: Android
                      os_version: '14'
                      serial: R5CX123456A
                      storage_total: 128849018880
                      storage_usage: 52428800000
                      timestamp: 1717027200
                      wifi_band: 5GHz
                      wifi_bssid: 00:11:22:33:44:55
                      wifi_channel: 36
                      wifi_ip: 192.168.1.55
                      wifi_mac: 00:aa:bb:cc:dd:ee
                      wifi_rssi: -58
                      wifi_ssid: Corp-WiFi
                    total: 1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    limit: 100
                    results:
                    - battery_charging: false
                      battery_level: 82
                      cpu_background: 2.1
                      cpu_idle: 78.3
                      cpu_system: 5.4
                      cpu_user: 14.2
                      device_id: 0c2a2c6c-5a95-4956-a02d-e1b39c2e5c6e
                      hostname: my-android-phone
                      location:
                        map_id: b4695157-0d1d-4da0-8f9e-5c38149d8b81
                        site_id: d14f16d8-d14f-11e5-8e81-1258369c38a9
                        timestamp: 1717027100
                        x: 423.5
                        y: 201
                      memory_total: 8589934592
                      memory_usage: 3758096384
                      mfg: Samsung
                      model: Galaxy S23
                      org_id: c168ddee-c14c-11e5-8e81-1258369c38a9
                      os_type: Android
                      os_version: '14'
                      serial: R5CX123456A
                      storage_total: 128849018880
                      storage_usage: 52428800000
                      timestamp: 1717027200
                      wifi_band: 5GHz
                      wifi_bssid: 00:11:22:33:44:55
                      wifi_channel: 36
                      wifi_ip: 192.168.1.55
                      wifi_mac: 00:aa:bb:cc:dd:ee
                      wifi_rssi: -58
                      wifi_ssid: Corp-WiFi
                    total: 1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/stats_marvis_clients_search'
                - description: Paginated list of Marvis Client stats records
                  examples:
                  - limit: 100
                    results:
                    - battery_charging: false
                      battery_level: 82
                      cpu_background: 2.1
                      cpu_idle: 78.3
                      cpu_system: 5.4
                      cpu_user: 14.2
                      device_id: 0c2a2c6c-5a95-4956-a02d-e1b39c2e5c6e
                      hostname: my-android-phone
                      location:
                        map_id: b4695157-0d1d-4da0-8f9e-5c38149d8b81
                        site_id: d14f16d8-d14f-11e5-8e81-1258369c38a9
                        timestamp: 1717027100
                        x: 423.5
                        y: 201
                      memory_total: 8589934592
                      memory_usage: 3758096384
                      mfg: Samsung
                      model: Galaxy S23
                      org_id: c168ddee-c14c-11e5-8e81-1258369c38a9
                      os_type: Android
                      os_version: '14'
                      serial: R5CX123456A
                      storage_total: 128849018880
                      storage_usage: 52428800000
                      timestamp: 1717027200
                      wifi_band: 5GHz
                      wifi_bssid: 00:11:22:33:44:55
                      wifi_channel: 36
                      wifi_ip: 192.168.1.55
                      wifi_mac: 00:aa:bb:cc:dd:ee
                      wifi_rssi: -58
                      wifi_ssid: Corp-WiFi
                    total: 1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    limit: 100
                    results:
                    - battery_charging: false
                      battery_level: 82
                      cpu_background: 2.1
                      cpu_idle: 78.3
                      cpu_system: 5.4
                      cpu_user: 14.2
                      device_id: 0c2a2c6c-5a95-4956-a02d-e1b39c2e5c6e
                      hostname: my-android-phone
                      location:
                        map_id: b4695157-0d1d-4da0-8f9e-5c38149d8b81
                        site_id: d14f16d8-d14f-11e5-8e81-1258369c38a9
                        timestamp: 1717027100
                        x: 423.5
                        y: 201
                      memory_total: 8589934592
                      memory_usage: 3758096384
                      mfg: Samsung
                      model: Galaxy S23
                      org_id: c168ddee-c14c-11e5-8e81-1258369c38a9
                      os_type: Android
                      os_version: '14'
                      serial: R5CX123456A
                      storage_total: 128849018880
                      storage_usage: 52428800000
                      timestamp: 1717027200
                      wifi_band: 5GHz
                      wifi_bssid: 00:11:22:33:44:55
                      wifi_channel: 36
                      wifi_ip: 192.168.1.55
                      wifi_mac: 00:aa:bb:cc:dd:ee
                      wifi_rssi: -58
                      wifi_ssid: Corp-WiFi
                    total: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/stats/mxedges:
    get:
      tags:
      - Orgs Stats - MxEdges
      summary: listOrgMxEdgesStats
      description: Get List of Org MxEdge Stats
      operationId: listOrgMxEdgesStats
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: for_site
        in: query
        description: 'Filter for site level Mist Edges. enum: `any`, `true`, `false`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/for_site'
          - description: 'Filter for site level Mist Edges. enum: `any`, `true`, `false`'
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/stats_mxedge'
                description: Mist Edge statistics records returned by a stats response
                examples:
                - - cpu_stat:
                      cpus:
                        property1:
                          idle: 0
                          interrupt: 0
                          system: 0
                          usage: 0
                          user: 0
                        property2:
                          idle: 0
                          interrupt: 0
                          system: 0
                          usage: 0
                          user: 0
                      idle: 0
                      interrupt: 0
                      system: 0
                      usage: 0
                      user: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ip_stat:
                      ip: string
                      ips:
                        property1: string
                        property2: string
                    lag_stat:
                      property1:
                        active_ports:
                        - string
                      property2:
                        active_ports:
                        - string
                    last_seen: 0
                    magic: string
                    memory_stat:
                      active: 0
                      available: 0
                      buffers: 0
                      cached: 0
                      free: 0
                      inactive: 0
                      swap_cached: 0
                      swap_free: 0
                      swap_total: 0
                      total: 0
                      usage: 0
                    model: string
                    mxagent_registered: true
                    mxcluster_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    num_tunnels: 0
                    port_stat:
                      property1:
                        full_duplex: true
                        lldp_stats:
                          mgmt_addr: string
                          port_desc: string
                          port_id: string
                          system_desc: string
                          system_name: string
                        rx_bytes: 0
                        rx_errors: 0
                        rx_pkts: 0
                        speed: 0
                        tx_bytes: 0
                        tx_pkts: 0
                        up: true
                      property2:
                        full_duplex: true
                        lldp_stats:
                          mgmt_addr: string
                          port_desc: string
                          port_id: string
                          system_desc: string
                          system_name: string
                        rx_bytes: 0
                        rx_errors: 0
                        rx_pkts: 0
                        speed: 0
                        tx_bytes: 0
                        tx_pkts: 0
                        up: true
                    status: string
                    tunterm_registered: true
                    tunterm_stat:
                      monitoring_failed: true
                    uptime: 0
                    virtualization_type: string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - cpu_stat:
                      cpus:
                        property1:
                          idle: 0
                          interrupt: 0
                          system: 0
                          usage: 0
                          user: 0
                        property2:
                          idle: 0
                          interrupt: 0
                          system: 0
                          usage: 0
                          user: 0
                      idle: 0
                      interrupt: 0
                      system: 0
                      usage: 0
                      user: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ip_stat:
                      ip: string
                      ips:
                        property1: string
                        property2: string
                    lag_stat:
                      property1:
                        active_ports:
                        - string
                      property2:
                        active_ports:
                        - string
                    last_seen: 0
                    magic: string
                    memory_stat:
                      active: 0
                      available: 0
                      buffers: 0
                      cached: 0
                      free: 0
                      inactive: 0
                      swap_cached: 0
                      swap_free: 0
                      swap_total: 0
                      total: 0
                      usage: 0
                    model: string
                    mxagent_registered: true
                    mxcluster_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    num_tunnels: 0
                    port_stat:
                      property1:
                        full_duplex: true
                        lldp_stats:
                          mgmt_addr: string
                          port_desc: string
                          port_id: string
                          system_desc: string
                          system_name: string
                        rx_bytes: 0
                        rx_errors: 0
                        rx_pkts: 0
                        speed: 0
                        tx_bytes: 0
                        tx_pkts: 0
                        up: true
                      property2:
                        full_duplex: true
                        lldp_stats:
                          mgmt_addr: string
                          port_desc: string
                          port_id: string
                          system_desc: string
                          system_name: string
                        rx_bytes: 0
                        rx_errors: 0
                        rx_pkts: 0
                        speed: 0
                        tx_bytes: 0
                        tx_pkts: 0
                        up: true
                    status: string
                    tunterm_registered: true
                    tunterm_stat:
                      monitoring_failed: true
                    uptime: 0
                    virtualization_type: string
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/stats_mxedge'
                description: Mist Edge statistics records returned by a stats response
                examples:
                - - cpu_stat:
                      cpus:
                        property1:
                          idle: 0
                          interrupt: 0
                          system: 0
                          usage: 0
                          user: 0
                        property2:
                          idle: 0
                          interrupt: 0
                          system: 0
                          usage: 0
                          user: 0
                      idle: 0
                      interrupt: 0
                      system: 0
                      usage: 0
                      user: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ip_stat:
                      ip: string
                      ips:
                        property1: string
                        property2: string
                    lag_stat:
                      property1:
                        active_ports:
                        - string
                      property2:
                        active_ports:
                        - string
                    last_seen: 0
                    magic: string
                    memory_stat:
                      active: 0
                      available: 0
                      buffers: 0
                      cached: 0
                      free: 0
                      inactive: 0
                      swap_cached: 0
                      swap_free: 0
                      swap_total: 0
                      total: 0
                      usage: 0
                    model: string
                    mxagent_registered: true
                    mxcluster_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    num_tunnels: 0
                    port_stat:
                      property1:
                        full_duplex: true
                        lldp_stats:
                          mgmt_addr: string
                          port_desc: string
                          port_id: string
                          system_desc: string
                          system_name: string
                        rx_bytes: 0
                        rx_errors: 0
                        rx_pkts: 0
                        speed: 0
                        tx_bytes: 0
                        tx_pkts: 0
                        up: true
                      property2:
                        full_duplex: true
                        lldp_stats:
                          mgmt_addr: string
                          port_desc: string
                          port_id: string
                          system_desc: string
                          system_name: string
                        rx_bytes: 0
                        rx_errors: 0
                        rx_pkts: 0
                        speed: 0
                        tx_bytes: 0
                        tx_pkts: 0
                        up: true
                    status: string
                    tunterm_registered: true
                    tunterm_stat:
                      monitoring_failed: true
                    uptime: 0
                    virtualization_type: string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - cpu_stat:
                      cpus:
                        property1:
                          idle: 0
                          interrupt: 0
                          system: 0
                          usage: 0
                          user: 0
                        property2:
                          idle: 0
                          interrupt: 0
                          system: 0
                          usage: 0
                          user: 0
                      idle: 0
                      interrupt: 0
                      system: 0
                      usage: 0
                      user: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ip_stat:
                      ip: string
                      ips:
                        property1: string
                        property2: string
                    lag_stat:
                      property1:
                        active_ports:
                        - string
                      property2:
                        active_ports:
                        - string
                    last_seen: 0
                    magic: string
                    memory_stat:
                      active: 0
                      available: 0
                      buffers: 0
                      cached: 0
                      free: 0
                      inactive: 0
                      swap_cached: 0
                      swap_free: 0
                      swap_total: 0
                      total: 0
                      usage: 0
                    model: string
                    mxagent_registered: true
                    mxcluster_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    num_tunnels: 0
                    port_stat:
                      property1:
                        full_duplex: true
                        lldp_stats:
                          mgmt_addr: string
                          port_desc: string
                          port_id: string
                          system_desc: string
                          system_name: string
                        rx_bytes: 0
                        rx_errors: 0
                        rx_pkts: 0
                        speed: 0
                        tx_bytes: 0
                        tx_pkts: 0
                        up: true
                      property2:
                        full_duplex: true
                        lldp_stats:
                          mgmt_addr: string
                          port_desc: string
                          port_id: string
                          system_desc: string
                          system_name: string
                        rx_bytes: 0
                        rx_errors: 0
                        rx_pkts: 0
                        speed: 0
                        tx_bytes: 0
                        tx_pkts: 0
                        up: true
                    status: string
                    tunterm_registered: true
                    tunterm_stat:
                      monitoring_failed: true
                    uptime: 0
                    virtualization_type: string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/stats/mxedges/{mxedge_id}:
    get:
      tags:
      - Orgs Stats - MxEdges
      summary: getOrgMxEdgeStats
      description: Get Org MxEdge Details Stats
      operationId: getOrgMxEdgeStats
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mxedge_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: for_site
        in: query
        description: Filter results by whether the object is scoped to a site
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: MxEdge Stats
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/stats_mxedge'
                - description: Statistics for a Mist Edge appliance returned by stats endpoints
                  examples:
                  - cpu_stat:
                      cpus:
                        cpu0:
                          idle: 89
                          interrupt: 0
                          system: 8
                          usage: 10
                          user: 1
                        cpu1:
                          idle: 81
                          interrupt: 0
                          system: 4
                          usage: 18
                          user: 13
                        cpu2:
                          idle: 81
                          interrupt: 0
                          system: 4
                          usage: 18
                          user: 13
                        cpu3:
                          idle: 2
                          interrupt: 0
                          system: 50
                          usage: 97
                          user: 46
                      idle: 62
                      interrupt: 0
                      system: 17
                      usage: 37
                      user: 19
                    created_time: 1632684398
                    for_site: false
                    id: 00000000-0000-0000-1000-020000a80cb4
                    inactive_vlan_strs:
                      wired:
                      - '100'
                      - 102-106
                    ip_stat:
                      ip: 192.168.1.244
                      ips:
                        ens18: 192.168.1.244/24,fe80::104c:ffff:fee0:caf8/64
                      macs:
                        ens18: e4434b217044
                    lag_stat:
                      lacp0:
                        active_ports:
                        - port0
                        - port1
                    last_seen: 1633721215
                    mac: 020000a80cb4
                    memory_stat:
                      active: 394936320
                      available: 4699291648
                      buffers: 107646976
                      cached: 478060544
                      free: 4330659840
                      inactive: 211980288
                      swap_cached: 0
                      swap_free: 1022357504
                      swap_total: 1022357504
                      total: 8365957120
                      usage: 48
                    model: ME-VM
                    modified_time: 1633643629
                    mxagent_registered: true
                    mxcluster_id: 678bc339-7635-4556-bbc0-e77ad493ef8b
                    name: me-vm-1
                    num_tunnels: 0
                    oob_ip_config:
                      dns:
                      - 8.8.8.8
                      - 1.1.1.1
                      gateway: 10.0.0.1
                      ip: 10.0.0.10
                      netmask: 255.255.255.0
                      type: static
                    org_id: 11b08247-b1ee-4152-9b25-312b323ce480
                    port_stat:
                      port0:
                        full_duplex: true
                        mac: 9e294e49091d
                        rx_bytes: 646898375700
                        rx_errors: 0
                        rx_pkts: 8784449574
                        speed: 10000
                        state: forwarding
                        tx_bytes: 647200748038
                        tx_errors: 0
                        tx_pkts: 8788647466
                        up: true
                      port1:
                        full_duplex: true
                        mac: a270fe53437e
                        rx_bytes: 647200437652
                        rx_errors: 0
                        rx_pkts: 8788644886
                        speed: 10000
                        state: forwarding
                        tx_bytes: 646898681650
                        tx_errors: 0
                        tx_pkts: 8784452092
                        up: true
                    serial: string
                    service_stat:
                      mxagent:
                        ext_ip: 99.0.86.164
                        last_seen: 1633721215
                        package_state: Installed
                        package_version: 3.1.1037-1
                        running_state: Running
                        uptime: 21240
                      tunterm:
                        ext_ip: 99.0.86.164
                        last_seen: 1633721203
                        package_state: Installed
                        package_version: 0.1.2449+deb10
                        running_state: Running
                        uptime: 76261
                    services:
                    - tunterm
                    site_id: 00000000-0000-0000-0000-000000000000
                    status: connected
                    tunterm_ip_config:
                      gateway: 192.168.11.1
                      ip: 192.168.11.91
                      netmask: 255.255.255.0
                    tunterm_port_config:
                      downstream_ports:
                      - '0'
                      - '1'
                      separate_upstream_downstream: false
                      upstream_ports:
                      - '0'
                      - '1'
                    tunterm_registered: true
                    tunterm_stat:
                      monitoring_failed: false
                    uptime: 76281
                    virtualization_type: KVM
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    cpu_stat:
                      cpus:
                        cpu0:
                          idle: 89
                          interrupt: 0
                          system: 8
                          usage: 10
                          user: 1
                        cpu1:
                          idle: 81
                          interrupt: 0
                          system: 4
                          usage: 18
                          user: 13
                        cpu2:
                          idle: 81
                          interrupt: 0
                          system: 4
                          usage: 18
                          user: 13
                        cpu3:
                          idle: 2
                          interrupt: 0
                          system: 50
                          usage: 97
                          user: 46
                      idle: 62
                      interrupt: 0
                      system: 17
                      usage: 37
                      user: 19
                    created_time: 1632684398
                    for_site: false
                    id: 00000000-0000-0000-1000-020000a80cb4
                    inactive_vlan_strs:
                      wired:
                      - '100'
                      - 102-106
                    ip_stat:
                      ip: 192.168.1.244
                      ips:
                        ens18: 192.168.1.244/24,fe80::104c:ffff:fee0:caf8/64
                      macs:
                        ens18: e4434b217044
                    lag_stat:
                      lacp0:
                        active_ports:
                        - port0
                        - port1
                    last_seen: 1633721215
                    mac: 020000a80cb4
                    memory_stat:
                      active: 394936320
                      available: 4699291648
                      buffers: 107646976
                      cached: 478060544
                      free: 4330659840
                      inactive: 211980288
                      swap_cached: 0
                      swap_free: 1022357504
                      swap_total: 1022357504
                      total: 8365957120
                      usage: 48
                    model: ME-VM
                    modified_time: 1633643629
                    mxagent_registered: true
                    mxcluster_id: 678bc339-7635-4556-bbc0-e77ad493ef8b
                    name: me-vm-1
                    num_tunnels: 0
                    oob_ip_config:
                      dns:
                      - 8.8.8.8
                      - 1.1.1.1
                      gateway: 10.0.0.1
                      ip: 10.0.0.10
                      netmask: 255.255.255.0
                      type: static
                    org_id: 11b08247-b1ee-4152-9b25-312b323ce480
                    port_stat:
                      port0:
                        full_duplex: true
                        mac: 9e294e49091d
                        rx_bytes: 646898375700
                        rx_errors: 0
                        rx_pkts: 8784449574
                        speed: 10000
                        state: forwarding
                        tx_bytes: 647200748038
                        tx_errors: 0
                        tx_pkts: 8788647466
                        up: true
                      port1:
                        full_duplex: true
                        mac: a270fe53437e
                        rx_bytes: 647200437652
                        rx_errors: 0
                        rx_pkts: 8788644886
                        speed: 10000
                        state: forwarding
                        tx_bytes: 646898681650
                        tx_errors: 0
                        tx_pkts: 8784452092
                        up: true
                    serial: string
                    service_stat:
                      mxagent:
                        ext_ip: 99.0.86.164
                        last_seen: 1633721215
                        package_state: Installed
                        package_version: 3.1.1037-1
                        running_state: Running
                        uptime: 21240
                      tunterm:
                        ext_ip: 99.0.86.164
                        last_seen: 1633721203
                        package_state: Installed
                        package_version: 0.1.2449+deb10
                        running_state: Running
                        uptime: 76261
                    services:
                    - tunterm
                    site_id: 00000000-0000-0000-0000-000000000000
                    status: connected
                    tunterm_ip_config:
                      gateway: 192.168.11.1
                      ip: 192.168.11.91
                      netmask: 255.255.255.0
                    tunterm_port_config:
                      downstream_ports:
                      - '0'
                      - '1'
                      separate_upstream_downstream: false
                      upstream_ports:
                      - '0'
                      - '1'
                    tunterm_registered: true
                    tunterm_stat:
                      monitoring_failed: false
                    uptime: 76281
                    virtualization_type: KVM
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/stats_mxedge'
                - description: Statistics for a Mist Edge appliance returned by stats endpoints
                  examples:
                  - cpu_stat:
                      cpus:
                        cpu0:
                          idle: 89
                          interrupt: 0
                          system: 8
                          usage: 10
                          user: 1
                        cpu1:
                          idle: 81
                          interrupt: 0
                          system: 4
                          usage: 18
                          user: 13
                        cpu2:
                          idle: 81
                          interrupt: 0
                          system: 4
                          usage: 18
                          user: 13
                        cpu3:
                          idle: 2
                          interrupt: 0
                          system: 50
                          usage: 97
                          user: 46
                      idle: 62
                      interrupt: 0
                      system: 17
                      usage: 37
                      user: 19
                    created_time: 1632684398
                    for_site: false
                    id: 00000000-0000-0000-1000-020000a80cb4
                    inactive_vlan_strs:
                      wired:
                      - '100'
                      - 102-106
                    ip_stat:
                      ip: 192.168.1.244
                      ips:
                        ens18: 192.168.1.244/24,fe80::104c:ffff:fee0:caf8/64
                      macs:
                        ens18: e4434b217044
                    lag_stat:
                      lacp0:
                        active_ports:
                        - port0
                        - port1
                    last_seen: 1633721215
                    mac: 020000a80cb4
                    memory_stat:
                      active: 394936320
                      available: 4699291648
                      buffers: 107646976
                      cached: 478060544
                      free: 4330659840
                      inactive: 211980288
                      swap_cached: 0
                      swap_free: 1022357504
                      swap_total: 1022357504
                      total: 8365957120
                      usage: 48
                    model: ME-VM
                    modified_time: 1633643629
                    mxagent_registered: true
                    mxcluster_id: 678bc339-7635-4556-bbc0-e77ad493ef8b
                    name: me-vm-1
                    num_tunnels: 0
                    oob_ip_config:
                      dns:
                      - 8.8.8.8
                      - 1.1.1.1
                      gateway: 10.0.0.1
                      ip: 10.0.0.10
                      netmask: 255.255.255.0
                      type: static
                    org_id: 11b08247-b1ee-4152-9b25-312b323ce480
                    port_stat:
                      port0:
                        full_duplex: true
                        mac: 9e294e49091d
                        rx_bytes: 646898375700
                        rx_errors: 0
                        rx_pkts: 8784449574
                        speed: 10000
                        state: forwarding
                        tx_bytes: 647200748038
                        tx_errors: 0
                        tx_pkts: 8788647466
                        up: true
                      port1:
                        full_duplex: true
                        mac: a270fe53437e
                        rx_bytes: 647200437652
                        rx_errors: 0
                        rx_pkts: 8788644886
                        speed: 10000
                        state: forwarding
                        tx_bytes: 646898681650
                        tx_errors: 0
                        tx_pkts: 8784452092
                        up: true
                    serial: string
                    service_stat:
                      mxagent:
                        ext_ip: 99.0.86.164
                        last_seen: 1633721215
                        package_state: Installed
                        package_version: 3.1.1037-1
                        running_state: Running
                        uptime: 21240
                      tunterm:
                        ext_ip: 99.0.86.164
                        last_seen: 1633721203
                        package_state: Installed
                        package_version: 0.1.2449+deb10
                        running_state: Running
                        uptime: 76261
                    services:
                    - tunterm
                    site_id: 00000000-0000-0000-0000-000000000000
                    status: connected
                    tunterm_ip_config:
                      gateway: 192.168.11.1
                      ip: 192.168.11.91
                      netmask: 255.255.255.0
                    tunterm_port_config:
                      downstream_ports:
                      - '0'
                      - '1'
                      separate_upstream_downstream: false
                      upstream_ports:
                      - '0'
                      - '1'
                    tunterm_registered: true
                    tunterm_stat:
                      monitoring_failed: false
                    uptime: 76281
                    virtualization_type: KVM
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    cpu_stat:
                      cpus:
                        cpu0:
                          idle: 89
                          interrupt: 0
                          system: 8
                          usage: 10
                          user: 1
                        cpu1:
                          idle: 81
                          interrupt: 0
                          system: 4
                          usage: 18
                          user: 13
                        cpu2:
                          idle: 81
                          interrupt: 0
                          system: 4
                          usage: 18
                          user: 13
                        cpu3:
                          idle: 2
                          interrupt: 0
                          system: 50
                          usage: 97
                          user: 46
                      idle: 62
                      interrupt: 0
                      system: 17
                      usage: 37
                      user: 19
                    created_time: 1632684398
                    for_site: false
                    id: 00000000-0000-0000-1000-020000a80cb4
                    inactive_vlan_strs:
                      wired:
                      - '100'
                      - 102-106
                    ip_stat:
                      ip: 192.168.1.244
                      ips:
                        ens18: 192.168.1.244/24,fe80::104c:ffff:fee0:caf8/64
                      macs:
                        ens18: e4434b217044
                    lag_stat:
                      lacp0:
                        active_ports:
                        - port0
                        - port1
                    last_seen: 1633721215
                    mac: 020000a80cb4
                    memory_stat:
                      active: 394936320
                      available: 4699291648
                      buffers: 107646976
                      cached: 478060544
                      free: 4330659840
                      inactive: 211980288
                      swap_cached: 0
                      swap_free: 1022357504
                      swap_total: 1022357504
                      total: 8365957120
                      usage: 48
                    model: ME-VM
                    modified_time: 1633643629
                    mxagent_registered: true
                    mxcluster_id: 678bc339-7635-4556-bbc0-e77ad493ef8b
                    name: me-vm-1
                    num_tunnels: 0
                    oob_ip_config:
                      dns:
                      - 8.8.8.8
                      - 1.1.1.1
                      gateway: 10.0.0.1
                      ip: 10.0.0.10
                      netmask: 255.255.255.0
                      type: static
                    org_id: 11b08247-b1ee-4152-9b25-312b323ce480
                    port_stat:
                      port0:
                        full_duplex: true
                        mac: 9e294e49091d
                        rx_bytes: 646898375700
                        rx_errors: 0
                        rx_pkts: 8784449574
                        speed: 10000
                        state: forwarding
                        tx_bytes: 647200748038
                        tx_errors: 0
                        tx_pkts: 8788647466
                        up: true
                      port1:
                        full_duplex: true
                        mac: a270fe53437e
                        rx_bytes: 647200437652
                        rx_errors: 0
                        rx_pkts: 8788644886
                        speed: 10000
                        state: forwarding
                        tx_bytes: 646898681650
                        tx_errors: 0
                        tx_pkts: 8784452092
                        up: true
                    serial: string
                    service_stat:
                      mxagent:
                        ext_ip: 99.0.86.164
                        last_seen: 1633721215
                        package_state: Installed
                        package_version: 3.1.1037-1
                        running_state: Running
                        uptime: 21240
                      tunterm:
                        ext_ip: 99.0.86.164
                        last_seen: 1633721203
                        package_state: Installed
                        package_version: 0.1.2449+deb10
                        running_state: Running
                        uptime: 76261
                    services:
                    - tunterm
                    site_id: 00000000-0000-0000-0000-000000000000
                    status: connected
                    tunterm_ip_config:
                      gateway: 192.168.11.1
                      ip: 192.168.11.91
                      netmask: 255.255.255.0
                    tunterm_port_config:
                      downstream_ports:
                      - '0'
                      - '1'
                      separate_upstream_downstream: false
                      upstream_ports:
                      - '0'
                      - '1'
                    tunterm_registered: true
                    tunterm_stat:
                      monitoring_failed: false
                    uptime: 76281
                    virtualization_type: KVM
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/stats/ospf_peers/count:
    get:
      tags:
      - Orgs Stats - Ospf
      summary: countOrgOspfStats
      description: Count OSPF peer stats by distinct attribute name
      operationId: countOrgOspfStats
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `site_id`, `org_id`, `mac`, `peer_ip`, `port_id`, `state`, `vrf_name`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/ospf_peer_stats_count_distinct'
          - description: 'Field used to group this count response. enum: `site_id`, `org_id`, `mac`, `peer_ip`, `port_id`, `state`, `vrf_name`'
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/stats/ospf_peers/search:
    get:
      tags:
      - Orgs Stats - Ospf
      summary: searchOrgOspfStats
      description: Search OSPF Neighbor Stats
      operationId: searchOrgOspfStats
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: site_id
        in: query
        description: Filter results by site identifier
        style: form
        explode: true
        schema:
          type: string
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: vrf_name
        in: query
        description: Filter peer results by VRF name
        style: form
        explode: true
        schema:
          type: string
      - name: peer_ip
        in: query
        description: Filter peer results by peer IP address
        style: form
        explode: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ospf_peer_stats_search_result'
                - description: Paginated OSPF peer statistics search result
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ospf_peer_stats_search_result'
                - description: Paginated OSPF peer statistics search result
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/stats/otherdevices/{device_mac}:
    get:
      tags:
      - Orgs Stats - Other Devices
      summary: getOrgOtherDeviceStats
      description: Get Otherdevice Stats
      operationId: getOrgOtherDeviceStats
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/stats_device_other'
                - description: Statistics for a third-party or other device tracked by Mist
                  examples:
                  - cached_stats: true
                    connected_devices:
                      0200010edbca:
                        mac: 020001abcdef
                        name: DNT-NTR-GWE
                        port_id: ge-0/0/1
                        type: gateway
                    last_seen: 1740996902
                    lldp_enabled: true
                    mac: 00304498a1e8
                    uptime: 622828
                    vendor: cradlepoint
                    vendor_specific:
                      interfaces:
                        ethernet-IPPT:
                          bytes_in: 331068567
                          bytes_out: 6763536255
                          display_name: Primary LAN
                          ip: 192.168.0.1
                          link: true
                          mode: lan
                          port_parent: Primary LAN
                          service_mode: Ethernet
                          type: ethernet
                          uptime: 0
                        ethernet-lan:
                          bytes_in: 13072566048
                          bytes_out: 5617915438
                          display_name: Secondary LAN
                          ip: 192.168.0.1
                          link: false
                          mode: lan
                          port_parent: Secondary LAN
                          service_mode: Ethernet
                          type: ethernet
                          uptime: 0
                        mdm-8a1084c9:
                          bytes_in: 0
                          bytes_out: 0
                          carrier: Unknown Service
                          imei: '866401234567894'
                          imsi: ''
                          ip: ''
                          link: false
                          mode: wan
                          mtu: 1400
                          rsrp: 0
                          rsrq: 0
                          rssi: 0
                          service_mode: Not Available
                          sinr: 0
                          state: NOSIM
                          type: mdm
                          uptime: 0
                        mdm-8a1fc70c:
                          bytes_in: 5623096929
                          bytes_out: 12372750366
                          carrier: AT&T
                          imei: '866401234567893'
                          imsi: '208001234567893'
                          ip: 12.68.86.17
                          link: true
                          mode: wan
                          mtu: 1400
                          rsrp: -108
                          rsrq: -14
                          rssi: -74
                          service_mode: 5G NSA
                          sinr: -1.2
                          state: READY
                          type: mdm
                          uptime: 2095779
                    version: 7.24.80
                contentMediaType: application/json
              examples:
                Otherdevice Stats:
                  value:
                    cached_stats: true
                    connected_devices:
                      0200010edbca:
                        mac: 020001abcdef
                        name: DNT-NTR-GWE
                        port_id: ge-0/0/1
                        type: gateway
                    last_seen: 1740996902
                    lldp_enabled: true
                    mac: 00304498a1e8
                    uptime: 622828
                    vendor: cradlepoint
                    vendor_specific:
                      interfaces:
                        ethernet-IPPT:
                          bytes_in: 331068567
                          bytes_out: 6763536255
                          display_name: Primary LAN
                          ip: 192.168.0.1
                          link: true
                          mode: lan
                          port_parent: Primary LAN
                          service_mode: Ethernet
                          type: ethernet
                          uptime: 0
                        ethernet-lan:
                          bytes_in: 13072566048
                          bytes_out: 5617915438
                          display_name: Secondary LAN
                          ip: 192.168.0.1
                          link: false
                          mode: lan
                          port_parent: Secondary LAN
                          service_mode: Ethernet
                          type: ethernet
                          uptime: 0
                        mdm-8a1084c9:
                          bytes_in: 0
                          bytes_out: 0
                          carrier: Unknown Service
                          imei: '866401234567894'
                          imsi: ''
                          ip: ''
                          link: false
                          mode: wan
                          mtu: 1400
                          rsrp: 0
                          rsrq: 0
                          rssi: 0
                          service_mode: Not Available
                          sinr: 0
                          state: NOSIM
                          type: mdm
                          uptime: 0
                        mdm-8a1fc70c:
                          bytes_in: 5623096929
                          bytes_out: 12372750366
                          carrier: AT&T
                          imei: '866401234567893'
                          imsi: '208001234567893'
                          ip: 12.68.86.17
                          link: true
                          mode: wan
                          mtu: 1400
                          rsrp: -108
                          rsrq: -14
                          rssi: -74
                          service_mode: 5G NSA
                          sinr: -1.2
                          state: READY
                          type: mdm
                          uptime: 2095779
                    version: 7.24.80
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/stats_device_other'
                - description: Statistics for a third-party or other device tracked by Mist
                  examples:
                  - cached_stats: true
                    connected_devices:
                      0200010edbca:
                        mac: 020001abcdef
                        name: DNT-NTR-GWE
                        port_id: ge-0/0/1
                        type: gateway
                    last_seen: 1740996902
                    lldp_enabled: true
                    mac: 00304498a1e8
                    uptime: 622828
                    vendor: cradlepoint
                    vendor_specific:
                      interfaces:
                        ethernet-IPPT:
                          bytes_in: 331068567
                          bytes_out: 6763536255
                          display_name: Primary LAN
                          ip: 192.168.0.1
                          link: true
                          mode: lan
                          port_parent: Primary LAN
                          service_mode: Ethernet
                          type: ethernet
                          uptime: 0
                        ethernet-lan:
                          bytes_in: 13072566048
                          bytes_out: 5617915438
                          display_name: Secondary LAN
                          ip: 192.168.0.1
                          link: false
                          mode: lan
                          port_parent: Secondary LAN
                          service_mode: Ethernet
                          type: ethernet
                          uptime: 0
                        mdm-8a1084c9:
                          bytes_in: 0
                          bytes_out: 0
                          carrier: Unknown Service
                          imei: '866401234567894'
                          imsi: ''
                          ip: ''
                          link: false
                          mode: wan
                          mtu: 1400
                          rsrp: 0
                          rsrq: 0
                          rssi: 0
                          service_mode: Not Available
                          sinr: 0
                          state: NOSIM
                          type: mdm
                          uptime: 0
                        mdm-8a1fc70c:
                          bytes_in: 5623096929
                          bytes_out: 12372750366
                          carrier: AT&T
                          imei: '866401234567893'
                          imsi: '208001234567893'
                          ip: 12.68.86.17
                          link: true
                          mode: wan
                          mtu: 1400
                          rsrp: -108
                          rsrq: -14
                          rssi: -74
                          service_mode: 5G NSA
                          sinr: -1.2
                          state: READY
                          type: mdm
                          uptime: 2095779
                    version: 7.24.80
                contentMediaType: application/vnd.api+json
              examples:
                Otherdevice Stats:
                  value:
                    cached_stats: true
                    connected_devices:
                      0200010edbca:
                        mac: 020001abcdef
                        name: DNT-NTR-GWE
                        port_id: ge-0/0/1
                        type: gateway
                    last_seen: 1740996902
                    lldp_enabled: true
                    mac: 00304498a1e8
                    uptime: 622828
                    vendor: cradlepoint
                    vendor_specific:
                      interfaces:
                        ethernet-IPPT:
                          bytes_in: 331068567
                          bytes_out: 6763536255
                          display_name: Primary LAN
                          ip: 192.168.0.1
                          link: true
                          mode: lan
                          port_parent: Primary LAN
                          service_mode: Ethernet
                          type: ethernet
                          uptime: 0
                        ethernet-lan:
                          bytes_in: 13072566048
                          bytes_out: 5617915438
                          display_name: Secondary LAN
                          ip: 192.168.0.1
                          link: false
                          mode: lan
                          port_parent: Secondary LAN
                          service_mode: Ethernet
                          type: ethernet
                          uptime: 0
                        mdm-8a1084c9:
                          bytes_in: 0
                          bytes_out: 0
                          carrier: Unknown Service
                          imei: '866401234567894'
                          imsi: ''
                          ip: ''
                          link: false
                          mode: wan
                          mtu: 1400
                          rsrp: 0
                          rsrq: 0
                          rssi: 0
                          service_mode: Not Available
                          sinr: 0
                          state: NOSIM
                          type: mdm
                          uptime: 0
                        mdm-8a1fc70c:
                          bytes_in: 5623096929
                          bytes_out: 12372750366
                          carrier: AT&T
                          imei: '866401234567893'
                          imsi: '208001234567893'
                          ip: 12.68.86.17
                          link: true
                          mode: wan
                          mtu: 1400
                          rsrp: -108
                          rsrq: -14
                          rssi: -74
                          service_mode: 5G NSA
                          sinr: -1.2
                          state: READY
                          type: mdm
                          uptime: 2095779
                    version: 7.24.80
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/stats/ports/count:
    get:
      tags:
      - Orgs Stats - Ports
      summary: countOrgSwOrGwPorts
      description: Count by Distinct Attributes of Switch/Gateway Ports at the Org level
      operationId: countOrgSwOrGwPorts
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `full_duplex`, `mac`, `neighbor_mac`, `neighbor_port_desc`, `neighbor_system_name`, `poe_disabled`, `poe_mode`, `poe_on`, `port_id`, `port_mac`, `speed`, `up`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/site_ports_count_distinct'
          - description: 'Field used to group this count response. enum: `full_duplex`, `mac`, `neighbor_mac`, `neighbor_port_desc`, `neighbor_system_name`, `poe_disabled`, `poe_mode`, `poe_on`, `port_id`, `port_mac`, `speed`, `up`'
      - name: full_duplex
        in: query
        description: Indicates full or half duplex
        style: form
        explode: true
        schema:
          type: boolean
          examples:
          - true
      - name: mac
        in: query
        description: Filter results by MAC address. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b53010101,5c5b53020202
          - 5c5b350e0410
        examples:
          Untitled Example1:
            value: 5c5b53010101,5c5b53020202
          Untitled Example2:
            value: 5c5b350e0410
      - name: neighbor_mac
        in: query
        description: Chassis identifier of the chassis type listed
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b350e0410
      - name: neighbor_port_desc
        in: query
        description: Description supplied by the system on the interface E.g. "GigabitEthernet2/0/39"
        style: form
        explode: true
        schema:
          type: string
          examples:
          - ge-2/0/39
      - name: neighbor_system_name
        in: query
        description: Name supplied by the system on the interface E.g. neighbor system name E.g. "Kumar-Acc-SW.mist.local"
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Kumar-Acc-SW.mist.local
      - name: poe_disabled
        in: query
        description: Is the POE configured not be disabled.
        style: form
        explode: true
        schema:
          type: boolean
          examples:
          - false
      - name: poe_mode
        in: query
        description: POE mode depending on class E.g. "802.3at"
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 802.3at
      - name: poe_on
        in: query
        description: Is the device attached to POE
        style: form
        explode: true
        schema:
          type: boolean
          examples:
          - true
      - name: port_id
        in: query
        description: Filter results by port identifier
        style: form
        explode: true
        schema:
          type: string
          examples:
          - ge-2/0/39
      - name: port_mac
        in: query
        description: Filter results by port MAC address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b350e0410
      - name: power_draw
        in: query
        description: Amount of power being used by the interface at the time the command is executed. Unit in watts.
        style: form
        explode: true
        schema:
          type: number
          contentEncoding: double
          examples:
          - 15.4
      - name: tx_pkts
        in: query
        description: Filter results by transmitted packet count
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
          examples:
          - 1000000
      - name: rx_pkts
        in: query
        description: Filter results by received packet count
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
          examples:
          - 1000000
      - name: rx_bytes
        in: query
        description: Filter results by received byte count
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
          examples:
          - 1000000
      - name: tx_bps
        in: query
        description: Filter results by transmit rate
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
          examples:
          - 1000000
      - name: rx_bps
        in: query
        description: Filter results by receive rate
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
          examples:
          - 1000000
      - name: tx_mcast_pkts
        in: query
        description: Filter results by transmitted multicast packet count
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
          examples:
          - 1000000
      - name: tx_bcast_pkts
        in: query
        description: Filter results by transmitted broadcast packet count
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
          examples:
          - 1000000
      - name: rx_mcast_pkts
        in: query
        description: Filter results by received multicast packet count
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
          examples:
          - 1000000
      - name: rx_bcast_pkts
        in: query
        description: Filter results by received broadcast packet count
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
          examples:
          - 1000000
      - name: speed
        in: query
        description: Filter results by port speed
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
          examples:
          - 1000000000
      - name: stp_state
        in: query
        description: 'STP state used to filter port results when `up`==`true`. enum: `""`, `blocking`, `disabled`, `forwarding`, `learning`, `listening`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/port_stp_state'
          - description: 'STP state used to filter port results when `up`==`true`. enum: `""`, `blocking`, `disabled`, `forwarding`, `learning`, `listening`'
      - name: stp_role
        in: query
        description: 'STP role used to filter port results when `up`==`true`. enum: `""`, `alternate`, `backup`, `designated`, `disabled`, `root`, `root-prevented`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/port_stp_role'
          - description: 'STP role used to filter port results when `up`==`true`. enum: `""`, `alternate`, `backup`, `designated`, `disabled`, `root`, `root-prevented`'
      - name: auth_state
        in: query
        description: 'Authentication state used to filter port results when `up`==`true` and the port has an authenticator role. enum: `""`, `authenticated`, `authenticating`, `held`, `init`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/port_auth_state'
          - description: 'Authentication state used to filter port results when `up`==`true` and the port has an authenticator role. enum: `""`, `authenticated`, `authenticating`, `held`, `init`'
      - name: up
        in: query
        description: Indicates if interface is up
        style: form
        explode: true
        schema:
          type: boolean
          examples:
          - true
      - name: site_id
        in: query
        description: Filter results by site identifier
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 72771e6a-6f5e-4de4-a5b9-1266c4197811
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/stats/ports/search:
    get:
      tags:
      - Orgs Stats - Ports
      summary: searchOrgSwOrGwPorts
      description: >-
        Search Switch / Gateway Ports Stats.

        Returns a list of switch/gateway ports stats that match the search criteria.


        The response provide current/last port status and statistics within the hour.

        Traffic information (Tx/Rx) are cumulative counters since the last device reboot.
      operationId: searchOrgSwOrGwPorts
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_type
        in: query
        description: 'Type of device. enum: `switch`, `gateway`, `all`. Accepts multiple comma-separated values.'
        style: form
        explode: true
        schema:
          type: string
          examples:
          - gateway,switch
      - name: auth_state
        in: query
        description: 'Authentication state used to filter port results when `up`==`true` and the port has an authenticator role. enum: `""`, `authenticated`, `authenticating`, `held`, `init`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/port_auth_state'
          - description: 'Authentication state used to filter port results when `up`==`true` and the port has an authenticator role. enum: `""`, `authenticated`, `authenticating`, `held`, `init`'
      - name: full_duplex
        in: query
        description: Indicates full or half duplex
        style: form
        explode: true
        schema:
          type: boolean
      - name: lte_imsi
        in: query
        description: LTE IMSI value, Check for null/empty
        style: form
        explode: true
        schema:
          type: string
          examples:
          - '310260000000001'
      - name: lte_iccid
        in: query
        description: LTE ICCID value, Check for null/empty
        style: form
        explode: true
        schema:
          type: string
          examples:
          - '89014103211118510720'
      - name: lte_imei
        in: query
        description: LTE IMEI value, Check for null/empty
        style: form
        explode: true
        schema:
          type: string
          examples:
          - '123456789012345'
      - name: mac
        in: query
        description: Filter results by MAC address. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b53010101,5c5b53020202
      - name: neighbor_mac
        in: query
        description: Chassis identifier of the chassis type listed. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b53010101,5c5b53020202
      - name: neighbor_port_desc
        in: query
        description: Description supplied by the system on the interface E.g. "GigabitEthernet2/0/39". Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - ge-0-2,ge-0-1
      - name: neighbor_system_name
        in: query
        description: Name supplied by the system on the interface E.g. neighbor system name E.g. "Kumar-Acc-SW.mist.local". Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - sdwan-newyork,toronto-srx-2_node1
      - name: poe_disabled
        in: query
        description: Is the POE configured not be disabled.
        style: form
        explode: true
        schema:
          type: boolean
      - name: poe_mode
        in: query
        description: POE mode depending on class E.g. "802.3at"
        style: form
        explode: true
        schema:
          type: string
      - name: poe_on
        in: query
        description: Is the device attached to POE
        style: form
        explode: true
        schema:
          type: boolean
      - name: poe_priority
        in: query
        description: 'PoE priority used to filter switch port results. enum: `low`, `high`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/poe_priority'
          - description: 'PoE priority used to filter switch port results. enum: `low`, `high`'
      - name: port_id
        in: query
        description: Filter results by port identifier. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - ge-0/0/1,ge-0/0/2
      - name: port_mac
        in: query
        description: Filter results by port MAC address. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b53010101,5c5b53020202
      - name: speed
        in: query
        description: Filter results by port speed
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: stp_state
        in: query
        description: 'STP state used to filter port results when `up`==`true`. enum: `""`, `blocking`, `disabled`, `forwarding`, `learning`, `listening`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/port_stp_state'
          - description: 'STP state used to filter port results when `up`==`true`. enum: `""`, `blocking`, `disabled`, `forwarding`, `learning`, `listening`'
      - name: stp_role
        in: query
        description: 'STP role used to filter port results when `up`==`true`. enum: `""`, `alternate`, `backup`, `designated`, `disabled`, `root`, `root-prevented`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/port_stp_role'
          - description: 'STP role used to filter port results when `up`==`true`. enum: `""`, `alternate`, `backup`, `designated`, `disabled`, `root`, `root-prevented`'
      - name: up
        in: query
        description: Indicates if interface is up
        style: form
        explode: true
        schema:
          type: boolean
      - name: xcvr_part_number
        in: query
        description: Optic Slot Partnumber, Check for null/empty
        style: form
        explode: true
        schema:
          type: string
          examples:
          - SFP-10G-SR
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_port_stats_search'
                - description: Paginated response for switch and gateway port statistics search results
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_port_stats_search'
                - description: Paginated response for switch and gateway port statistics search results
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/stats/sites:
    get:
      tags:
      - Orgs Stats - Sites
      summary: listOrgSiteStats
      description: Get List of Org Site Stats
      operationId: listOrgSiteStats
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/stats_site'
                description: Site statistics records returned by a stats response
                examples:
                - - address: 1601 S De Anza Blvd, Cupertino, CA 95014, USA
                    alarmtemplate_id: null
                    analyticEnabled: true
                    aptemplate_id: null
                    country_code: US
                    created_time: 1472591606
                    engagementEnabled: true
                    gatewaytemplate_id: e571f2a2-d748-4ad4-bd6c-895467957c21
                    id: 83bc290a-b76d-47fa-a294-d34e47f30f7f
                    lat: 37.295553
                    latlng:
                      lat: 37.295553
                      lng: -122.033007
                    lng: -122.033007
                    modified_time: 1728057857
                    msp_id: a9af4951-a1de-4520-b398-c95a58947349
                    name: Live-Demo
                    networktemplate_id: 964cb213-deb2-469d-8c1e-a5f8661c6886
                    notes: This site is used for demonstration purposes.
                    num_ap: 17
                    num_ap_connected: 14
                    num_clients: 14
                    num_devices: 26
                    num_devices_connected: 22
                    num_gateway: 1
                    num_gateway_connected: 1
                    num_switch: 8
                    num_switch_connected: 7
                    org_id: b9814b40-ac4b-4424-86a8-b787eb68b86a
                    rftemplate_id: 2c134c07-3c57-46b3-a53b-8aea92ed7234
                    secpolicy_id: null
                    sitegroup_ids:
                    - 5644a432-eea9-4a2f-a30a-ddaf4dbc79cf
                    - 5fc0f305-f626-49db-8869-10b87f201bba
                    - 882796ef-190b-405e-98ef-cb487140cf64
                    sitetemplate_id: null
                    timezone: America/Los_Angeles
                    tzoffset: 960
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - address: 1601 S De Anza Blvd, Cupertino, CA 95014, USA
                    alarmtemplate_id: null
                    analyticEnabled: true
                    aptemplate_id: null
                    country_code: US
                    created_time: 1472591606
                    engagementEnabled: true
                    gatewaytemplate_id: e571f2a2-d748-4ad4-bd6c-895467957c21
                    id: 83bc290a-b76d-47fa-a294-d34e47f30f7f
                    lat: 37.295553
                    latlng:
                      lat: 37.295553
                      lng: -122.033007
                    lng: -122.033007
                    modified_time: 1728057857
                    msp_id: a9af4951-a1de-4520-b398-c95a58947349
                    name: Live-Demo
                    networktemplate_id: 964cb213-deb2-469d-8c1e-a5f8661c6886
                    notes: This site is used for demonstration purposes.
                    num_ap: 17
                    num_ap_connected: 14
                    num_clients: 14
                    num_devices: 26
                    num_devices_connected: 22
                    num_gateway: 1
                    num_gateway_connected: 1
                    num_switch: 8
                    num_switch_connected: 7
                    org_id: b9814b40-ac4b-4424-86a8-b787eb68b86a
                    rftemplate_id: 2c134c07-3c57-46b3-a53b-8aea92ed7234
                    secpolicy_id: null
                    sitegroup_ids:
                    - 5644a432-eea9-4a2f-a30a-ddaf4dbc79cf
                    - 5fc0f305-f626-49db-8869-10b87f201bba
                    - 882796ef-190b-405e-98ef-cb487140cf64
                    sitetemplate_id: null
                    timezone: America/Los_Angeles
                    tzoffset: 960
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/stats_site'
                description: Site statistics records returned by a stats response
                examples:
                - - address: 1601 S De Anza Blvd, Cupertino, CA 95014, USA
                    alarmtemplate_id: null
                    analyticEnabled: true
                    aptemplate_id: null
                    country_code: US
                    created_time: 1472591606
                    engagementEnabled: true
                    gatewaytemplate_id: e571f2a2-d748-4ad4-bd6c-895467957c21
                    id: 83bc290a-b76d-47fa-a294-d34e47f30f7f
                    lat: 37.295553
                    latlng:
                      lat: 37.295553
                      lng: -122.033007
                    lng: -122.033007
                    modified_time: 1728057857
                    msp_id: a9af4951-a1de-4520-b398-c95a58947349
                    name: Live-Demo
                    networktemplate_id: 964cb213-deb2-469d-8c1e-a5f8661c6886
                    notes: This site is used for demonstration purposes.
                    num_ap: 17
                    num_ap_connected: 14
                    num_clients: 14
                    num_devices: 26
                    num_devices_connected: 22
                    num_gateway: 1
                    num_gateway_connected: 1
                    num_switch: 8
                    num_switch_connected: 7
                    org_id: b9814b40-ac4b-4424-86a8-b787eb68b86a
                    rftemplate_id: 2c134c07-3c57-46b3-a53b-8aea92ed7234
                    secpolicy_id: null
                    sitegroup_ids:
                    - 5644a432-eea9-4a2f-a30a-ddaf4dbc79cf
                    - 5fc0f305-f626-49db-8869-10b87f201bba
                    - 882796ef-190b-405e-98ef-cb487140cf64
                    sitetemplate_id: null
                    timezone: America/Los_Angeles
                    tzoffset: 960
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - address: 1601 S De Anza Blvd, Cupertino, CA 95014, USA
                    alarmtemplate_id: null
                    analyticEnabled: true
                    aptemplate_id: null
                    country_code: US
                    created_time: 1472591606
                    engagementEnabled: true
                    gatewaytemplate_id: e571f2a2-d748-4ad4-bd6c-895467957c21
                    id: 83bc290a-b76d-47fa-a294-d34e47f30f7f
                    lat: 37.295553
                    latlng:
                      lat: 37.295553
                      lng: -122.033007
                    lng: -122.033007
                    modified_time: 1728057857
                    msp_id: a9af4951-a1de-4520-b398-c95a58947349
                    name: Live-Demo
                    networktemplate_id: 964cb213-deb2-469d-8c1e-a5f8661c6886
                    notes: This site is used for demonstration purposes.
                    num_ap: 17
                    num_ap_connected: 14
                    num_clients: 14
                    num_devices: 26
                    num_devices_connected: 22
                    num_gateway: 1
                    num_gateway_connected: 1
                    num_switch: 8
                    num_switch_connected: 7
                    org_id: b9814b40-ac4b-4424-86a8-b787eb68b86a
                    rftemplate_id: 2c134c07-3c57-46b3-a53b-8aea92ed7234
                    secpolicy_id: null
                    sitegroup_ids:
                    - 5644a432-eea9-4a2f-a30a-ddaf4dbc79cf
                    - 5fc0f305-f626-49db-8869-10b87f201bba
                    - 882796ef-190b-405e-98ef-cb487140cf64
                    sitetemplate_id: null
                    timezone: America/Los_Angeles
                    tzoffset: 960
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/stats/tunnels/count:
    get:
      tags:
      - Orgs Stats - Tunnels
      summary: countOrgTunnelsStats
      description: Count by Distinct Attributes of Mist Tunnels Stats
      operationId: countOrgTunnelsStats
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group tunnel statistics count results. enum: `ap`, `auth_algo`, `encrypt_algo`, `ike_version`, `ip`, `last_event`, `mac`, `mxcluster_id`, `mxedge_id`, `node`, `peer_host`, `peer_ip`, `peer_mxedge_id`, `protocol`, `remote_ip`, `remote_port`, `site_id`, `state`, `tunnel_name`, `up`, `wxtunnel_id`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/org_tunnel_count_distinct'
          - description: 'Field used to group tunnel statistics count results. enum: `ap`, `auth_algo`, `encrypt_algo`, `ike_version`, `ip`, `last_event`, `mac`, `mxcluster_id`, `mxedge_id`, `node`, `peer_host`, `peer_ip`, `peer_mxedge_id`, `protocol`, `remote_ip`, `remote_port`, `site_id`, `state`, `tunnel_name`, `up`, `wxtunnel_id`'
      - name: type
        in: query
        description: 'Filter results by type. enum: `wan`, `wxtunnel`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/org_tunnel_type_count'
          - description: 'Filter results by type. enum: `wan`, `wxtunnel`'
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/stats/tunnels/search:
    get:
      tags:
      - Orgs Stats - Tunnels
      summary: searchOrgTunnelsStats
      description: >
        By default the endpoint returns only `wxtunnel` type stats, to get `wan` type stats

        you need to specify `type=wan` in the query parameters.



        Tunnel types:

        - `wxtunnel` (default) - A WxLan Tunnel (WxTunnel) are used to create a secure connection between Juniper Mist Access Points and third-party VPN concentrators using protocols such as L2TPv3 or dmvpn.

        - `wan` - A WAN Tunnel is a secure connection between two Gateways, typically used for site-to-site or mesh connectivity. It can be configured with various protocols and encryption methods.



        If `type` is not specified or `type`==`wxtunnel`, the following parameters are supported:

        - `mxcluster_id` - the MX cluster ID

        - `site_id` - the site ID

        - `wxtunnel_id` - the WX tunnel ID

        - `ap` - the AP MAC address



        If `type`==`wan`, the following parameters are supported:

        - `mac` - the MAC address of the WAN device

        - `node` - the node ID

        - `peer_ip` - the peer IP address

        - `peer_host` - the peer host name

        - `ip` - the IP address of the WAN device

        - `tunnel_name` - the name of the tunnel

        - `protocol` - the protocol used for the tunnel

        - `auth_algo` - the authentication algorithm used for the tunnel

        - `encrypt_algo` - the encryption algorithm used for the tunnel

        - `ike_version` - the IKE version used for the tunnel

        - `up` - the status of the tunnel (up or down)
      operationId: searchOrgTunnelsStats
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mxcluster_id
        in: query
        description: Filter results by mxcluster id when `type`==`wxtunnel`
        style: form
        explode: true
        schema:
          type: string
      - name: site_id
        in: query
        description: Filter results by site identifier
        style: form
        explode: true
        schema:
          type: string
      - name: wxtunnel_id
        in: query
        description: Filter results by wxtunnel id when `type`==`wxtunnel`
        style: form
        explode: true
        schema:
          type: string
      - name: ap
        in: query
        description: Filter results by AP MAC address when `type`==`wxtunnel`
        style: form
        explode: true
        schema:
          type: string
      - name: mac
        in: query
        description: Filter results by MAC address when `type`==`wan`
        style: form
        explode: true
        schema:
          type: string
      - name: node
        in: query
        description: Filter results by node when `type`==`wan`
        style: form
        explode: true
        schema:
          type: string
      - name: peer_ip
        in: query
        description: Filter results by peer ip when `type`==`wan`
        style: form
        explode: true
        schema:
          type: string
      - name: peer_host
        in: query
        description: Filter results by peer host when `type`==`wan`
        style: form
        explode: true
        schema:
          type: string
      - name: ip
        in: query
        description: Filter results by IP address when `type`==`wan`
        style: form
        explode: true
        schema:
          type: string
      - name: tunnel_name
        in: query
        description: Filter results by tunnel name when `type`==`wan`
        style: form
        explode: true
        schema:
          type: string
      - name: protocol
        in: query
        description: Filter results by protocol when `type`==`wan`
        style: form
        explode: true
        schema:
          type: string
      - name: auth_algo
        in: query
        description: Filter results by auth algo when `type`==`wan`
        style: form
        explode: true
        schema:
          type: string
      - name: encrypt_algo
        in: query
        description: Filter results by encrypt algo when `type`==`wan`
        style: form
        explode: true
        schema:
          type: string
      - name: ike_version
        in: query
        description: Filter results by ike version when `type`==`wan`
        style: form
        explode: true
        schema:
          type: string
      - name: up
        in: query
        description: Filter results by up when `type`==`wan`
        style: form
        explode: true
        schema:
          type: string
      - name: type
        in: query
        description: 'Filter results by type. enum: `wan`, `wxtunnel`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/tunnel_type'
          - description: 'Filter results by type. enum: `wan`, `wxtunnel`'
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 5m
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_tunnel_search'
                - description: Paginated response for organization tunnel statistics search results
                  examples:
                  - '{"end":1531862583,"limit":10,"results":[{"auth_algo":"hmac-md5-96","encrypt_algo":"aes-256-cbc","ike_version":"2","ip":"192.168.233.0","last_event":"down reason","mac":"020001ae9dd5","node":"node0","org_id":"78c11da8-f984-4425-bedb-a7ddd7d0f6da","peer_host":"sunnyvale1-vpn.zscalerbeta.net","peer_ip":"10.224.8.16","protocol":"ipsec","rx_bytes":150,"rx_pkts":75,"site_id":"e83e7928-eda1-4e93-82db-df3dd42ab726","tunnel_name":"Device-ipsec-1","tx_bytes":100,"tx_pkts":50,"up":true,"uptime":10,"wan_name":"wan"}],"start":1531776183,"total":1}'
                  - '{"end":1531862583,"limit":10,"results":[{"ap":"5c5b35000010","last_seen":1547437078,"mtu":582,"mxcluster_id":"572586b7-f97b-a22b-526c-8b97a3f609c4","mxedge_id":"387804a7-3474-85ce-15a2-f9a9684c9c90","mxtunnel_id":"7dae216d-7c98-a51b-e068-dd7d477b7216","org_id":"2818e386-8dec-2562-9ede-5b8a0fbbdc71","peer_mxedge_id":"09320a5c-bc23-441e-80a0-b96c632d45f5","remote_ip":"172.16.1.2","remote_port":13535,"sessions":[{"local_sid":31,"remote_id":"mxtunnel","remote_sid":13,"state":"established"}],"site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","start_time":1744000000,"state":"established_with_sessions"}],"start":1531776183,"total":1}'
                contentMediaType: application/json
              examples:
                Type Wan:
                  value:
                    end: 1531862583
                    limit: 10
                    results:
                    - auth_algo: hmac-md5-96
                      encrypt_algo: aes-256-cbc
                      ike_version: '2'
                      ip: 192.168.233.0
                      last_event: down reason
                      mac: 020001ae9dd5
                      node: node0
                      org_id: 78c11da8-f984-4425-bedb-a7ddd7d0f6da
                      peer_host: sunnyvale1-vpn.zscalerbeta.net
                      peer_ip: 10.224.8.16
                      protocol: ipsec
                      rx_bytes: 150
                      rx_pkts: 75
                      site_id: e83e7928-eda1-4e93-82db-df3dd42ab726
                      tunnel_name: Device-ipsec-1
                      tx_bytes: 100
                      tx_pkts: 50
                      up: true
                      uptime: 10
                      wan_name: wan
                    start: 1531776183
                    total: 1
                Type Wxtunnel:
                  value:
                    end: 1531862583
                    limit: 10
                    results:
                    - ap: 5c5b35000010
                      last_seen: 1547437078
                      mtu: 582
                      mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4
                      mxedge_id: 387804a7-3474-85ce-15a2-f9a9684c9c90
                      mxtunnel_id: 7dae216d-7c98-a51b-e068-dd7d477b7216
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      peer_mxedge_id: 09320a5c-bc23-441e-80a0-b96c632d45f5
                      remote_ip: 172.16.1.2
                      remote_port: 13535
                      sessions:
                      - local_sid: 31
                        remote_id: mxtunnel
                        remote_sid: 13
                        state: established
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      start_time: 1744000000
                      state: established_with_sessions
                    start: 1531776183
                    total: 1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_tunnel_search'
                - description: Paginated response for organization tunnel statistics search results
                  examples:
                  - '{"end":1531862583,"limit":10,"results":[{"auth_algo":"hmac-md5-96","encrypt_algo":"aes-256-cbc","ike_version":"2","ip":"192.168.233.0","last_event":"down reason","mac":"020001ae9dd5","node":"node0","org_id":"78c11da8-f984-4425-bedb-a7ddd7d0f6da","peer_host":"sunnyvale1-vpn.zscalerbeta.net","peer_ip":"10.224.8.16","protocol":"ipsec","rx_bytes":150,"rx_pkts":75,"site_id":"e83e7928-eda1-4e93-82db-df3dd42ab726","tunnel_name":"Device-ipsec-1","tx_bytes":100,"tx_pkts":50,"up":true,"uptime":10,"wan_name":"wan"}],"start":1531776183,"total":1}'
                  - '{"end":1531862583,"limit":10,"results":[{"ap":"5c5b35000010","last_seen":1547437078,"mtu":582,"mxcluster_id":"572586b7-f97b-a22b-526c-8b97a3f609c4","mxedge_id":"387804a7-3474-85ce-15a2-f9a9684c9c90","mxtunnel_id":"7dae216d-7c98-a51b-e068-dd7d477b7216","org_id":"2818e386-8dec-2562-9ede-5b8a0fbbdc71","peer_mxedge_id":"09320a5c-bc23-441e-80a0-b96c632d45f5","remote_ip":"172.16.1.2","remote_port":13535,"sessions":[{"local_sid":31,"remote_id":"mxtunnel","remote_sid":13,"state":"established"}],"site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","start_time":1744000000,"state":"established_with_sessions"}],"start":1531776183,"total":1}'
                contentMediaType: application/vnd.api+json
              examples:
                Type Wan:
                  value:
                    end: 1531862583
                    limit: 10
                    results:
                    - auth_algo: hmac-md5-96
                      encrypt_algo: aes-256-cbc
                      ike_version: '2'
                      ip: 192.168.233.0
                      last_event: down reason
                      mac: 020001ae9dd5
                      node: node0
                      org_id: 78c11da8-f984-4425-bedb-a7ddd7d0f6da
                      peer_host: sunnyvale1-vpn.zscalerbeta.net
                      peer_ip: 10.224.8.16
                      protocol: ipsec
                      rx_bytes: 150
                      rx_pkts: 75
                      site_id: e83e7928-eda1-4e93-82db-df3dd42ab726
                      tunnel_name: Device-ipsec-1
                      tx_bytes: 100
                      tx_pkts: 50
                      up: true
                      uptime: 10
                      wan_name: wan
                    start: 1531776183
                    total: 1
                Type Wxtunnel:
                  value:
                    end: 1531862583
                    limit: 10
                    results:
                    - ap: 5c5b35000010
                      last_seen: 1547437078
                      mtu: 582
                      mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4
                      mxedge_id: 387804a7-3474-85ce-15a2-f9a9684c9c90
                      mxtunnel_id: 7dae216d-7c98-a51b-e068-dd7d477b7216
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      peer_mxedge_id: 09320a5c-bc23-441e-80a0-b96c632d45f5
                      remote_ip: 172.16.1.2
                      remote_port: 13535
                      sessions:
                      - local_sid: 31
                        remote_id: mxtunnel
                        remote_sid: 13
                        state: established
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      start_time: 1744000000
                      state: established_with_sessions
                    start: 1531776183
                    total: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/stats/vpn_peers/count:
    get:
      tags:
      - Orgs Stats - VPN Peers
      summary: countOrgPeerPathStats
      description: Count by Distinct Attributes of Org Peer Path Stats
      operationId: countOrgPeerPathStats
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: Field used to group this count response
        style: form
        explode: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/stats/vpn_peers/search:
    get:
      tags:
      - Orgs Stats - VPN Peers
      summary: searchOrgPeerPathStats
      description: Search Org Peer Path Stats
      operationId: searchOrgPeerPathStats
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mac
        in: query
        description: Filter results by MAC address. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b53010101,5c5b53020202
      - name: site_id
        in: query
        description: Filter results by site identifier
        style: form
        explode: true
        schema:
          type: string
      - name: type
        in: query
        description: 'VPN implementation type used to filter the results. enum: `ipsec`, `svr`. Accepts multiple comma-separated values.'
        style: form
        explode: true
        schema:
          type: string
          examples:
          - svr,ipsec
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vpn_peer_stat_search'
                - description: Search response containing VPN peer path statistics
                  examples:
                  - end: 1619518989.4989712
                    limit: 10
                    results:
                    - is_active: true
                      last_seen: 1619518709.222
                      mac: 020001c04668
                      org_id: 0c160b7f-1027-4cd1-923b-744534c4b070
                      peer_mac: 020001367edd
                      peer_port_id: DC_Internet
                      peer_site_id: 725a8d34-a126-4f2c-b990-d1219421cb75
                      port_id: Lte
                      site_id: 725a8d34-a126-4f2c-b990-d1219421cb75
                      type: svr
                      up: true
                      uptime: 1527128046
                    - is_active: true
                      last_seen: 1619518709.222
                      latency: 91
                      mac: 020001c04668
                      mos: 4
                      mtu: 1500
                      org_id: 0c160b7f-1027-4cd1-923b-744534c4b070
                      peer_mac: 020001367edd
                      peer_port_id: DC_Internet
                      peer_router_name: RIDCBBP1
                      peer_site_id: 725a8d34-a126-4f2c-b990-d1219421cb75
                      port_id: Lte
                      router_name: RIST01544AP1
                      site_id: 725a8d34-a126-4f2c-b990-d1219421cb75
                      type: svr
                      up: true
                      uptime: 1527128046
                    start: 1619518689.4989705
                    total: 2
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1619518989.4989712
                    limit: 10
                    results:
                    - is_active: true
                      last_seen: 1619518709.222
                      mac: 020001c04668
                      org_id: 0c160b7f-1027-4cd1-923b-744534c4b070
                      peer_mac: 020001367edd
                      peer_port_id: DC_Internet
                      peer_site_id: 725a8d34-a126-4f2c-b990-d1219421cb75
                      port_id: Lte
                      site_id: 725a8d34-a126-4f2c-b990-d1219421cb75
                      type: svr
                      up: true
                      uptime: 1527128046
                    - is_active: true
                      last_seen: 1619518709.222
                      latency: 91
                      mac: 020001c04668
                      mos: 4
                      mtu: 1500
                      org_id: 0c160b7f-1027-4cd1-923b-744534c4b070
                      peer_mac: 020001367edd
                      peer_port_id: DC_Internet
                      peer_router_name: RIDCBBP1
                      peer_site_id: 725a8d34-a126-4f2c-b990-d1219421cb75
                      port_id: Lte
                      router_name: RIST01544AP1
                      site_id: 725a8d34-a126-4f2c-b990-d1219421cb75
                      type: svr
                      up: true
                      uptime: 1527128046
                    start: 1619518689.4989705
                    total: 2
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vpn_peer_stat_search'
                - description: Search response containing VPN peer path statistics
                  examples:
                  - end: 1619518989.4989712
                    limit: 10
                    results:
                    - is_active: true
                      last_seen: 1619518709.222
                      mac: 020001c04668
                      org_id: 0c160b7f-1027-4cd1-923b-744534c4b070
                      peer_mac: 020001367edd
                      peer_port_id: DC_Internet
                      peer_site_id: 725a8d34-a126-4f2c-b990-d1219421cb75
                      port_id: Lte
                      site_id: 725a8d34-a126-4f2c-b990-d1219421cb75
                      type: svr
                      up: true
                      uptime: 1527128046
                    - is_active: true
                      last_seen: 1619518709.222
                      latency: 91
                      mac: 020001c04668
                      mos: 4
                      mtu: 1500
                      org_id: 0c160b7f-1027-4cd1-923b-744534c4b070
                      peer_mac: 020001367edd
                      peer_port_id: DC_Internet
                      peer_router_name: RIDCBBP1
                      peer_site_id: 725a8d34-a126-4f2c-b990-d1219421cb75
                      port_id: Lte
                      router_name: RIST01544AP1
                      site_id: 725a8d34-a126-4f2c-b990-d1219421cb75
                      type: svr
                      up: true
                      uptime: 1527128046
                    start: 1619518689.4989705
                    total: 2
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1619518989.4989712
                    limit: 10
                    results:
                    - is_active: true
                      last_seen: 1619518709.222
                      mac: 020001c04668
                      org_id: 0c160b7f-1027-4cd1-923b-744534c4b070
                      peer_mac: 020001367edd
                      peer_port_id: DC_Internet
                      peer_site_id: 725a8d34-a126-4f2c-b990-d1219421cb75
                      port_id: Lte
                      site_id: 725a8d34-a126-4f2c-b990-d1219421cb75
                      type: svr
                      up: true
                      uptime: 1527128046
                    - is_active: true
                      last_seen: 1619518709.222
                      latency: 91
                      mac: 020001c04668
                      mos: 4
                      mtu: 1500
                      org_id: 0c160b7f-1027-4cd1-923b-744534c4b070
                      peer_mac: 020001367edd
                      peer_port_id: DC_Internet
                      peer_router_name: RIDCBBP1
                      peer_site_id: 725a8d34-a126-4f2c-b990-d1219421cb75
                      port_id: Lte
                      router_name: RIST01544AP1
                      site_id: 725a8d34-a126-4f2c-b990-d1219421cb75
                      type: svr
                      up: true
                      uptime: 1527128046
                    start: 1619518689.4989705
                    total: 2
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/nacrules:
    get:
      tags:
      - Orgs NAC Rules
      summary: listOrgNacRules
      description: List organization NAC authentication policy rules with evaluation order.
      operationId: listOrgNacRules
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/nac_rule'
                description: List of NAC authentication policy rules
                examples:
                - - action: allow
                    apply_tags:
                    - string
                    created_time: 0
                    id: 455f6eca-6276-4993-bfeb-53cbbbba6208
                    matching:
                      auth_type: eap-tls
                      nactags:
                      - string
                      port_types:
                      - wireless
                      site_ids:
                      - 454f6eca-6276-4993-bfeb-53cbbbba6308
                      sitegroup_ids:
                      - 453f6eca-6276-4993-bfeb-53cbbbba6408
                    modified_time: 0
                    name: string
                    not_matching:
                      auth_type: eap-tls
                      nactags:
                      - string
                      port_types:
                      - wireless
                      site_ids:
                      - 452f6eca-6276-4993-bfeb-53cbbbba6508
                      sitegroup_ids:
                      - 451f6eca-6276-4993-bfeb-53cbbbba6608
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - action: allow
                    apply_tags:
                    - string
                    created_time: 0
                    id: 455f6eca-6276-4993-bfeb-53cbbbba6208
                    matching:
                      auth_type: eap-tls
                      nactags:
                      - string
                      port_types:
                      - wireless
                      site_ids:
                      - 454f6eca-6276-4993-bfeb-53cbbbba6308
                      sitegroup_ids:
                      - 453f6eca-6276-4993-bfeb-53cbbbba6408
                    modified_time: 0
                    name: string
                    not_matching:
                      auth_type: eap-tls
                      nactags:
                      - string
                      port_types:
                      - wireless
                      site_ids:
                      - 452f6eca-6276-4993-bfeb-53cbbbba6508
                      sitegroup_ids:
                      - 451f6eca-6276-4993-bfeb-53cbbbba6608
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/nac_rule'
                description: List of NAC authentication policy rules
                examples:
                - - action: allow
                    apply_tags:
                    - string
                    created_time: 0
                    id: 455f6eca-6276-4993-bfeb-53cbbbba6208
                    matching:
                      auth_type: eap-tls
                      nactags:
                      - string
                      port_types:
                      - wireless
                      site_ids:
                      - 454f6eca-6276-4993-bfeb-53cbbbba6308
                      sitegroup_ids:
                      - 453f6eca-6276-4993-bfeb-53cbbbba6408
                    modified_time: 0
                    name: string
                    not_matching:
                      auth_type: eap-tls
                      nactags:
                      - string
                      port_types:
                      - wireless
                      site_ids:
                      - 452f6eca-6276-4993-bfeb-53cbbbba6508
                      sitegroup_ids:
                      - 451f6eca-6276-4993-bfeb-53cbbbba6608
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - action: allow
                    apply_tags:
                    - string
                    created_time: 0
                    id: 455f6eca-6276-4993-bfeb-53cbbbba6208
                    matching:
                      auth_type: eap-tls
                      nactags:
                      - string
                      port_types:
                      - wireless
                      site_ids:
                      - 454f6eca-6276-4993-bfeb-53cbbbba6308
                      sitegroup_ids:
                      - 453f6eca-6276-4993-bfeb-53cbbbba6408
                    modified_time: 0
                    name: string
                    not_matching:
                      auth_type: eap-tls
                      nactags:
                      - string
                      port_types:
                      - wireless
                      site_ids:
                      - 452f6eca-6276-4993-bfeb-53cbbbba6508
                      sitegroup_ids:
                      - 451f6eca-6276-4993-bfeb-53cbbbba6608
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs NAC Rules
      summary: createOrgNacRule
      description: Create a NAC authentication policy rule with match and not-match criteria, an allow or block action, optional result tags, and rule priority.
      operationId: createOrgNacRule
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/nac_rule'
              - examples:
                - action: allow
                  apply_tags:
                  - c049dfcd-0c73-5014-1c64-062e9903f1e5"
                  matching:
                    auth_type: eap-tls
                    nactags:
                    - 041d5d36-716c-4cfb-4988-3857c6aa14a2
                    - a809a97f-d599-f812-eb8c-c3f84aabf6ba
                    port_types:
                    - wired
                    site_ids:
                    - bb19fc3e-4124-4b57-80d9-c3f6edce47c4
                    - bb19fc3e-6564-4b57-80d9-c3f6edce47c1
                    sitegroup_ids:
                    - bb19fc3e-4124-4b57-80d9-c3f6edce47c4
                    - bb19fc3e-6564-4b57-80d9-c3f6edce47c1
                  name: name1
                  not_matching: {}
                  order: 1
              contentMediaType: application/json
            examples:
              Example:
                value:
                  action: allow
                  apply_tags:
                  - c049dfcd-0c73-5014-1c64-062e9903f1e5"
                  matching:
                    auth_type: eap-tls
                    nactags:
                    - 041d5d36-716c-4cfb-4988-3857c6aa14a2
                    - a809a97f-d599-f812-eb8c-c3f84aabf6ba
                    port_types:
                    - wired
                    site_ids:
                    - bb19fc3e-4124-4b57-80d9-c3f6edce47c4
                    - bb19fc3e-6564-4b57-80d9-c3f6edce47c1
                    sitegroup_ids:
                    - bb19fc3e-4124-4b57-80d9-c3f6edce47c4
                    - bb19fc3e-6564-4b57-80d9-c3f6edce47c1
                  name: name1
                  not_matching: {}
                  order: 1
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/nac_rule'
                - description: NAC authentication policy rule that matches request criteria and applies an allow or block action
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/nac_rule'
                - description: NAC authentication policy rule that matches request criteria and applies an allow or block action
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/nacrules/{nacrule_id}:
    delete:
      tags:
      - Orgs NAC Rules
      summary: deleteOrgNacRule
      description: Delete an organization NAC authentication policy rule by rule ID.
      operationId: deleteOrgNacRule
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: nacrule_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs NAC Rules
      summary: getOrgNacRule
      description: Retrieve configuration details for a specific NAC authentication policy rule, including action, matching criteria, dry-run state, and priority.
      operationId: getOrgNacRule
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: nacrule_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/nac_rule'
                - description: NAC authentication policy rule that matches request criteria and applies an allow or block action
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/nac_rule'
                - description: NAC authentication policy rule that matches request criteria and applies an allow or block action
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs NAC Rules
      summary: updateOrgNacRule
      description: Update a NAC authentication policy rule, including match and not-match criteria, action, result tags, dry-run state, and priority.
      operationId: updateOrgNacRule
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: nacrule_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/nac_rule'
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/nac_rule'
                - description: NAC authentication policy rule that matches request criteria and applies an allow or block action
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/nac_rule'
                - description: NAC authentication policy rule that matches request criteria and applies an allow or block action
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/networktemplates:
    get:
      tags:
      - Orgs Network Templates
      summary: listOrgNetworkTemplates
      description: List organization network templates that provide switch network, port, management, routing, NAC, and service configuration at the organization level.
      operationId: listOrgNetworkTemplates
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/network_template'
                description: List of network templates
                examples:
                - - additional_config_cmds:
                    - set snmp community public
                    created_time: 0
                    dhcp_snooping:
                      all_networks: true
                      enable_arp_spoof_check: true
                      enable_ip_source_guard: true
                      enabled: true
                      networks:
                      - string
                    dns_servers:
                    - 8.8.8.8
                    - 4.4.4.4
                    dns_suffix:
                    - .mist.local
                    - .mist.com
                    extra_routes:
                      0.0.0.0/0:
                        via: 1.2.3.4
                    group_tags: {}
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6808
                    import_org_networks:
                    - ap
                    mist_nac:
                      enabled: true
                      network: default
                    modified_time: 0
                    name: template_name
                    networks:
                      corp:
                        vlan_id: 600
                      default:
                        subnet: 192.168.1.0/24
                        vlan_id: 1
                      guest:
                        vlan_id: 700
                      mgmt:
                        vlan_id: 500
                    ntp_servers:
                    - 192.168.1.10
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    port_usages:
                      ap:
                        all_networks: false
                        allow_dhcpd: true
                        bypass_auth_when_server_down: true
                        description: WAP
                        disable_autoneg: false
                        disabled: false
                        duplex: auto
                        enable_mac_auth: false
                        enable_qos: true
                        mac_auth_only: false
                        mac_auth_protocol: pap
                        mac_limit: 0
                        mode: trunk
                        networks:
                        - guest
                        - corp
                        persist_mac: false
                        poe_disabled: false
                        port_network: default
                        server_reject_network: null
                        storm_control:
                          no_broadcast: false
                          no_multicast: false
                          no_registered_multicast: false
                          no_unknown_unicast: false
                          percentage: 80
                        stp_edge: true
                      dynamic:
                        mode: dynamic
                        reset_default_when: link_down
                        rules:
                        - equals: string
                          equals_any:
                          - string
                          expression: string
                          src: lldp_chassis_id
                          usage: string
                      iot:
                        allow_dhcpd: true
                        mode: access
                        port_network: default
                        stp_edge: true
                      uplink:
                        all_networks: true
                        enable_qos: false
                        mode: trunk
                        port_network: default
                        stp_edge: false
                    radius_config:
                      acct_interim_interval: 0
                      acct_servers:
                      - host: 1.2.3.4
                        keywrap_enabled: true
                        keywrap_format: hex
                        keywrap_kek: '1122334455'
                        keywrap_mack: '1122334455'
                        port: 1813
                        secret: testing123
                      auth_servers:
                      - host: 1.2.3.4
                        keywrap_enabled: true
                        keywrap_format: hex
                        keywrap_kek: '1122334455'
                        keywrap_mack: '1122334455'
                        port: 1812
                        secret: testing123
                      auth_servers_retries: 3
                      auth_servers_timeout: 5
                      coa_enabled: false
                      coa_port: 3799
                      network: default
                    remote_syslog:
                      archive:
                        files: 20
                        size: 5m
                      console:
                        contents:
                        - facility: config
                          severity: warning
                      enabled: false
                      files:
                      - archive:
                          files: 10
                          size: 5m
                        contents:
                        - facility: config
                          severity: warning
                        explicit_priority: true
                        file: file-name
                        match: '!alarm|ntp|errors.crc_error[chan]'
                        structured_data: true
                      network: default
                      send_to_all_servers: false
                      servers:
                      - facility: config
                        host: syslogd.internal
                        port: 514
                        protocol: udp
                        severity: info
                        tag: ''
                      time_format: millisecond
                      users:
                      - contents:
                        - facility: config
                          severity: warning
                        match: '"!alarm|ntp|errors.crc_error[chan]"'
                        user: '*'
                    switch_matching:
                      enable: true
                      rules:
                      - additional_config_cmds:
                        - set snmp community public
                        match_model: EX4300
                        match_name[0:3]: abc
                        name: match by name
                        port_config:
                          ge-0/0/0:
                            usage: uplink
                          ge-0/0/8-16ge-1/0/0-47:
                            usage: ap
                      - additional_config_cmds:
                        - set snmp community public2
                        match_role: access
                        name: match by role
                        port_config:
                          ge-0/0/0:
                            usage: uplink
                    switch_mgmt:
                      config_revert_timer: 10
                      protect_re:
                        enabled: false
                      root_password: string
                      tacacs:
                        acct_servers:
                        - host: 198.51.100.1
                          port: '49'
                          secret: string
                          timeout: 10
                        enabled: true
                        network: string
                        tacplus_servers:
                        - host: 198.51.100.1
                          port: '49'
                          secret: string
                          timeout: 10
                    vrf_config:
                      enabled: false
                    vrf_instances:
                      property1:
                        extra_routes:
                          property1:
                            via: 198.51.100.1
                          property2:
                            via: 198.51.100.10
                        networks:
                        - string
                      property2:
                        extra_routes:
                          property1:
                            via: 198.51.100.1
                          property2:
                            via: 198.51.100.10
                        networks:
                        - string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - additional_config_cmds:
                    - set snmp community public
                    created_time: 0
                    dhcp_snooping:
                      all_networks: true
                      enable_arp_spoof_check: true
                      enable_ip_source_guard: true
                      enabled: true
                      networks:
                      - string
                    dns_servers:
                    - 8.8.8.8
                    - 4.4.4.4
                    dns_suffix:
                    - .mist.local
                    - .mist.com
                    extra_routes:
                      0.0.0.0/0:
                        via: 1.2.3.4
                    group_tags: {}
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6808
                    import_org_networks:
                    - ap
                    mist_nac:
                      enabled: true
                      network: default
                    modified_time: 0
                    name: template_name
                    networks:
                      corp:
                        vlan_id: 600
                      default:
                        subnet: 192.168.1.0/24
                        vlan_id: 1
                      guest:
                        vlan_id: 700
                      mgmt:
                        vlan_id: 500
                    ntp_servers:
                    - 192.168.1.10
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    port_usages:
                      ap:
                        all_networks: false
                        allow_dhcpd: true
                        bypass_auth_when_server_down: true
                        description: WAP
                        disable_autoneg: false
                        disabled: false
                        duplex: auto
                        enable_mac_auth: false
                        enable_qos: true
                        mac_auth_only: false
                        mac_auth_protocol: pap
                        mac_limit: 0
                        mode: trunk
                        networks:
                        - guest
                        - corp
                        persist_mac: false
                        poe_disabled: false
                        port_network: default
                        server_reject_network: null
                        storm_control:
                          no_broadcast: false
                          no_multicast: false
                          no_registered_multicast: false
                          no_unknown_unicast: false
                          percentage: 80
                        stp_edge: true
                      dynamic:
                        mode: dynamic
                        reset_default_when: link_down
                        rules:
                        - equals: string
                          equals_any:
                          - string
                          expression: string
                          src: lldp_chassis_id
                          usage: string
                      iot:
                        allow_dhcpd: true
                        mode: access
                        port_network: default
                        stp_edge: true
                      uplink:
                        all_networks: true
                        enable_qos: false
                        mode: trunk
                        port_network: default
                        stp_edge: false
                    radius_config:
                      acct_interim_interval: 0
                      acct_servers:
                      - host: 1.2.3.4
                        keywrap_enabled: true
                        keywrap_format: hex
                        keywrap_kek: '1122334455'
                        keywrap_mack: '1122334455'
                        port: 1813
                        secret: testing123
                      auth_servers:
                      - host: 1.2.3.4
                        keywrap_enabled: true
                        keywrap_format: hex
                        keywrap_kek: '1122334455'
                        keywrap_mack: '1122334455'
                        port: 1812
                        secret: testing123
                      auth_servers_retries: 3
                      auth_servers_timeout: 5
                      coa_enabled: false
                      coa_port: 3799
                      network: default
                    remote_syslog:
                      archive:
                        files: 20
                        size: 5m
                      console:
                        contents:
                        - facility: config
                          severity: warning
                      enabled: false
                      files:
                      - archive:
                          files: 10
                          size: 5m
                        contents:
                        - facility: config
                          severity: warning
                        explicit_priority: true
                        file: file-name
                        match: '!alarm|ntp|errors.crc_error[chan]'
                        structured_data: true
                      network: default
                      send_to_all_servers: false
                      servers:
                      - facility: config
                        host: syslogd.internal
                        port: 514
                        protocol: udp
                        severity: info
                        tag: ''
                      time_format: millisecond
                      users:
                      - contents:
                        - facility: config
                          severity: warning
                        match: '"!alarm|ntp|errors.crc_error[chan]"'
                        user: '*'
                    switch_matching:
                      enable: true
                      rules:
                      - additional_config_cmds:
                        - set snmp community public
                        match_model: EX4300
                        match_name[0:3]: abc
                        name: match by name
                        port_config:
                          ge-0/0/0:
                            usage: uplink
                          ge-0/0/8-16ge-1/0/0-47:
                            usage: ap
                      - additional_config_cmds:
                        - set snmp community public2
                        match_role: access
                        name: match by role
                        port_config:
                          ge-0/0/0:
                            usage: uplink
                    switch_mgmt:
                      config_revert_timer: 10
                      protect_re:
                        enabled: false
                      root_password: string
                      tacacs:
                        acct_servers:
                        - host: 198.51.100.1
                          port: '49'
                          secret: string
                          timeout: 10
                        enabled: true
                        network: string
                        tacplus_servers:
                        - host: 198.51.100.1
                          port: '49'
                          secret: string
                          timeout: 10
                    vrf_config:
                      enabled: false
                    vrf_instances:
                      property1:
                        extra_routes:
                          property1:
                            via: 198.51.100.1
                          property2:
                            via: 198.51.100.10
                        networks:
                        - string
                      property2:
                        extra_routes:
                          property1:
                            via: 198.51.100.1
                          property2:
                            via: 198.51.100.10
                        networks:
                        - string
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/network_template'
                description: List of network templates
                examples:
                - - additional_config_cmds:
                    - set snmp community public
                    created_time: 0
                    dhcp_snooping:
                      all_networks: true
                      enable_arp_spoof_check: true
                      enable_ip_source_guard: true
                      enabled: true
                      networks:
                      - string
                    dns_servers:
                    - 8.8.8.8
                    - 4.4.4.4
                    dns_suffix:
                    - .mist.local
                    - .mist.com
                    extra_routes:
                      0.0.0.0/0:
                        via: 1.2.3.4
                    group_tags: {}
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6808
                    import_org_networks:
                    - ap
                    mist_nac:
                      enabled: true
                      network: default
                    modified_time: 0
                    name: template_name
                    networks:
                      corp:
                        vlan_id: 600
                      default:
                        subnet: 192.168.1.0/24
                        vlan_id: 1
                      guest:
                        vlan_id: 700
                      mgmt:
                        vlan_id: 500
                    ntp_servers:
                    - 192.168.1.10
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    port_usages:
                      ap:
                        all_networks: false
                        allow_dhcpd: true
                        bypass_auth_when_server_down: true
                        description: WAP
                        disable_autoneg: false
                        disabled: false
                        duplex: auto
                        enable_mac_auth: false
                        enable_qos: true
                        mac_auth_only: false
                        mac_auth_protocol: pap
                        mac_limit: 0
                        mode: trunk
                        networks:
                        - guest
                        - corp
                        persist_mac: false
                        poe_disabled: false
                        port_network: default
                        server_reject_network: null
                        storm_control:
                          no_broadcast: false
                          no_multicast: false
                          no_registered_multicast: false
                          no_unknown_unicast: false
                          percentage: 80
                        stp_edge: true
                      dynamic:
                        mode: dynamic
                        reset_default_when: link_down
                        rules:
                        - equals: string
                          equals_any:
                          - string
                          expression: string
                          src: lldp_chassis_id
                          usage: string
                      iot:
                        allow_dhcpd: true
                        mode: access
                        port_network: default
                        stp_edge: true
                      uplink:
                        all_networks: true
                        enable_qos: false
                        mode: trunk
                        port_network: default
                        stp_edge: false
                    radius_config:
                      acct_interim_interval: 0
                      acct_servers:
                      - host: 1.2.3.4
                        keywrap_enabled: true
                        keywrap_format: hex
                        keywrap_kek: '1122334455'
                        keywrap_mack: '1122334455'
                        port: 1813
                        secret: testing123
                      auth_servers:
                      - host: 1.2.3.4
                        keywrap_enabled: true
                        keywrap_format: hex
                        keywrap_kek: '1122334455'
                        keywrap_mack: '1122334455'
                        port: 1812
                        secret: testing123
                      auth_servers_retries: 3
                      auth_servers_timeout: 5
                      coa_enabled: false
                      coa_port: 3799
                      network: default
                    remote_syslog:
                      archive:
                        files: 20
                        size: 5m
                      console:
                        contents:
                        - facility: config
                          severity: warning
                      enabled: false
                      files:
                      - archive:
                          files: 10
                          size: 5m
                        contents:
                        - facility: config
                          severity: warning
                        explicit_priority: true
                        file: file-name
                        match: '!alarm|ntp|errors.crc_error[chan]'
                        structured_data: true
                      network: default
                      send_to_all_servers: false
                      servers:
                      - facility: config
                        host: syslogd.internal
                        port: 514
                        protocol: udp
                        severity: info
                        tag: ''
                      time_format: millisecond
                      users:
                      - contents:
                        - facility: config
                          severity: warning
                        match: '"!alarm|ntp|errors.crc_error[chan]"'
                        user: '*'
                    switch_matching:
                      enable: true
                      rules:
                      - additional_config_cmds:
                        - set snmp community public
                        match_model: EX4300
                        match_name[0:3]: abc
                        name: match by name
                        port_config:
                          ge-0/0/0:
                            usage: uplink
                          ge-0/0/8-16ge-1/0/0-47:
                            usage: ap
                      - additional_config_cmds:
                        - set snmp community public2
                        match_role: access
                        name: match by role
                        port_config:
                          ge-0/0/0:
                            usage: uplink
                    switch_mgmt:
                      config_revert_timer: 10
                      protect_re:
                        enabled: false
                      root_password: string
                      tacacs:
                        acct_servers:
                        - host: 198.51.100.1
                          port: '49'
                          secret: string
                          timeout: 10
                        enabled: true
                        network: string
                        tacplus_servers:
                        - host: 198.51.100.1
                          port: '49'
                          secret: string
                          timeout: 10
                    vrf_config:
                      enabled: false
                    vrf_instances:
                      property1:
                        extra_routes:
                          property1:
                            via: 198.51.100.1
                          property2:
                            via: 198.51.100.10
                        networks:
                        - string
                      property2:
                        extra_routes:
                          property1:
                            via: 198.51.100.1
                          property2:
                            via: 198.51.100.10
                        networks:
                        - string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - additional_config_cmds:
                    - set snmp community public
                    created_time: 0
                    dhcp_snooping:
                      all_networks: true
                      enable_arp_spoof_check: true
                      enable_ip_source_guard: true
                      enabled: true
                      networks:
                      - string
                    dns_servers:
                    - 8.8.8.8
                    - 4.4.4.4
                    dns_suffix:
                    - .mist.local
                    - .mist.com
                    extra_routes:
                      0.0.0.0/0:
                        via: 1.2.3.4
                    group_tags: {}
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6808
                    import_org_networks:
                    - ap
                    mist_nac:
                      enabled: true
                      network: default
                    modified_time: 0
                    name: template_name
                    networks:
                      corp:
                        vlan_id: 600
                      default:
                        subnet: 192.168.1.0/24
                        vlan_id: 1
                      guest:
                        vlan_id: 700
                      mgmt:
                        vlan_id: 500
                    ntp_servers:
                    - 192.168.1.10
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    port_usages:
                      ap:
                        all_networks: false
                        allow_dhcpd: true
                        bypass_auth_when_server_down: true
                        description: WAP
                        disable_autoneg: false
                        disabled: false
                        duplex: auto
                        enable_mac_auth: false
                        enable_qos: true
                        mac_auth_only: false
                        mac_auth_protocol: pap
                        mac_limit: 0
                        mode: trunk
                        networks:
                        - guest
                        - corp
                        persist_mac: false
                        poe_disabled: false
                        port_network: default
                        server_reject_network: null
                        storm_control:
                          no_broadcast: false
                          no_multicast: false
                          no_registered_multicast: false
                          no_unknown_unicast: false
                          percentage: 80
                        stp_edge: true
                      dynamic:
                        mode: dynamic
                        reset_default_when: link_down
                        rules:
                        - equals: string
                          equals_any:
                          - string
                          expression: string
                          src: lldp_chassis_id
                          usage: string
                      iot:
                        allow_dhcpd: true
                        mode: access
                        port_network: default
                        stp_edge: true
                      uplink:
                        all_networks: true
                        enable_qos: false
                        mode: trunk
                        port_network: default
                        stp_edge: false
                    radius_config:
                      acct_interim_interval: 0
                      acct_servers:
                      - host: 1.2.3.4
                        keywrap_enabled: true
                        keywrap_format: hex
                        keywrap_kek: '1122334455'
                        keywrap_mack: '1122334455'
                        port: 1813
                        secret: testing123
                      auth_servers:
                      - host: 1.2.3.4
                        keywrap_enabled: true
                        keywrap_format: hex
                        keywrap_kek: '1122334455'
                        keywrap_mack: '1122334455'
                        port: 1812
                        secret: testing123
                      auth_servers_retries: 3
                      auth_servers_timeout: 5
                      coa_enabled: false
                      coa_port: 3799
                      network: default
                    remote_syslog:
                      archive:
                        files: 20
                        size: 5m
                      console:
                        contents:
                        - facility: config
                          severity: warning
                      enabled: false
                      files:
                      - archive:
                          files: 10
                          size: 5m
                        contents:
                        - facility: config
                          severity: warning
                        explicit_priority: true
                        file: file-name
                        match: '!alarm|ntp|errors.crc_error[chan]'
                        structured_data: true
                      network: default
                      send_to_all_servers: false
                      servers:
                      - facility: config
                        host: syslogd.internal
                        port: 514
                        protocol: udp
                        severity: info
                        tag: ''
                      time_format: millisecond
                      users:
                      - contents:
                        - facility: config
                          severity: warning
                        match: '"!alarm|ntp|errors.crc_error[chan]"'
                        user: '*'
                    switch_matching:
                      enable: true
                      rules:
                      - additional_config_cmds:
                        - set snmp community public
                        match_model: EX4300
                        match_name[0:3]: abc
                        name: match by name
                        port_config:
                          ge-0/0/0:
                            usage: uplink
                          ge-0/0/8-16ge-1/0/0-47:
                            usage: ap
                      - additional_config_cmds:
                        - set snmp community public2
                        match_role: access
                        name: match by role
                        port_config:
                          ge-0/0/0:
                            usage: uplink
                    switch_mgmt:
                      config_revert_timer: 10
                      protect_re:
                        enabled: false
                      root_password: string
                      tacacs:
                        acct_servers:
                        - host: 198.51.100.1
                          port: '49'
                          secret: string
                          timeout: 10
                        enabled: true
                        network: string
                        tacplus_servers:
                        - host: 198.51.100.1
                          port: '49'
                          secret: string
                          timeout: 10
                    vrf_config:
                      enabled: false
                    vrf_instances:
                      property1:
                        extra_routes:
                          property1:
                            via: 198.51.100.1
                          property2:
                            via: 198.51.100.10
                        networks:
                        - string
                      property2:
                        extra_routes:
                          property1:
                            via: 198.51.100.1
                          property2:
                            via: 198.51.100.10
                        networks:
                        - string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs Network Templates
      summary: createOrgNetworkTemplate
      description: >-
        Create an organization network template with network, port usage, switch management, routing, NAC, and service  configuration at the organization level.


        Network templates can be applied to multiple sites within the organization to provide consistent network configuration across sites.

        To assign a network template to a site, use the [Update Site]($e/Sites/updateSiteInfo) endpoint and specify the network template ID in the `networktemplate_id` field of the request body.
      operationId: createOrgNetworkTemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/network_template'
              - description: Request Body
                examples:
                - additional_config_cmds:
                  - set snmp community public
                  dhcp_snooping:
                    all_networks: true
                    enable_arp_spoof_check: true
                    enable_ip_source_guard: true
                    enabled: true
                    networks:
                    - string
                  dns_servers:
                  - string
                  dns_suffix:
                  - string
                  import_org_networks:
                  - ap
                  mist_nac:
                    enabled: true
                    network: string
                  name: string
                  networks:
                    property1:
                      subnet: 192.168.1.0/24
                      vlan_id: 10
                    property2:
                      subnet: 192.168.1.0/24
                      vlan_id: 10
                  ntp_servers:
                  - string
                  port_usages:
                    dynamic:
                      mode: dynamic
                      reset_default_when: link_down
                      rules:
                      - equals: string
                        equals_any:
                        - string
                        expression: string
                        src: lldp_chassis_id
                        usage: string
                    property1:
                      all_networks: false
                      allow_dhcpd: true
                      bypass_auth_when_server_down: true
                      description: string
                      disable_autoneg: false
                      disabled: false
                      duplex: auto
                      enable_mac_auth: true
                      enable_qos: true
                      guest_network: string
                      mac_auth_only: true
                      mac_auth_protocol: pap
                      mac_limit: 0
                      mode: access
                      networks:
                      - string
                      persist_mac: false
                      poe_disabled: false
                      port_auth: dot1x
                      port_network: string
                      server_reject_network: null
                      speed: auto
                      storm_control:
                        no_broadcast: false
                        no_multicast: false
                        no_registered_multicast: false
                        no_unknown_unicast: false
                        percentage: 80
                      stp_edge: true
                      voip_network: string
                    property2:
                      all_networks: false
                      allow_dhcpd: true
                      bypass_auth_when_server_down: true
                      description: string
                      disable_autoneg: false
                      disabled: false
                      duplex: auto
                      enable_mac_auth: true
                      enable_qos: true
                      guest_network: string
                      mac_auth_only: true
                      mac_auth_protocol: pap
                      mac_limit: 0
                      mode: access
                      networks:
                      - string
                      persist_mac: false
                      poe_disabled: false
                      port_network: string
                      server_reject_network: null
                      speed: auto
                      storm_control:
                        no_broadcast: false
                        no_multicast: false
                        no_registered_multicast: false
                        no_unknown_unicast: false
                        percentage: 80
                      stp_edge: true
                      voip_network: string
                  switch_mgmt:
                    config_revert_timer: 10
                    protect_re:
                      enabled: false
                    root_password: string
                    tacacs:
                      acct_servers:
                      - host: 198.51.100.1
                        port: '49'
                        secret: string
                        timeout: 10
                      enabled: true
                      network: string
                      tacplus_servers:
                      - host: 198.51.100.1
                        port: '49'
                        secret: string
                        timeout: 10
                  vrf_config:
                    enabled: false
                  vrf_instances:
                    property1:
                      extra_routes:
                        property1:
                          via: 192.0.2.10
                        property2:
                          via: 198.51.100.1
                      networks:
                      - string
                    property2:
                      extra_routes:
                        property1:
                          via: 198.51.100.1
                        property2:
                          via: 198.51.100.10
                      networks:
                      - string
              contentMediaType: application/json
            examples:
              Example:
                value:
                  additional_config_cmds:
                  - set snmp community public
                  dhcp_snooping:
                    all_networks: true
                    enable_arp_spoof_check: true
                    enable_ip_source_guard: true
                    enabled: true
                    networks:
                    - string
                  dns_servers:
                  - string
                  dns_suffix:
                  - string
                  import_org_networks:
                  - ap
                  mist_nac:
                    enabled: true
                    network: string
                  name: string
                  networks:
                    property1:
                      subnet: 192.168.1.0/24
                      vlan_id: 10
                    property2:
                      subnet: 192.168.1.0/24
                      vlan_id: 10
                  ntp_servers:
                  - string
                  port_usages:
                    dynamic:
                      mode: dynamic
                      reset_default_when: link_down
                      rules:
                      - equals: string
                        equals_any:
                        - string
                        expression: string
                        src: lldp_chassis_id
                        usage: string
                    property1:
                      all_networks: false
                      allow_dhcpd: true
                      bypass_auth_when_server_down: true
                      description: string
                      disable_autoneg: false
                      disabled: false
                      duplex: auto
                      enable_mac_auth: true
                      enable_qos: true
                      guest_network: string
                      mac_auth_only: true
                      mac_auth_protocol: pap
                      mac_limit: 0
                      mode: access
                      networks:
                      - string
                      persist_mac: false
                      poe_disabled: false
                      port_auth: dot1x
                      port_network: string
                      server_reject_network: null
                      speed: auto
                      storm_control:
                        no_broadcast: false
                        no_multicast: false
                        no_registered_multicast: false
                        no_unknown_unicast: false
                        percentage: 80
                      stp_edge: true
                      voip_network: string
                    property2:
                      all_networks: false
                      allow_dhcpd: true
                      bypass_auth_when_server_down: true
                      description: string
                      disable_autoneg: false
                      disabled: false
                      duplex: auto
                      enable_mac_auth: true
                      enable_qos: true
                      guest_network: string
                      mac_auth_only: true
                      mac_auth_protocol: pap
                      mac_limit: 0
                      mode: access
                      networks:
                      - string
                      persist_mac: false
                      poe_disabled: false
                      port_network: string
                      server_reject_network: null
                      speed: auto
                      storm_control:
                        no_broadcast: false
                        no_multicast: false
                        no_registered_multicast: false
                        no_unknown_unicast: false
                        percentage: 80
                      stp_edge: true
                      voip_network: string
                  switch_mgmt:
                    config_revert_timer: 10
                    protect_re:
                      enabled: false
                    root_password: string
                    tacacs:
                      acct_servers:
                      - host: 198.51.100.1
                        port: '49'
                        secret: string
                        timeout: 10
                      enabled: true
                      network: string
                      tacplus_servers:
                      - host: 198.51.100.1
                        port: '49'
                        secret: string
                        timeout: 10
                  vrf_config:
                    enabled: false
                  vrf_instances:
                    property1:
                      extra_routes:
                        property1:
                          via: 192.0.2.10
                        property2:
                          via: 198.51.100.1
                      networks:
                      - string
                    property2:
                      extra_routes:
                        property1:
                          via: 198.51.100.1
                        property2:
                          via: 198.51.100.10
                      networks:
                      - string
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/network_template'
                - description: Network template configuration applied to sites or site groups
                  examples:
                  - additional_config_cmds:
                    - set snmp community public
                    created_time: 0
                    dhcp_snooping:
                      all_networks: true
                      enable_arp_spoof_check: true
                      enable_ip_source_guard: true
                      enabled: true
                      networks:
                      - string
                    dns_servers:
                    - string
                    dns_suffix:
                    - string
                    extra_routes:
                      property1:
                        via: string
                      property2:
                        via: string
                    group_tags: {}
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6708
                    import_org_networks:
                    - ap
                    mist_nac:
                      enabled: true
                      network: string
                    modified_time: 0
                    name: string
                    networks:
                      property1:
                        subnet: 192.168.1.0/24
                        vlan_id: 10
                      property2:
                        subnet: 192.168.1.0/24
                        vlan_id: 10
                    ntp_servers:
                    - string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    port_usages:
                      dynamic:
                        mode: dynamic
                        reset_default_when: link_down
                        rules:
                        - equals: string
                          equals_any:
                          - string
                          expression: string
                          src: lldp_chassis_id
                          usage: string
                      property1:
                        all_networks: false
                        allow_dhcpd: true
                        bypass_auth_when_server_down: true
                        description: string
                        disable_autoneg: false
                        disabled: false
                        duplex: auto
                        enable_mac_auth: true
                        enable_qos: true
                        guest_network: string
                        mac_auth_only: true
                        mac_auth_protocol: pap
                        mac_limit: 0
                        networks:
                        - string
                        persist_mac: false
                        poe_disabled: false
                        port_auth: dot1x
                        port_network: string
                        server_reject_network: null
                        speed: auto
                        storm_control:
                          no_broadcast: false
                          no_multicast: false
                          no_registered_multicast: false
                          no_unknown_unicast: false
                          percentage: 80
                        stp_edge: true
                        voip_network: string
                      property2:
                        all_networks: false
                        allow_dhcpd: true
                        bypass_auth_when_server_down: true
                        description: string
                        disable_autoneg: false
                        disabled: false
                        duplex: auto
                        enable_mac_auth: true
                        enable_qos: true
                        guest_network: string
                        mac_auth_only: true
                        mac_auth_protocol: pap
                        mac_limit: 0
                        mode: access
                        networks:
                        - string
                        persist_mac: false
                        poe_disabled: false
                        port_network: string
                        server_reject_network: null
                        speed: auto
                        storm_control:
                          no_broadcast: false
                          no_multicast: false
                          no_registered_multicast: false
                          no_unknown_unicast: false
                          percentage: 80
                        stp_edge: true
                        voip_network: string
                    switch_mgmt:
                      config_revert_timer: 10
                      protect_re:
                        enabled: false
                      root_password: string
                      tacacs:
                        acct_servers:
                        - host: 198.51.100.1
                          port: '49'
                          secret: string
                          timeout: 10
                        enabled: true
                        network: string
                        tacplus_servers:
                        - host: 198.51.100.1
                          port: '49'
                          secret: string
                          timeout: 10
                    vrf_config:
                      enabled: false
                    vrf_instances:
                      property1:
                        extra_routes:
                          property1:
                            via: 198.51.100.1
                          property2:
                            via: 198.51.100.10
                        networks:
                        - string
                      property2:
                        extra_routes:
                          property1:
                            via: 198.51.100.1
                          property2:
                            via: 198.51.100.10
                        networks:
                        - string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    additional_config_cmds:
                    - set snmp community public
                    created_time: 0
                    dhcp_snooping:
                      all_networks: true
                      enable_arp_spoof_check: true
                      enable_ip_source_guard: true
                      enabled: true
                      networks:
                      - string
                    dns_servers:
                    - string
                    dns_suffix:
                    - string
                    extra_routes:
                      property1:
                        via: string
                      property2:
                        via: string
                    group_tags: {}
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6708
                    import_org_networks:
                    - ap
                    mist_nac:
                      enabled: true
                      network: string
                    modified_time: 0
                    name: string
                    networks:
                      property1:
                        subnet: 192.168.1.0/24
                        vlan_id: 10
                      property2:
                        subnet: 192.168.1.0/24
                        vlan_id: 10
                    ntp_servers:
                    - string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    port_usages:
                      dynamic:
                        mode: dynamic
                        reset_default_when: link_down
                        rules:
                        - equals: string
                          equals_any:
                          - string
                          expression: string
                          src: lldp_chassis_id
                          usage: string
                      property1:
                        all_networks: false
                        allow_dhcpd: true
                        bypass_auth_when_server_down: true
                        description: string
                        disable_autoneg: false
                        disabled: false
                        duplex: auto
                        enable_mac_auth: true
                        enable_qos: true
                        guest_network: string
                        mac_auth_only: true
                        mac_auth_protocol: pap
                        mac_limit: 0
                        networks:
                        - string
                        persist_mac: false
                        poe_disabled: false
                        port_auth: dot1x
                        port_network: string
                        server_reject_network: null
                        speed: auto
                        storm_control:
                          no_broadcast: false
                          no_multicast: false
                          no_registered_multicast: false
                          no_unknown_unicast: false
                          percentage: 80
                        stp_edge: true
                        voip_network: string
                      property2:
                        all_networks: false
                        allow_dhcpd: true
                        bypass_auth_when_server_down: true
                        description: string
                        disable_autoneg: false
                        disabled: false
                        duplex: auto
                        enable_mac_auth: true
                        enable_qos: true
                        guest_network: string
                        mac_auth_only: true
                        mac_auth_protocol: pap
                        mac_limit: 0
                        mode: access
                        networks:
                        - string
                        persist_mac: false
                        poe_disabled: false
                        port_network: string
                        server_reject_network: null
                        speed: auto
                        storm_control:
                          no_broadcast: false
                          no_multicast: false
                          no_registered_multicast: false
                          no_unknown_unicast: false
                          percentage: 80
                        stp_edge: true
                        voip_network: string
                    switch_mgmt:
                      config_revert_timer: 10
                      protect_re:
                        enabled: false
                      root_password: string
                      tacacs:
                        acct_servers:
                        - host: 198.51.100.1
                          port: '49'
                          secret: string
                          timeout: 10
                        enabled: true
                        network: string
                        tacplus_servers:
                        - host: 198.51.100.1
                          port: '49'
                          secret: string
                          timeout: 10
                    vrf_config:
                      enabled: false
                    vrf_instances:
                      property1:
                        extra_routes:
                          property1:
                            via: 198.51.100.1
                          property2:
                            via: 198.51.100.10
                        networks:
                        - string
                      property2:
                        extra_routes:
                          property1:
                            via: 198.51.100.1
                          property2:
                            via: 198.51.100.10
                        networks:
                        - string
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/network_template'
                - description: Network template configuration applied to sites or site groups
                  examples:
                  - additional_config_cmds:
                    - set snmp community public
                    created_time: 0
                    dhcp_snooping:
                      all_networks: true
                      enable_arp_spoof_check: true
                      enable_ip_source_guard: true
                      enabled: true
                      networks:
                      - string
                    dns_servers:
                    - string
                    dns_suffix:
                    - string
                    extra_routes:
                      property1:
                        via: string
                      property2:
                        via: string
                    group_tags: {}
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6708
                    import_org_networks:
                    - ap
                    mist_nac:
                      enabled: true
                      network: string
                    modified_time: 0
                    name: string
                    networks:
                      property1:
                        subnet: 192.168.1.0/24
                        vlan_id: 10
                      property2:
                        subnet: 192.168.1.0/24
                        vlan_id: 10
                    ntp_servers:
                    - string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    port_usages:
                      dynamic:
                        mode: dynamic
                        reset_default_when: link_down
                        rules:
                        - equals: string
                          equals_any:
                          - string
                          expression: string
                          src: lldp_chassis_id
                          usage: string
                      property1:
                        all_networks: false
                        allow_dhcpd: true
                        bypass_auth_when_server_down: true
                        description: string
                        disable_autoneg: false
                        disabled: false
                        duplex: auto
                        enable_mac_auth: true
                        enable_qos: true
                        guest_network: string
                        mac_auth_only: true
                        mac_auth_protocol: pap
                        mac_limit: 0
                        networks:
                        - string
                        persist_mac: false
                        poe_disabled: false
                        port_auth: dot1x
                        port_network: string
                        server_reject_network: null
                        speed: auto
                        storm_control:
                          no_broadcast: false
                          no_multicast: false
                          no_registered_multicast: false
                          no_unknown_unicast: false
                          percentage: 80
                        stp_edge: true
                        voip_network: string
                      property2:
                        all_networks: false
                        allow_dhcpd: true
                        bypass_auth_when_server_down: true
                        description: string
                        disable_autoneg: false
                        disabled: false
                        duplex: auto
                        enable_mac_auth: true
                        enable_qos: true
                        guest_network: string
                        mac_auth_only: true
                        mac_auth_protocol: pap
                        mac_limit: 0
                        mode: access
                        networks:
                        - string
                        persist_mac: false
                        poe_disabled: false
                        port_network: string
                        server_reject_network: null
                        speed: auto
                        storm_control:
                          no_broadcast: false
                          no_multicast: false
                          no_registered_multicast: false
                          no_unknown_unicast: false
                          percentage: 80
                        stp_edge: true
                        voip_network: string
                    switch_mgmt:
                      config_revert_timer: 10
                      protect_re:
                        enabled: false
                      root_password: string
                      tacacs:
                        acct_servers:
                        - host: 198.51.100.1
                          port: '49'
                          secret: string
                          timeout: 10
                        enabled: true
                        network: string
                        tacplus_servers:
                        - host: 198.51.100.1
                          port: '49'
                          secret: string
                          timeout: 10
                    vrf_config:
                      enabled: false
                    vrf_instances:
                      property1:
                        extra_routes:
                          property1:
                            via: 198.51.100.1
                          property2:
                            via: 198.51.100.10
                        networks:
                        - string
                      property2:
                        extra_routes:
                          property1:
                            via: 198.51.100.1
                          property2:
                            via: 198.51.100.10
                        networks:
                        - string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    additional_config_cmds:
                    - set snmp community public
                    created_time: 0
                    dhcp_snooping:
                      all_networks: true
                      enable_arp_spoof_check: true
                      enable_ip_source_guard: true
                      enabled: true
                      networks:
                      - string
                    dns_servers:
                    - string
                    dns_suffix:
                    - string
                    extra_routes:
                      property1:
                        via: string
                      property2:
                        via: string
                    group_tags: {}
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6708
                    import_org_networks:
                    - ap
                    mist_nac:
                      enabled: true
                      network: string
                    modified_time: 0
                    name: string
                    networks:
                      property1:
                        subnet: 192.168.1.0/24
                        vlan_id: 10
                      property2:
                        subnet: 192.168.1.0/24
                        vlan_id: 10
                    ntp_servers:
                    - string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    port_usages:
                      dynamic:
                        mode: dynamic
                        reset_default_when: link_down
                        rules:
                        - equals: string
                          equals_any:
                          - string
                          expression: string
                          src: lldp_chassis_id
                          usage: string
                      property1:
                        all_networks: false
                        allow_dhcpd: true
                        bypass_auth_when_server_down: true
                        description: string
                        disable_autoneg: false
                        disabled: false
                        duplex: auto
                        enable_mac_auth: true
                        enable_qos: true
                        guest_network: string
                        mac_auth_only: true
                        mac_auth_protocol: pap
                        mac_limit: 0
                        networks:
                        - string
                        persist_mac: false
                        poe_disabled: false
                        port_auth: dot1x
                        port_network: string
                        server_reject_network: null
                        speed: auto
                        storm_control:
                          no_broadcast: false
                          no_multicast: false
                          no_registered_multicast: false
                          no_unknown_unicast: false
                          percentage: 80
                        stp_edge: true
                        voip_network: string
                      property2:
                        all_networks: false
                        allow_dhcpd: true
                        bypass_auth_when_server_down: true
                        description: string
                        disable_autoneg: false
                        disabled: false
                        duplex: auto
                        enable_mac_auth: true
                        enable_qos: true
                        guest_network: string
                        mac_auth_only: true
                        mac_auth_protocol: pap
                        mac_limit: 0
                        mode: access
                        networks:
                        - string
                        persist_mac: false
                        poe_disabled: false
                        port_network: string
                        server_reject_network: null
                        speed: auto
                        storm_control:
                          no_broadcast: false
                          no_multicast: false
                          no_registered_multicast: false
                          no_unknown_unicast: false
                          percentage: 80
                        stp_edge: true
                        voip_network: string
                    switch_mgmt:
                      config_revert_timer: 10
                      protect_re:
                        enabled: false
                      root_password: string
                      tacacs:
                        acct_servers:
                        - host: 198.51.100.1
                          port: '49'
                          secret: string
                          timeout: 10
                        enabled: true
                        network: string
                        tacplus_servers:
                        - host: 198.51.100.1
                          port: '49'
                          secret: string
                          timeout: 10
                    vrf_config:
                      enabled: false
                    vrf_instances:
                      property1:
                        extra_routes:
                          property1:
                            via: 198.51.100.1
                          property2:
                            via: 198.51.100.10
                        networks:
                        - string
                      property2:
                        extra_routes:
                          property1:
                            via: 198.51.100.1
                          property2:
                            via: 198.51.100.10
                        networks:
                        - string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/networktemplates/{networktemplate_id}:
    delete:
      tags:
      - Orgs Network Templates
      summary: deleteOrgNetworkTemplate
      description: Delete an organization network template by template ID so it can no longer be applied to sites or site groups.
      operationId: deleteOrgNetworkTemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: networktemplate_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs Network Templates
      summary: getOrgNetworkTemplate
      description: Retrieve details for a specific organization network template, including network, port usage, switch management, routing, NAC, and service defaults.
      operationId: getOrgNetworkTemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: networktemplate_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/network_template'
                - description: Network template configuration applied to sites or site groups
                contentMediaType: application/json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs Network Templates
      summary: updateOrgNetworkTemplate
      description: Update an organization network template, including network, port usage, switch management, routing, NAC, and service defaults.
      operationId: updateOrgNetworkTemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: networktemplate_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/network_template'
              - description: Request Body
                examples:
                - additional_config_cmds:
                  - set snmp community public
                  dhcp_snooping:
                    all_networks: true
                    enable_arp_spoof_check: true
                    enable_ip_source_guard: true
                    enabled: true
                    networks:
                    - string
                  dns_servers:
                  - string
                  dns_suffix:
                  - string
                  extra_routes:
                    property1:
                      via: string
                    property2:
                      via: string
                  group_tags: {}
                  import_org_networks:
                  - ap
                  mist_nac:
                    enabled: true
                    network: string
                  name: string
                  networks:
                    property1:
                      subnet: 192.168.1.0/24
                      vlan_id: 10
                    property2:
                      subnet: 192.168.1.0/24
                      vlan_id: 10
                  ntp_servers:
                  - string
                  port_usages:
                    dynamic:
                      mode: dynamic
                      reset_default_when: link_down
                      rules:
                      - equals: string
                        equals_any:
                        - string
                        expression: string
                        src: lldp_chassis_id
                        usage: string
                    property1:
                      all_networks: false
                      allow_dhcpd: true
                      bypass_auth_when_server_down: true
                      description: string
                      disable_autoneg: false
                      disabled: false
                      duplex: auto
                      enable_mac_auth: true
                      enable_qos: true
                      guest_network: string
                      mac_auth_only: true
                      mac_auth_protocol: pap
                      mac_limit: 0
                      mode: access
                      networks:
                      - string
                      persist_mac: false
                      poe_disabled: false
                      port_auth: dot1x
                      port_network: string
                      server_reject_network: null
                      speed: auto
                      storm_control:
                        no_broadcast: false
                        no_multicast: false
                        no_registered_multicast: false
                        no_unknown_unicast: false
                        percentage: 80
                      stp_edge: true
                      voip_network: string
                    property2:
                      all_networks: false
                      allow_dhcpd: true
                      bypass_auth_when_server_down: true
                      description: string
                      disable_autoneg: false
                      disabled: false
                      duplex: auto
                      enable_mac_auth: true
                      enable_qos: true
                      guest_network: string
                      mac_auth_only: true
                      mac_auth_protocol: pap
                      mac_limit: 0
                      mode: access
                      networks:
                      - string
                      persist_mac: false
                      poe_disabled: false
                      port_network: string
                      server_reject_network: null
                      speed: auto
                      storm_control:
                        no_broadcast: false
                        no_multicast: false
                        no_registered_multicast: false
                        no_unknown_unicast: false
                        percentage: 80
                      stp_edge: true
                      voip_network: string
                  switch_mgmt:
                    config_revert_timer: 10
                    protect_re:
                      enabled: false
                    root_password: string
                    tacacs:
                      acct_servers:
                      - host: 198.51.100.1
                        port: '49'
                        secret: string
                        timeout: 10
                      enabled: true
                      network: string
                      tacplus_servers:
                      - host: 198.51.100.1
                        port: '49'
                        secret: string
                        timeout: 10
                  vrf_config:
                    enabled: false
                  vrf_instances:
                    property1:
                      extra_routes:
                        property1:
                          via: 198.51.100.1
                        property2:
                          via: 198.51.100.2
                      networks:
                      - string
                    property2:
                      extra_routes:
                        property1:
                          via: 198.51.100.1
                        property2:
                          via: 198.51.100.2
                      networks:
                      - string
              contentMediaType: application/json
            examples:
              Example:
                value:
                  additional_config_cmds:
                  - set snmp community public
                  dhcp_snooping:
                    all_networks: true
                    enable_arp_spoof_check: true
                    enable_ip_source_guard: true
                    enabled: true
                    networks:
                    - string
                  dns_servers:
                  - string
                  dns_suffix:
                  - string
                  extra_routes:
                    property1:
                      via: string
                    property2:
                      via: string
                  group_tags: {}
                  import_org_networks:
                  - ap
                  mist_nac:
                    enabled: true
                    network: string
                  name: string
                  networks:
                    property1:
                      subnet: 192.168.1.0/24
                      vlan_id: 10
                    property2:
                      subnet: 192.168.1.0/24
                      vlan_id: 10
                  ntp_servers:
                  - string
                  port_usages:
                    dynamic:
                      mode: dynamic
                      reset_default_when: link_down
                      rules:
                      - equals: string
                        equals_any:
                        - string
                        expression: string
                        src: lldp_chassis_id
                        usage: string
                    property1:
                      all_networks: false
                      allow_dhcpd: true
                      bypass_auth_when_server_down: true
                      description: string
                      disable_autoneg: false
                      disabled: false
                      duplex: auto
                      enable_mac_auth: true
                      enable_qos: true
                      guest_network: string
                      mac_auth_only: true
                      mac_auth_protocol: pap
                      mac_limit: 0
                      mode: access
                      networks:
                      - string
                      persist_mac: false
                      poe_disabled: false
                      port_auth: dot1x
                      port_network: string
                      server_reject_network: null
                      speed: auto
                      storm_control:
                        no_broadcast: false
                        no_multicast: false
                        no_registered_multicast: false
                        no_unknown_unicast: false
                        percentage: 80
                      stp_edge: true
                      voip_network: string
                    property2:
                      all_networks: false
                      allow_dhcpd: true
                      bypass_auth_when_server_down: true
                      description: string
                      disable_autoneg: false
                      disabled: false
                      duplex: auto
                      enable_mac_auth: true
                      enable_qos: true
                      guest_network: string
                      mac_auth_only: true
                      mac_auth_protocol: pap
                      mac_limit: 0
                      mode: access
                      networks:
                      - string
                      persist_mac: false
                      poe_disabled: false
                      port_network: string
                      server_reject_network: null
                      speed: auto
                      storm_control:
                        no_broadcast: false
                        no_multicast: false
                        no_registered_multicast: false
                        no_unknown_unicast: false
                        percentage: 80
                      stp_edge: true
                      voip_network: string
                  switch_mgmt:
                    config_revert_timer: 10
                    protect_re:
                      enabled: false
                    root_password: string
                    tacacs:
                      acct_servers:
                      - host: 198.51.100.1
                        port: '49'
                        secret: string
                        timeout: 10
                      enabled: true
                      network: string
                      tacplus_servers:
                      - host: 198.51.100.1
                        port: '49'
                        secret: string
                        timeout: 10
                  vrf_config:
                    enabled: false
                  vrf_instances:
                    property1:
                      extra_routes:
                        property1:
                          via: 198.51.100.1
                        property2:
                          via: 198.51.100.2
                      networks:
                      - string
                    property2:
                      extra_routes:
                        property1:
                          via: 198.51.100.1
                        property2:
                          via: 198.51.100.2
                      networks:
                      - string
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/network_template'
                - description: Network template configuration applied to sites or site groups
                  examples:
                  - additional_config_cmds:
                    - set snmp community public
                    dhcp_snooping:
                      all_networks: true
                      enable_arp_spoof_check: true
                      enable_ip_source_guard: true
                      enabled: true
                      networks:
                      - string
                    dns_servers:
                    - string
                    dns_suffix:
                    - string
                    extra_routes:
                      property1:
                        via: string
                      property2:
                        via: string
                    import_org_networks:
                    - ap
                    mist_nac:
                      enabled: true
                      network: string
                    name: string
                    networks:
                      property1:
                        subnet: 192.168.1.0/24
                        vlan_id: 10
                      property2:
                        subnet: 192.168.1.0/24
                        vlan_id: 10
                    ntp_servers:
                    - string
                    port_usages:
                      dynamic:
                        mode: dynamic
                        reset_default_when: link_down
                        rules:
                        - equals: string
                          equals_any:
                          - string
                          expression: string
                          src: lldp_chassis_id
                          usage: string
                      property1:
                        all_networks: false
                        allow_dhcpd: true
                        bypass_auth_when_server_down: true
                        description: string
                        disable_autoneg: false
                        disabled: false
                        duplex: auto
                        enable_mac_auth: true
                        enable_qos: true
                        guest_network: string
                        mac_auth_only: true
                        mac_auth_protocol: pap
                        mac_limit: 0
                        mode: access
                        networks:
                        - string
                        persist_mac: false
                        poe_disabled: false
                        port_auth: dot1x
                        port_network: string
                        server_reject_network: null
                        speed: auto
                        storm_control:
                          no_broadcast: false
                          no_multicast: false
                          no_registered_multicast: false
                          no_unknown_unicast: false
                          percentage: 80
                        stp_edge: true
                        voip_network: string
                      property2:
                        all_networks: false
                        allow_dhcpd: true
                        bypass_auth_when_server_down: true
                        description: string
                        disable_autoneg: false
                        disabled: false
                        duplex: auto
                        enable_mac_auth: true
                        enable_qos: true
                        guest_network: string
                        mac_auth_only: true
                        mac_auth_protocol: pap
                        mac_limit: 0
                        mode: access
                        networks:
                        - string
                        persist_mac: false
                        poe_disabled: false
                        port_network: string
                        server_reject_network: null
                        speed: auto
                        storm_control:
                          no_broadcast: false
                          no_multicast: false
                          no_registered_multicast: false
                          no_unknown_unicast: false
                          percentage: 80
                        stp_edge: true
                        voip_network: string
                    switch_mgmt:
                      config_revert_timer: 10
                      protect_re:
                        enabled: false
                      root_password: string
                      tacacs:
                        acct_servers:
                        - host: 198.51.100.1
                          port: '49'
                          secret: string
                          timeout: 10
                        enabled: true
                        network: string
                        tacplus_servers:
                        - host: 198.51.100.1
                          port: '49'
                          secret: string
                          timeout: 10
                    vrf_config:
                      enabled: false
                    vrf_instances:
                      property1:
                        extra_routes:
                          property1:
                            via: 198.51.100.1
                          property2:
                            via: 198.51.100.2
                        networks:
                        - string
                      property2:
                        extra_routes:
                          property1:
                            via: 198.51.100.1
                          property2:
                            via: 198.51.100.2
                        networks:
                        - string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    additional_config_cmds:
                    - set snmp community public
                    dhcp_snooping:
                      all_networks: true
                      enable_arp_spoof_check: true
                      enable_ip_source_guard: true
                      enabled: true
                      networks:
                      - string
                    dns_servers:
                    - string
                    dns_suffix:
                    - string
                    extra_routes:
                      property1:
                        via: string
                      property2:
                        via: string
                    import_org_networks:
                    - ap
                    mist_nac:
                      enabled: true
                      network: string
                    name: string
                    networks:
                      property1:
                        subnet: 192.168.1.0/24
                        vlan_id: 10
                      property2:
                        subnet: 192.168.1.0/24
                        vlan_id: 10
                    ntp_servers:
                    - string
                    port_usages:
                      dynamic:
                        mode: dynamic
                        reset_default_when: link_down
                        rules:
                        - equals: string
                          equals_any:
                          - string
                          expression: string
                          src: lldp_chassis_id
                          usage: string
                      property1:
                        all_networks: false
                        allow_dhcpd: true
                        bypass_auth_when_server_down: true
                        description: string
                        disable_autoneg: false
                        disabled: false
                        duplex: auto
                        enable_mac_auth: true
                        enable_qos: true
                        guest_network: string
                        mac_auth_only: true
                        mac_auth_protocol: pap
                        mac_limit: 0
                        mode: access
                        networks:
                        - string
                        persist_mac: false
                        poe_disabled: false
                        port_auth: dot1x
                        port_network: string
                        server_reject_network: null
                        speed: auto
                        storm_control:
                          no_broadcast: false
                          no_multicast: false
                          no_registered_multicast: false
                          no_unknown_unicast: false
                          percentage: 80
                        stp_edge: true
                        voip_network: string
                      property2:
                        all_networks: false
                        allow_dhcpd: true
                        bypass_auth_when_server_down: true
                        description: string
                        disable_autoneg: false
                        disabled: false
                        duplex: auto
                        enable_mac_auth: true
                        enable_qos: true
                        guest_network: string
                        mac_auth_only: true
                        mac_auth_protocol: pap
                        mac_limit: 0
                        mode: access
                        networks:
                        - string
                        persist_mac: false
                        poe_disabled: false
                        port_network: string
                        server_reject_network: null
                        speed: auto
                        storm_control:
                          no_broadcast: false
                          no_multicast: false
                          no_registered_multicast: false
                          no_unknown_unicast: false
                          percentage: 80
                        stp_edge: true
                        voip_network: string
                    switch_mgmt:
                      config_revert_timer: 10
                      protect_re:
                        enabled: false
                      root_password: string
                      tacacs:
                        acct_servers:
                        - host: 198.51.100.1
                          port: '49'
                          secret: string
                          timeout: 10
                        enabled: true
                        network: string
                        tacplus_servers:
                        - host: 198.51.100.1
                          port: '49'
                          secret: string
                          timeout: 10
                    vrf_config:
                      enabled: false
                    vrf_instances:
                      property1:
                        extra_routes:
                          property1:
                            via: 198.51.100.1
                          property2:
                            via: 198.51.100.2
                        networks:
                        - string
                      property2:
                        extra_routes:
                          property1:
                            via: 198.51.100.1
                          property2:
                            via: 198.51.100.2
                        networks:
                        - string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/networks:
    get:
      tags:
      - Orgs Networks
      summary: listOrgNetworks
      description: List organization-level Layer 3 network definitions used for service routes and gateway or network template configuration.
      operationId: listOrgNetworks
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/network'
                description: List of organization network definitions
                examples:
                - - created_time: 0
                    disallow_mist_services: false
                    gateway: 192.168.70.1
                    hosts:
                      property1:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                      property2:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6f13
                    internal_access:
                      enabled: true
                    internet_access:
                      create_simple_service_policy: false
                      destination_nat:
                        property1:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                        property2:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                      enabled: true
                      restricted: false
                      static_nat:
                        property1:
                          internal_ip: 192.168.70.3
                          name: printer-1
                        property2:
                          internal_ip: 192.168.70.3
                          name: printer-1
                    isolation: true
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    subnet: 192.168.70.0/24
                    tenants:
                      property1:
                        addresses:
                        - 10.10.10.10
                      property2:
                        addresses:
                        - 10.10.10.45
                    vlan_id: 10
                    vpn_access:
                      property1:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
                      property2:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 0
                    disallow_mist_services: false
                    gateway: 192.168.70.1
                    hosts:
                      property1:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                      property2:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6f13
                    internal_access:
                      enabled: true
                    internet_access:
                      create_simple_service_policy: false
                      destination_nat:
                        property1:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                        property2:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                      enabled: true
                      restricted: false
                      static_nat:
                        property1:
                          internal_ip: 192.168.70.3
                          name: printer-1
                        property2:
                          internal_ip: 192.168.70.3
                          name: printer-1
                    isolation: true
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    subnet: 192.168.70.0/24
                    tenants:
                      property1:
                        addresses:
                        - 10.10.10.10
                      property2:
                        addresses:
                        - 10.10.10.45
                    vlan_id: 10
                    vpn_access:
                      property1:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
                      property2:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/network'
                description: List of organization network definitions
                examples:
                - - created_time: 0
                    disallow_mist_services: false
                    gateway: 192.168.70.1
                    hosts:
                      property1:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                      property2:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6f13
                    internal_access:
                      enabled: true
                    internet_access:
                      create_simple_service_policy: false
                      destination_nat:
                        property1:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                        property2:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                      enabled: true
                      restricted: false
                      static_nat:
                        property1:
                          internal_ip: 192.168.70.3
                          name: printer-1
                        property2:
                          internal_ip: 192.168.70.3
                          name: printer-1
                    isolation: true
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    subnet: 192.168.70.0/24
                    tenants:
                      property1:
                        addresses:
                        - 10.10.10.10
                      property2:
                        addresses:
                        - 10.10.10.45
                    vlan_id: 10
                    vpn_access:
                      property1:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
                      property2:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 0
                    disallow_mist_services: false
                    gateway: 192.168.70.1
                    hosts:
                      property1:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                      property2:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6f13
                    internal_access:
                      enabled: true
                    internet_access:
                      create_simple_service_policy: false
                      destination_nat:
                        property1:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                        property2:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                      enabled: true
                      restricted: false
                      static_nat:
                        property1:
                          internal_ip: 192.168.70.3
                          name: printer-1
                        property2:
                          internal_ip: 192.168.70.3
                          name: printer-1
                    isolation: true
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    subnet: 192.168.70.0/24
                    tenants:
                      property1:
                        addresses:
                        - 10.10.10.10
                      property2:
                        addresses:
                        - 10.10.10.45
                    vlan_id: 10
                    vpn_access:
                      property1:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
                      property2:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs Networks
      summary: createOrgNetwork
      description: >-
        Create an organization network definition with subnet, gateway,

        VLAN, access, NAT, multicast, tenant, and VPN access settings used for service

        routes and gateway or network template configuration.



        Networks can be used

        - in the gateway configuration to define Layer 3 network settings and policies for traffic entering or leaving the gateway through a specific interface, such as a corporate LAN, guest Wi-Fi, or DMZ network.

        - in the service policies to allow or deny traffic matching the network or to apply specific inspection settings or steering rules.
      operationId: createOrgNetwork
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/network'
              - examples:
                - disallow_mist_services: false
                  gateway: 192.168.70.1
                  hosts:
                    property1:
                      external_ips: 172.16.10.32-172.16.10.35
                      ips: 192.168.70.32-192.168.70.35
                    property2:
                      external_ips: 172.16.10.32-172.16.10.35
                      ips: 192.168.70.32-192.168.70.35
                  internal_access:
                    enabled: true
                  internet_access:
                    create_simple_service_policy: false
                    destination_nat:
                      property1:
                        internal_ip: 192.168.70.30
                        name: web server
                        port: '443'
                      property2:
                        internal_ip: 192.168.70.30
                        name: web server
                        port: '443'
                    enabled: true
                    restricted: false
                    static_nat:
                      property1:
                        internal_ip: 192.168.70.3
                        name: printer-1
                      property2:
                        internal_ip: 192.168.70.3
                        name: printer-1
                  isolation: true
                  name: string
                  subnet: 192.168.70.0/24
                  tenants:
                    property1:
                      addresses:
                      - 10.10.10.10.
                    property2:
                      addresses:
                      - 10.10.10.52
                  vlan_id: 10
                  vpn_access:
                    property1:
                      allow_ping: true
                      destination_nat:
                        property1:
                          internal_ip: 192.168.70.5/30
                          name: web server
                          port: '443'
                        property2:
                          internal_ip: 192.168.70.5/30
                          name: web server
                          port: '443'
                      nat_pool: 172.16.0.0/26
                      routed: true
                      source_nat:
                        external_ip: 172.16.0.8/30
                      static_nat:
                        property1:
                          internal_ip: 192.168.70.3
                          name: pos_station-1
                        property2:
                          internal_ip: 192.168.70.3
                          name: pos_station-1
                      summarized_subnet: 172.16.0.0/16
                    property2:
                      allow_ping: true
                      destination_nat:
                        property1:
                          internal_ip: 192.168.70.5/30
                          name: web server
                          port: '443'
                        property2:
                          internal_ip: 192.168.70.5/30
                          name: web server
                          port: '443'
                      nat_pool: 172.16.0.0/26
                      routed: true
                      source_nat:
                        external_ip: 172.16.0.8/30
                      static_nat:
                        property1:
                          internal_ip: 192.168.70.3
                          name: pos_station-1
                        property2:
                          internal_ip: 192.168.70.3
                          name: pos_station-1
                      summarized_subnet: 172.16.0.0/16
              contentMediaType: application/json
            examples:
              Example:
                value:
                  disallow_mist_services: false
                  gateway: 192.168.70.1
                  hosts:
                    property1:
                      external_ips: 172.16.10.32-172.16.10.35
                      ips: 192.168.70.32-192.168.70.35
                    property2:
                      external_ips: 172.16.10.32-172.16.10.35
                      ips: 192.168.70.32-192.168.70.35
                  internal_access:
                    enabled: true
                  internet_access:
                    create_simple_service_policy: false
                    destination_nat:
                      property1:
                        internal_ip: 192.168.70.30
                        name: web server
                        port: '443'
                      property2:
                        internal_ip: 192.168.70.30
                        name: web server
                        port: '443'
                    enabled: true
                    restricted: false
                    static_nat:
                      property1:
                        internal_ip: 192.168.70.3
                        name: printer-1
                      property2:
                        internal_ip: 192.168.70.3
                        name: printer-1
                  isolation: true
                  name: string
                  subnet: 192.168.70.0/24
                  tenants:
                    property1:
                      addresses:
                      - 10.10.10.10.
                    property2:
                      addresses:
                      - 10.10.10.52
                  vlan_id: 10
                  vpn_access:
                    property1:
                      allow_ping: true
                      destination_nat:
                        property1:
                          internal_ip: 192.168.70.5/30
                          name: web server
                          port: '443'
                        property2:
                          internal_ip: 192.168.70.5/30
                          name: web server
                          port: '443'
                      nat_pool: 172.16.0.0/26
                      routed: true
                      source_nat:
                        external_ip: 172.16.0.8/30
                      static_nat:
                        property1:
                          internal_ip: 192.168.70.3
                          name: pos_station-1
                        property2:
                          internal_ip: 192.168.70.3
                          name: pos_station-1
                      summarized_subnet: 172.16.0.0/16
                    property2:
                      allow_ping: true
                      destination_nat:
                        property1:
                          internal_ip: 192.168.70.5/30
                          name: web server
                          port: '443'
                        property2:
                          internal_ip: 192.168.70.5/30
                          name: web server
                          port: '443'
                      nat_pool: 172.16.0.0/26
                      routed: true
                      source_nat:
                        external_ip: 172.16.0.8/30
                      static_nat:
                        property1:
                          internal_ip: 192.168.70.3
                          name: pos_station-1
                        property2:
                          internal_ip: 192.168.70.3
                          name: pos_station-1
                      summarized_subnet: 172.16.0.0/16
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/network'
                - description: Organization-level Layer 3 network definition that can be merged into site settings and used for service routes. Networks are used to define the service routes in the Gateway settings or templates
                  examples:
                  - created_time: 0
                    disallow_mist_services: false
                    gateway: 192.168.70.1
                    hosts:
                      property1:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                      property2:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6f12
                    internal_access:
                      enabled: true
                    internet_access:
                      create_simple_service_policy: false
                      destination_nat:
                        property1:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                        property2:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                      enabled: true
                      restricted: false
                      static_nat:
                        property1:
                          internal_ip: 192.168.70.3
                          name: printer-1
                        property2:
                          internal_ip: 192.168.70.3
                          name: printer-1
                    isolation: true
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    subnet: 192.168.70.0/24
                    tenants:
                      property1:
                        addresses:
                        - 10.10.10.10
                      property2:
                        addresses:
                        - 10.10.10.52
                    vlan_id: 10
                    vpn_access:
                      property1:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
                      property2:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    disallow_mist_services: false
                    gateway: 192.168.70.1
                    hosts:
                      property1:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                      property2:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6f12
                    internal_access:
                      enabled: true
                    internet_access:
                      create_simple_service_policy: false
                      destination_nat:
                        property1:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                        property2:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                      enabled: true
                      restricted: false
                      static_nat:
                        property1:
                          internal_ip: 192.168.70.3
                          name: printer-1
                        property2:
                          internal_ip: 192.168.70.3
                          name: printer-1
                    isolation: true
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    subnet: 192.168.70.0/24
                    tenants:
                      property1:
                        addresses:
                        - 10.10.10.10
                      property2:
                        addresses:
                        - 10.10.10.52
                    vlan_id: 10
                    vpn_access:
                      property1:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
                      property2:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/network'
                - description: Organization-level Layer 3 network definition that can be merged into site settings and used for service routes. Networks are used to define the service routes in the Gateway settings or templates
                  examples:
                  - created_time: 0
                    disallow_mist_services: false
                    gateway: 192.168.70.1
                    hosts:
                      property1:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                      property2:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6f12
                    internal_access:
                      enabled: true
                    internet_access:
                      create_simple_service_policy: false
                      destination_nat:
                        property1:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                        property2:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                      enabled: true
                      restricted: false
                      static_nat:
                        property1:
                          internal_ip: 192.168.70.3
                          name: printer-1
                        property2:
                          internal_ip: 192.168.70.3
                          name: printer-1
                    isolation: true
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    subnet: 192.168.70.0/24
                    tenants:
                      property1:
                        addresses:
                        - 10.10.10.10
                      property2:
                        addresses:
                        - 10.10.10.52
                    vlan_id: 10
                    vpn_access:
                      property1:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
                      property2:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    disallow_mist_services: false
                    gateway: 192.168.70.1
                    hosts:
                      property1:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                      property2:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6f12
                    internal_access:
                      enabled: true
                    internet_access:
                      create_simple_service_policy: false
                      destination_nat:
                        property1:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                        property2:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                      enabled: true
                      restricted: false
                      static_nat:
                        property1:
                          internal_ip: 192.168.70.3
                          name: printer-1
                        property2:
                          internal_ip: 192.168.70.3
                          name: printer-1
                    isolation: true
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    subnet: 192.168.70.0/24
                    tenants:
                      property1:
                        addresses:
                        - 10.10.10.10
                      property2:
                        addresses:
                        - 10.10.10.52
                    vlan_id: 10
                    vpn_access:
                      property1:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
                      property2:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/networks/{network_id}:
    delete:
      tags:
      - Orgs Networks
      summary: deleteOrgNetwork
      description: Delete an organization network definition by network ID so it can no longer be referenced by gateway or network template configuration.
      operationId: deleteOrgNetwork
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: network_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs Networks
      summary: getOrgNetwork
      description: Retrieve details for a specific organization network, including subnet, gateway, VLAN, access, NAT, multicast, tenant, and VPN access settings.
      operationId: getOrgNetwork
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: network_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/network'
                - description: Organization-level Layer 3 network definition that can be merged into site settings and used for service routes. Networks are used to define the service routes in the Gateway settings or templates
                  examples:
                  - created_time: 0
                    disallow_mist_services: false
                    gateway: 192.168.70.1
                    hosts:
                      property1:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                      property2:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6f12
                    internal_access:
                      enabled: true
                    internet_access:
                      create_simple_service_policy: false
                      destination_nat:
                        property1:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                        property2:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                      enabled: true
                      restricted: false
                      static_nat:
                        property1:
                          internal_ip: 192.168.70.3
                          name: printer-1
                        property2:
                          internal_ip: 192.168.70.3
                          name: printer-1
                    isolation: true
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    subnet: 192.168.70.0/24
                    tenants:
                      property1:
                        addresses:
                        - 10.10.10.10
                      property2:
                        addresses:
                        - 10.10.10.52
                    vlan_id: 10
                    vpn_access:
                      property1:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
                      property2:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    disallow_mist_services: false
                    gateway: 192.168.70.1
                    hosts:
                      property1:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                      property2:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6f12
                    internal_access:
                      enabled: true
                    internet_access:
                      create_simple_service_policy: false
                      destination_nat:
                        property1:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                        property2:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                      enabled: true
                      restricted: false
                      static_nat:
                        property1:
                          internal_ip: 192.168.70.3
                          name: printer-1
                        property2:
                          internal_ip: 192.168.70.3
                          name: printer-1
                    isolation: true
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    subnet: 192.168.70.0/24
                    tenants:
                      property1:
                        addresses:
                        - 10.10.10.10
                      property2:
                        addresses:
                        - 10.10.10.52
                    vlan_id: 10
                    vpn_access:
                      property1:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
                      property2:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/network'
                - description: Organization-level Layer 3 network definition that can be merged into site settings and used for service routes. Networks are used to define the service routes in the Gateway settings or templates
                  examples:
                  - created_time: 0
                    disallow_mist_services: false
                    gateway: 192.168.70.1
                    hosts:
                      property1:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                      property2:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6f12
                    internal_access:
                      enabled: true
                    internet_access:
                      create_simple_service_policy: false
                      destination_nat:
                        property1:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                        property2:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                      enabled: true
                      restricted: false
                      static_nat:
                        property1:
                          internal_ip: 192.168.70.3
                          name: printer-1
                        property2:
                          internal_ip: 192.168.70.3
                          name: printer-1
                    isolation: true
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    subnet: 192.168.70.0/24
                    tenants:
                      property1:
                        addresses:
                        - 10.10.10.10
                      property2:
                        addresses:
                        - 10.10.10.52
                    vlan_id: 10
                    vpn_access:
                      property1:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
                      property2:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    disallow_mist_services: false
                    gateway: 192.168.70.1
                    hosts:
                      property1:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                      property2:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6f12
                    internal_access:
                      enabled: true
                    internet_access:
                      create_simple_service_policy: false
                      destination_nat:
                        property1:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                        property2:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                      enabled: true
                      restricted: false
                      static_nat:
                        property1:
                          internal_ip: 192.168.70.3
                          name: printer-1
                        property2:
                          internal_ip: 192.168.70.3
                          name: printer-1
                    isolation: true
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    subnet: 192.168.70.0/24
                    tenants:
                      property1:
                        addresses:
                        - 10.10.10.10
                      property2:
                        addresses:
                        - 10.10.10.52
                    vlan_id: 10
                    vpn_access:
                      property1:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
                      property2:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs Networks
      summary: updateOrgNetwork
      description: Update an organization network definition, including subnet, gateway, VLAN, access, NAT, multicast, tenant, and VPN access settings.
      operationId: updateOrgNetwork
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: network_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/network'
              - examples:
                - disallow_mist_services: false
                  gateway: 192.168.70.1
                  hosts:
                    property1:
                      external_ips: 172.16.10.32-172.16.10.35
                      ips: 192.168.70.32-192.168.70.35
                    property2:
                      external_ips: 172.16.10.32-172.16.10.35
                      ips: 192.168.70.32-192.168.70.35
                  internal_access:
                    enabled: true
                  internet_access:
                    create_simple_service_policy: false
                    destination_nat:
                      property1:
                        internal_ip: 192.168.70.30
                        name: web server
                        port: '443'
                      property2:
                        internal_ip: 192.168.70.30
                        name: web server
                        port: '443'
                    enabled: true
                    restricted: false
                    static_nat:
                      property1:
                        internal_ip: 192.168.70.3
                        name: printer-1
                      property2:
                        internal_ip: 192.168.70.3
                        name: printer-1
                  isolation: true
                  name: string
                  subnet: 192.168.70.0/24
                  tenants:
                    property1:
                      addresses:
                      - 10.10.10.10
                    property2:
                      addresses:
                      - 10.10.10.52
                  vlan_id: 10
                  vpn_access:
                    property1:
                      allow_ping: true
                      destination_nat:
                        property1:
                          internal_ip: 192.168.70.5/30
                          name: web server
                          port: '443'
                        property2:
                          internal_ip: 192.168.70.5/30
                          name: web server
                          port: '443'
                      nat_pool: 172.16.0.0/26
                      routed: true
                      source_nat:
                        external_ip: 172.16.0.8/30
                      static_nat:
                        property1:
                          internal_ip: 192.168.70.3
                          name: pos_station-1
                        property2:
                          internal_ip: 192.168.70.3
                          name: pos_station-1
                      summarized_subnet: 172.16.0.0/16
                    property2:
                      allow_ping: true
                      destination_nat:
                        property1:
                          internal_ip: 192.168.70.5/30
                          name: web server
                          port: '443'
                        property2:
                          internal_ip: 192.168.70.5/30
                          name: web server
                          port: '443'
                      nat_pool: 172.16.0.0/26
                      routed: true
                      source_nat:
                        external_ip: 172.16.0.8/30
                      static_nat:
                        property1:
                          internal_ip: 192.168.70.3
                          name: pos_station-1
                        property2:
                          internal_ip: 192.168.70.3
                          name: pos_station-1
                      summarized_subnet: 172.16.0.0/16
              contentMediaType: application/json
            examples:
              Example:
                value:
                  disallow_mist_services: false
                  gateway: 192.168.70.1
                  hosts:
                    property1:
                      external_ips: 172.16.10.32-172.16.10.35
                      ips: 192.168.70.32-192.168.70.35
                    property2:
                      external_ips: 172.16.10.32-172.16.10.35
                      ips: 192.168.70.32-192.168.70.35
                  internal_access:
                    enabled: true
                  internet_access:
                    create_simple_service_policy: false
                    destination_nat:
                      property1:
                        internal_ip: 192.168.70.30
                        name: web server
                        port: '443'
                      property2:
                        internal_ip: 192.168.70.30
                        name: web server
                        port: '443'
                    enabled: true
                    restricted: false
                    static_nat:
                      property1:
                        internal_ip: 192.168.70.3
                        name: printer-1
                      property2:
                        internal_ip: 192.168.70.3
                        name: printer-1
                  isolation: true
                  name: string
                  subnet: 192.168.70.0/24
                  tenants:
                    property1:
                      addresses:
                      - 10.10.10.10
                    property2:
                      addresses:
                      - 10.10.10.52
                  vlan_id: 10
                  vpn_access:
                    property1:
                      allow_ping: true
                      destination_nat:
                        property1:
                          internal_ip: 192.168.70.5/30
                          name: web server
                          port: '443'
                        property2:
                          internal_ip: 192.168.70.5/30
                          name: web server
                          port: '443'
                      nat_pool: 172.16.0.0/26
                      routed: true
                      source_nat:
                        external_ip: 172.16.0.8/30
                      static_nat:
                        property1:
                          internal_ip: 192.168.70.3
                          name: pos_station-1
                        property2:
                          internal_ip: 192.168.70.3
                          name: pos_station-1
                      summarized_subnet: 172.16.0.0/16
                    property2:
                      allow_ping: true
                      destination_nat:
                        property1:
                          internal_ip: 192.168.70.5/30
                          name: web server
                          port: '443'
                        property2:
                          internal_ip: 192.168.70.5/30
                          name: web server
                          port: '443'
                      nat_pool: 172.16.0.0/26
                      routed: true
                      source_nat:
                        external_ip: 172.16.0.8/30
                      static_nat:
                        property1:
                          internal_ip: 192.168.70.3
                          name: pos_station-1
                        property2:
                          internal_ip: 192.168.70.3
                          name: pos_station-1
                      summarized_subnet: 172.16.0.0/16
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/network'
                - description: Organization-level Layer 3 network definition that can be merged into site settings and used for service routes. Networks are used to define the service routes in the Gateway settings or templates
                  examples:
                  - created_time: 0
                    disallow_mist_services: false
                    gateway: 192.168.70.1
                    hosts:
                      property1:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                      property2:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6f12
                    internal_access:
                      enabled: true
                    internet_access:
                      create_simple_service_policy: false
                      destination_nat:
                        property1:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                        property2:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                      enabled: true
                      restricted: false
                      static_nat:
                        property1:
                          internal_ip: 192.168.70.3
                          name: printer-1
                        property2:
                          internal_ip: 192.168.70.3
                          name: printer-1
                    isolation: true
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    subnet: 192.168.70.0/24
                    tenants:
                      property1:
                        addresses:
                        - 10.10.10.10
                      property2:
                        addresses:
                        - 10.10.10.52
                    vlan_id: 10
                    vpn_access:
                      property1:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
                      property2:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    disallow_mist_services: false
                    gateway: 192.168.70.1
                    hosts:
                      property1:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                      property2:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6f12
                    internal_access:
                      enabled: true
                    internet_access:
                      create_simple_service_policy: false
                      destination_nat:
                        property1:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                        property2:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                      enabled: true
                      restricted: false
                      static_nat:
                        property1:
                          internal_ip: 192.168.70.3
                          name: printer-1
                        property2:
                          internal_ip: 192.168.70.3
                          name: printer-1
                    isolation: true
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    subnet: 192.168.70.0/24
                    tenants:
                      property1:
                        addresses:
                        - 10.10.10.10
                      property2:
                        addresses:
                        - 10.10.10.52
                    vlan_id: 10
                    vpn_access:
                      property1:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
                      property2:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/network'
                - description: Organization-level Layer 3 network definition that can be merged into site settings and used for service routes. Networks are used to define the service routes in the Gateway settings or templates
                  examples:
                  - created_time: 0
                    disallow_mist_services: false
                    gateway: 192.168.70.1
                    hosts:
                      property1:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                      property2:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6f12
                    internal_access:
                      enabled: true
                    internet_access:
                      create_simple_service_policy: false
                      destination_nat:
                        property1:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                        property2:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                      enabled: true
                      restricted: false
                      static_nat:
                        property1:
                          internal_ip: 192.168.70.3
                          name: printer-1
                        property2:
                          internal_ip: 192.168.70.3
                          name: printer-1
                    isolation: true
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    subnet: 192.168.70.0/24
                    tenants:
                      property1:
                        addresses:
                        - 10.10.10.10
                      property2:
                        addresses:
                        - 10.10.10.52
                    vlan_id: 10
                    vpn_access:
                      property1:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
                      property2:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    disallow_mist_services: false
                    gateway: 192.168.70.1
                    hosts:
                      property1:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                      property2:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6f12
                    internal_access:
                      enabled: true
                    internet_access:
                      create_simple_service_policy: false
                      destination_nat:
                        property1:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                        property2:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                      enabled: true
                      restricted: false
                      static_nat:
                        property1:
                          internal_ip: 192.168.70.3
                          name: printer-1
                        property2:
                          internal_ip: 192.168.70.3
                          name: printer-1
                    isolation: true
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    subnet: 192.168.70.0/24
                    tenants:
                      property1:
                        addresses:
                        - 10.10.10.10
                      property2:
                        addresses:
                        - 10.10.10.52
                    vlan_id: 10
                    vpn_access:
                      property1:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
                      property2:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/pma/dashboards:
    get:
      tags:
      - Orgs Premium Analytics
      summary: listOrgPmaDashboards
      description: List Premium Analytics dashboard metadata and redirect URLs available to the organization.
      operationId: listOrgPmaDashboards
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/pma_dashboard'
                description: List of PMA dashboard metadata records
                examples:
                - - name: dashboard_1
                    url: https://mist.looker.com/login/embed/%2Fembed%2Fdashboards%2F1?group_ids=%5B3%5D&last_name=%22%22&models=%5B%22generic%22%5D&.....
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - name: dashboard_1
                    url: https://mist.looker.com/login/embed/%2Fembed%2Fdashboards%2F1?group_ids=%5B3%5D&last_name=%22%22&models=%5B%22generic%22%5D&.....
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/pma_dashboard'
                description: List of PMA dashboard metadata records
                examples:
                - - name: dashboard_1
                    url: https://mist.looker.com/login/embed/%2Fembed%2Fdashboards%2F1?group_ids=%5B3%5D&last_name=%22%22&models=%5B%22generic%22%5D&.....
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - name: dashboard_1
                    url: https://mist.looker.com/login/embed/%2Fembed%2Fdashboards%2F1?group_ids=%5B3%5D&last_name=%22%22&models=%5B%22generic%22%5D&.....
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/psks:
    get:
      tags:
      - Orgs Psks
      summary: listOrgPsks
      description: List organization personal PSKs for WLAN access, optionally filtering by name, SSID, or role.
      operationId: listOrgPsks
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: name
        in: query
        description: Filter results by name. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - psk-a,psk-b
      - name: ssid
        in: query
        description: Filter results by SSID. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Corp,Guest
      - name: role
        in: query
        description: Filter PSK results by role. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - employee,contractor
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/psk'
                description: List of personal PSK configurations
                examples:
                - - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    passphrase: secretpsk
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ssid: string
                    usage: multi
                    vlan_id: 1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    passphrase: secretpsk
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ssid: string
                    usage: multi
                    vlan_id: 1
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/psk'
                description: List of personal PSK configurations
                examples:
                - - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    passphrase: secretpsk
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ssid: string
                    usage: multi
                    vlan_id: 1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    passphrase: secretpsk
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ssid: string
                    usage: multi
                    vlan_id: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs Psks
      summary: createOrgPsk
      description: >-
        Create an organization personal PSK for WLAN access, including SSID, passphrase, usage mode, optional client MAC binding, role, VLAN, and expiration settings.



        When `usage`==`macs`, corresponding "macs" field will hold a list consisting of client MAC addresses (["xx:xx:xx:xx:xx",...]) or mac patterns(["xx:xx:*","xx*",...]) or both (["xx:xx:xx:xx:xx:xx", "xx:*", ...]). This list is capped at 5000
      operationId: createOrgPsk
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: upsert
        in: query
        description: If a key exists with the same `name`, replace it with the new one
        style: form
        explode: true
        schema:
          type: boolean
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/psk'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/psk'
                - description: Personal pre-shared key configuration for WLAN access
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/psk'
                - description: Personal pre-shared key configuration for WLAN access
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs Psks
      summary: updateOrgMultiplePsks
      description: Update multiple organization personal PSKs in one request, including passphrase, usage mode, role, VLAN, expiration, and notification settings.
      operationId: updateOrgMultiplePsks
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              uniqueItems: true
              type: array
              items:
                $ref: '#/components/schemas/psk'
              description: ''
              examples:
              - - expire_time: 1614990263
                  mac: string
                  max_usage: 0
                  name: string
                  passphrase: secretpsk
                  ssid: string
                  usage: multi
                  vlan_id: 10
              contentMediaType: application/json
            examples:
              Example:
                value:
                - expire_time: 1614990263
                  mac: string
                  max_usage: 0
                  name: string
                  passphrase: secretpsk
                  ssid: string
                  usage: multi
                  vlan_id: 10
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/psk'
                description: List of personal PSK configurations
                examples:
                - - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    passphrase: secretpsk
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ssid: string
                    usage: multi
                    vlan_id: 1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    passphrase: secretpsk
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ssid: string
                    usage: multi
                    vlan_id: 1
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/psk'
                description: List of personal PSK configurations
                examples:
                - - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    passphrase: secretpsk
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ssid: string
                    usage: multi
                    vlan_id: 1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    passphrase: secretpsk
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ssid: string
                    usage: multi
                    vlan_id: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/psks/delete:
    post:
      tags:
      - Orgs Psks
      summary: deleteOrgPskList
      description: >-
        Delete one or more organization PSKs by ID.


        The request accepts a single PSK ID string or a list of PSK ID strings.

        **Warning**: If no PSK IDs are provided in the request, all organization PSKs will be deleted and clients will no longer be able to authenticate to any SSID with a PSK.
      operationId: deleteOrgPskList
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/psk_id_list'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/psks/import:
    post:
      tags:
      - Orgs Psks
      summary: importOrgPsks
      description: >-
        Import organization PSKs from a CSV file or JSON payload.


        ## CSV File Format

        ```

        PSK Import CSV File Format:

        name,ssid,passphrase,usage,vlan_id,mac,max_usage,role,expire_time,notify_expiry,expiry_notification_time,notify_on_create_or_edit,email

        Common,warehouse,foryoureyesonly,single,35,a31425f31278,0,student,1618594236

        Justin,reception,visible,multi,1002,200,teacher,1618594236

        Common2,ssid,1245678-xx,single,35,a31425f31278,0,student,1618594236,true,7,true,admin@test.com

        ```
      operationId: importOrgPsks
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              type: object
              properties:
                file:
                  type: string
                  description: Uploaded CSV or binary file containing PSKs to import
                  contentEncoding: base64
              contentMediaType: multipart/form-data
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/psk'
                description: List of personal PSK configurations
                examples:
                - - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    passphrase: secretpsk
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ssid: string
                    usage: multi
                    vlan_id: 1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    passphrase: secretpsk
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ssid: string
                    usage: multi
                    vlan_id: 1
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/psk'
                description: List of personal PSK configurations
                examples:
                - - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    passphrase: secretpsk
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ssid: string
                    usage: multi
                    vlan_id: 1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    passphrase: secretpsk
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ssid: string
                    usage: multi
                    vlan_id: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/psks/{psk_id}:
    delete:
      tags:
      - Orgs Psks
      summary: deleteOrgPsk
      description: Delete an organization personal PSK by PSK ID so clients can no longer authenticate with that key.
      operationId: deleteOrgPsk
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: psk_id
        in: path
        description: PSK ID
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs Psks
      summary: getOrgPsk
      description: Retrieve details for an organization personal PSK, including SSID, usage mode, MAC binding, role, VLAN, expiration, and notification settings.
      operationId: getOrgPsk
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: psk_id
        in: path
        description: PSK ID
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/psk'
                - description: Personal pre-shared key configuration for WLAN access
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/psk'
                - description: Personal pre-shared key configuration for WLAN access
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs Psks
      summary: updateOrgPsk
      description: Update an organization personal PSK, including passphrase, usage mode, MAC binding, role, VLAN, expiration, and notification settings.
      operationId: updateOrgPsk
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: psk_id
        in: path
        description: PSK ID
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/psk'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/psk'
                - description: Personal pre-shared key configuration for WLAN access
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/psk'
                - description: Personal pre-shared key configuration for WLAN access
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/psks/{psk_id}/delete_old_passphrase:
    post:
      tags:
      - Orgs Psks
      summary: deleteOrgPskOldPassphrase
      description: "Remove the stored `old_passphrase` from a PSK after rotation. \nIf successful, the response returns the PSK with `old_passphrase` removed."
      operationId: deleteOrgPskOldPassphrase
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: psk_id
        in: path
        description: PSK ID
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/psk'
                - description: Personal pre-shared key configuration for WLAN access
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/psk'
                - description: Personal pre-shared key configuration for WLAN access
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/pskportals:
    get:
      tags:
      - Orgs Psk Portals
      summary: listOrgPskPortals
      description: List self-service PSK Portal configurations in the organization, including portal mode, SSID, authentication, expiry, and passphrase rules.
      operationId: listOrgPskPortals
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/psk_portal'
                description: List of PSK portal configurations
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/psk_portal'
                description: List of PSK portal configurations
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs Psk Portals
      summary: createOrgPskPortal
      description: Create a self-service PSK Portal configuration for issuing personal PSKs, including SSID, BYOD or admin mode, SSO or sponsor authentication, passphrase rules, and expiry settings.
      operationId: createOrgPskPortal
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/psk_portal'
              - examples:
                - auth: sso
                  expire_time: 262800
                  expiry_notification_time: 2
                  hide_psks_created_by_other_admins: false
                  max_usage: 1
                  name: USR-test
                  notify_expiry: false
                  passphrase_rules:
                    alphabets_enabled: true
                    length: 8
                    numerics_enabled: true
                    symbols: ()[]{}_%@#&$
                    symbols_enabled: true
                  ssid: USR-test
                  sso:
                    idp_cert: >-
                      -----BEGIN CERTIFICATE-----

                      MIIDqDCCApCgA...-----END CERTIFICATE-----
                    idp_sign_algo: sha256
                    idp_sso_url: https://dev-00000000.okta.com/app/dev-00000000/a6b88bec5ab7/sso/saml
                    issuer: http://www.okta.com/a6b88bec5ab7
                    nameid_format: email
                  type: byod
                  vlan_id: 42
              contentMediaType: application/json
            examples:
              Example:
                value:
                  auth: sso
                  expire_time: 262800
                  expiry_notification_time: 2
                  hide_psks_created_by_other_admins: false
                  max_usage: 1
                  name: USR-test
                  notify_expiry: false
                  passphrase_rules:
                    alphabets_enabled: true
                    length: 8
                    numerics_enabled: true
                    symbols: ()[]{}_%@#&$
                    symbols_enabled: true
                  ssid: USR-test
                  sso:
                    idp_cert: >-
                      -----BEGIN CERTIFICATE-----

                      MIIDqDCCApCgA...-----END CERTIFICATE-----
                    idp_sign_algo: sha256
                    idp_sso_url: https://dev-00000000.okta.com/app/dev-00000000/a6b88bec5ab7/sso/saml
                    issuer: http://www.okta.com/a6b88bec5ab7
                    nameid_format: email
                  type: byod
                  vlan_id: 42
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/psk_portal'
                - description: Self-service portal configuration for issuing personal PSKs
                  examples:
                  - auth: sso
                    created_time: 1727272316
                    expire_time: 262800
                    expiry_notification_time: 2
                    hide_psks_created_by_other_admins: false
                    id: 86ef73e5-e360-4e33-abd8-c2da7b11cbd6
                    max_usage: 1
                    modified_time: 1727272316
                    name: USR-test
                    notify_expiry: false
                    org_id: 8f6c24d5-b618-4c30-b6ff-b2febc1078ab
                    passphrase_rules:
                      alphabets_enabled: true
                      length: 8
                      numerics_enabled: true
                      symbols: ()[]{}_%@#&$
                      symbols_enabled: true
                    role: ''
                    ssid: USR-test
                    sso:
                      idp_cert: >-
                        -----BEGIN CERTIFICATE-----

                        MIIDqDCCApCgA...-----END CERTIFICATE-----
                      idp_sign_algo: sha256
                      idp_sso_url: https://dev-00000000.okta.com/app/dev-00000000/a6b88bec5ab7/sso/saml
                      issuer: http://www.okta.com/a6b88bec5ab7
                      nameid_format: email
                    type: byod
                    ui_url: https://pskportal.gc1.mist.com/#!byod/a6b88bec-5ab7-41ae-a34c-44ff52a8b81d
                    vlan_id: 123
                contentMediaType: application/json
              examples:
                PSK Portal:
                  value:
                    auth: sso
                    created_time: 1727272316
                    expire_time: 262800
                    expiry_notification_time: 2
                    hide_psks_created_by_other_admins: false
                    id: 86ef73e5-e360-4e33-abd8-c2da7b11cbd6
                    max_usage: 1
                    modified_time: 1727272316
                    name: USR-test
                    notify_expiry: false
                    org_id: 8f6c24d5-b618-4c30-b6ff-b2febc1078ab
                    passphrase_rules:
                      alphabets_enabled: true
                      length: 8
                      numerics_enabled: true
                      symbols: ()[]{}_%@#&$
                      symbols_enabled: true
                    role: ''
                    ssid: USR-test
                    sso:
                      idp_cert: >-
                        -----BEGIN CERTIFICATE-----

                        MIIDqDCCApCgA...-----END CERTIFICATE-----
                      idp_sign_algo: sha256
                      idp_sso_url: https://dev-00000000.okta.com/app/dev-00000000/a6b88bec5ab7/sso/saml
                      issuer: http://www.okta.com/a6b88bec5ab7
                      nameid_format: email
                    type: byod
                    ui_url: https://pskportal.gc1.mist.com/#!byod/a6b88bec-5ab7-41ae-a34c-44ff52a8b81d
                    vlan_id: 123
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/psk_portal'
                - description: Self-service portal configuration for issuing personal PSKs
                  examples:
                  - auth: sso
                    created_time: 1727272316
                    expire_time: 262800
                    expiry_notification_time: 2
                    hide_psks_created_by_other_admins: false
                    id: 86ef73e5-e360-4e33-abd8-c2da7b11cbd6
                    max_usage: 1
                    modified_time: 1727272316
                    name: USR-test
                    notify_expiry: false
                    org_id: 8f6c24d5-b618-4c30-b6ff-b2febc1078ab
                    passphrase_rules:
                      alphabets_enabled: true
                      length: 8
                      numerics_enabled: true
                      symbols: ()[]{}_%@#&$
                      symbols_enabled: true
                    role: ''
                    ssid: USR-test
                    sso:
                      idp_cert: >-
                        -----BEGIN CERTIFICATE-----

                        MIIDqDCCApCgA...-----END CERTIFICATE-----
                      idp_sign_algo: sha256
                      idp_sso_url: https://dev-00000000.okta.com/app/dev-00000000/a6b88bec5ab7/sso/saml
                      issuer: http://www.okta.com/a6b88bec5ab7
                      nameid_format: email
                    type: byod
                    ui_url: https://pskportal.gc1.mist.com/#!byod/a6b88bec-5ab7-41ae-a34c-44ff52a8b81d
                    vlan_id: 123
                contentMediaType: application/vnd.api+json
              examples:
                PSK Portal:
                  value:
                    auth: sso
                    created_time: 1727272316
                    expire_time: 262800
                    expiry_notification_time: 2
                    hide_psks_created_by_other_admins: false
                    id: 86ef73e5-e360-4e33-abd8-c2da7b11cbd6
                    max_usage: 1
                    modified_time: 1727272316
                    name: USR-test
                    notify_expiry: false
                    org_id: 8f6c24d5-b618-4c30-b6ff-b2febc1078ab
                    passphrase_rules:
                      alphabets_enabled: true
                      length: 8
                      numerics_enabled: true
                      symbols: ()[]{}_%@#&$
                      symbols_enabled: true
                    role: ''
                    ssid: USR-test
                    sso:
                      idp_cert: >-
                        -----BEGIN CERTIFICATE-----

                        MIIDqDCCApCgA...-----END CERTIFICATE-----
                      idp_sign_algo: sha256
                      idp_sso_url: https://dev-00000000.okta.com/app/dev-00000000/a6b88bec5ab7/sso/saml
                      issuer: http://www.okta.com/a6b88bec5ab7
                      nameid_format: email
                    type: byod
                    ui_url: https://pskportal.gc1.mist.com/#!byod/a6b88bec-5ab7-41ae-a34c-44ff52a8b81d
                    vlan_id: 123
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/pskportals/logs:
    get:
      tags:
      - Orgs Psk Portals
      summary: listOrgPskPortalLogs
      description: List PSK Portal log entries in the organization for the selected time range.
      operationId: listOrgPskPortalLogs
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_psk_portal_logs_search'
                - description: Paginated response for organization PSK Portal log search results
                  examples:
                  - end: 1428954000
                    limit: 100
                    results:
                    - id: 8a3dcaa7-80e3-4bb0-a75b-7bc6322cfd09
                      message: Rotate PSK test@mist.com
                      name_id: test@mist.com
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      psk_id: 608fe603-f9f0-4ce9-9473-04ef6c6ea749
                      psk_name: test@mist.com
                      pskportal_id: c1742c09-af35-4161-96ef-7dc65c6d5674
                      timestamp: 1686346104.096
                    start: 1428939600
                    total: 135
                contentMediaType: application/json
              examples:
                PSK Portal Logs:
                  value:
                    end: 1428954000
                    limit: 100
                    results:
                    - id: 8a3dcaa7-80e3-4bb0-a75b-7bc6322cfd09
                      message: Rotate PSK test@mist.com
                      name_id: test@mist.com
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      psk_id: 608fe603-f9f0-4ce9-9473-04ef6c6ea749
                      psk_name: test@mist.com
                      pskportal_id: c1742c09-af35-4161-96ef-7dc65c6d5674
                      timestamp: 1686346104.096
                    start: 1428939600
                    total: 135
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_psk_portal_logs_search'
                - description: Paginated response for organization PSK Portal log search results
                  examples:
                  - end: 1428954000
                    limit: 100
                    results:
                    - id: 8a3dcaa7-80e3-4bb0-a75b-7bc6322cfd09
                      message: Rotate PSK test@mist.com
                      name_id: test@mist.com
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      psk_id: 608fe603-f9f0-4ce9-9473-04ef6c6ea749
                      psk_name: test@mist.com
                      pskportal_id: c1742c09-af35-4161-96ef-7dc65c6d5674
                      timestamp: 1686346104.096
                    start: 1428939600
                    total: 135
                contentMediaType: application/vnd.api+json
              examples:
                PSK Portal Logs:
                  value:
                    end: 1428954000
                    limit: 100
                    results:
                    - id: 8a3dcaa7-80e3-4bb0-a75b-7bc6322cfd09
                      message: Rotate PSK test@mist.com
                      name_id: test@mist.com
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      psk_id: 608fe603-f9f0-4ce9-9473-04ef6c6ea749
                      psk_name: test@mist.com
                      pskportal_id: c1742c09-af35-4161-96ef-7dc65c6d5674
                      timestamp: 1686346104.096
                    start: 1428939600
                    total: 135
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/pskportals/logs/count:
    get:
      tags:
      - Orgs Psk Portals
      summary: countOrgPskPortalLogs
      description: Count PSK Portal log entries across the organization, optionally grouped by `distinct` and filtered by time range.
      operationId: countOrgPskPortalLogs
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `admin_id`, `admin_name`, `psk_id`, `psk_name`, `pskportal_id`, `user_id`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/org_psk_portal_logs_count_distinct'
          - description: 'Field used to group this count response. enum: `admin_id`, `admin_name`, `psk_id`, `psk_name`, `pskportal_id`, `user_id`'
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/pskportals/logs/search:
    get:
      tags:
      - Orgs Psk Portals
      summary: searchOrgPskPortalLogs
      description: Search PSK Portal log entries across the organization with filters for PSK, portal, admin, SSO NameID, and time range.
      operationId: searchOrgPskPortalLogs
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: psk_name
        in: query
        description: Filter PSK portal log results by PSK name
        style: form
        explode: true
        schema:
          type: string
      - name: psk_id
        in: query
        description: Filter PSK portal log results by PSK identifier
        style: form
        explode: true
        schema:
          type: string
      - name: pskportal_id
        in: query
        description: Filter PSK portal log results by PSK portal identifier
        style: form
        explode: true
        schema:
          type: string
      - name: id
        in: query
        description: Filter results by identifier
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: uuid
      - name: admin_name
        in: query
        description: Filter audit log results by administrator name
        style: form
        explode: true
        schema:
          type: string
      - name: admin_id
        in: query
        description: Filter audit log results by administrator identifier
        style: form
        explode: true
        schema:
          type: string
      - name: name_id
        in: query
        description: Filter results by name id
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: uuid
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_psk_portal_logs_search'
                - description: Paginated response for organization PSK Portal log search results
                  examples:
                  - end: 1428954000
                    limit: 100
                    results:
                    - id: 8a3dcaa7-80e3-4bb0-a75b-7bc6322cfd09
                      message: Rotate PSK test@mist.com
                      name_id: test@mist.com
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      psk_id: 608fe603-f9f0-4ce9-9473-04ef6c6ea749
                      psk_name: test@mist.com
                      pskportal_id: c1742c09-af35-4161-96ef-7dc65c6d5674
                      timestamp: 1686346104.096
                    start: 1428939600
                    total: 135
                contentMediaType: application/json
              examples:
                PSK Portal Logs:
                  value:
                    end: 1428954000
                    limit: 100
                    results:
                    - id: 8a3dcaa7-80e3-4bb0-a75b-7bc6322cfd09
                      message: Rotate PSK test@mist.com
                      name_id: test@mist.com
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      psk_id: 608fe603-f9f0-4ce9-9473-04ef6c6ea749
                      psk_name: test@mist.com
                      pskportal_id: c1742c09-af35-4161-96ef-7dc65c6d5674
                      timestamp: 1686346104.096
                    start: 1428939600
                    total: 135
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_psk_portal_logs_search'
                - description: Paginated response for organization PSK Portal log search results
                  examples:
                  - end: 1428954000
                    limit: 100
                    results:
                    - id: 8a3dcaa7-80e3-4bb0-a75b-7bc6322cfd09
                      message: Rotate PSK test@mist.com
                      name_id: test@mist.com
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      psk_id: 608fe603-f9f0-4ce9-9473-04ef6c6ea749
                      psk_name: test@mist.com
                      pskportal_id: c1742c09-af35-4161-96ef-7dc65c6d5674
                      timestamp: 1686346104.096
                    start: 1428939600
                    total: 135
                contentMediaType: application/vnd.api+json
              examples:
                PSK Portal Logs:
                  value:
                    end: 1428954000
                    limit: 100
                    results:
                    - id: 8a3dcaa7-80e3-4bb0-a75b-7bc6322cfd09
                      message: Rotate PSK test@mist.com
                      name_id: test@mist.com
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      psk_id: 608fe603-f9f0-4ce9-9473-04ef6c6ea749
                      psk_name: test@mist.com
                      pskportal_id: c1742c09-af35-4161-96ef-7dc65c6d5674
                      timestamp: 1686346104.096
                    start: 1428939600
                    total: 135
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/pskportals/{pskportal_id}:
    delete:
      tags:
      - Orgs Psk Portals
      summary: deleteOrgPskPortal
      description: Delete a PSK Portal configuration by portal ID, removing the self-service entry point for issuing PSKs through that portal.
      operationId: deleteOrgPskPortal
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: pskportal_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs Psk Portals
      summary: getOrgPskPortal
      description: Retrieve PSK Portal configuration details, including SSID, mode, authentication, SSO, passphrase, expiry, notification, and template URLs.
      operationId: getOrgPskPortal
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: pskportal_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/psk_portal'
                - description: Self-service portal configuration for issuing personal PSKs
                  examples:
                  - auth: sso
                    created_time: 1727272316
                    expire_time: 262800
                    expiry_notification_time: 2
                    hide_psks_created_by_other_admins: false
                    id: 86ef73e5-e360-4e33-abd8-c2da7b11cbd6
                    max_usage: 1
                    modified_time: 1727272316
                    name: USR-test
                    notify_expiry: false
                    org_id: 8f6c24d5-b618-4c30-b6ff-b2febc1078ab
                    passphrase_rules:
                      alphabets_enabled: true
                      length: 8
                      numerics_enabled: true
                      symbols: ()[]{}_%@#&$
                      symbols_enabled: true
                    role: ''
                    ssid: USR-test
                    sso:
                      idp_cert: >-
                        -----BEGIN CERTIFICATE-----

                        MIIDqDCCApCgA...-----END CERTIFICATE-----
                      idp_sign_algo: sha256
                      idp_sso_url: https://dev-00000000.okta.com/app/dev-00000000/a6b88bec5ab7/sso/saml
                      issuer: http://www.okta.com/a6b88bec5ab7
                      nameid_format: email
                    type: byod
                    ui_url: https://pskportal.gc1.mist.com/#!byod/a6b88bec-5ab7-41ae-a34c-44ff52a8b81d
                    vlan_id: 123
                contentMediaType: application/json
              examples:
                PSK Portal:
                  value:
                    auth: sso
                    created_time: 1727272316
                    expire_time: 262800
                    expiry_notification_time: 2
                    hide_psks_created_by_other_admins: false
                    id: 86ef73e5-e360-4e33-abd8-c2da7b11cbd6
                    max_usage: 1
                    modified_time: 1727272316
                    name: USR-test
                    notify_expiry: false
                    org_id: 8f6c24d5-b618-4c30-b6ff-b2febc1078ab
                    passphrase_rules:
                      alphabets_enabled: true
                      length: 8
                      numerics_enabled: true
                      symbols: ()[]{}_%@#&$
                      symbols_enabled: true
                    role: ''
                    ssid: USR-test
                    sso:
                      idp_cert: >-
                        -----BEGIN CERTIFICATE-----

                        MIIDqDCCApCgA...-----END CERTIFICATE-----
                      idp_sign_algo: sha256
                      idp_sso_url: https://dev-00000000.okta.com/app/dev-00000000/a6b88bec5ab7/sso/saml
                      issuer: http://www.okta.com/a6b88bec5ab7
                      nameid_format: email
                    type: byod
                    ui_url: https://pskportal.gc1.mist.com/#!byod/a6b88bec-5ab7-41ae-a34c-44ff52a8b81d
                    vlan_id: 123
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/psk_portal'
                - description: Self-service portal configuration for issuing personal PSKs
                  examples:
                  - auth: sso
                    created_time: 1727272316
                    expire_time: 262800
                    expiry_notification_time: 2
                    hide_psks_created_by_other_admins: false
                    id: 86ef73e5-e360-4e33-abd8-c2da7b11cbd6
                    max_usage: 1
                    modified_time: 1727272316
                    name: USR-test
                    notify_expiry: false
                    org_id: 8f6c24d5-b618-4c30-b6ff-b2febc1078ab
                    passphrase_rules:
                      alphabets_enabled: true
                      length: 8
                      numerics_enabled: true
                      symbols: ()[]{}_%@#&$
                      symbols_enabled: true
                    role: ''
                    ssid: USR-test
                    sso:
                      idp_cert: >-
                        -----BEGIN CERTIFICATE-----

                        MIIDqDCCApCgA...-----END CERTIFICATE-----
                      idp_sign_algo: sha256
                      idp_sso_url: https://dev-00000000.okta.com/app/dev-00000000/a6b88bec5ab7/sso/saml
                      issuer: http://www.okta.com/a6b88bec5ab7
                      nameid_format: email
                    type: byod
                    ui_url: https://pskportal.gc1.mist.com/#!byod/a6b88bec-5ab7-41ae-a34c-44ff52a8b81d
                    vlan_id: 123
                contentMediaType: application/vnd.api+json
              examples:
                PSK Portal:
                  value:
                    auth: sso
                    created_time: 1727272316
                    expire_time: 262800
                    expiry_notification_time: 2
                    hide_psks_created_by_other_admins: false
                    id: 86ef73e5-e360-4e33-abd8-c2da7b11cbd6
                    max_usage: 1
                    modified_time: 1727272316
                    name: USR-test
                    notify_expiry: false
                    org_id: 8f6c24d5-b618-4c30-b6ff-b2febc1078ab
                    passphrase_rules:
                      alphabets_enabled: true
                      length: 8
                      numerics_enabled: true
                      symbols: ()[]{}_%@#&$
                      symbols_enabled: true
                    role: ''
                    ssid: USR-test
                    sso:
                      idp_cert: >-
                        -----BEGIN CERTIFICATE-----

                        MIIDqDCCApCgA...-----END CERTIFICATE-----
                      idp_sign_algo: sha256
                      idp_sso_url: https://dev-00000000.okta.com/app/dev-00000000/a6b88bec5ab7/sso/saml
                      issuer: http://www.okta.com/a6b88bec5ab7
                      nameid_format: email
                    type: byod
                    ui_url: https://pskportal.gc1.mist.com/#!byod/a6b88bec-5ab7-41ae-a34c-44ff52a8b81d
                    vlan_id: 123
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs Psk Portals
      summary: updateOrgPskPortal
      description: Update a PSK Portal configuration, including SSID, mode, authentication, SSO, passphrase, expiry, notification, and template settings.
      operationId: updateOrgPskPortal
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: pskportal_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/psk_portal'
              - examples:
                - auth: sso
                  expire_time: 262800
                  expiry_notification_time: 2
                  hide_psks_created_by_other_admins: false
                  max_usage: 1
                  name: USR-test
                  notify_expiry: false
                  passphrase_rules:
                    alphabets_enabled: true
                    length: 8
                    numerics_enabled: true
                    symbols: ()[]{}_%@#&$
                    symbols_enabled: true
                  sponsors:
                    idp_cert: >-
                      -----BEGIN CERTIFICATE-----

                      MIIDqDCCApCgA...-----END CERTIFICATE-----
                    idp_sign_algo: sha256
                    idp_sso_url: https://dev-00000000.okta.com/app/dev-00000000/a6b88bec5ab7/sso/saml
                    issuer: http://www.okta.com/a6b88bec5ab7
                    nameid_format: email
                  ssid: USR-test
                  type: byod
                  vlan_id: nu42ll
              contentMediaType: application/json
            examples:
              Example:
                value:
                  auth: sso
                  expire_time: 262800
                  expiry_notification_time: 2
                  hide_psks_created_by_other_admins: false
                  max_usage: 1
                  name: USR-test
                  notify_expiry: false
                  passphrase_rules:
                    alphabets_enabled: true
                    length: 8
                    numerics_enabled: true
                    symbols: ()[]{}_%@#&$
                    symbols_enabled: true
                  sponsors:
                    idp_cert: >-
                      -----BEGIN CERTIFICATE-----

                      MIIDqDCCApCgA...-----END CERTIFICATE-----
                    idp_sign_algo: sha256
                    idp_sso_url: https://dev-00000000.okta.com/app/dev-00000000/a6b88bec5ab7/sso/saml
                    issuer: http://www.okta.com/a6b88bec5ab7
                    nameid_format: email
                  ssid: USR-test
                  type: byod
                  vlan_id: nu42ll
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/psk_portal'
                - description: Self-service portal configuration for issuing personal PSKs
                  examples:
                  - auth: sso
                    created_time: 1727272316
                    expire_time: 262800
                    expiry_notification_time: 2
                    hide_psks_created_by_other_admins: false
                    id: 86ef73e5-e360-4e33-abd8-c2da7b11cbd6
                    max_usage: 1
                    modified_time: 1727272316
                    name: USR-test
                    notify_expiry: false
                    org_id: 8f6c24d5-b618-4c30-b6ff-b2febc1078ab
                    passphrase_rules:
                      alphabets_enabled: true
                      length: 8
                      numerics_enabled: true
                      symbols: ()[]{}_%@#&$
                      symbols_enabled: true
                    role: ''
                    ssid: USR-test
                    sso:
                      idp_cert: >-
                        -----BEGIN CERTIFICATE-----

                        MIIDqDCCApCgA...-----END CERTIFICATE-----
                      idp_sign_algo: sha256
                      idp_sso_url: https://dev-00000000.okta.com/app/dev-00000000/a6b88bec5ab7/sso/saml
                      issuer: http://www.okta.com/a6b88bec5ab7
                      nameid_format: email
                    type: byod
                    ui_url: https://pskportal.gc1.mist.com/#!byod/a6b88bec-5ab7-41ae-a34c-44ff52a8b81d
                    vlan_id: 123
                contentMediaType: application/json
              examples:
                PSK Portal:
                  value:
                    auth: sso
                    created_time: 1727272316
                    expire_time: 262800
                    expiry_notification_time: 2
                    hide_psks_created_by_other_admins: false
                    id: 86ef73e5-e360-4e33-abd8-c2da7b11cbd6
                    max_usage: 1
                    modified_time: 1727272316
                    name: USR-test
                    notify_expiry: false
                    org_id: 8f6c24d5-b618-4c30-b6ff-b2febc1078ab
                    passphrase_rules:
                      alphabets_enabled: true
                      length: 8
                      numerics_enabled: true
                      symbols: ()[]{}_%@#&$
                      symbols_enabled: true
                    role: ''
                    ssid: USR-test
                    sso:
                      idp_cert: >-
                        -----BEGIN CERTIFICATE-----

                        MIIDqDCCApCgA...-----END CERTIFICATE-----
                      idp_sign_algo: sha256
                      idp_sso_url: https://dev-00000000.okta.com/app/dev-00000000/a6b88bec5ab7/sso/saml
                      issuer: http://www.okta.com/a6b88bec5ab7
                      nameid_format: email
                    type: byod
                    ui_url: https://pskportal.gc1.mist.com/#!byod/a6b88bec-5ab7-41ae-a34c-44ff52a8b81d
                    vlan_id: 123
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/psk_portal'
                - description: Self-service portal configuration for issuing personal PSKs
                  examples:
                  - auth: sso
                    created_time: 1727272316
                    expire_time: 262800
                    expiry_notification_time: 2
                    hide_psks_created_by_other_admins: false
                    id: 86ef73e5-e360-4e33-abd8-c2da7b11cbd6
                    max_usage: 1
                    modified_time: 1727272316
                    name: USR-test
                    notify_expiry: false
                    org_id: 8f6c24d5-b618-4c30-b6ff-b2febc1078ab
                    passphrase_rules:
                      alphabets_enabled: true
                      length: 8
                      numerics_enabled: true
                      symbols: ()[]{}_%@#&$
                      symbols_enabled: true
                    role: ''
                    ssid: USR-test
                    sso:
                      idp_cert: >-
                        -----BEGIN CERTIFICATE-----

                        MIIDqDCCApCgA...-----END CERTIFICATE-----
                      idp_sign_algo: sha256
                      idp_sso_url: https://dev-00000000.okta.com/app/dev-00000000/a6b88bec5ab7/sso/saml
                      issuer: http://www.okta.com/a6b88bec5ab7
                      nameid_format: email
                    type: byod
                    ui_url: https://pskportal.gc1.mist.com/#!byod/a6b88bec-5ab7-41ae-a34c-44ff52a8b81d
                    vlan_id: 123
                contentMediaType: application/vnd.api+json
              examples:
                PSK Portal:
                  value:
                    auth: sso
                    created_time: 1727272316
                    expire_time: 262800
                    expiry_notification_time: 2
                    hide_psks_created_by_other_admins: false
                    id: 86ef73e5-e360-4e33-abd8-c2da7b11cbd6
                    max_usage: 1
                    modified_time: 1727272316
                    name: USR-test
                    notify_expiry: false
                    org_id: 8f6c24d5-b618-4c30-b6ff-b2febc1078ab
                    passphrase_rules:
                      alphabets_enabled: true
                      length: 8
                      numerics_enabled: true
                      symbols: ()[]{}_%@#&$
                      symbols_enabled: true
                    role: ''
                    ssid: USR-test
                    sso:
                      idp_cert: >-
                        -----BEGIN CERTIFICATE-----

                        MIIDqDCCApCgA...-----END CERTIFICATE-----
                      idp_sign_algo: sha256
                      idp_sso_url: https://dev-00000000.okta.com/app/dev-00000000/a6b88bec5ab7/sso/saml
                      issuer: http://www.okta.com/a6b88bec5ab7
                      nameid_format: email
                    type: byod
                    ui_url: https://pskportal.gc1.mist.com/#!byod/a6b88bec-5ab7-41ae-a34c-44ff52a8b81d
                    vlan_id: 123
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/pskportals/{pskportal_id}/portal_image:
    delete:
      tags:
      - Orgs Psk Portals
      summary: deleteOrgPskPortalImage
      description: Delete the custom background image for a PSK Portal. If no image is configured, the PSK Portal uses the default background image.
      operationId: deleteOrgPskPortalImage
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: pskportal_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs Psk Portals
      summary: uploadOrgPskPortalImage
      description: Upload a custom background image for a PSK Portal.
      operationId: uploadOrgPskPortalImage
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: pskportal_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              type: object
              properties:
                file:
                  type: string
                  description: Image binary payload to upload for the PSK portal
                  contentEncoding: base64
                json:
                  type: string
                  description: Metadata JSON string describing the PSK portal image upload
              contentMediaType: multipart/form-data
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/pskportals/{pskportal_id}/portal_template:
    put:
      tags:
      - Orgs Psk Portals
      summary: updateOrgPskPortalTemplate
      description: Update PSK Portal UI template settings, including alignment, color, logo, Powered by visibility, and Terms of Service text.
      operationId: updateOrgPskPortalTemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: pskportal_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/psk_portal_template'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/exports/e911_report:
    delete:
      tags:
      - Orgs Reports
      summary: disableOrgE911Report
      description: Disable automatic E911 AP BSSID report generation for the organization.
      operationId: disableOrgE911Report
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org_e911_report'
                - description: E911 AP BSSID report status for the organization
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org_e911_report'
                - description: E911 AP BSSID report status for the organization
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs Reports
      summary: getOrgE911Report
      description: Get the status of E911 AP BSSID reports and download URL if available.
      operationId: getOrgE911Report
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org_e911_report'
                - description: E911 AP BSSID report status for the organization
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org_e911_report'
                - description: E911 AP BSSID report status for the organization
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs Reports
      summary: enableOrgE911Report
      description: Enable automatic E911 AP BSSID report generation for the organization. Reports will be generated immediately and then every 24 hours.
      operationId: enableOrgE911Report
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org_e911_report'
                - description: E911 AP BSSID report status for the organization
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org_e911_report'
                - description: E911 AP BSSID report status for the organization
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/rftemplates:
    get:
      tags:
      - Orgs RF Templates
      summary: listOrgRfTemplates
      description: List organization RF templates used by RRM to apply radio settings across sites.
      operationId: listOrgRfTemplates
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/rf_template'
                description: List of RF templates
                examples:
                - - ant_gain_24: 0
                    ant_gain_5: 0
                    band_24:
                      allow_rrm_disable: true
                      ant_gain: 0
                      bandwidth: 20
                      channels:
                      - 1
                      - 6
                      - 11
                      disabled: false
                      power_max: 11
                      power_min: 3
                      preamble: short
                    band_24_usage: auto
                    band_5:
                      allow_rrm_disable: false
                      ant_gain: 0
                      bandwidth: 80
                      channels:
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 149
                      - 153
                      - 157
                      - 161
                      disabled: false
                      power_max: 16
                      power_min: 9
                      preamble: short
                    country_code: FR
                    created_time: 1594743723
                    enable_unii_4: false
                    id: b3f20330-f76a-49f1-bc65-0d8727140b1d
                    model_specific: {}
                    modified_time: 1613582192
                    name: Lab
                    org_id: 203d3d02-dbc0-4c1b-9f41-76896a3330f4
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - ant_gain_24: 0
                    ant_gain_5: 0
                    band_24:
                      allow_rrm_disable: true
                      ant_gain: 0
                      bandwidth: 20
                      channels:
                      - 1
                      - 6
                      - 11
                      disabled: false
                      power_max: 11
                      power_min: 3
                      preamble: short
                    band_24_usage: auto
                    band_5:
                      allow_rrm_disable: false
                      ant_gain: 0
                      bandwidth: 80
                      channels:
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 149
                      - 153
                      - 157
                      - 161
                      disabled: false
                      power_max: 16
                      power_min: 9
                      preamble: short
                    country_code: FR
                    created_time: 1594743723
                    enable_unii_4: false
                    id: b3f20330-f76a-49f1-bc65-0d8727140b1d
                    model_specific: {}
                    modified_time: 1613582192
                    name: Lab
                    org_id: 203d3d02-dbc0-4c1b-9f41-76896a3330f4
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/rf_template'
                description: List of RF templates
                examples:
                - - ant_gain_24: 0
                    ant_gain_5: 0
                    band_24:
                      allow_rrm_disable: true
                      ant_gain: 0
                      bandwidth: 20
                      channels:
                      - 1
                      - 6
                      - 11
                      disabled: false
                      power_max: 11
                      power_min: 3
                      preamble: short
                    band_24_usage: auto
                    band_5:
                      allow_rrm_disable: false
                      ant_gain: 0
                      bandwidth: 80
                      channels:
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 149
                      - 153
                      - 157
                      - 161
                      disabled: false
                      power_max: 16
                      power_min: 9
                      preamble: short
                    country_code: FR
                    created_time: 1594743723
                    enable_unii_4: false
                    id: b3f20330-f76a-49f1-bc65-0d8727140b1d
                    model_specific: {}
                    modified_time: 1613582192
                    name: Lab
                    org_id: 203d3d02-dbc0-4c1b-9f41-76896a3330f4
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - ant_gain_24: 0
                    ant_gain_5: 0
                    band_24:
                      allow_rrm_disable: true
                      ant_gain: 0
                      bandwidth: 20
                      channels:
                      - 1
                      - 6
                      - 11
                      disabled: false
                      power_max: 11
                      power_min: 3
                      preamble: short
                    band_24_usage: auto
                    band_5:
                      allow_rrm_disable: false
                      ant_gain: 0
                      bandwidth: 80
                      channels:
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 149
                      - 153
                      - 157
                      - 161
                      disabled: false
                      power_max: 16
                      power_min: 9
                      preamble: short
                    country_code: FR
                    created_time: 1594743723
                    enable_unii_4: false
                    id: b3f20330-f76a-49f1-bc65-0d8727140b1d
                    model_specific: {}
                    modified_time: 1613582192
                    name: Lab
                    org_id: 203d3d02-dbc0-4c1b-9f41-76896a3330f4
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs RF Templates
      summary: createOrgRfTemplate
      description: >-
        Create an organization RF template with 2.4, 5, and 6 GHz radio

        settings, country code, scanning behavior, antenna gain, and model-specific

        overrides.


        To assign a RF template to a site, use the [Update Site]($e/Sites/updateSiteInfo) endpoint and specify the RF template ID in the `rftemplate_id` field of the request body.
      operationId: createOrgRfTemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/rf_template'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rf_template'
                - description: RF template used by the current RRM calculation
                  examples:
                  - ant_gain_24: 0
                    ant_gain_5: 0
                    band_24:
                      allow_rrm_disable: true
                      ant_gain: 0
                      bandwidth: 20
                      channels:
                      - 1
                      - 6
                      - 11
                      disabled: false
                      power_max: 11
                      power_min: 3
                      preamble: short
                    band_24_usage: auto
                    band_5:
                      allow_rrm_disable: false
                      ant_gain: 0
                      bandwidth: 80
                      channels:
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 149
                      - 153
                      - 157
                      - 161
                      disabled: false
                      power_max: 16
                      power_min: 9
                      preamble: short
                    country_code: FR
                    created_time: 1594743723
                    enable_unii_4: false
                    id: b3f20330-f76a-49f1-bc65-0d8727140b1d
                    model_specific: {}
                    modified_time: 1613582192
                    name: Lab
                    org_id: 203d3d02-dbc0-4c1b-9f41-76896a3330f4
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    ant_gain_24: 0
                    ant_gain_5: 0
                    band_24:
                      allow_rrm_disable: true
                      ant_gain: 0
                      bandwidth: 20
                      channels:
                      - 1
                      - 6
                      - 11
                      disabled: false
                      power_max: 11
                      power_min: 3
                      preamble: short
                    band_24_usage: auto
                    band_5:
                      allow_rrm_disable: false
                      ant_gain: 0
                      bandwidth: 80
                      channels:
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 149
                      - 153
                      - 157
                      - 161
                      disabled: false
                      power_max: 16
                      power_min: 9
                      preamble: short
                    country_code: FR
                    created_time: 1594743723
                    enable_unii_4: false
                    id: b3f20330-f76a-49f1-bc65-0d8727140b1d
                    model_specific: {}
                    modified_time: 1613582192
                    name: Lab
                    org_id: 203d3d02-dbc0-4c1b-9f41-76896a3330f4
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rf_template'
                - description: RF template used by the current RRM calculation
                  examples:
                  - ant_gain_24: 0
                    ant_gain_5: 0
                    band_24:
                      allow_rrm_disable: true
                      ant_gain: 0
                      bandwidth: 20
                      channels:
                      - 1
                      - 6
                      - 11
                      disabled: false
                      power_max: 11
                      power_min: 3
                      preamble: short
                    band_24_usage: auto
                    band_5:
                      allow_rrm_disable: false
                      ant_gain: 0
                      bandwidth: 80
                      channels:
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 149
                      - 153
                      - 157
                      - 161
                      disabled: false
                      power_max: 16
                      power_min: 9
                      preamble: short
                    country_code: FR
                    created_time: 1594743723
                    enable_unii_4: false
                    id: b3f20330-f76a-49f1-bc65-0d8727140b1d
                    model_specific: {}
                    modified_time: 1613582192
                    name: Lab
                    org_id: 203d3d02-dbc0-4c1b-9f41-76896a3330f4
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    ant_gain_24: 0
                    ant_gain_5: 0
                    band_24:
                      allow_rrm_disable: true
                      ant_gain: 0
                      bandwidth: 20
                      channels:
                      - 1
                      - 6
                      - 11
                      disabled: false
                      power_max: 11
                      power_min: 3
                      preamble: short
                    band_24_usage: auto
                    band_5:
                      allow_rrm_disable: false
                      ant_gain: 0
                      bandwidth: 80
                      channels:
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 149
                      - 153
                      - 157
                      - 161
                      disabled: false
                      power_max: 16
                      power_min: 9
                      preamble: short
                    country_code: FR
                    created_time: 1594743723
                    enable_unii_4: false
                    id: b3f20330-f76a-49f1-bc65-0d8727140b1d
                    model_specific: {}
                    modified_time: 1613582192
                    name: Lab
                    org_id: 203d3d02-dbc0-4c1b-9f41-76896a3330f4
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/rftemplates/{rftemplate_id}:
    delete:
      tags:
      - Orgs RF Templates
      summary: deleteOrgRfTemplate
      description: Delete an organization RF template by template ID so it can no longer be applied to sites.
      operationId: deleteOrgRfTemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: rftemplate_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs RF Templates
      summary: getOrgRfTemplate
      description: Retrieve details for a specific organization RF template, including radio settings, country code, scanning behavior, antenna gain, and model-specific overrides.
      operationId: getOrgRfTemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: rftemplate_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rf_template'
                - description: RF template used by the current RRM calculation
                  examples:
                  - ant_gain_24: 0
                    ant_gain_5: 0
                    band_24:
                      allow_rrm_disable: true
                      ant_gain: 0
                      bandwidth: 20
                      channels:
                      - 1
                      - 6
                      - 11
                      disabled: false
                      power_max: 11
                      power_min: 3
                      preamble: short
                    band_24_usage: auto
                    band_5:
                      allow_rrm_disable: false
                      ant_gain: 0
                      bandwidth: 80
                      channels:
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 149
                      - 153
                      - 157
                      - 161
                      disabled: false
                      power_max: 16
                      power_min: 9
                      preamble: short
                    country_code: FR
                    created_time: 1594743723
                    enable_unii_4: false
                    id: b3f20330-f76a-49f1-bc65-0d8727140b1d
                    model_specific: {}
                    modified_time: 1613582192
                    name: Lab
                    org_id: 203d3d02-dbc0-4c1b-9f41-76896a3330f4
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    ant_gain_24: 0
                    ant_gain_5: 0
                    band_24:
                      allow_rrm_disable: true
                      ant_gain: 0
                      bandwidth: 20
                      channels:
                      - 1
                      - 6
                      - 11
                      disabled: false
                      power_max: 11
                      power_min: 3
                      preamble: short
                    band_24_usage: auto
                    band_5:
                      allow_rrm_disable: false
                      ant_gain: 0
                      bandwidth: 80
                      channels:
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 149
                      - 153
                      - 157
                      - 161
                      disabled: false
                      power_max: 16
                      power_min: 9
                      preamble: short
                    country_code: FR
                    created_time: 1594743723
                    enable_unii_4: false
                    id: b3f20330-f76a-49f1-bc65-0d8727140b1d
                    model_specific: {}
                    modified_time: 1613582192
                    name: Lab
                    org_id: 203d3d02-dbc0-4c1b-9f41-76896a3330f4
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rf_template'
                - description: RF template used by the current RRM calculation
                  examples:
                  - ant_gain_24: 0
                    ant_gain_5: 0
                    band_24:
                      allow_rrm_disable: true
                      ant_gain: 0
                      bandwidth: 20
                      channels:
                      - 1
                      - 6
                      - 11
                      disabled: false
                      power_max: 11
                      power_min: 3
                      preamble: short
                    band_24_usage: auto
                    band_5:
                      allow_rrm_disable: false
                      ant_gain: 0
                      bandwidth: 80
                      channels:
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 149
                      - 153
                      - 157
                      - 161
                      disabled: false
                      power_max: 16
                      power_min: 9
                      preamble: short
                    country_code: FR
                    created_time: 1594743723
                    enable_unii_4: false
                    id: b3f20330-f76a-49f1-bc65-0d8727140b1d
                    model_specific: {}
                    modified_time: 1613582192
                    name: Lab
                    org_id: 203d3d02-dbc0-4c1b-9f41-76896a3330f4
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    ant_gain_24: 0
                    ant_gain_5: 0
                    band_24:
                      allow_rrm_disable: true
                      ant_gain: 0
                      bandwidth: 20
                      channels:
                      - 1
                      - 6
                      - 11
                      disabled: false
                      power_max: 11
                      power_min: 3
                      preamble: short
                    band_24_usage: auto
                    band_5:
                      allow_rrm_disable: false
                      ant_gain: 0
                      bandwidth: 80
                      channels:
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 149
                      - 153
                      - 157
                      - 161
                      disabled: false
                      power_max: 16
                      power_min: 9
                      preamble: short
                    country_code: FR
                    created_time: 1594743723
                    enable_unii_4: false
                    id: b3f20330-f76a-49f1-bc65-0d8727140b1d
                    model_specific: {}
                    modified_time: 1613582192
                    name: Lab
                    org_id: 203d3d02-dbc0-4c1b-9f41-76896a3330f4
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs RF Templates
      summary: updateOrgRfTemplate
      description: Update an organization RF template, including radio settings, country code, scanning behavior, antenna gain, and model-specific overrides.
      operationId: updateOrgRfTemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: rftemplate_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/rf_template'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rf_template'
                - description: RF template used by the current RRM calculation
                  examples:
                  - ant_gain_24: 0
                    ant_gain_5: 0
                    band_24:
                      allow_rrm_disable: true
                      ant_gain: 0
                      bandwidth: 20
                      channels:
                      - 1
                      - 6
                      - 11
                      disabled: false
                      power_max: 11
                      power_min: 3
                      preamble: short
                    band_24_usage: auto
                    band_5:
                      allow_rrm_disable: false
                      ant_gain: 0
                      bandwidth: 80
                      channels:
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 149
                      - 153
                      - 157
                      - 161
                      disabled: false
                      power_max: 16
                      power_min: 9
                      preamble: short
                    country_code: FR
                    created_time: 1594743723
                    enable_unii_4: false
                    id: b3f20330-f76a-49f1-bc65-0d8727140b1d
                    model_specific: {}
                    modified_time: 1613582192
                    name: Lab
                    org_id: 203d3d02-dbc0-4c1b-9f41-76896a3330f4
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    ant_gain_24: 0
                    ant_gain_5: 0
                    band_24:
                      allow_rrm_disable: true
                      ant_gain: 0
                      bandwidth: 20
                      channels:
                      - 1
                      - 6
                      - 11
                      disabled: false
                      power_max: 11
                      power_min: 3
                      preamble: short
                    band_24_usage: auto
                    band_5:
                      allow_rrm_disable: false
                      ant_gain: 0
                      bandwidth: 80
                      channels:
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 149
                      - 153
                      - 157
                      - 161
                      disabled: false
                      power_max: 16
                      power_min: 9
                      preamble: short
                    country_code: FR
                    created_time: 1594743723
                    enable_unii_4: false
                    id: b3f20330-f76a-49f1-bc65-0d8727140b1d
                    model_specific: {}
                    modified_time: 1613582192
                    name: Lab
                    org_id: 203d3d02-dbc0-4c1b-9f41-76896a3330f4
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rf_template'
                - description: RF template used by the current RRM calculation
                  examples:
                  - ant_gain_24: 0
                    ant_gain_5: 0
                    band_24:
                      allow_rrm_disable: true
                      ant_gain: 0
                      bandwidth: 20
                      channels:
                      - 1
                      - 6
                      - 11
                      disabled: false
                      power_max: 11
                      power_min: 3
                      preamble: short
                    band_24_usage: auto
                    band_5:
                      allow_rrm_disable: false
                      ant_gain: 0
                      bandwidth: 80
                      channels:
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 149
                      - 153
                      - 157
                      - 161
                      disabled: false
                      power_max: 16
                      power_min: 9
                      preamble: short
                    country_code: FR
                    created_time: 1594743723
                    enable_unii_4: false
                    id: b3f20330-f76a-49f1-bc65-0d8727140b1d
                    model_specific: {}
                    modified_time: 1613582192
                    name: Lab
                    org_id: 203d3d02-dbc0-4c1b-9f41-76896a3330f4
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    ant_gain_24: 0
                    ant_gain_5: 0
                    band_24:
                      allow_rrm_disable: true
                      ant_gain: 0
                      bandwidth: 20
                      channels:
                      - 1
                      - 6
                      - 11
                      disabled: false
                      power_max: 11
                      power_min: 3
                      preamble: short
                    band_24_usage: auto
                    band_5:
                      allow_rrm_disable: false
                      ant_gain: 0
                      bandwidth: 80
                      channels:
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 149
                      - 153
                      - 157
                      - 161
                      disabled: false
                      power_max: 16
                      power_min: 9
                      preamble: short
                    country_code: FR
                    created_time: 1594743723
                    enable_unii_4: false
                    id: b3f20330-f76a-49f1-bc65-0d8727140b1d
                    model_specific: {}
                    modified_time: 1613582192
                    name: Lab
                    org_id: 203d3d02-dbc0-4c1b-9f41-76896a3330f4
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/mobile/verify/{secret}:
    post:
      tags:
      - Orgs SDK Invites
      summary: activateSdkInvite
      description: Activate a mobile SDK invite by verifying the invite secret and binding it to the supplied device identifier. The response returns the device-specific secret used by the mobile SDK client.
      operationId: activateSdkInvite
      parameters:
      - name: secret
        in: path
        description: ''
        required: true
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/device_id_string'
              - examples:
                - device_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
              contentMediaType: application/json
            examples:
              Example:
                value:
                  device_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_mobile_verify_secret'
                - description: Mobile SDK invite verification response
                  examples:
                  - name: Macy's
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: device-specific-secret
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    name: Macy's
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: device-specific-secret
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_mobile_verify_secret'
                - description: Mobile SDK invite verification response
                  examples:
                  - name: Macy's
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: device-specific-secret
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    name: Macy's
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: device-specific-secret
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/sdkinvites:
    get:
      tags:
      - Orgs SDK Invites
      summary: listSdkInvites
      description: List SDK invites configured for the organization. SDK invites are used to onboard mobile SDK clients and can define whether an invite is enabled, limited by usage quota, or scoped to a site.
      operationId: listSdkInvites
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/sdkinvite'
                description: SDK invite configurations returned by list operations
                examples:
                - - created_time: 1428954000
                    enabled: true
                    expire_time: 1428954000
                    id: 5034b980-b49e-501c-66e0-9de4c38f18a2
                    name: Macy's
                    quota: -1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 1428954000
                    enabled: true
                    expire_time: 1428954000
                    id: 5034b980-b49e-501c-66e0-9de4c38f18a2
                    name: Macy's
                    quota: -1
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/sdkinvite'
                description: SDK invite configurations returned by list operations
                examples:
                - - created_time: 1428954000
                    enabled: true
                    expire_time: 1428954000
                    id: 5034b980-b49e-501c-66e0-9de4c38f18a2
                    name: Macy's
                    quota: -1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 1428954000
                    enabled: true
                    expire_time: 1428954000
                    id: 5034b980-b49e-501c-66e0-9de4c38f18a2
                    name: Macy's
                    quota: -1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs SDK Invites
      summary: createSdkInvite
      description: Create an SDK invite that mobile SDK clients can use to onboard into the organization. The invite can be enabled or disabled, limited by usage quota, and associated with a site.
      operationId: createSdkInvite
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/sdkinvite'
              - description: Request Body
                examples:
                - enabled: true
                  name: string
                  quota: 0
                  quota_limited: true
              contentMediaType: application/json
            examples:
              Example:
                value:
                  enabled: true
                  name: string
                  quota: 0
                  quota_limited: true
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sdkinvite'
                - description: SDK invite configuration used to onboard mobile SDK clients to an organization
                  examples:
                  - created_time: 1428954000
                    enabled: true
                    expire_time: 1428954000
                    id: 5034b980-b49e-501c-66e0-9de4c38f18a2
                    name: Macy's
                    quota: -1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 1428954000
                    enabled: true
                    expire_time: 1428954000
                    id: 5034b980-b49e-501c-66e0-9de4c38f18a2
                    name: Macy's
                    quota: -1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sdkinvite'
                - description: SDK invite configuration used to onboard mobile SDK clients to an organization
                  examples:
                  - created_time: 1428954000
                    enabled: true
                    expire_time: 1428954000
                    id: 5034b980-b49e-501c-66e0-9de4c38f18a2
                    name: Macy's
                    quota: -1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 1428954000
                    enabled: true
                    expire_time: 1428954000
                    id: 5034b980-b49e-501c-66e0-9de4c38f18a2
                    name: Macy's
                    quota: -1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/sdkinvites/{sdkinvite_id}:
    delete:
      tags:
      - Orgs SDK Invites
      summary: revokeSdkInvite
      description: Revoke an SDK invite so it can no longer be used for mobile SDK client onboarding.
      operationId: revokeSdkInvite
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: sdkinvite_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs SDK Invites
      summary: getSdkInvite
      description: Return the configuration and status of an SDK invite, including enablement, expiration time, usage quota, and site scope.
      operationId: getSdkInvite
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: sdkinvite_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sdkinvite'
                - description: SDK invite configuration used to onboard mobile SDK clients to an organization
                  examples:
                  - created_time: 1428954000
                    enabled: true
                    expire_time: 1428954000
                    id: 5034b980-b49e-501c-66e0-9de4c38f18a2
                    name: Macy's
                    quota: -1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 1428954000
                    enabled: true
                    expire_time: 1428954000
                    id: 5034b980-b49e-501c-66e0-9de4c38f18a2
                    name: Macy's
                    quota: -1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sdkinvite'
                - description: SDK invite configuration used to onboard mobile SDK clients to an organization
                  examples:
                  - created_time: 1428954000
                    enabled: true
                    expire_time: 1428954000
                    id: 5034b980-b49e-501c-66e0-9de4c38f18a2
                    name: Macy's
                    quota: -1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 1428954000
                    enabled: true
                    expire_time: 1428954000
                    id: 5034b980-b49e-501c-66e0-9de4c38f18a2
                    name: Macy's
                    quota: -1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs SDK Invites
      summary: updateSdkInvite
      description: Update an SDK invite's onboarding settings, such as its display name, enabled state, expiration time, quota, or site association.
      operationId: updateSdkInvite
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: sdkinvite_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/sdkinvite'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sdkinvite'
                - description: SDK invite configuration used to onboard mobile SDK clients to an organization
                  examples:
                  - created_time: 1428954000
                    enabled: true
                    expire_time: 1428954000
                    id: 5034b980-b49e-501c-66e0-9de4c38f18a2
                    name: Macy's
                    quota: -1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 1428954000
                    enabled: true
                    expire_time: 1428954000
                    id: 5034b980-b49e-501c-66e0-9de4c38f18a2
                    name: Macy's
                    quota: -1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sdkinvite'
                - description: SDK invite configuration used to onboard mobile SDK clients to an organization
                  examples:
                  - created_time: 1428954000
                    enabled: true
                    expire_time: 1428954000
                    id: 5034b980-b49e-501c-66e0-9de4c38f18a2
                    name: Macy's
                    quota: -1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 1428954000
                    enabled: true
                    expire_time: 1428954000
                    id: 5034b980-b49e-501c-66e0-9de4c38f18a2
                    name: Macy's
                    quota: -1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/sdkinvites/{sdkinvite_id}/email:
    post:
      tags:
      - Orgs SDK Invites
      summary: sendSdkInviteEmail
      description: Send the SDK invite to a recipient email address so the recipient can onboard a mobile SDK client.
      operationId: sendSdkInviteEmail
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: sdkinvite_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/email_string'
              - description: Request Body
                examples:
                - email: test@abc.com
              contentMediaType: application/json
            examples:
              Example:
                value:
                  email: test@abc.com
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/sdkinvites/{sdkinvite_id}/qrcode:
    get:
      tags:
      - Orgs SDK Invites
      summary: getSdkInviteQrCode
      description: Download a QR code image for the SDK invite so it can be scanned by a mobile SDK client during onboarding.
      operationId: getSdkInviteQrCode
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: sdkinvite_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: string
                description: File
                contentEncoding: base64
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                type: string
                description: File
                contentEncoding: base64
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/sdkinvites/{sdkinvite_id}/sms:
    post:
      tags:
      - Orgs SDK Invites
      summary: sendSdkInviteSms
      description: Send the SDK invite to a phone number by SMS so the recipient can onboard a mobile SDK client.
      operationId: sendSdkInviteSms
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: sdkinvite_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/sdk_invite_sms'
              - description: Request Body
                examples:
                - number: '14081234567'
              contentMediaType: application/json
            examples:
              Example:
                value:
                  number: '14081234567'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/sdktemplates:
    get:
      tags:
      - Orgs SDK Templates
      summary: listSdkTemplates
      description: List SDK templates configured for the organization. SDK templates define visual customization for the mobile SDK experience, including branding images, colors, header text, and welcome messages.
      operationId: listSdkTemplates
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/sdktemplate'
                description: SDK visual customization templates returned by list operations
                examples:
                - - bg_image: https://p.imgci.com/db/PICTURES/CMS/227700/227791.4.jpg
                    btn_flr_bgcolor: '#282828'
                    default: true
                    header_txt: Mist
                    name: default
                    search_txtcolor: '#282828'
                    welcome_msg: Welcome to Mist
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - bg_image: https://p.imgci.com/db/PICTURES/CMS/227700/227791.4.jpg
                    btn_flr_bgcolor: '#282828'
                    default: true
                    header_txt: Mist
                    name: default
                    search_txtcolor: '#282828'
                    welcome_msg: Welcome to Mist
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/sdktemplate'
                description: SDK visual customization templates returned by list operations
                examples:
                - - bg_image: https://p.imgci.com/db/PICTURES/CMS/227700/227791.4.jpg
                    btn_flr_bgcolor: '#282828'
                    default: true
                    header_txt: Mist
                    name: default
                    search_txtcolor: '#282828'
                    welcome_msg: Welcome to Mist
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - bg_image: https://p.imgci.com/db/PICTURES/CMS/227700/227791.4.jpg
                    btn_flr_bgcolor: '#282828'
                    default: true
                    header_txt: Mist
                    name: default
                    search_txtcolor: '#282828'
                    welcome_msg: Welcome to Mist
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs SDK Templates
      summary: createSdkTemplate
      description: Create an SDK template that defines visual customization for the mobile SDK experience, including branding images, colors, header text, and welcome messages.
      operationId: createSdkTemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/sdktemplate'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sdktemplate'
                - description: Visual customization template for the mobile SDK experience
                  examples:
                  - bg_image: https://p.imgci.com/db/PICTURES/CMS/227700/227791.4.jpg
                    btn_flr_bgcolor: '#282828'
                    default: true
                    header_txt: Mist
                    name: default
                    search_txtcolor: '#282828'
                    welcome_msg: Welcome to Mist
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    bg_image: https://p.imgci.com/db/PICTURES/CMS/227700/227791.4.jpg
                    btn_flr_bgcolor: '#282828'
                    default: true
                    header_txt: Mist
                    name: default
                    search_txtcolor: '#282828'
                    welcome_msg: Welcome to Mist
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sdktemplate'
                - description: Visual customization template for the mobile SDK experience
                  examples:
                  - bg_image: https://p.imgci.com/db/PICTURES/CMS/227700/227791.4.jpg
                    btn_flr_bgcolor: '#282828'
                    default: true
                    header_txt: Mist
                    name: default
                    search_txtcolor: '#282828'
                    welcome_msg: Welcome to Mist
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    bg_image: https://p.imgci.com/db/PICTURES/CMS/227700/227791.4.jpg
                    btn_flr_bgcolor: '#282828'
                    default: true
                    header_txt: Mist
                    name: default
                    search_txtcolor: '#282828'
                    welcome_msg: Welcome to Mist
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/sdktemplates/{sdktemplate_id}:
    delete:
      tags:
      - Orgs SDK Templates
      summary: deleteSdkTemplate
      description: Delete an SDK visual customization template from the organization.
      operationId: deleteSdkTemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: sdktemplate_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs SDK Templates
      summary: getSdkTemplate
      description: Return the visual customization settings for an SDK template, including branding text, image URLs, colors, default state, and site scope.
      operationId: getSdkTemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: sdktemplate_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sdktemplate'
                - description: Visual customization template for the mobile SDK experience
                  examples:
                  - bg_image: https://p.imgci.com/db/PICTURES/CMS/227700/227791.4.jpg
                    btn_flr_bgcolor: '#282828'
                    default: true
                    header_txt: Mist
                    name: default
                    search_txtcolor: '#282828'
                    welcome_msg: Welcome to Mist
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    bg_image: https://p.imgci.com/db/PICTURES/CMS/227700/227791.4.jpg
                    btn_flr_bgcolor: '#282828'
                    default: true
                    header_txt: Mist
                    name: default
                    search_txtcolor: '#282828'
                    welcome_msg: Welcome to Mist
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sdktemplate'
                - description: Visual customization template for the mobile SDK experience
                  examples:
                  - bg_image: https://p.imgci.com/db/PICTURES/CMS/227700/227791.4.jpg
                    btn_flr_bgcolor: '#282828'
                    default: true
                    header_txt: Mist
                    name: default
                    search_txtcolor: '#282828'
                    welcome_msg: Welcome to Mist
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    bg_image: https://p.imgci.com/db/PICTURES/CMS/227700/227791.4.jpg
                    btn_flr_bgcolor: '#282828'
                    default: true
                    header_txt: Mist
                    name: default
                    search_txtcolor: '#282828'
                    welcome_msg: Welcome to Mist
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs SDK Templates
      summary: updateSdkTemplate
      description: Update an SDK template's visual customization settings, such as branding images, colors, header text, welcome message, default state, or site association.
      operationId: updateSdkTemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: sdktemplate_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/sdktemplate'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sdktemplate'
                - description: Visual customization template for the mobile SDK experience
                  examples:
                  - bg_image: https://p.imgci.com/db/PICTURES/CMS/227700/227791.4.jpg
                    btn_flr_bgcolor: '#282828'
                    default: true
                    header_txt: Mist
                    name: default
                    search_txtcolor: '#282828'
                    welcome_msg: Welcome to Mist
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    bg_image: https://p.imgci.com/db/PICTURES/CMS/227700/227791.4.jpg
                    btn_flr_bgcolor: '#282828'
                    default: true
                    header_txt: Mist
                    name: default
                    search_txtcolor: '#282828'
                    welcome_msg: Welcome to Mist
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sdktemplate'
                - description: Visual customization template for the mobile SDK experience
                  examples:
                  - bg_image: https://p.imgci.com/db/PICTURES/CMS/227700/227791.4.jpg
                    btn_flr_bgcolor: '#282828'
                    default: true
                    header_txt: Mist
                    name: default
                    search_txtcolor: '#282828'
                    welcome_msg: Welcome to Mist
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    bg_image: https://p.imgci.com/db/PICTURES/CMS/227700/227791.4.jpg
                    btn_flr_bgcolor: '#282828'
                    default: true
                    header_txt: Mist
                    name: default
                    search_txtcolor: '#282828'
                    welcome_msg: Welcome to Mist
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/secpolicies:
    get:
      tags:
      - Orgs Security Policies
      summary: listOrgSecPolicies
      description: List organization security policies. Security policies define WLAN configuration baselines used to audit intended wireless settings against actual AP configuration.
      operationId: listOrgSecPolicies
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/secpolicy'
                description: Security policies returned by list operations
                examples:
                - - name: corporate only
                    wlans:
                    - auth:
                        pairwise:
                        - wpa1-tkip
                        - wpa2-tkip
                        type: psk
                      band: both
                      ssid: office
                    - auth:
                        type: open
                      band: '5'
                      ssid: office-guest
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - name: corporate only
                    wlans:
                    - auth:
                        pairwise:
                        - wpa1-tkip
                        - wpa2-tkip
                        type: psk
                      band: both
                      ssid: office
                    - auth:
                        type: open
                      band: '5'
                      ssid: office-guest
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/secpolicy'
                description: Security policies returned by list operations
                examples:
                - - name: corporate only
                    wlans:
                    - auth:
                        pairwise:
                        - wpa1-tkip
                        - wpa2-tkip
                        type: psk
                      band: both
                      ssid: office
                    - auth:
                        type: open
                      band: '5'
                      ssid: office-guest
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - name: corporate only
                    wlans:
                    - auth:
                        pairwise:
                        - wpa1-tkip
                        - wpa2-tkip
                        type: psk
                      band: both
                      ssid: office
                    - auth:
                        type: open
                      band: '5'
                      ssid: office-guest
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs Security Policies
      summary: createOrgSecPolicy
      description: Create an organization security policy containing WLAN configuration baselines for auditing site and AP configuration compliance.
      operationId: createOrgSecPolicy
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/secpolicy'
              - examples:
                - name: string
                  wlans:
                  - acct_immediate_update: false
                    acct_interim_interval: 0
                    acct_servers:
                    - host: 1.2.3.4
                      keywrap_enabled: true
                      keywrap_format: hex
                      keywrap_kek: '1122334455'
                      keywrap_mack: '1122334455'
                      port: 1813
                      secret: testing123
                    allow_ipv6_ndp: true
                    allow_mdns: false
                    allow_ssdp: false
                    app_limit:
                      apps:
                        dropbox: 300
                        netflix: 60
                      enabled: false
                      wxtag_ids:
                        f99862d9-2726-931f-7559-3dfdf5d070d3: 30
                    app_qos:
                      apps:
                        skype-business-video:
                          dscp: 32
                          dst_subnet: 10.2.0.0/16
                          src_subnet: 10.2.0.0/16
                      enabled: true
                      others:
                      - dscp: 32
                        dst_subnet: 10.2.0.0/16
                        port_ranges: 80,1024-6553
                        protocol: udp
                        src_subnet: 10.2.0.0/16
                    arp_filter: false
                    auth:
                      anticlog_threshold: 16
                      eap_reauth: false
                      enable_mac_auth: false
                      key_idx: 1
                      keys:
                      - string
                      multi_psk_only: false
                      pairwise:
                      - wpa2-ccmp
                      private_wlan: true
                      psk: foryoureyesonly
                      type: psk
                      wep_as_secondary_auth: true
                    auth_server_selection: ordered
                    auth_servers:
                    - host: 1.2.3.4
                      keywrap_enabled: true
                      keywrap_format: hex
                      keywrap_kek: '1122334455'
                      keywrap_mack: '1122334455'
                      port: 1812
                      secret: testing123
                    auth_servers_nas_id: 5c5b350e0101-nas
                    auth_servers_nas_ip: 15.3.1.5
                    auth_servers_retries: 5
                    auth_servers_timeout: 5
                    band: string
                    band_steer: false
                    band_steer_force_band5: false
                    bands:
                    - '24'
                    - '5'
                    block_blacklist_clients: false
                    bonjour:
                      additional_vlan_ids: 10,20
                      enabled: false
                      services:
                        airplay:
                          radius_groups:
                          - teachers
                          scope: same_ap
                    cisco_cwa:
                      allowed_hostnames:
                      - snapchat.com
                      allowed_subnets:
                      - 63.5.3.0/24
                      blocked_subnets:
                      - 192.168.0.0/16
                      enabled: false
                    client_limit_down: 1000
                    client_limit_down_enabled: false
                    client_limit_up: 512
                    client_limit_up_enabled: false
                    coa_servers:
                    - disable_event_timestamp_check: false
                      enabled: false
                      ip: 1.2.3.4
                      port: 3799
                      secret: testing456
                    disable_11ax: false
                    disable_ht_vht_rates: false
                    disable_uapsd: false
                    disable_v1_roam_notify: false
                    disable_v2_roam_notify: false
                    disable_wmm: false
                    dns_server_rewrite:
                      enabled: false
                      radius_groups:
                        contractor: 172.1.1.1
                        guest: 8.8.8.8
                    dtim: 2
                    dynamic_psk:
                      default_psk: foryoureyesonly
                      default_vlan_id: 999
                      enabled: false
                      source: cloud_psks
                    dynamic_vlan:
                      default_vlan_id: 999
                      enabled: false
                      local_vlan_ids:
                      - 1
                      type: airespace-interface-name
                      vlans:
                        '131': default
                        '322': fast,video
                    enable_local_keycaching: false
                    enable_wireless_bridging: false
                    enabled: true
                    fast_dot1x_timers: false
                    hide_ssid: false
                    hostname_ie: false
                    hotspot20:
                      domain_name:
                      - mist.com
                      enabled: true
                      nai_realms:
                      - string
                      operators:
                      - google
                      - att
                      rcoi:
                      - 5A03BA0000
                      venue_name: some_name
                    interface: all
                    isolation: false
                    l2_isolation: false
                    legacy_overds: false
                    limit_bcast: false
                    limit_probe_response: true
                    max_idletime: 1800
                    mist_nac:
                      enabled: false
                    no_static_dns: false
                    no_static_ip: false
                    portal:
                      amazon_client_id: string
                      amazon_client_secret: string
                      amazon_email_domains:
                      - string
                      amazon_enabled: false
                      auth: none
                      azure_client_id: string
                      azure_client_secret: string
                      azure_enabled: false
                      azure_tenant_id: string
                      broadnet_password: password
                      broadnet_sid: MIST
                      broadnet_user_id: juniper
                      bypass_when_cloud_down: false
                      clickatell_api_key: string
                      cross_site: false
                      email_enabled: true
                      enabled: false
                      expire: 1440
                      external_portal_url: string
                      facebook_client_id: string
                      facebook_client_secret: string
                      facebook_email_domains:
                      - string
                      facebook_enabled: false
                      forward: false
                      forward_url: https://abc.com/promotions
                      google_client_id: string
                      google_client_secret: string
                      google_email_domains:
                      - mydomain.edu
                      - mydomain.org
                      google_enabled: false
                      gupshup_password: string
                      gupshup_userid: string
                      microsoft_client_id: string
                      microsoft_client_secret: string
                      microsoft_email_domains:
                      - string
                      microsoft_enabled: false
                      passphrase_enabled: false
                      password: let me in
                      predefined_sponsors_enabled: true
                      privacy: true
                      puzzel_password: string
                      puzzel_service_id: string
                      puzzel_username: string
                      smsMessageFormat: string
                      sms_enabled: false
                      sms_provider: twilio
                      sponsor_auto_approve: false
                      sponsor_email_domains:
                      - reserved.net
                      - reserved.org
                      sponsor_enabled: false
                      sponsor_link_validity_duration: '30'
                      sponsor_notify_all: false
                      sponsor_status_notify: false
                      sponsors:
                        sponsor1@company.com: FirstName1 LastName1
                        sponsor2@company.com: FirstName2 LastName2
                      sso_default_role: string
                      sso_forced_role: string
                      sso_idp_cert: string
                      sso_idp_sign_algo: sha256
                      sso_idp_sso_url: string
                      sso_issuer: string
                      sso_nameid_format: email
                      telstra_client_id: string
                      telstra_client_secret: string
                      twilio_auth_token: af9dac44c344a875ab5d31cb7abcdefg
                      twilio_phone_number: '+18548888888'
                      twilio_sid: AC72ec6ba0ec5af30e6731c5e47abcdefgh
                    portal_allowed_hostnames:
                    - snapchat.com
                    - ibm.com
                    portal_allowed_subnets:
                    - 63.5.3.0/24
                    portal_denied_hostnames:
                    - msg.snapchat.com
                    qos:
                      class: best_effort
                      overwrite: false
                    radsec:
                      enabled: true
                      idle_timeout: 60
                      mxcluster_ids:
                      - 572586b7-f97b-a22b-526c-8b97a3f609c4
                      proxy_hosts:
                      - mxedge1.local
                      server_name: radsec.abc.com
                      servers:
                      - host: 1.1.1.1
                        port: 1812
                      use_mxedge: true
                      use_site_mxedge: false
                    rateset:
                      '24':
                        ht: 00ff00ff00ff
                        legacy:
                        - '6'
                        - '9'
                        - '12'
                        - '18'
                        - 24b
                        - '36'
                        - '48'
                        - '54'
                        min_rssi: -70
                        template: custom
                        vht: 03ff03ff03ff01ff
                      '5':
                        ht: 00ff00ff00ff
                        legacy:
                        - '6'
                        - '9'
                        - '12'
                        - '18'
                        - 24b
                        - '36'
                        - '48'
                        - '54'
                        min_rssi: -70
                        template: custom
                        vht: 03ff03ff03ff01ff
                    roam_mode: NONE
                    schedule:
                      enabled: false
                      hours:
                        fri: 09:00-17:00
                        mon: 09:00-17:00
                    sle_excluded: false
                    ssid: corporate
                    use_eapol_v1: false
                    vlan_enabled: false
                    vlan_ids:
                    - 3
                    - 4
                    - 5
                    vlan_pooling: false
                    wxtag_ids:
                    - 497f6eca-6276-4993-bfeb-53e4bbba6f08
                    wxtunnel_id: string
                    wxtunnel_remote_id: string
              contentMediaType: application/json
            examples:
              Example:
                value:
                  name: string
                  wlans:
                  - acct_immediate_update: false
                    acct_interim_interval: 0
                    acct_servers:
                    - host: 1.2.3.4
                      keywrap_enabled: true
                      keywrap_format: hex
                      keywrap_kek: '1122334455'
                      keywrap_mack: '1122334455'
                      port: 1813
                      secret: testing123
                    allow_ipv6_ndp: true
                    allow_mdns: false
                    allow_ssdp: false
                    app_limit:
                      apps:
                        dropbox: 300
                        netflix: 60
                      enabled: false
                      wxtag_ids:
                        f99862d9-2726-931f-7559-3dfdf5d070d3: 30
                    app_qos:
                      apps:
                        skype-business-video:
                          dscp: 32
                          dst_subnet: 10.2.0.0/16
                          src_subnet: 10.2.0.0/16
                      enabled: true
                      others:
                      - dscp: 32
                        dst_subnet: 10.2.0.0/16
                        port_ranges: 80,1024-6553
                        protocol: udp
                        src_subnet: 10.2.0.0/16
                    arp_filter: false
                    auth:
                      anticlog_threshold: 16
                      eap_reauth: false
                      enable_mac_auth: false
                      key_idx: 1
                      keys:
                      - string
                      multi_psk_only: false
                      pairwise:
                      - wpa2-ccmp
                      private_wlan: true
                      psk: foryoureyesonly
                      type: psk
                      wep_as_secondary_auth: true
                    auth_server_selection: ordered
                    auth_servers:
                    - host: 1.2.3.4
                      keywrap_enabled: true
                      keywrap_format: hex
                      keywrap_kek: '1122334455'
                      keywrap_mack: '1122334455'
                      port: 1812
                      secret: testing123
                    auth_servers_nas_id: 5c5b350e0101-nas
                    auth_servers_nas_ip: 15.3.1.5
                    auth_servers_retries: 5
                    auth_servers_timeout: 5
                    band: string
                    band_steer: false
                    band_steer_force_band5: false
                    bands:
                    - '24'
                    - '5'
                    block_blacklist_clients: false
                    bonjour:
                      additional_vlan_ids: 10,20
                      enabled: false
                      services:
                        airplay:
                          radius_groups:
                          - teachers
                          scope: same_ap
                    cisco_cwa:
                      allowed_hostnames:
                      - snapchat.com
                      allowed_subnets:
                      - 63.5.3.0/24
                      blocked_subnets:
                      - 192.168.0.0/16
                      enabled: false
                    client_limit_down: 1000
                    client_limit_down_enabled: false
                    client_limit_up: 512
                    client_limit_up_enabled: false
                    coa_servers:
                    - disable_event_timestamp_check: false
                      enabled: false
                      ip: 1.2.3.4
                      port: 3799
                      secret: testing456
                    disable_11ax: false
                    disable_ht_vht_rates: false
                    disable_uapsd: false
                    disable_v1_roam_notify: false
                    disable_v2_roam_notify: false
                    disable_wmm: false
                    dns_server_rewrite:
                      enabled: false
                      radius_groups:
                        contractor: 172.1.1.1
                        guest: 8.8.8.8
                    dtim: 2
                    dynamic_psk:
                      default_psk: foryoureyesonly
                      default_vlan_id: 999
                      enabled: false
                      source: cloud_psks
                    dynamic_vlan:
                      default_vlan_id: 999
                      enabled: false
                      local_vlan_ids:
                      - 1
                      type: airespace-interface-name
                      vlans:
                        '131': default
                        '322': fast,video
                    enable_local_keycaching: false
                    enable_wireless_bridging: false
                    enabled: true
                    fast_dot1x_timers: false
                    hide_ssid: false
                    hostname_ie: false
                    hotspot20:
                      domain_name:
                      - mist.com
                      enabled: true
                      nai_realms:
                      - string
                      operators:
                      - google
                      - att
                      rcoi:
                      - 5A03BA0000
                      venue_name: some_name
                    interface: all
                    isolation: false
                    l2_isolation: false
                    legacy_overds: false
                    limit_bcast: false
                    limit_probe_response: true
                    max_idletime: 1800
                    mist_nac:
                      enabled: false
                    no_static_dns: false
                    no_static_ip: false
                    portal:
                      amazon_client_id: string
                      amazon_client_secret: string
                      amazon_email_domains:
                      - string
                      amazon_enabled: false
                      auth: none
                      azure_client_id: string
                      azure_client_secret: string
                      azure_enabled: false
                      azure_tenant_id: string
                      broadnet_password: password
                      broadnet_sid: MIST
                      broadnet_user_id: juniper
                      bypass_when_cloud_down: false
                      clickatell_api_key: string
                      cross_site: false
                      email_enabled: true
                      enabled: false
                      expire: 1440
                      external_portal_url: string
                      facebook_client_id: string
                      facebook_client_secret: string
                      facebook_email_domains:
                      - string
                      facebook_enabled: false
                      forward: false
                      forward_url: https://abc.com/promotions
                      google_client_id: string
                      google_client_secret: string
                      google_email_domains:
                      - mydomain.edu
                      - mydomain.org
                      google_enabled: false
                      gupshup_password: string
                      gupshup_userid: string
                      microsoft_client_id: string
                      microsoft_client_secret: string
                      microsoft_email_domains:
                      - string
                      microsoft_enabled: false
                      passphrase_enabled: false
                      password: let me in
                      predefined_sponsors_enabled: true
                      privacy: true
                      puzzel_password: string
                      puzzel_service_id: string
                      puzzel_username: string
                      smsMessageFormat: string
                      sms_enabled: false
                      sms_provider: twilio
                      sponsor_auto_approve: false
                      sponsor_email_domains:
                      - reserved.net
                      - reserved.org
                      sponsor_enabled: false
                      sponsor_link_validity_duration: '30'
                      sponsor_notify_all: false
                      sponsor_status_notify: false
                      sponsors:
                        sponsor1@company.com: FirstName1 LastName1
                        sponsor2@company.com: FirstName2 LastName2
                      sso_default_role: string
                      sso_forced_role: string
                      sso_idp_cert: string
                      sso_idp_sign_algo: sha256
                      sso_idp_sso_url: string
                      sso_issuer: string
                      sso_nameid_format: email
                      telstra_client_id: string
                      telstra_client_secret: string
                      twilio_auth_token: af9dac44c344a875ab5d31cb7abcdefg
                      twilio_phone_number: '+18548888888'
                      twilio_sid: AC72ec6ba0ec5af30e6731c5e47abcdefgh
                    portal_allowed_hostnames:
                    - snapchat.com
                    - ibm.com
                    portal_allowed_subnets:
                    - 63.5.3.0/24
                    portal_denied_hostnames:
                    - msg.snapchat.com
                    qos:
                      class: best_effort
                      overwrite: false
                    radsec:
                      enabled: true
                      idle_timeout: 60
                      mxcluster_ids:
                      - 572586b7-f97b-a22b-526c-8b97a3f609c4
                      proxy_hosts:
                      - mxedge1.local
                      server_name: radsec.abc.com
                      servers:
                      - host: 1.1.1.1
                        port: 1812
                      use_mxedge: true
                      use_site_mxedge: false
                    rateset:
                      '24':
                        ht: 00ff00ff00ff
                        legacy:
                        - '6'
                        - '9'
                        - '12'
                        - '18'
                        - 24b
                        - '36'
                        - '48'
                        - '54'
                        min_rssi: -70
                        template: custom
                        vht: 03ff03ff03ff01ff
                      '5':
                        ht: 00ff00ff00ff
                        legacy:
                        - '6'
                        - '9'
                        - '12'
                        - '18'
                        - 24b
                        - '36'
                        - '48'
                        - '54'
                        min_rssi: -70
                        template: custom
                        vht: 03ff03ff03ff01ff
                    roam_mode: NONE
                    schedule:
                      enabled: false
                      hours:
                        fri: 09:00-17:00
                        mon: 09:00-17:00
                    sle_excluded: false
                    ssid: corporate
                    use_eapol_v1: false
                    vlan_enabled: false
                    vlan_ids:
                    - 3
                    - 4
                    - 5
                    vlan_pooling: false
                    wxtag_ids:
                    - 497f6eca-6276-4993-bfeb-53e4bbba6f08
                    wxtunnel_id: string
                    wxtunnel_remote_id: string
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secpolicy'
                - description: Security Policy is designed to audit / catch discrepancies between "what’s intended to be running" versus "what’s actually running" in a network. Many big organizations have separated Security and IT team (for good reasons). Each site can be assigned a security policy. Whenever an AP is provisioned, the configuration will be checked against the security policy. Any violations will be flagged in Device Config History where you can search for the when and where the violation occurs.
                  examples:
                  - name: corporate only
                    wlans:
                    - auth:
                        pairwise:
                        - wpa1-tkip
                        - wpa2-tkip
                        type: psk
                      band: both
                      ssid: office
                    - auth:
                        type: open
                      band: '5'
                      ssid: office-guest
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    name: corporate only
                    wlans:
                    - auth:
                        pairwise:
                        - wpa1-tkip
                        - wpa2-tkip
                        type: psk
                      band: both
                      ssid: office
                    - auth:
                        type: open
                      band: '5'
                      ssid: office-guest
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secpolicy'
                - description: Security Policy is designed to audit / catch discrepancies between "what’s intended to be running" versus "what’s actually running" in a network. Many big organizations have separated Security and IT team (for good reasons). Each site can be assigned a security policy. Whenever an AP is provisioned, the configuration will be checked against the security policy. Any violations will be flagged in Device Config History where you can search for the when and where the violation occurs.
                  examples:
                  - name: corporate only
                    wlans:
                    - auth:
                        pairwise:
                        - wpa1-tkip
                        - wpa2-tkip
                        type: psk
                      band: both
                      ssid: office
                    - auth:
                        type: open
                      band: '5'
                      ssid: office-guest
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    name: corporate only
                    wlans:
                    - auth:
                        pairwise:
                        - wpa1-tkip
                        - wpa2-tkip
                        type: psk
                      band: both
                      ssid: office
                    - auth:
                        type: open
                      band: '5'
                      ssid: office-guest
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/secpolicies/{secpolicy_id}:
    delete:
      tags:
      - Orgs Security Policies
      summary: deleteOrgSecPolicy
      description: Remove an organization security policy from the set available for assignment and configuration compliance checks.
      operationId: deleteOrgSecPolicy
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: secpolicy_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs Security Policies
      summary: getOrgSecPolicy
      description: Return an organization security policy, including the WLAN configuration baselines used for compliance auditing.
      operationId: getOrgSecPolicy
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: secpolicy_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secpolicy'
                - description: Security Policy is designed to audit / catch discrepancies between "what’s intended to be running" versus "what’s actually running" in a network. Many big organizations have separated Security and IT team (for good reasons). Each site can be assigned a security policy. Whenever an AP is provisioned, the configuration will be checked against the security policy. Any violations will be flagged in Device Config History where you can search for the when and where the violation occurs.
                  examples:
                  - name: corporate only
                    wlans:
                    - auth:
                        pairwise:
                        - wpa1-tkip
                        - wpa2-tkip
                        type: psk
                      band: both
                      ssid: office
                    - auth:
                        type: open
                      band: '5'
                      ssid: office-guest
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    name: corporate only
                    wlans:
                    - auth:
                        pairwise:
                        - wpa1-tkip
                        - wpa2-tkip
                        type: psk
                      band: both
                      ssid: office
                    - auth:
                        type: open
                      band: '5'
                      ssid: office-guest
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secpolicy'
                - description: Security Policy is designed to audit / catch discrepancies between "what’s intended to be running" versus "what’s actually running" in a network. Many big organizations have separated Security and IT team (for good reasons). Each site can be assigned a security policy. Whenever an AP is provisioned, the configuration will be checked against the security policy. Any violations will be flagged in Device Config History where you can search for the when and where the violation occurs.
                  examples:
                  - name: corporate only
                    wlans:
                    - auth:
                        pairwise:
                        - wpa1-tkip
                        - wpa2-tkip
                        type: psk
                      band: both
                      ssid: office
                    - auth:
                        type: open
                      band: '5'
                      ssid: office-guest
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    name: corporate only
                    wlans:
                    - auth:
                        pairwise:
                        - wpa1-tkip
                        - wpa2-tkip
                        type: psk
                      band: both
                      ssid: office
                    - auth:
                        type: open
                      band: '5'
                      ssid: office-guest
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs Security Policies
      summary: updateOrgSecPolicy
      description: Update an organization security policy, including its name and WLAN configuration baselines for compliance auditing.
      operationId: updateOrgSecPolicy
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: secpolicy_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/secpolicy'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secpolicy'
                - description: Security Policy is designed to audit / catch discrepancies between "what’s intended to be running" versus "what’s actually running" in a network. Many big organizations have separated Security and IT team (for good reasons). Each site can be assigned a security policy. Whenever an AP is provisioned, the configuration will be checked against the security policy. Any violations will be flagged in Device Config History where you can search for the when and where the violation occurs.
                  examples:
                  - name: corporate only
                    wlans:
                    - auth:
                        pairwise:
                        - wpa1-tkip
                        - wpa2-tkip
                        type: psk
                      band: both
                      ssid: office
                    - auth:
                        type: open
                      band: '5'
                      ssid: office-guest
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    name: corporate only
                    wlans:
                    - auth:
                        pairwise:
                        - wpa1-tkip
                        - wpa2-tkip
                        type: psk
                      band: both
                      ssid: office
                    - auth:
                        type: open
                      band: '5'
                      ssid: office-guest
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secpolicy'
                - description: Security Policy is designed to audit / catch discrepancies between "what’s intended to be running" versus "what’s actually running" in a network. Many big organizations have separated Security and IT team (for good reasons). Each site can be assigned a security policy. Whenever an AP is provisioned, the configuration will be checked against the security policy. Any violations will be flagged in Device Config History where you can search for the when and where the violation occurs.
                  examples:
                  - name: corporate only
                    wlans:
                    - auth:
                        pairwise:
                        - wpa1-tkip
                        - wpa2-tkip
                        type: psk
                      band: both
                      ssid: office
                    - auth:
                        type: open
                      band: '5'
                      ssid: office-guest
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    name: corporate only
                    wlans:
                    - auth:
                        pairwise:
                        - wpa1-tkip
                        - wpa2-tkip
                        type: psk
                      band: both
                      ssid: office
                    - auth:
                        type: open
                      band: '5'
                      ssid: office-guest
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/services:
    get:
      tags:
      - Orgs Services
      summary: listOrgServices
      description: List organization service definitions. Services describe applications, application categories, URLs, hostnames, subnets, or custom protocol and port match criteria used by gateway and SSR policies.
      operationId: listOrgServices
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/service'
                description: Service definitions returned by list operations
                examples:
                - - addresses:
                    - string
                    apps:
                    - string
                    dscp: 8
                    hostnames:
                    - string
                    max_jitter: 0
                    max_latency: 0
                    max_loss: 0
                    name: string
                    specs:
                    - port_range: '0'
                      protocol: any
                    traffic_class: best_effort
                    traffic_type: default
                    type: custom
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - addresses:
                    - string
                    apps:
                    - string
                    dscp: 8
                    hostnames:
                    - string
                    max_jitter: 0
                    max_latency: 0
                    max_loss: 0
                    name: string
                    specs:
                    - port_range: '0'
                      protocol: any
                    traffic_class: best_effort
                    traffic_type: default
                    type: custom
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/service'
                description: Service definitions returned by list operations
                examples:
                - - addresses:
                    - string
                    apps:
                    - string
                    dscp: 8
                    hostnames:
                    - string
                    max_jitter: 0
                    max_latency: 0
                    max_loss: 0
                    name: string
                    specs:
                    - port_range: '0'
                      protocol: any
                    traffic_class: best_effort
                    traffic_type: default
                    type: custom
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - addresses:
                    - string
                    apps:
                    - string
                    dscp: 8
                    hostnames:
                    - string
                    max_jitter: 0
                    max_latency: 0
                    max_loss: 0
                    name: string
                    specs:
                    - port_range: '0'
                      protocol: any
                    traffic_class: best_effort
                    traffic_type: default
                    type: custom
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs Services
      summary: createOrgService
      description: >-
        Create an organization service definition with the match criteria

        used by gateway and SSR policies, such as applications, URLs, hostnames,

        subnets, or custom protocol and port rules.



        Services can be user in the service policies to allow or deny traffic matching the service or to apply specific inspection settings or steering rules.
      operationId: createOrgService
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/service'
              - examples:
                - addresses:
                  - 0.0.0.0/0
                  app_key: string
                  name: string
                  network_id: d6797cf4-42b9-4cad-8591-9dd91c3f0fc3
                  specs:
                  - port_range: 8080,8443
                    protocol: any
                  subnet: string
                  type: custom
              contentMediaType: application/json
            examples:
              Example:
                value:
                  addresses:
                  - 0.0.0.0/0
                  app_key: string
                  name: string
                  network_id: d6797cf4-42b9-4cad-8591-9dd91c3f0fc3
                  specs:
                  - port_range: 8080,8443
                    protocol: any
                  subnet: string
                  type: custom
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/service'
                - description: Traffic service definition for applications or destinations used by gateway and SSR policies
                  examples:
                  - addresses:
                    - string
                    app_categories:
                    - string
                    apps:
                    - string
                    created_time: 0
                    dscp: 0
                    failover_policy: revertible
                    hostnames:
                    - string
                    id: 497f6eca-6276-5004-bfeb-53cbbbba6f16
                    max_jitter: 0
                    max_latency: 0
                    max_loss: 0
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    sle_enabled: false
                    specs:
                    - port_range: '0'
                      protocol: any
                    traffic_class: best_effort
                    traffic_type: data_best_effort
                    type: custom
                    vpn_name: addresses
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    addresses:
                    - string
                    app_categories:
                    - string
                    apps:
                    - string
                    created_time: 0
                    dscp: 0
                    failover_policy: revertible
                    hostnames:
                    - string
                    id: 497f6eca-6276-5004-bfeb-53cbbbba6f16
                    max_jitter: 0
                    max_latency: 0
                    max_loss: 0
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    sle_enabled: false
                    specs:
                    - port_range: '0'
                      protocol: any
                    traffic_class: best_effort
                    traffic_type: data_best_effort
                    type: custom
                    vpn_name: addresses
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/service'
                - description: Traffic service definition for applications or destinations used by gateway and SSR policies
                  examples:
                  - addresses:
                    - string
                    app_categories:
                    - string
                    apps:
                    - string
                    created_time: 0
                    dscp: 0
                    failover_policy: revertible
                    hostnames:
                    - string
                    id: 497f6eca-6276-5004-bfeb-53cbbbba6f16
                    max_jitter: 0
                    max_latency: 0
                    max_loss: 0
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    sle_enabled: false
                    specs:
                    - port_range: '0'
                      protocol: any
                    traffic_class: best_effort
                    traffic_type: data_best_effort
                    type: custom
                    vpn_name: addresses
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    addresses:
                    - string
                    app_categories:
                    - string
                    apps:
                    - string
                    created_time: 0
                    dscp: 0
                    failover_policy: revertible
                    hostnames:
                    - string
                    id: 497f6eca-6276-5004-bfeb-53cbbbba6f16
                    max_jitter: 0
                    max_latency: 0
                    max_loss: 0
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    sle_enabled: false
                    specs:
                    - port_range: '0'
                      protocol: any
                    traffic_class: best_effort
                    traffic_type: data_best_effort
                    type: custom
                    vpn_name: addresses
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/services/{service_id}:
    delete:
      tags:
      - Orgs Services
      summary: deleteOrgService
      description: Remove an organization service definition from the available service catalog.
      operationId: deleteOrgService
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: service_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs Services
      summary: getOrgService
      description: Return an organization service definition, including its matching mode, match values, traffic classification, and optional SSR path-selection thresholds.
      operationId: getOrgService
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: service_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/service'
                - description: Traffic service definition for applications or destinations used by gateway and SSR policies
                  examples:
                  - addresses:
                    - string
                    app_categories:
                    - string
                    apps:
                    - string
                    created_time: 0
                    dscp: 0
                    failover_policy: revertible
                    hostnames:
                    - string
                    id: 497f6eca-6276-5004-bfeb-53cbbbba6f16
                    max_jitter: 0
                    max_latency: 0
                    max_loss: 0
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    sle_enabled: false
                    specs:
                    - port_range: '0'
                      protocol: any
                    traffic_class: best_effort
                    traffic_type: data_best_effort
                    type: custom
                    vpn_name: addresses
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    addresses:
                    - string
                    app_categories:
                    - string
                    apps:
                    - string
                    created_time: 0
                    dscp: 0
                    failover_policy: revertible
                    hostnames:
                    - string
                    id: 497f6eca-6276-5004-bfeb-53cbbbba6f16
                    max_jitter: 0
                    max_latency: 0
                    max_loss: 0
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    sle_enabled: false
                    specs:
                    - port_range: '0'
                      protocol: any
                    traffic_class: best_effort
                    traffic_type: data_best_effort
                    type: custom
                    vpn_name: addresses
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/service'
                - description: Traffic service definition for applications or destinations used by gateway and SSR policies
                  examples:
                  - addresses:
                    - string
                    app_categories:
                    - string
                    apps:
                    - string
                    created_time: 0
                    dscp: 0
                    failover_policy: revertible
                    hostnames:
                    - string
                    id: 497f6eca-6276-5004-bfeb-53cbbbba6f16
                    max_jitter: 0
                    max_latency: 0
                    max_loss: 0
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    sle_enabled: false
                    specs:
                    - port_range: '0'
                      protocol: any
                    traffic_class: best_effort
                    traffic_type: data_best_effort
                    type: custom
                    vpn_name: addresses
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    addresses:
                    - string
                    app_categories:
                    - string
                    apps:
                    - string
                    created_time: 0
                    dscp: 0
                    failover_policy: revertible
                    hostnames:
                    - string
                    id: 497f6eca-6276-5004-bfeb-53cbbbba6f16
                    max_jitter: 0
                    max_latency: 0
                    max_loss: 0
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    sle_enabled: false
                    specs:
                    - port_range: '0'
                      protocol: any
                    traffic_class: best_effort
                    traffic_type: data_best_effort
                    type: custom
                    vpn_name: addresses
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs Services
      summary: updateOrgService
      description: Update an organization service definition, including its matching mode, match values, traffic classification, or optional SSR path-selection thresholds.
      operationId: updateOrgService
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: service_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/service'
              - examples:
                - addresses:
                  - string
                  app_categories:
                  - string
                  apps:
                  - string
                  dscp: 0
                  failover_policy: revertible
                  hostnames:
                  - string
                  max_jitter: 0
                  max_latency: 0
                  max_loss: 0
                  name: string
                  sle_enabled: false
                  specs:
                  - port_range: '0'
                    protocol: any
                  traffic_class: best_effort
                  traffic_type: data_best_effort
                  type: custom
                  vpn_name: addresses
              contentMediaType: application/json
            examples:
              Example:
                value:
                  addresses:
                  - string
                  app_categories:
                  - string
                  apps:
                  - string
                  dscp: 0
                  failover_policy: revertible
                  hostnames:
                  - string
                  max_jitter: 0
                  max_latency: 0
                  max_loss: 0
                  name: string
                  sle_enabled: false
                  specs:
                  - port_range: '0'
                    protocol: any
                  traffic_class: best_effort
                  traffic_type: data_best_effort
                  type: custom
                  vpn_name: addresses
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/service'
                - description: Traffic service definition for applications or destinations used by gateway and SSR policies
                  examples:
                  - addresses:
                    - string
                    app_categories:
                    - string
                    apps:
                    - string
                    created_time: 0
                    dscp: 0
                    failover_policy: revertible
                    hostnames:
                    - string
                    id: 497f6eca-6276-5004-bfeb-53cbbbba6f16
                    max_jitter: 0
                    max_latency: 0
                    max_loss: 0
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    sle_enabled: false
                    specs:
                    - port_range: '0'
                      protocol: any
                    traffic_class: best_effort
                    traffic_type: data_best_effort
                    type: custom
                    vpn_name: addresses
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    addresses:
                    - string
                    app_categories:
                    - string
                    apps:
                    - string
                    created_time: 0
                    dscp: 0
                    failover_policy: revertible
                    hostnames:
                    - string
                    id: 497f6eca-6276-5004-bfeb-53cbbbba6f16
                    max_jitter: 0
                    max_latency: 0
                    max_loss: 0
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    sle_enabled: false
                    specs:
                    - port_range: '0'
                      protocol: any
                    traffic_class: best_effort
                    traffic_type: data_best_effort
                    type: custom
                    vpn_name: addresses
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/service'
                - description: Traffic service definition for applications or destinations used by gateway and SSR policies
                  examples:
                  - addresses:
                    - string
                    app_categories:
                    - string
                    apps:
                    - string
                    created_time: 0
                    dscp: 0
                    failover_policy: revertible
                    hostnames:
                    - string
                    id: 497f6eca-6276-5004-bfeb-53cbbbba6f16
                    max_jitter: 0
                    max_latency: 0
                    max_loss: 0
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    sle_enabled: false
                    specs:
                    - port_range: '0'
                      protocol: any
                    traffic_class: best_effort
                    traffic_type: data_best_effort
                    type: custom
                    vpn_name: addresses
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    addresses:
                    - string
                    app_categories:
                    - string
                    apps:
                    - string
                    created_time: 0
                    dscp: 0
                    failover_policy: revertible
                    hostnames:
                    - string
                    id: 497f6eca-6276-5004-bfeb-53cbbbba6f16
                    max_jitter: 0
                    max_latency: 0
                    max_loss: 0
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    sle_enabled: false
                    specs:
                    - port_range: '0'
                      protocol: any
                    traffic_class: best_effort
                    traffic_type: data_best_effort
                    type: custom
                    vpn_name: addresses
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/servicepolicies:
    get:
      tags:
      - Orgs Service Policies
      summary: listOrgServicePolicies
      description: List organization-level service policies. Service policies match tenants to services or service groups and define the allow or deny action plus optional inspection controls.
      operationId: listOrgServicePolicies
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/org_service_policy'
                description: List of organization-level service policies
                examples:
                - - action: allow
                    created_time: 0
                    id: string
                    modified_time: 0
                    name: string
                    org_id: string
                    services:
                    - string
                    tenants:
                    - string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - action: allow
                    created_time: 0
                    id: string
                    modified_time: 0
                    name: string
                    org_id: string
                    services:
                    - string
                    tenants:
                    - string
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/org_service_policy'
                description: List of organization-level service policies
                examples:
                - - action: allow
                    created_time: 0
                    id: string
                    modified_time: 0
                    name: string
                    org_id: string
                    services:
                    - string
                    tenants:
                    - string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - action: allow
                    created_time: 0
                    id: string
                    modified_time: 0
                    name: string
                    org_id: string
                    services:
                    - string
                    tenants:
                    - string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs Service Policies
      summary: createOrgServicePolicy
      description: >-
        Create an organization-level service policy that matches tenants

        to services and applies an allow or deny action with optional security inspection

        settings.



        Organization-level service policies can be imported in the gateway templates and gateway policies.
      operationId: createOrgServicePolicy
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/org_service_policy'
              - examples:
                - action: allow
                  name: string
                  services:
                  - string
                  tenants:
                  - string
              contentMediaType: application/json
            examples:
              Example:
                value:
                  action: allow
                  name: string
                  services:
                  - string
                  tenants:
                  - string
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org_service_policy'
                - description: Organization-level service policy that allows or denies traffic for tenants and services
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org_service_policy'
                - description: Organization-level service policy that allows or denies traffic for tenants and services
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/servicepolicies/{servicepolicy_id}:
    delete:
      tags:
      - Orgs Service Policies
      summary: deleteOrgServicePolicy
      description: Remove an organization-level service policy from the available policy set.
      operationId: deleteOrgServicePolicy
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: servicepolicy_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs Service Policies
      summary: getOrgServicePolicy
      description: Return an organization-level service policy, including the matched tenants and services, action, local routing, path preference, and inspection settings.
      operationId: getOrgServicePolicy
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: servicepolicy_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org_service_policy'
                - description: Organization-level service policy that allows or denies traffic for tenants and services
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org_service_policy'
                - description: Organization-level service policy that allows or denies traffic for tenants and services
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs Service Policies
      summary: updateOrgServicePolicy
      description: Update an organization-level service policy, including its tenant and service matches, action, local routing, path preference, or inspection settings.
      operationId: updateOrgServicePolicy
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: servicepolicy_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/org_service_policy'
              - examples:
                - action: allow
                  name: string
                  services:
                  - string
                  tenants:
                  - string
              contentMediaType: application/json
            examples:
              Example:
                value:
                  action: allow
                  name: string
                  services:
                  - string
                  tenants:
                  - string
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org_service_policy'
                - description: Organization-level service policy that allows or denies traffic for tenants and services
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org_service_policy'
                - description: Organization-level service policy that allows or denies traffic for tenants and services
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/setting:
    get:
      tags:
      - Orgs Setting
      summary: getOrgSettings
      description: Return organization-wide settings, including feature flags, automatic device assignment rules, management connectivity, packet capture, security controls, and integration configuration.
      operationId: getOrgSettings
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org_setting'
                - description: Organization-wide feature, integration, management, and security settings
                  examples:
                  - '{"auto_device_naming":{"enable":true,"rules":[{"match_device":"ap","prefix":"MIST-","src":"lldp_port_desc"}]},"auto_deviceprofile_assignment":{"enable":true,"rules":[{"expression":"string","model":"string","prefix":"string","src":"name","subnet":"string","suffix":"string","value":"string"}]},"auto_site_assignment":{"enable":true,"rules":[{"expression":"string","model":"string","prefix":"string","src":"name","subnet":"string","suffix":"string","value":"string"}]},"cacerts":["string"],"cloudshark":{"apitoken":"string","url":"string"},"created_time":0,"device_cert":{"cert":"string","key":"string"},"device_updown_threshold":0,"disable_pcap":true,"id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","installer":{"allow_all_sites":true,"extra_site_ids":["b069b358-4c97-5319-1f8c-7c5ca64d6ab1"],"grace_period":0},"mgmt":{"mxtunnel_ids":["b069b358-4c97-5319-1f8c-7c5ca64d6ab1"],"use_mxtunnel":true,"use_wxtunnel":true},"modified_time":0,"msp_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","name":"string","password_policy":{"enabled":true,"expiry_in_days":180,"min_length":8,"requires_special_char":true,"requires_two_factor_auth":true},"pcap":{"bucket":"string","max_pkt_len":0},"pcap_bucket_verified":true,"remote_syslog":{"enabled":true,"send_to_all_servers":true,"servers":[{"facility":"conflict-log","host":"string","port":0,"protocol":"udp","severity":"any","tag":"string"}]},"security":{"disable_local_ssh":true,"fips_zeroize_password":"string","limit_ssh_access":true},"tags":["string"],"ui_idle_timeout":0}'
                  - '{"auto_device_naming":{"enable":true,"rules":[{"expression":"...","src":"lldp_port_desc"}]},"auto_deviceprofile_assignment":{"enable":true},"auto_site_assignment":{"enable":true,"rules":[{"expression":"[0:3]","prefix":"XX-","src":"name","suffix":"-YY"},{"src":"subnet","subnet":"10.1.2.0/18","value":"s1351"},{"expression":"...","src":"lldp_system_name"},{"expression":"...","src":"dns_suffix"},{"model":"AP41","src":"model","value":"s1351"}]},"cacerts":["-----BEGIN CERTIFICATE-----\nMIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE\n-----END CERTIFICATE-----","-----BEGIN CERTIFICATE-----\nBhMCRVMxFDASBgNVBAoMC1N0YXJ0Q29tIENBMSwwKgYDVn-----END CERTIFICATE-----"],"cloudshark":{"apitoken":"accbd6f10c6d05c3","url":"https://cloudshark.hosted.domain"},"device_cert":{"cert":"-----BEGIN CERTIFICATE-----\nMIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE\n-----END CERTIFICATE-----","key":"-----BEGIN PRI..."},"device_updown_threshold":0,"disable_pcap":false,"installer":{"allow_all_sites":false,"extra_site_ids":["4ac1dcf4-9d8b-7211-65c4-057819f0862b","52f4347e-3e4b-186c-21ca-ad5b70eb23d6"],"grace_period":14},"mgmt":{"mxtunnel_ids":["08cd7499-5841-51c8-e663-fb16b6f3b45e"],"use_mxtunnel":true,"use_wxtunnel":false},"password_policy":{"enabled":true,"expiry_in_days":60,"min_length":8,"requires_special_char":false,"requires_two_factor_auth":true},"pcap":{"bucket":"myorg_pcap","max_pkt_len":128},"pcap_bucket_verified":true,"remote_syslog":{"enabled":true,"send_to_all_servers":true,"servers":[{"facility":"any","host":"syslogd.internal","port":514,"protocol":"udp","severity":"info","tag":""}]},"security":{"disable_local_ssh":false,"fips_zeroize_password":"NUKETHESITE","limit_ssh_access":false},"tags":["beta"],"ui_idle_timeout":10}'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    auto_device_naming:
                      enable: true
                      rules:
                      - match_device: ap
                        prefix: MIST-
                        src: lldp_port_desc
                    auto_deviceprofile_assignment:
                      enable: true
                      rules:
                      - expression: string
                        model: string
                        prefix: string
                        src: name
                        subnet: string
                        suffix: string
                        value: string
                    auto_site_assignment:
                      enable: true
                      rules:
                      - expression: string
                        model: string
                        prefix: string
                        src: name
                        subnet: string
                        suffix: string
                        value: string
                    cacerts:
                    - string
                    cloudshark:
                      apitoken: string
                      url: string
                    created_time: 0
                    device_cert:
                      cert: string
                      key: string
                    device_updown_threshold: 0
                    disable_pcap: true
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    installer:
                      allow_all_sites: true
                      extra_site_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      grace_period: 0
                    mgmt:
                      mxtunnel_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      use_mxtunnel: true
                      use_wxtunnel: true
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    password_policy:
                      enabled: true
                      expiry_in_days: 180
                      min_length: 8
                      requires_special_char: true
                      requires_two_factor_auth: true
                    pcap:
                      bucket: string
                      max_pkt_len: 0
                    pcap_bucket_verified: true
                    remote_syslog:
                      enabled: true
                      send_to_all_servers: true
                      servers:
                      - facility: conflict-log
                        host: string
                        port: 0
                        protocol: udp
                        severity: any
                        tag: string
                    security:
                      disable_local_ssh: true
                      fips_zeroize_password: string
                      limit_ssh_access: true
                    tags:
                    - string
                    ui_idle_timeout: 0
                Example2:
                  value:
                    auto_device_naming:
                      enable: true
                      rules:
                      - expression: '...'
                        src: lldp_port_desc
                    auto_deviceprofile_assignment:
                      enable: true
                    auto_site_assignment:
                      enable: true
                      rules:
                      - expression: '[0:3]'
                        prefix: XX-
                        src: name
                        suffix: -YY
                      - src: subnet
                        subnet: 10.1.2.0/18
                        value: s1351
                      - expression: '...'
                        src: lldp_system_name
                      - expression: '...'
                        src: dns_suffix
                      - model: AP41
                        src: model
                        value: s1351
                    cacerts:
                    - >-
                      -----BEGIN CERTIFICATE-----

                      MIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE

                      -----END CERTIFICATE-----
                    - >-
                      -----BEGIN CERTIFICATE-----

                      BhMCRVMxFDASBgNVBAoMC1N0YXJ0Q29tIENBMSwwKgYDVn-----END CERTIFICATE-----
                    cloudshark:
                      apitoken: accbd6f10c6d05c3
                      url: https://cloudshark.hosted.domain
                    device_cert:
                      cert: >-
                        -----BEGIN CERTIFICATE-----

                        MIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE

                        -----END CERTIFICATE-----
                      key: '-----BEGIN PRI...'
                    device_updown_threshold: 0
                    disable_pcap: false
                    installer:
                      allow_all_sites: false
                      extra_site_ids:
                      - 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      - 52f4347e-3e4b-186c-21ca-ad5b70eb23d6
                      grace_period: 14
                    mgmt:
                      mxtunnel_ids:
                      - 08cd7499-5841-51c8-e663-fb16b6f3b45e
                      use_mxtunnel: true
                      use_wxtunnel: false
                    password_policy:
                      enabled: true
                      expiry_in_days: 60
                      min_length: 8
                      requires_special_char: false
                      requires_two_factor_auth: true
                    pcap:
                      bucket: myorg_pcap
                      max_pkt_len: 128
                    pcap_bucket_verified: true
                    remote_syslog:
                      enabled: true
                      send_to_all_servers: true
                      servers:
                      - facility: any
                        host: syslogd.internal
                        port: 514
                        protocol: udp
                        severity: info
                        tag: ''
                    security:
                      disable_local_ssh: false
                      fips_zeroize_password: NUKETHESITE
                      limit_ssh_access: false
                    tags:
                    - beta
                    ui_idle_timeout: 10
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org_setting'
                - description: Organization-wide feature, integration, management, and security settings
                  examples:
                  - '{"auto_device_naming":{"enable":true,"rules":[{"match_device":"ap","prefix":"MIST-","src":"lldp_port_desc"}]},"auto_deviceprofile_assignment":{"enable":true,"rules":[{"expression":"string","model":"string","prefix":"string","src":"name","subnet":"string","suffix":"string","value":"string"}]},"auto_site_assignment":{"enable":true,"rules":[{"expression":"string","model":"string","prefix":"string","src":"name","subnet":"string","suffix":"string","value":"string"}]},"cacerts":["string"],"cloudshark":{"apitoken":"string","url":"string"},"created_time":0,"device_cert":{"cert":"string","key":"string"},"device_updown_threshold":0,"disable_pcap":true,"id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","installer":{"allow_all_sites":true,"extra_site_ids":["b069b358-4c97-5319-1f8c-7c5ca64d6ab1"],"grace_period":0},"mgmt":{"mxtunnel_ids":["b069b358-4c97-5319-1f8c-7c5ca64d6ab1"],"use_mxtunnel":true,"use_wxtunnel":true},"modified_time":0,"msp_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","name":"string","password_policy":{"enabled":true,"expiry_in_days":180,"min_length":8,"requires_special_char":true,"requires_two_factor_auth":true},"pcap":{"bucket":"string","max_pkt_len":0},"pcap_bucket_verified":true,"remote_syslog":{"enabled":true,"send_to_all_servers":true,"servers":[{"facility":"conflict-log","host":"string","port":0,"protocol":"udp","severity":"any","tag":"string"}]},"security":{"disable_local_ssh":true,"fips_zeroize_password":"string","limit_ssh_access":true},"tags":["string"],"ui_idle_timeout":0}'
                  - '{"auto_device_naming":{"enable":true,"rules":[{"expression":"...","src":"lldp_port_desc"}]},"auto_deviceprofile_assignment":{"enable":true},"auto_site_assignment":{"enable":true,"rules":[{"expression":"[0:3]","prefix":"XX-","src":"name","suffix":"-YY"},{"src":"subnet","subnet":"10.1.2.0/18","value":"s1351"},{"expression":"...","src":"lldp_system_name"},{"expression":"...","src":"dns_suffix"},{"model":"AP41","src":"model","value":"s1351"}]},"cacerts":["-----BEGIN CERTIFICATE-----\nMIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE\n-----END CERTIFICATE-----","-----BEGIN CERTIFICATE-----\nBhMCRVMxFDASBgNVBAoMC1N0YXJ0Q29tIENBMSwwKgYDVn-----END CERTIFICATE-----"],"cloudshark":{"apitoken":"accbd6f10c6d05c3","url":"https://cloudshark.hosted.domain"},"device_cert":{"cert":"-----BEGIN CERTIFICATE-----\nMIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE\n-----END CERTIFICATE-----","key":"-----BEGIN PRI..."},"device_updown_threshold":0,"disable_pcap":false,"installer":{"allow_all_sites":false,"extra_site_ids":["4ac1dcf4-9d8b-7211-65c4-057819f0862b","52f4347e-3e4b-186c-21ca-ad5b70eb23d6"],"grace_period":14},"mgmt":{"mxtunnel_ids":["08cd7499-5841-51c8-e663-fb16b6f3b45e"],"use_mxtunnel":true,"use_wxtunnel":false},"password_policy":{"enabled":true,"expiry_in_days":60,"min_length":8,"requires_special_char":false,"requires_two_factor_auth":true},"pcap":{"bucket":"myorg_pcap","max_pkt_len":128},"pcap_bucket_verified":true,"remote_syslog":{"enabled":true,"send_to_all_servers":true,"servers":[{"facility":"any","host":"syslogd.internal","port":514,"protocol":"udp","severity":"info","tag":""}]},"security":{"disable_local_ssh":false,"fips_zeroize_password":"NUKETHESITE","limit_ssh_access":false},"tags":["beta"],"ui_idle_timeout":10}'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    auto_device_naming:
                      enable: true
                      rules:
                      - match_device: ap
                        prefix: MIST-
                        src: lldp_port_desc
                    auto_deviceprofile_assignment:
                      enable: true
                      rules:
                      - expression: string
                        model: string
                        prefix: string
                        src: name
                        subnet: string
                        suffix: string
                        value: string
                    auto_site_assignment:
                      enable: true
                      rules:
                      - expression: string
                        model: string
                        prefix: string
                        src: name
                        subnet: string
                        suffix: string
                        value: string
                    cacerts:
                    - string
                    cloudshark:
                      apitoken: string
                      url: string
                    created_time: 0
                    device_cert:
                      cert: string
                      key: string
                    device_updown_threshold: 0
                    disable_pcap: true
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    installer:
                      allow_all_sites: true
                      extra_site_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      grace_period: 0
                    mgmt:
                      mxtunnel_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      use_mxtunnel: true
                      use_wxtunnel: true
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    password_policy:
                      enabled: true
                      expiry_in_days: 180
                      min_length: 8
                      requires_special_char: true
                      requires_two_factor_auth: true
                    pcap:
                      bucket: string
                      max_pkt_len: 0
                    pcap_bucket_verified: true
                    remote_syslog:
                      enabled: true
                      send_to_all_servers: true
                      servers:
                      - facility: conflict-log
                        host: string
                        port: 0
                        protocol: udp
                        severity: any
                        tag: string
                    security:
                      disable_local_ssh: true
                      fips_zeroize_password: string
                      limit_ssh_access: true
                    tags:
                    - string
                    ui_idle_timeout: 0
                Example2:
                  value:
                    auto_device_naming:
                      enable: true
                      rules:
                      - expression: '...'
                        src: lldp_port_desc
                    auto_deviceprofile_assignment:
                      enable: true
                    auto_site_assignment:
                      enable: true
                      rules:
                      - expression: '[0:3]'
                        prefix: XX-
                        src: name
                        suffix: -YY
                      - src: subnet
                        subnet: 10.1.2.0/18
                        value: s1351
                      - expression: '...'
                        src: lldp_system_name
                      - expression: '...'
                        src: dns_suffix
                      - model: AP41
                        src: model
                        value: s1351
                    cacerts:
                    - >-
                      -----BEGIN CERTIFICATE-----

                      MIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE

                      -----END CERTIFICATE-----
                    - >-
                      -----BEGIN CERTIFICATE-----

                      BhMCRVMxFDASBgNVBAoMC1N0YXJ0Q29tIENBMSwwKgYDVn-----END CERTIFICATE-----
                    cloudshark:
                      apitoken: accbd6f10c6d05c3
                      url: https://cloudshark.hosted.domain
                    device_cert:
                      cert: >-
                        -----BEGIN CERTIFICATE-----

                        MIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE

                        -----END CERTIFICATE-----
                      key: '-----BEGIN PRI...'
                    device_updown_threshold: 0
                    disable_pcap: false
                    installer:
                      allow_all_sites: false
                      extra_site_ids:
                      - 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      - 52f4347e-3e4b-186c-21ca-ad5b70eb23d6
                      grace_period: 14
                    mgmt:
                      mxtunnel_ids:
                      - 08cd7499-5841-51c8-e663-fb16b6f3b45e
                      use_mxtunnel: true
                      use_wxtunnel: false
                    password_policy:
                      enabled: true
                      expiry_in_days: 60
                      min_length: 8
                      requires_special_char: false
                      requires_two_factor_auth: true
                    pcap:
                      bucket: myorg_pcap
                      max_pkt_len: 128
                    pcap_bucket_verified: true
                    remote_syslog:
                      enabled: true
                      send_to_all_servers: true
                      servers:
                      - facility: any
                        host: syslogd.internal
                        port: 514
                        protocol: udp
                        severity: info
                        tag: ''
                    security:
                      disable_local_ssh: false
                      fips_zeroize_password: NUKETHESITE
                      limit_ssh_access: false
                    tags:
                    - beta
                    ui_idle_timeout: 10
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs Setting
      summary: updateOrgSettings
      description: Update organization-wide settings such as automatic device assignment rules, management connectivity, packet capture, password policy, security controls, tags, and integration options.
      operationId: updateOrgSettings
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/org_setting'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org_setting'
                - description: Organization-wide feature, integration, management, and security settings
                  examples:
                  - auto_device_naming:
                      enable: true
                      rules:
                      - match_device: ap
                        prefix: MIST-
                        src: lldp_port_desc
                    auto_deviceprofile_assignment:
                      enable: true
                      rules:
                      - expression: string
                        model: string
                        prefix: string
                        src: name
                        subnet: string
                        suffix: string
                        value: string
                    auto_site_assignment:
                      enable: true
                      rules:
                      - expression: string
                        model: string
                        prefix: string
                        src: name
                        subnet: string
                        suffix: string
                        value: string
                    cacerts:
                    - string
                    cloudshark:
                      apitoken: string
                      url: string
                    device_cert:
                      cert: string
                      key: string
                    disable_pcap: true
                    installer:
                      allow_all_sites: true
                      extra_site_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      grace_period: 0
                    mgmt:
                      mxtunnel_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      use_mxtunnel: true
                      use_wxtunnel: true
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    password_policy:
                      enabled: true
                      expiry_in_days: 365
                      min_length: 8
                      requires_special_char: true
                      requires_two_factor_auth: true
                    pcap:
                      bucket: string
                      max_pkt_len: 0
                    pcap_bucket_verified: true
                    remote_syslog:
                      enabled: true
                      send_to_all_servers: true
                      servers:
                      - facility: change-log
                        host: string
                        port: 0
                        protocol: udp
                        severity: critical
                        tag: string
                    security:
                      disable_local_ssh: true
                      fips_zeroize_password: string
                      limit_ssh_access: true
                    tags:
                    - string
                    ui_idle_timeout: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    auto_device_naming:
                      enable: true
                      rules:
                      - match_device: ap
                        prefix: MIST-
                        src: lldp_port_desc
                    auto_deviceprofile_assignment:
                      enable: true
                      rules:
                      - expression: string
                        model: string
                        prefix: string
                        src: name
                        subnet: string
                        suffix: string
                        value: string
                    auto_site_assignment:
                      enable: true
                      rules:
                      - expression: string
                        model: string
                        prefix: string
                        src: name
                        subnet: string
                        suffix: string
                        value: string
                    cacerts:
                    - string
                    cloudshark:
                      apitoken: string
                      url: string
                    device_cert:
                      cert: string
                      key: string
                    disable_pcap: true
                    installer:
                      allow_all_sites: true
                      extra_site_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      grace_period: 0
                    mgmt:
                      mxtunnel_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      use_mxtunnel: true
                      use_wxtunnel: true
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    password_policy:
                      enabled: true
                      expiry_in_days: 365
                      min_length: 8
                      requires_special_char: true
                      requires_two_factor_auth: true
                    pcap:
                      bucket: string
                      max_pkt_len: 0
                    pcap_bucket_verified: true
                    remote_syslog:
                      enabled: true
                      send_to_all_servers: true
                      servers:
                      - facility: change-log
                        host: string
                        port: 0
                        protocol: udp
                        severity: critical
                        tag: string
                    security:
                      disable_local_ssh: true
                      fips_zeroize_password: string
                      limit_ssh_access: true
                    tags:
                    - string
                    ui_idle_timeout: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/setting/blacklist:
    delete:
      tags:
      - Orgs Setting
      summary: deleteOrgWirelessClientsBlocklist
      description: Clear the organization wireless client blocklist by removing all blocked client MAC addresses.
      operationId: deleteOrgWirelessClientsBlocklist
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs Setting
      summary: createOrgWirelessClientsBlocklist
      description: Replace the organization wireless client blocklist with the supplied client MAC addresses. The list can contain up to 1000 MAC addresses; retrieve the current list from the `blacklist_url` field in organization settings.
      operationId: createOrgWirelessClientsBlocklist
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/mac_addresses'
              - description: Request Body
                examples:
                - macs:
                  - 18-65-90-de-f4-c6
                  - 84-89-ad-5d-69-0d
              contentMediaType: application/json
            examples:
              Example:
                value:
                  macs:
                  - 18-65-90-de-f4-c6
                  - 84-89-ad-5d-69-0d
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mac_addresses'
                - description: Request containing one or more MAC addresses
                  examples:
                  - macs:
                    - 18-65-90-de-f4-c6
                    - 84-89-ad-5d-69-0d
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    macs:
                    - 18-65-90-de-f4-c6
                    - 84-89-ad-5d-69-0d
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mac_addresses'
                - description: Request containing one or more MAC addresses
                  examples:
                  - macs:
                    - 18-65-90-de-f4-c6
                    - 84-89-ad-5d-69-0d
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    macs:
                    - 18-65-90-de-f4-c6
                    - 84-89-ad-5d-69-0d
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/setting/pcap_bucket/setup:
    post:
      tags:
      - Orgs Setting
      summary: setOrgCustomBucket
      description: Start custom packet capture bucket setup by saving the bucket name and having Mist write a `MIST_TOKEN` file to the bucket. Complete ownership verification with the verify endpoint by submitting the token contents.
      operationId: setOrgCustomBucket
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/pcap_bucket'
              - description: Request Body
                examples:
                - bucket: company-private-pcap
              contentMediaType: application/json
            examples:
              Example:
                value:
                  bucket: company-private-pcap
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_pcap_bucket_config'
                - description: Result of a custom packet capture bucket setup or verification operation
                  examples:
                  - '{"bucket":"company-private-pcap","detail":"failed to write bucket - 403 AccessDenied"}'
                  - '{}'
                contentMediaType: application/json
              examples:
                Failed:
                  value:
                    bucket: company-private-pcap
                    detail: failed to write bucket - 403 AccessDenied
                Success:
                  value: {}
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_pcap_bucket_config'
                - description: Result of a custom packet capture bucket setup or verification operation
                  examples:
                  - '{"bucket":"company-private-pcap","detail":"failed to write bucket - 403 AccessDenied"}'
                  - '{}'
                contentMediaType: application/vnd.api+json
              examples:
                Failed:
                  value:
                    bucket: company-private-pcap
                    detail: failed to write bucket - 403 AccessDenied
                Success:
                  value: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/setting/pcap_bucket/verify:
    post:
      tags:
      - Orgs Setting
      summary: verifyOrgCustomBucket
      description: Verify ownership of a custom packet capture bucket by submitting the token read from the `MIST_TOKEN` file. If verification succeeds, Mist creates a `VERIFIED` file in the bucket.
      operationId: verifyOrgCustomBucket
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/pcap_bucket_verify'
              - description: Request Body
                examples:
                - bucket: company-private-pcap
                  verify_token: eyJhbGciOiJIUzI1J9.eyJzdWIiOiIxMjM0joiMjgxOG5MDIyfQ.2rzcRvMA3Eg09NnjCAC-1EWMRtxAnFDM
              contentMediaType: application/json
            examples:
              Example:
                value:
                  bucket: company-private-pcap
                  verify_token: eyJhbGciOiJIUzI1J9.eyJzdWIiOiIxMjM0joiMjgxOG5MDIyfQ.2rzcRvMA3Eg09NnjCAC-1EWMRtxAnFDM
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/sitegroups:
    get:
      tags:
      - Orgs Sitegroups
      summary: listOrgSiteGroups
      description: List site groups configured in the organization. A site group collects site IDs so sites can be managed or referenced as a group.
      operationId: listOrgSiteGroups
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/sitegroup'
                description: Site groups returned by list operations
                examples:
                - - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/sitegroup'
                description: Site groups returned by list operations
                examples:
                - - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs Sitegroups
      summary: createOrgSiteGroup
      description: Create a site group in the organization with a display name and optional site membership.
      operationId: createOrgSiteGroup
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/sitegroup'
              - description: Request Body
                examples:
                - name: string
              contentMediaType: application/json
            examples:
              Example:
                value:
                  name: string
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sitegroup'
                - description: Group of sites within an organization
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sitegroup'
                - description: Group of sites within an organization
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/sitegroups/{sitegroup_id}:
    delete:
      tags:
      - Orgs Sitegroups
      summary: deleteOrgSiteGroup
      description: Remove a site group from the organization.
      operationId: deleteOrgSiteGroup
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: sitegroup_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs Sitegroups
      summary: getOrgSiteGroup
      description: Return a site group, including its display name and the site IDs included in the group.
      operationId: getOrgSiteGroup
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: sitegroup_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sitegroup'
                - description: Group of sites within an organization
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sitegroup'
                - description: Group of sites within an organization
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs Sitegroups
      summary: updateOrgSiteGroup
      description: Update the display name used to identify a site group in the organization.
      operationId: updateOrgSiteGroup
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: sitegroup_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/name_string'
              - description: Request Body
                examples:
                - name: string
              contentMediaType: application/json
            examples:
              Example:
                value:
                  name: string
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sitegroup'
                - description: Group of sites within an organization
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sitegroup'
                - description: Group of sites within an organization
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_ids:
                    - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/sites:
    get:
      tags:
      - Orgs Sites
      summary: listOrgSites
      description: List sites in the organization. Site records include location metadata, timezone, site group membership, and template or policy associations.
      operationId: listOrgSites
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/site'
                description: Site records returned by a list response
                examples:
                - - address: 1601 S. Deanza Blvd., Cupertino, CA, 95014
                    alarmtemplate_id: 684dfc5c-fe77-2290-eb1d-ef3d677fe168
                    aptemplate_id: 16bdf952-ade2-4491-80b0-85ce506c760b
                    country_code: US
                    created_time: 0
                    gatewaytemplate_id: 6f9b2e75-9b2f-b5ae-81e3-e14c76f1a90f
                    id: 497f6eca-6276-5007-bfeb-53cbbbba6f19
                    latlng:
                      lat: 37.295833
                      lng: -122.032946
                    modified_time: 0
                    name: Mist Office
                    networktemplate_id: 12ae9bd2-e0ab-107b-72e8-a7a005565ec2
                    notes: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    rftemplate_id: bb8a9017-1e36-5d6c-6f2b-551abe8a76a2
                    secpolicy_id: 3bcd0beb-5d0a-4cbd-92c1-14aea91e98ef
                    sitegroup_ids:
                    - 497f6eca-6276-5008-bfeb-53cbbbba6f1a
                    timezone: America/Los_Angeles
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - address: 1601 S. Deanza Blvd., Cupertino, CA, 95014
                    alarmtemplate_id: 684dfc5c-fe77-2290-eb1d-ef3d677fe168
                    aptemplate_id: 16bdf952-ade2-4491-80b0-85ce506c760b
                    country_code: US
                    created_time: 0
                    gatewaytemplate_id: 6f9b2e75-9b2f-b5ae-81e3-e14c76f1a90f
                    id: 497f6eca-6276-5007-bfeb-53cbbbba6f19
                    latlng:
                      lat: 37.295833
                      lng: -122.032946
                    modified_time: 0
                    name: Mist Office
                    networktemplate_id: 12ae9bd2-e0ab-107b-72e8-a7a005565ec2
                    notes: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    rftemplate_id: bb8a9017-1e36-5d6c-6f2b-551abe8a76a2
                    secpolicy_id: 3bcd0beb-5d0a-4cbd-92c1-14aea91e98ef
                    sitegroup_ids:
                    - 497f6eca-6276-5008-bfeb-53cbbbba6f1a
                    timezone: America/Los_Angeles
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/site'
                description: Site records returned by a list response
                examples:
                - - address: 1601 S. Deanza Blvd., Cupertino, CA, 95014
                    alarmtemplate_id: 684dfc5c-fe77-2290-eb1d-ef3d677fe168
                    aptemplate_id: 16bdf952-ade2-4491-80b0-85ce506c760b
                    country_code: US
                    created_time: 0
                    gatewaytemplate_id: 6f9b2e75-9b2f-b5ae-81e3-e14c76f1a90f
                    id: 497f6eca-6276-5007-bfeb-53cbbbba6f19
                    latlng:
                      lat: 37.295833
                      lng: -122.032946
                    modified_time: 0
                    name: Mist Office
                    networktemplate_id: 12ae9bd2-e0ab-107b-72e8-a7a005565ec2
                    notes: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    rftemplate_id: bb8a9017-1e36-5d6c-6f2b-551abe8a76a2
                    secpolicy_id: 3bcd0beb-5d0a-4cbd-92c1-14aea91e98ef
                    sitegroup_ids:
                    - 497f6eca-6276-5008-bfeb-53cbbbba6f1a
                    timezone: America/Los_Angeles
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - address: 1601 S. Deanza Blvd., Cupertino, CA, 95014
                    alarmtemplate_id: 684dfc5c-fe77-2290-eb1d-ef3d677fe168
                    aptemplate_id: 16bdf952-ade2-4491-80b0-85ce506c760b
                    country_code: US
                    created_time: 0
                    gatewaytemplate_id: 6f9b2e75-9b2f-b5ae-81e3-e14c76f1a90f
                    id: 497f6eca-6276-5007-bfeb-53cbbbba6f19
                    latlng:
                      lat: 37.295833
                      lng: -122.032946
                    modified_time: 0
                    name: Mist Office
                    networktemplate_id: 12ae9bd2-e0ab-107b-72e8-a7a005565ec2
                    notes: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    rftemplate_id: bb8a9017-1e36-5d6c-6f2b-551abe8a76a2
                    secpolicy_id: 3bcd0beb-5d0a-4cbd-92c1-14aea91e98ef
                    sitegroup_ids:
                    - 497f6eca-6276-5008-bfeb-53cbbbba6f1a
                    timezone: America/Los_Angeles
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs Sites
      summary: createOrgSite
      description: Create a site in the organization with location metadata, timezone, site group membership, and optional template or policy associations.
      operationId: createOrgSite
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/site'
              - description: Request Body
                examples:
                - address: 1601 S. Deanza Blvd., Cupertino, CA, 95014
                  alarmtemplate_id: 684dfc5c-fe77-2290-eb1d-ef3d677fe168
                  aptemplate_id: 16bdf952-ade2-4491-80b0-85ce506c760b
                  country_code: US
                  gatewaytemplate_id: 6f9b2e75-9b2f-b5ae-81e3-e14c76f1a90f
                  latlng:
                    lat: 37.295833
                    lng: -122.032946
                  name: Mist Office
                  networktemplate_id: 12ae9bd2-e0ab-107b-72e8-a7a005565ec2
                  notes: string
                  rftemplate_id: bb8a9017-1e36-5d6c-6f2b-551abe8a76a2
                  secpolicy_id: 3bcd0beb-5d0a-4cbd-92c1-14aea91e98ef
                  sitegroup_ids:
                  - 497f6eca-6276-4997-bfeb-53cbbbba6f3b
                  timezone: America/Los_Angeles
              contentMediaType: application/json
            examples:
              Example:
                value:
                  address: 1601 S. Deanza Blvd., Cupertino, CA, 95014
                  alarmtemplate_id: 684dfc5c-fe77-2290-eb1d-ef3d677fe168
                  aptemplate_id: 16bdf952-ade2-4491-80b0-85ce506c760b
                  country_code: US
                  gatewaytemplate_id: 6f9b2e75-9b2f-b5ae-81e3-e14c76f1a90f
                  latlng:
                    lat: 37.295833
                    lng: -122.032946
                  name: Mist Office
                  networktemplate_id: 12ae9bd2-e0ab-107b-72e8-a7a005565ec2
                  notes: string
                  rftemplate_id: bb8a9017-1e36-5d6c-6f2b-551abe8a76a2
                  secpolicy_id: 3bcd0beb-5d0a-4cbd-92c1-14aea91e98ef
                  sitegroup_ids:
                  - 497f6eca-6276-4997-bfeb-53cbbbba6f3b
                  timezone: America/Los_Angeles
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/site'
                - description: Site configuration and metadata within an organization
                  examples:
                  - address: 1601 S. Deanza Blvd., Cupertino, CA, 95014
                    alarmtemplate_id: 684dfc5c-fe77-2290-eb1d-ef3d677fe168
                    aptemplate_id: 16bdf952-ade2-4491-80b0-85ce506c760b
                    country_code: US
                    created_time: 0
                    gatewaytemplate_id: 6f9b2e75-9b2f-b5ae-81e3-e14c76f1a90f
                    id: 497f6eca-6276-5005-bfeb-53cbbbba6f17
                    latlng:
                      lat: 37.295833
                      lng: -122.032946
                    modified_time: 0
                    name: Mist Office
                    networktemplate_id: 12ae9bd2-e0ab-107b-72e8-a7a005565ec2
                    notes: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    rftemplate_id: bb8a9017-1e36-5d6c-6f2b-551abe8a76a2
                    secpolicy_id: 3bcd0beb-5d0a-4cbd-92c1-14aea91e98ef
                    sitegroup_ids:
                    - 497f6eca-6276-5006-bfeb-53cbbbba6f18
                    timezone: America/Los_Angeles
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    address: 1601 S. Deanza Blvd., Cupertino, CA, 95014
                    alarmtemplate_id: 684dfc5c-fe77-2290-eb1d-ef3d677fe168
                    aptemplate_id: 16bdf952-ade2-4491-80b0-85ce506c760b
                    country_code: US
                    created_time: 0
                    gatewaytemplate_id: 6f9b2e75-9b2f-b5ae-81e3-e14c76f1a90f
                    id: 497f6eca-6276-5005-bfeb-53cbbbba6f17
                    latlng:
                      lat: 37.295833
                      lng: -122.032946
                    modified_time: 0
                    name: Mist Office
                    networktemplate_id: 12ae9bd2-e0ab-107b-72e8-a7a005565ec2
                    notes: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    rftemplate_id: bb8a9017-1e36-5d6c-6f2b-551abe8a76a2
                    secpolicy_id: 3bcd0beb-5d0a-4cbd-92c1-14aea91e98ef
                    sitegroup_ids:
                    - 497f6eca-6276-5006-bfeb-53cbbbba6f18
                    timezone: America/Los_Angeles
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/site'
                - description: Site configuration and metadata within an organization
                  examples:
                  - address: 1601 S. Deanza Blvd., Cupertino, CA, 95014
                    alarmtemplate_id: 684dfc5c-fe77-2290-eb1d-ef3d677fe168
                    aptemplate_id: 16bdf952-ade2-4491-80b0-85ce506c760b
                    country_code: US
                    created_time: 0
                    gatewaytemplate_id: 6f9b2e75-9b2f-b5ae-81e3-e14c76f1a90f
                    id: 497f6eca-6276-5005-bfeb-53cbbbba6f17
                    latlng:
                      lat: 37.295833
                      lng: -122.032946
                    modified_time: 0
                    name: Mist Office
                    networktemplate_id: 12ae9bd2-e0ab-107b-72e8-a7a005565ec2
                    notes: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    rftemplate_id: bb8a9017-1e36-5d6c-6f2b-551abe8a76a2
                    secpolicy_id: 3bcd0beb-5d0a-4cbd-92c1-14aea91e98ef
                    sitegroup_ids:
                    - 497f6eca-6276-5006-bfeb-53cbbbba6f18
                    timezone: America/Los_Angeles
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    address: 1601 S. Deanza Blvd., Cupertino, CA, 95014
                    alarmtemplate_id: 684dfc5c-fe77-2290-eb1d-ef3d677fe168
                    aptemplate_id: 16bdf952-ade2-4491-80b0-85ce506c760b
                    country_code: US
                    created_time: 0
                    gatewaytemplate_id: 6f9b2e75-9b2f-b5ae-81e3-e14c76f1a90f
                    id: 497f6eca-6276-5005-bfeb-53cbbbba6f17
                    latlng:
                      lat: 37.295833
                      lng: -122.032946
                    modified_time: 0
                    name: Mist Office
                    networktemplate_id: 12ae9bd2-e0ab-107b-72e8-a7a005565ec2
                    notes: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    rftemplate_id: bb8a9017-1e36-5d6c-6f2b-551abe8a76a2
                    secpolicy_id: 3bcd0beb-5d0a-4cbd-92c1-14aea91e98ef
                    sitegroup_ids:
                    - 497f6eca-6276-5006-bfeb-53cbbbba6f18
                    timezone: America/Los_Angeles
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/sites/count:
    get:
      tags:
      - Orgs Sites
      summary: countOrgSites
      description: Count organization sites grouped by a distinct site attribute, such as country code, site name, feature flags, or enabled services.
      operationId: countOrgSites
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `analytic_enabled`, `app_waking`, `asset_enabled`, `auto_upgrade_enabled`, `auto_upgrade_version`, `country_code`, `honeypot_enabled`, `id`, `locate_unconnected`, `mesh_enabled`, `name`, `remote_syslog_enabled`, `rogue_enabled`, `rtsa_enabled`, `vna_enabled`, `wifi_enabled`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/org_sites_count_distinct'
          - description: 'Field used to group this count response. enum: `analytic_enabled`, `app_waking`, `asset_enabled`, `auto_upgrade_enabled`, `auto_upgrade_version`, `country_code`, `honeypot_enabled`, `id`, `locate_unconnected`, `mesh_enabled`, `name`, `remote_syslog_enabled`, `rogue_enabled`, `rtsa_enabled`, `vna_enabled`, `wifi_enabled`'
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/sites/search:
    get:
      tags:
      - Orgs Sites
      summary: searchOrgSites
      description: Search organization sites with filters for feature flags, country code, identifiers, names, upgrade settings, and other site attributes. Supports pagination and sorting.
      operationId: searchOrgSites
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: analytic_enabled
        in: query
        description: If Advanced Analytic feature is enabled. Accepts multiple comma-separated boolean values.
        style: form
        explode: true
        schema:
          type: boolean
      - name: app_waking
        in: query
        description: If App Waking feature is enabled
        style: form
        explode: true
        schema:
          type: boolean
      - name: asset_enabled
        in: query
        description: If Asset Tracking is enabled. Accepts multiple comma-separated boolean values.
        style: form
        explode: true
        schema:
          type: boolean
      - name: auto_upgrade_enabled
        in: query
        description: Filter results by whether automatic upgrades are enabled
        style: form
        explode: true
        schema:
          type: boolean
      - name: auto_upgrade_version
        in: query
        description: Filter results by automatic upgrade version. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - custom,stable
      - name: country_code
        in: query
        description: Filter results by country code. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - CA,FR
      - name: honeypot_enabled
        in: query
        description: If Honeypot detection is enabled. Accepts multiple comma-separated boolean values.
        style: form
        explode: true
        schema:
          type: boolean
      - name: id
        in: query
        description: Filter results by identifier. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002
      - name: locate_unconnected
        in: query
        description: If unconnected client are located. Accepts multiple comma-separated boolean values.
        style: form
        explode: true
        schema:
          type: boolean
      - name: mesh_enabled
        in: query
        description: If Mesh feature is enabled. Accepts multiple comma-separated boolean values.
        style: form
        explode: true
        schema:
          type: boolean
      - name: name
        in: query
        description: Partial / full Site name. Case insensitive. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `my-site*` and `*site*` match `my-site-01`). Suffix-only wildcards (e.g. `*site-01`) are not supported. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - my-site-01,my-site*
          - my-site-01
          - my-site*
          - '*site*'
        examples:
          Untitled Example1:
            value: my-site-01,my-site*
          Untitled Example2:
            value: my-site-01
          Untitled Example3:
            value: my-site*
          Untitled Example4:
            value: '*site*'
      - name: rogue_enabled
        in: query
        description: If Rogue detection is enabled. Accepts multiple comma-separated boolean values.
        style: form
        explode: true
        schema:
          type: boolean
      - name: remote_syslog_enabled
        in: query
        description: If Remote Syslog is enabled
        style: form
        explode: true
        schema:
          type: boolean
      - name: rtsa_enabled
        in: query
        description: If managed mobility feature is enabled. Accepts multiple comma-separated boolean values.
        style: form
        explode: true
        schema:
          type: boolean
      - name: vna_enabled
        in: query
        description: If Virtual Network Assistant is enabled. Accepts multiple comma-separated boolean values.
        style: form
        explode: true
        schema:
          type: boolean
      - name: wifi_enabled
        in: query
        description: If Wi-Fi feature is enabled
        style: form
        explode: true
        schema:
          type: boolean
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_site_search'
                - description: Paginated response for organization site search results
                  examples:
                  - end: 0
                    limit: 0
                    next: string
                    results:
                    - auto_upgrade_enabled: true
                      auto_upgrade_version: string
                      country_code: string
                      honeypot_enabled: true
                      id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      timestamp: 0
                      timezone: string
                      vna_enabled: true
                      wifi_enabled: true
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 0
                    limit: 0
                    next: string
                    results:
                    - auto_upgrade_enabled: true
                      auto_upgrade_version: string
                      country_code: string
                      honeypot_enabled: true
                      id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      timestamp: 0
                      timezone: string
                      vna_enabled: true
                      wifi_enabled: true
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_site_search'
                - description: Paginated response for organization site search results
                  examples:
                  - end: 0
                    limit: 0
                    next: string
                    results:
                    - auto_upgrade_enabled: true
                      auto_upgrade_version: string
                      country_code: string
                      honeypot_enabled: true
                      id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      timestamp: 0
                      timezone: string
                      vna_enabled: true
                      wifi_enabled: true
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 0
                    limit: 0
                    next: string
                    results:
                    - auto_upgrade_enabled: true
                      auto_upgrade_version: string
                      country_code: string
                      honeypot_enabled: true
                      id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      timestamp: 0
                      timezone: string
                      vna_enabled: true
                      wifi_enabled: true
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/sitetemplates:
    get:
      tags:
      - Orgs Site Templates
      summary: listOrgSiteTemplates
      description: List site templates configured in the organization. Site templates contain automatic upgrade settings and variables available to WLAN configuration.
      operationId: listOrgSiteTemplates
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/site_template'
                description: List of site templates
                examples:
                - - auto_upgrade:
                      day_of_week: mon
                      enabled: true
                      time_of_day: string
                      version: string
                    name: string
                    vars:
                      SSID_STR: string
                      VLAN_ID: string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - auto_upgrade:
                      day_of_week: mon
                      enabled: true
                      time_of_day: string
                      version: string
                    name: string
                    vars:
                      SSID_STR: string
                      VLAN_ID: string
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/site_template'
                description: List of site templates
                examples:
                - - auto_upgrade:
                      day_of_week: mon
                      enabled: true
                      time_of_day: string
                      version: string
                    name: string
                    vars:
                      SSID_STR: string
                      VLAN_ID: string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - auto_upgrade:
                      day_of_week: mon
                      enabled: true
                      time_of_day: string
                      version: string
                    name: string
                    vars:
                      SSID_STR: string
                      VLAN_ID: string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs Site Templates
      summary: createOrgSiteTemplate
      description: >-
        Create a site template with automatic upgrade settings and template

        variables available to WLAN configuration.


        To assign a Site template to a site, use the [Update Site]($e/Sites/updateSiteInfo) endpoint and specify the Site template ID in the `sitetemplate_id` field of the request body.'
      operationId: createOrgSiteTemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/site_template'
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/site_template'
                - description: Site template containing auto-upgrade settings and template variables
                  examples:
                  - auto_upgrade:
                      day_of_week: mon
                      enabled: true
                      time_of_day: string
                      version: string
                    name: string
                    vars:
                      SSID_STR: string
                      VLAN_ID: string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    auto_upgrade:
                      day_of_week: mon
                      enabled: true
                      time_of_day: string
                      version: string
                    name: string
                    vars:
                      SSID_STR: string
                      VLAN_ID: string
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/site_template'
                - description: Site template containing auto-upgrade settings and template variables
                  examples:
                  - auto_upgrade:
                      day_of_week: mon
                      enabled: true
                      time_of_day: string
                      version: string
                    name: string
                    vars:
                      SSID_STR: string
                      VLAN_ID: string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    auto_upgrade:
                      day_of_week: mon
                      enabled: true
                      time_of_day: string
                      version: string
                    name: string
                    vars:
                      SSID_STR: string
                      VLAN_ID: string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/sitetemplates/{sitetemplate_id}:
    delete:
      tags:
      - Orgs Site Templates
      summary: deleteOrgSiteTemplate
      description: Remove a site template from the organization.
      operationId: deleteOrgSiteTemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: sitetemplate_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs Site Templates
      summary: getOrgSiteTemplate
      description: Return a site template, including automatic upgrade settings and template variables available to WLAN configuration.
      operationId: getOrgSiteTemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: sitetemplate_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/site_template'
                - description: Site template containing auto-upgrade settings and template variables
                  examples:
                  - auto_upgrade:
                      day_of_week: mon
                      enabled: true
                      time_of_day: string
                      version: string
                    name: string
                    vars:
                      SSID_STR: string
                      VLAN_ID: string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    auto_upgrade:
                      day_of_week: mon
                      enabled: true
                      time_of_day: string
                      version: string
                    name: string
                    vars:
                      SSID_STR: string
                      VLAN_ID: string
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/site_template'
                - description: Site template containing auto-upgrade settings and template variables
                  examples:
                  - auto_upgrade:
                      day_of_week: mon
                      enabled: true
                      time_of_day: string
                      version: string
                    name: string
                    vars:
                      SSID_STR: string
                      VLAN_ID: string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    auto_upgrade:
                      day_of_week: mon
                      enabled: true
                      time_of_day: string
                      version: string
                    name: string
                    vars:
                      SSID_STR: string
                      VLAN_ID: string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs Site Templates
      summary: updateOrgSiteTemplate
      description: Update a site template's automatic upgrade settings and template variables available to WLAN configuration.
      operationId: updateOrgSiteTemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: sitetemplate_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/site_template'
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/site_template'
                - description: Site template containing auto-upgrade settings and template variables
                  examples:
                  - auto_upgrade:
                      day_of_week: mon
                      enabled: true
                      time_of_day: string
                      version: string
                    name: string
                    vars:
                      SSID_STR: string
                      VLAN_ID: string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    auto_upgrade:
                      day_of_week: mon
                      enabled: true
                      time_of_day: string
                      version: string
                    name: string
                    vars:
                      SSID_STR: string
                      VLAN_ID: string
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/site_template'
                - description: Site template containing auto-upgrade settings and template variables
                  examples:
                  - auto_upgrade:
                      day_of_week: mon
                      enabled: true
                      time_of_day: string
                      version: string
                    name: string
                    vars:
                      SSID_STR: string
                      VLAN_ID: string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    auto_upgrade:
                      day_of_week: mon
                      enabled: true
                      time_of_day: string
                      version: string
                    name: string
                    vars:
                      SSID_STR: string
                      VLAN_ID: string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/insights/sites-sle:
    get:
      tags:
      - Orgs SLEs
      summary: getOrgSitesSle
      description: Return per-site Service-Level Expectation (SLE) scores for Wi-Fi, wired, or WAN service over the requested time window.
      operationId: getOrgSitesSle
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: sle
        in: query
        description: 'Filter insights by SLE name. enum: `wan`, `wifi`, `wired`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/org_site_sle_type'
          - description: 'Filter insights by SLE name. enum: `wan`, `wifi`, `wired`'
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: interval
        in: query
        description: Aggregation works by giving a time range plus interval (e.g. 1d, 1h, 10m) where aggregation function would be applied to.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_org_site_sle'
                - description: Organization site SLE response for Wi-Fi, wired, or WAN
                  examples:
                  - '{"end":1651323600,"interval":3600,"limit":1,"page":2,"results":[{"application_health":0.8250000047942866,"gateway-health":1,"num_clients":65,"num_gateways":1,"site_id":"f5fcbee5-1234-5678-9101-1619ede87879","wan-link-health":0.9988471089272484}],"start":1651269600,"total":4}'
                  - '{"end":1651323600,"interval":3600,"limit":1,"page":2,"results":[{"ap-availability":1,"ap-health":0.6735632316819553,"capacity":0.9802900770150502,"coverage":0.812181632387686,"num_aps":3,"num_clients":24,"roaming":1,"site_id":"f5fcbee5-1234-5678-9101-1619ede87879","successful-connect":0.9535864983932881,"throughput":1,"time-to-connect":0.9791666666666666}],"start":1651269600,"total":4}'
                  - '{"end":1651323600,"interval":3600,"limit":1,"page":2,"results":[{"num_clients":6,"num_switches":1,"site_id":"f5fcbee5-1234-5678-9101-1619ede87879","switch-bandwidth":0.9669529756744796,"switch-health":1,"switch-throughput":1}],"start":1651269600,"total":4}'
                contentMediaType: application/json
              examples:
                WAN SLE:
                  value:
                    end: 1651323600
                    interval: 3600
                    limit: 1
                    page: 2
                    results:
                    - application_health: 0.8250000047942866
                      gateway-health: 1
                      num_clients: 65
                      num_gateways: 1
                      site_id: f5fcbee5-1234-5678-9101-1619ede87879
                      wan-link-health: 0.9988471089272484
                    start: 1651269600
                    total: 4
                Wi-Fi SLE:
                  value:
                    end: 1651323600
                    interval: 3600
                    limit: 1
                    page: 2
                    results:
                    - ap-availability: 1
                      ap-health: 0.6735632316819553
                      capacity: 0.9802900770150502
                      coverage: 0.812181632387686
                      num_aps: 3
                      num_clients: 24
                      roaming: 1
                      site_id: f5fcbee5-1234-5678-9101-1619ede87879
                      successful-connect: 0.9535864983932881
                      throughput: 1
                      time-to-connect: 0.9791666666666666
                    start: 1651269600
                    total: 4
                Wired SLE:
                  value:
                    end: 1651323600
                    interval: 3600
                    limit: 1
                    page: 2
                    results:
                    - num_clients: 6
                      num_switches: 1
                      site_id: f5fcbee5-1234-5678-9101-1619ede87879
                      switch-bandwidth: 0.9669529756744796
                      switch-health: 1
                      switch-throughput: 1
                    start: 1651269600
                    total: 4
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_org_site_sle'
                - description: Organization site SLE response for Wi-Fi, wired, or WAN
                  examples:
                  - '{"end":1651323600,"interval":3600,"limit":1,"page":2,"results":[{"application_health":0.8250000047942866,"gateway-health":1,"num_clients":65,"num_gateways":1,"site_id":"f5fcbee5-1234-5678-9101-1619ede87879","wan-link-health":0.9988471089272484}],"start":1651269600,"total":4}'
                  - '{"end":1651323600,"interval":3600,"limit":1,"page":2,"results":[{"ap-availability":1,"ap-health":0.6735632316819553,"capacity":0.9802900770150502,"coverage":0.812181632387686,"num_aps":3,"num_clients":24,"roaming":1,"site_id":"f5fcbee5-1234-5678-9101-1619ede87879","successful-connect":0.9535864983932881,"throughput":1,"time-to-connect":0.9791666666666666}],"start":1651269600,"total":4}'
                  - '{"end":1651323600,"interval":3600,"limit":1,"page":2,"results":[{"num_clients":6,"num_switches":1,"site_id":"f5fcbee5-1234-5678-9101-1619ede87879","switch-bandwidth":0.9669529756744796,"switch-health":1,"switch-throughput":1}],"start":1651269600,"total":4}'
                contentMediaType: application/vnd.api+json
              examples:
                WAN SLE:
                  value:
                    end: 1651323600
                    interval: 3600
                    limit: 1
                    page: 2
                    results:
                    - application_health: 0.8250000047942866
                      gateway-health: 1
                      num_clients: 65
                      num_gateways: 1
                      site_id: f5fcbee5-1234-5678-9101-1619ede87879
                      wan-link-health: 0.9988471089272484
                    start: 1651269600
                    total: 4
                Wi-Fi SLE:
                  value:
                    end: 1651323600
                    interval: 3600
                    limit: 1
                    page: 2
                    results:
                    - ap-availability: 1
                      ap-health: 0.6735632316819553
                      capacity: 0.9802900770150502
                      coverage: 0.812181632387686
                      num_aps: 3
                      num_clients: 24
                      roaming: 1
                      site_id: f5fcbee5-1234-5678-9101-1619ede87879
                      successful-connect: 0.9535864983932881
                      throughput: 1
                      time-to-connect: 0.9791666666666666
                    start: 1651269600
                    total: 4
                Wired SLE:
                  value:
                    end: 1651323600
                    interval: 3600
                    limit: 1
                    page: 2
                    results:
                    - num_clients: 6
                      num_switches: 1
                      site_id: f5fcbee5-1234-5678-9101-1619ede87879
                      switch-bandwidth: 0.9669529756744796
                      switch-health: 1
                      switch-throughput: 1
                    start: 1651269600
                    total: 4
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/insights/{metric}:
    get:
      tags:
      - Orgs SLEs
      summary: getOrgSle
      description: Return organization-level insight data for the selected metric, such as all or worst sites, Mist Edge insights, or other supported insight metrics, over the requested time window.
      operationId: getOrgSle
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: metric
        in: path
        description: See [List Insight Metrics]($e/Constants%20Definitions/listInsightMetrics) for available metrics
        required: true
        schema:
          type: string
      - name: sle
        in: query
        description: See [List Insight Metrics]($e/Constants%20Definitions/listInsightMetrics) for more details
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: interval
        in: query
        description: Aggregation works by giving a time range plus interval (e.g. 1d, 1h, 10m) where aggregation function would be applied to.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 10m
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/insight_metrics'
                - description: Insight metric response for a requested time range and aggregation interval
                  examples:
                  - end: 1643706000
                    interval: 3600
                    limit: 100
                    results:
                    - ap-availability: 0.9919400860511628
                      ap-health: 0.967607512909879
                      capacity: 0.7484652273070254
                      coverage: 0.91217567374857
                      num_aps: 13
                      num_clients: 12
                      roaming: 0.991735537682683
                      roaming-exp: 0.991735537682683
                      site_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b
                      successful-connect: 0.46052632135780236
                      throughput: 0.6775702123846302
                      time-to-connect: 0.9349112447196916
                    - ap-availability: 0.9990384613092129
                      ap-health: 0.48201754375507955
                      capacity: 0.9702673450306101
                      coverage: 0.8335392334930375
                      num_aps: 1
                      num_clients: 6
                      roaming: 1
                      roaming-exp: 1
                      site_id: 49ff76e0-a283-4e7d-b38d-041f1e9aff3c
                      successful-connect: 1
                      throughput: 0
                      time-to-connect: 1
                    - ap-availability: 1
                      ap-health: 0.982456140612301
                      capacity: 1
                      coverage: 0.9276041182442488
                      num_aps: 2
                      num_clients: 3
                      roaming: 1
                      roaming-exp: 1
                      site_id: 9b9b48f1-15a4-459e-86cc-9cbec9005983
                      successful-connect: 1
                      throughput: 1
                      time-to-connect: 0.8125
                    - ap-availability: 0.9981132070973234
                      ap-health: 0.9991228068084047
                      capacity: 1
                      coverage: 1
                      num_aps: 1
                      num_clients: 0
                      roaming: 1
                      roaming-exp: 1
                      site_id: eb0e1671-7a6b-472b-94c3-c187dafe5274
                      successful-connect: 1
                      throughput: 0
                      time-to-connect: 0.5
                    start: 1643670000
                contentMediaType: application/json
              examples:
                Worst Sites By Sle:
                  value:
                    end: 1643706000
                    interval: 3600
                    limit: 100
                    results:
                    - ap-availability: 0.9919400860511628
                      ap-health: 0.967607512909879
                      capacity: 0.7484652273070254
                      coverage: 0.91217567374857
                      num_aps: 13
                      num_clients: 12
                      roaming: 0.991735537682683
                      roaming-exp: 0.991735537682683
                      site_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b
                      successful-connect: 0.46052632135780236
                      throughput: 0.6775702123846302
                      time-to-connect: 0.9349112447196916
                    - ap-availability: 0.9990384613092129
                      ap-health: 0.48201754375507955
                      capacity: 0.9702673450306101
                      coverage: 0.8335392334930375
                      num_aps: 1
                      num_clients: 6
                      roaming: 1
                      roaming-exp: 1
                      site_id: 49ff76e0-a283-4e7d-b38d-041f1e9aff3c
                      successful-connect: 1
                      throughput: 0
                      time-to-connect: 1
                    - ap-availability: 1
                      ap-health: 0.982456140612301
                      capacity: 1
                      coverage: 0.9276041182442488
                      num_aps: 2
                      num_clients: 3
                      roaming: 1
                      roaming-exp: 1
                      site_id: 9b9b48f1-15a4-459e-86cc-9cbec9005983
                      successful-connect: 1
                      throughput: 1
                      time-to-connect: 0.8125
                    - ap-availability: 0.9981132070973234
                      ap-health: 0.9991228068084047
                      capacity: 1
                      coverage: 1
                      num_aps: 1
                      num_clients: 0
                      roaming: 1
                      roaming-exp: 1
                      site_id: eb0e1671-7a6b-472b-94c3-c187dafe5274
                      successful-connect: 1
                      throughput: 0
                      time-to-connect: 0.5
                    start: 1643670000
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/insight_metrics'
                - description: Insight metric response for a requested time range and aggregation interval
                  examples:
                  - end: 1643706000
                    interval: 3600
                    limit: 100
                    results:
                    - ap-availability: 0.9919400860511628
                      ap-health: 0.967607512909879
                      capacity: 0.7484652273070254
                      coverage: 0.91217567374857
                      num_aps: 13
                      num_clients: 12
                      roaming: 0.991735537682683
                      roaming-exp: 0.991735537682683
                      site_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b
                      successful-connect: 0.46052632135780236
                      throughput: 0.6775702123846302
                      time-to-connect: 0.9349112447196916
                    - ap-availability: 0.9990384613092129
                      ap-health: 0.48201754375507955
                      capacity: 0.9702673450306101
                      coverage: 0.8335392334930375
                      num_aps: 1
                      num_clients: 6
                      roaming: 1
                      roaming-exp: 1
                      site_id: 49ff76e0-a283-4e7d-b38d-041f1e9aff3c
                      successful-connect: 1
                      throughput: 0
                      time-to-connect: 1
                    - ap-availability: 1
                      ap-health: 0.982456140612301
                      capacity: 1
                      coverage: 0.9276041182442488
                      num_aps: 2
                      num_clients: 3
                      roaming: 1
                      roaming-exp: 1
                      site_id: 9b9b48f1-15a4-459e-86cc-9cbec9005983
                      successful-connect: 1
                      throughput: 1
                      time-to-connect: 0.8125
                    - ap-availability: 0.9981132070973234
                      ap-health: 0.9991228068084047
                      capacity: 1
                      coverage: 1
                      num_aps: 1
                      num_clients: 0
                      roaming: 1
                      roaming-exp: 1
                      site_id: eb0e1671-7a6b-472b-94c3-c187dafe5274
                      successful-connect: 1
                      throughput: 0
                      time-to-connect: 0.5
                    start: 1643670000
                contentMediaType: application/vnd.api+json
              examples:
                Worst Sites By Sle:
                  value:
                    end: 1643706000
                    interval: 3600
                    limit: 100
                    results:
                    - ap-availability: 0.9919400860511628
                      ap-health: 0.967607512909879
                      capacity: 0.7484652273070254
                      coverage: 0.91217567374857
                      num_aps: 13
                      num_clients: 12
                      roaming: 0.991735537682683
                      roaming-exp: 0.991735537682683
                      site_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b
                      successful-connect: 0.46052632135780236
                      throughput: 0.6775702123846302
                      time-to-connect: 0.9349112447196916
                    - ap-availability: 0.9990384613092129
                      ap-health: 0.48201754375507955
                      capacity: 0.9702673450306101
                      coverage: 0.8335392334930375
                      num_aps: 1
                      num_clients: 6
                      roaming: 1
                      roaming-exp: 1
                      site_id: 49ff76e0-a283-4e7d-b38d-041f1e9aff3c
                      successful-connect: 1
                      throughput: 0
                      time-to-connect: 1
                    - ap-availability: 1
                      ap-health: 0.982456140612301
                      capacity: 1
                      coverage: 0.9276041182442488
                      num_aps: 2
                      num_clients: 3
                      roaming: 1
                      roaming-exp: 1
                      site_id: 9b9b48f1-15a4-459e-86cc-9cbec9005983
                      successful-connect: 1
                      throughput: 1
                      time-to-connect: 0.8125
                    - ap-availability: 0.9981132070973234
                      ap-health: 0.9991228068084047
                      capacity: 1
                      coverage: 1
                      num_aps: 1
                      num_clients: 0
                      roaming: 1
                      roaming-exp: 1
                      site_id: eb0e1671-7a6b-472b-94c3-c187dafe5274
                      successful-connect: 1
                      throughput: 0
                      time-to-connect: 0.5
                    start: 1643670000
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/ssoroles:
    get:
      tags:
      - Orgs SSO Roles
      summary: listOrgSsoRoles
      description: List organization SSO role definitions that map identity-provider role assertions to organization, site, or site group privilege scopes.
      operationId: listOrgSsoRoles
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/sso_role_org'
                description: Organization SSO roles returned by the request
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/sso_role_org'
                description: Organization SSO roles returned by the request
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs SSO Roles
      summary: createOrgSsoRole
      description: Create an organization SSO role definition with a display name and the privileges granted when the role is matched during SSO.
      operationId: createOrgSsoRole
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/sso_role_org'
              - description: Request Body
                examples:
                - '{"name":"string","privileges":[{"org_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","role":"admin","scope":"org"},{"role":"read","scope":"site","site_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1"},{"org_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","role":"read","scope":"sitegroup","sitegroup_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1"}]}'
              contentMediaType: application/json
            examples:
              Example:
                value:
                  name: string
                  privileges:
                  - org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    role: admin
                    scope: org
                  - role: read
                    scope: site
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  - org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    role: read
                    scope: sitegroup
                    sitegroup_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sso_role_org'
                - description: Organization SSO role definition
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    privileges:
                    - role: admin
                      scope: sitegroup
                      sitegroup_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    privileges:
                    - role: admin
                      scope: sitegroup
                      sitegroup_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sso_role_org'
                - description: Organization SSO role definition
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    privileges:
                    - role: admin
                      scope: sitegroup
                      sitegroup_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    privileges:
                    - role: admin
                      scope: sitegroup
                      sitegroup_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/ssoroles/{ssorole_id}:
    delete:
      tags:
      - Orgs SSO Roles
      summary: deleteOrgSsoRole
      description: Delete an organization SSO role definition so it can no longer grant privileges during SSO.
      operationId: deleteOrgSsoRole
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: ssorole_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs SSO Roles
      summary: getOrgSsoRole
      description: Return one organization SSO role definition, including its display name and granted privileges.
      operationId: getOrgSsoRole
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: ssorole_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sso_role_org'
                - description: Organization SSO role definition
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    privileges:
                    - role: admin
                      scope: sitegroup
                      sitegroup_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    privileges:
                    - role: admin
                      scope: sitegroup
                      sitegroup_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sso_role_org'
                - description: Organization SSO role definition
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    privileges:
                    - role: admin
                      scope: sitegroup
                      sitegroup_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    privileges:
                    - role: admin
                      scope: sitegroup
                      sitegroup_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs SSO Roles
      summary: updateOrgSsoRole
      description: Update an organization SSO role definition, including its display name and granted privileges.
      operationId: updateOrgSsoRole
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: ssorole_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/sso_role_org'
              - description: Request Body
                examples:
                - '{"name":"string","privileges":[{"org_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","role":"admin","scope":"org"},{"role":"read","scope":"site","site_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1"},{"org_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","role":"read","scope":"sitegroup","sitegroup_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1"}]}'
              contentMediaType: application/json
            examples:
              Example:
                value:
                  name: string
                  privileges:
                  - org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    role: admin
                    scope: org
                  - role: read
                    scope: site
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  - org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    role: read
                    scope: sitegroup
                    sitegroup_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sso_role_org'
                - description: Organization SSO role definition
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    privileges:
                    - role: admin
                      scope: sitegroup
                      sitegroup_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    privileges:
                    - role: admin
                      scope: sitegroup
                      sitegroup_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sso_role_org'
                - description: Organization SSO role definition
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    privileges:
                    - role: admin
                      scope: sitegroup
                      sitegroup_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    privileges:
                    - role: admin
                      scope: sitegroup
                      sitegroup_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/ssos:
    get:
      tags:
      - Orgs SSO
      summary: listOrgSsos
      description: List SSO identity provider configurations defined for this organization.
      operationId: listOrgSsos
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/sso'
                description: List of SSO configurations
                examples:
                - - created_time: 0
                    custom_logout_url: string
                    default_role: string
                    domain: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    idp_cert: string
                    idp_sign_algo: sha256
                    idp_sso_url: string
                    ignore_unmatched_roles: true
                    issuer: string
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    nameid_format: email
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 0
                    custom_logout_url: string
                    default_role: string
                    domain: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    idp_cert: string
                    idp_sign_algo: sha256
                    idp_sso_url: string
                    ignore_unmatched_roles: true
                    issuer: string
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    nameid_format: email
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: string
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/sso'
                description: List of SSO configurations
                examples:
                - - created_time: 0
                    custom_logout_url: string
                    default_role: string
                    domain: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    idp_cert: string
                    idp_sign_algo: sha256
                    idp_sso_url: string
                    ignore_unmatched_roles: true
                    issuer: string
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    nameid_format: email
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 0
                    custom_logout_url: string
                    default_role: string
                    domain: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    idp_cert: string
                    idp_sign_algo: sha256
                    idp_sso_url: string
                    ignore_unmatched_roles: true
                    issuer: string
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    nameid_format: email
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs SSO
      summary: createOrgSso
      description: Create an organization SSO identity provider configuration, including provider settings and role-handling behavior.
      operationId: createOrgSso
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/sso'
              - description: Request Body
                examples:
                - custom_logout_url: string
                  idp_cert: string
                  idp_sign_algo: sha256
                  idp_sso_url: string
                  ignore_unmatched_roles: true
                  issuer: string
                  name: string
                  nameid_format: email
              contentMediaType: application/json
            examples:
              Example:
                value:
                  custom_logout_url: string
                  idp_cert: string
                  idp_sign_algo: sha256
                  idp_sso_url: string
                  ignore_unmatched_roles: true
                  issuer: string
                  name: string
                  nameid_format: email
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sso'
                - description: Single sign-on identity provider configuration
                  examples:
                  - created_time: 0
                    custom_logout_url: string
                    default_role: string
                    domain: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    idp_cert: string
                    idp_sign_algo: sha256
                    idp_sso_url: string
                    ignore_unmatched_roles: true
                    issuer: string
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    nameid_format: email
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    custom_logout_url: string
                    default_role: string
                    domain: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    idp_cert: string
                    idp_sign_algo: sha256
                    idp_sso_url: string
                    ignore_unmatched_roles: true
                    issuer: string
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    nameid_format: email
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: string
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sso'
                - description: Single sign-on identity provider configuration
                  examples:
                  - created_time: 0
                    custom_logout_url: string
                    default_role: string
                    domain: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    idp_cert: string
                    idp_sign_algo: sha256
                    idp_sso_url: string
                    ignore_unmatched_roles: true
                    issuer: string
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    nameid_format: email
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    custom_logout_url: string
                    default_role: string
                    domain: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    idp_cert: string
                    idp_sign_algo: sha256
                    idp_sso_url: string
                    ignore_unmatched_roles: true
                    issuer: string
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    nameid_format: email
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/ssos/{sso_id}:
    delete:
      tags:
      - Orgs SSO
      summary: deleteOrgSso
      description: Delete an organization SSO identity provider configuration so it can no longer be used for administrator login.
      operationId: deleteOrgSso
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: sso_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs SSO
      summary: getOrgSso
      description: Return one organization SSO identity provider configuration, including provider settings and generated SSO URLs.
      operationId: getOrgSso
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: sso_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sso'
                - description: Single sign-on identity provider configuration
                  examples:
                  - created_time: 0
                    custom_logout_url: string
                    default_role: string
                    domain: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    idp_cert: string
                    idp_sign_algo: sha256
                    idp_sso_url: string
                    ignore_unmatched_roles: true
                    issuer: string
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    nameid_format: email
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    custom_logout_url: string
                    default_role: string
                    domain: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    idp_cert: string
                    idp_sign_algo: sha256
                    idp_sso_url: string
                    ignore_unmatched_roles: true
                    issuer: string
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    nameid_format: email
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: string
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sso'
                - description: Single sign-on identity provider configuration
                  examples:
                  - created_time: 0
                    custom_logout_url: string
                    default_role: string
                    domain: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    idp_cert: string
                    idp_sign_algo: sha256
                    idp_sso_url: string
                    ignore_unmatched_roles: true
                    issuer: string
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    nameid_format: email
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    custom_logout_url: string
                    default_role: string
                    domain: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    idp_cert: string
                    idp_sign_algo: sha256
                    idp_sso_url: string
                    ignore_unmatched_roles: true
                    issuer: string
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    nameid_format: email
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs SSO
      summary: updateOrgSso
      description: Update an organization SSO identity provider configuration, such as IdP URLs, certificates, issuer, NameID format, and unmatched-role handling.
      operationId: updateOrgSso
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: sso_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/sso'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sso'
                - description: Single sign-on identity provider configuration
                  examples:
                  - created_time: 0
                    custom_logout_url: string
                    default_role: string
                    domain: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    idp_cert: string
                    idp_sign_algo: sha256
                    idp_sso_url: string
                    ignore_unmatched_roles: true
                    issuer: string
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    nameid_format: email
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    custom_logout_url: string
                    default_role: string
                    domain: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    idp_cert: string
                    idp_sign_algo: sha256
                    idp_sso_url: string
                    ignore_unmatched_roles: true
                    issuer: string
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    nameid_format: email
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: string
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sso'
                - description: Single sign-on identity provider configuration
                  examples:
                  - created_time: 0
                    custom_logout_url: string
                    default_role: string
                    domain: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    idp_cert: string
                    idp_sign_algo: sha256
                    idp_sso_url: string
                    ignore_unmatched_roles: true
                    issuer: string
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    nameid_format: email
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    custom_logout_url: string
                    default_role: string
                    domain: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    idp_cert: string
                    idp_sign_algo: sha256
                    idp_sso_url: string
                    ignore_unmatched_roles: true
                    issuer: string
                    modified_time: 0
                    msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    nameid_format: email
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/ssos/{sso_id}/delete_admins:
    post:
      tags:
      - Orgs SSO
      summary: deleteOrgSsoAdmins
      description: Remove SSO-linked organization administrator accounts by email for this SSO profile.
      operationId: deleteOrgSsoAdmins
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: sso_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/sso_delete_admins'
              - description: Request Body
                examples:
                - emails:
                  - john@abc.com
                  - may@abc.com
              contentMediaType: application/json
            examples:
              Example:
                value:
                  emails:
                  - john@abc.com
                  - may@abc.com
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sso_delete_admins_response'
                - description: Result of deleting SSO admin accounts
                contentMediaType: application/json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/ssos/{sso_id}/failures:
    get:
      tags:
      - Orgs SSO
      summary: listOrgSsoLatestFailures
      description: List recent authentication failures for this organization SSO configuration, including failure details and captured SAML assertion data when available.
      operationId: listOrgSsoLatestFailures
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: sso_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_sso_failure_search'
                - description: Response containing recent SSO authentication failure records
                  examples:
                  - results:
                    - detail: string
                      saml_assertion_xml: string
                      timestamp: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    results:
                    - detail: string
                      saml_assertion_xml: string
                      timestamp: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_sso_failure_search'
                - description: Response containing recent SSO authentication failure records
                  examples:
                  - results:
                    - detail: string
                      saml_assertion_xml: string
                      timestamp: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    results:
                    - detail: string
                      saml_assertion_xml: string
                      timestamp: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/ssos/{sso_id}/metadata:
    get:
      tags:
      - Orgs SSO
      summary: getOrgSamlMetadata
      description: Return generated SAML service provider metadata for this organization SSO configuration as JSON.
      operationId: getOrgSamlMetadata
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: sso_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/saml_metadata'
                - description: Read-only SAML and SCIM metadata generated for an SSO configuration
                  examples:
                  - acs_url: https://api.mist.com/api/v1/saml/llDfa13f/login
                    entity_id: https://api.mist.com/api/v1/saml/llDfa13f/login
                    logout_url: https://api.mist.com/api/v1/saml/llDfa13f/logout
                    metadata: <?xml version="1.0" encoding="UTF-8"?><md:EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" entityID="https://api.mist.com/api/v1/saml/llDfa13f/login" validUntil="2027-10-12T21:59:01Z" xmlns:ds="http://www.w3.org/2000/09/xmldsig#"><md:SPSSODescriptor AuthnRequestsSigned="false" WantAssertionsSigned="true" protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol"><md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</md:NameIDFormat><md:AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://api.mist.com/api/v1/saml/llDfa13f/login" index="0" isDefault="true"/></md:SPSSODescriptor></md:EntityDescriptor>
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    acs_url: https://api.mist.com/api/v1/saml/llDfa13f/login
                    entity_id: https://api.mist.com/api/v1/saml/llDfa13f/login
                    logout_url: https://api.mist.com/api/v1/saml/llDfa13f/logout
                    metadata: <?xml version="1.0" encoding="UTF-8"?><md:EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" entityID="https://api.mist.com/api/v1/saml/llDfa13f/login" validUntil="2027-10-12T21:59:01Z" xmlns:ds="http://www.w3.org/2000/09/xmldsig#"><md:SPSSODescriptor AuthnRequestsSigned="false" WantAssertionsSigned="true" protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol"><md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</md:NameIDFormat><md:AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://api.mist.com/api/v1/saml/llDfa13f/login" index="0" isDefault="true"/></md:SPSSODescriptor></md:EntityDescriptor>
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/saml_metadata'
                - description: Read-only SAML and SCIM metadata generated for an SSO configuration
                  examples:
                  - acs_url: https://api.mist.com/api/v1/saml/llDfa13f/login
                    entity_id: https://api.mist.com/api/v1/saml/llDfa13f/login
                    logout_url: https://api.mist.com/api/v1/saml/llDfa13f/logout
                    metadata: <?xml version="1.0" encoding="UTF-8"?><md:EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" entityID="https://api.mist.com/api/v1/saml/llDfa13f/login" validUntil="2027-10-12T21:59:01Z" xmlns:ds="http://www.w3.org/2000/09/xmldsig#"><md:SPSSODescriptor AuthnRequestsSigned="false" WantAssertionsSigned="true" protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol"><md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</md:NameIDFormat><md:AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://api.mist.com/api/v1/saml/llDfa13f/login" index="0" isDefault="true"/></md:SPSSODescriptor></md:EntityDescriptor>
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    acs_url: https://api.mist.com/api/v1/saml/llDfa13f/login
                    entity_id: https://api.mist.com/api/v1/saml/llDfa13f/login
                    logout_url: https://api.mist.com/api/v1/saml/llDfa13f/logout
                    metadata: <?xml version="1.0" encoding="UTF-8"?><md:EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" entityID="https://api.mist.com/api/v1/saml/llDfa13f/login" validUntil="2027-10-12T21:59:01Z" xmlns:ds="http://www.w3.org/2000/09/xmldsig#"><md:SPSSODescriptor AuthnRequestsSigned="false" WantAssertionsSigned="true" protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol"><md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</md:NameIDFormat><md:AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://api.mist.com/api/v1/saml/llDfa13f/login" index="0" isDefault="true"/></md:SPSSODescriptor></md:EntityDescriptor>
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/ssos/{sso_id}/metadata.xml:
    get:
      tags:
      - Orgs SSO
      summary: downloadOrgSamlMetadata
      description: >-
        Download generated SAML service provider metadata XML for this

        organization SSO configuration. Use this XML to configure the identity provider

        with Mist service-provider details such as entity ID, ACS URL, logout URL,

        NameID format, and requested attributes.



        Example of metadata.xml:

        ```xml

        <?xml version=\"1.0\" encoding=\"UTF-8\"?><md:EntityDescriptor xmlns:md=\"urn:oasis:names:tc:SAML:2.0:metadata\" entityID=\"https://api.mist.com/api/v1/saml/5hdF5g/login\"\ validUntil=\"2027-10-12T21:59:01Z\" xmlns:ds=\"http://www.w3.org/2000/09/xmldsig#\">
            <md:SPSSODescriptor AuthnRequestsSigned=\"false\" WantAssertionsSigned=\"true\" protocolSupportEnumeration=\"urn:oasis:names:tc:SAML:2.0:protocol\">
                <md:SingleLogoutService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST\"\ Location=\"https://api.mist.com/api/v1/saml/5hdF5g/logout\" />
                <md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</md:NameIDFormat>
                <md:AssertionConsumerService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST\"\ Location=\"https://api.mist.com/api/v1/saml/5hdF5g/login\" index=\"0\" isDefault=\"true\"/>
                <md:AttributeConsumingService index=\"0\">
                    <md:ServiceName xml:lang=\"en-US\">Mist</md:ServiceName>
                    <md:RequestedAttribute\ Name=\"Role\" NameFormat=\"urn:oasis:names:tc:SAML:2.0:attrname-format:basic\"\ isRequired=\"true\"/>
                    <md:RequestedAttribute Name=\"FirstName\"\ NameFormat=\"urn:oasis:names:tc:SAML:2.0:attrname-format:basic\" isRequired=\"false\"/>
                    <md:RequestedAttribute Name=\"LastName\" NameFormat=\"urn:oasis:names:tc:SAML:2.0:attrname-format:basic\" isRequired=\"false\"/>
                </md:AttributeConsumingService>
            </md:SPSSODescriptor>
        </md:EntityDescriptor>

        ```
      operationId: downloadOrgSamlMetadata
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: sso_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: string
                description: File
                contentEncoding: base64
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                type: string
                description: File
                contentEncoding: base64
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/templates:
    get:
      tags:
      - Orgs WLAN Templates
      summary: listOrgTemplates
      description: Get List of Org WLAN Templates
      operationId: listOrgTemplates
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/template'
                description: WLAN template records returned by a template list response
                examples:
                - - 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
                contentMediaType: application/json
              examples:
                Example:
                  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
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/template'
                description: WLAN template records returned by a template list response
                examples:
                - - 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
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  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
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs WLAN Templates
      summary: createOrgTemplate
      description: Create Org Template
      operationId: createOrgTemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/template'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/template'
                - description: WLAN template configuration applied across sites or site groups
                  examples:
                  - 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
                contentMediaType: application/json
              examples:
                Example:
                  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
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/template'
                - description: WLAN template configuration applied across sites or site groups
                  examples:
                  - 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
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  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
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/templates/{template_id}:
    delete:
      tags:
      - Orgs WLAN Templates
      summary: deleteOrgTemplate
      description: Delete Org Template
      operationId: deleteOrgTemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: template_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs WLAN Templates
      summary: getOrgTemplate
      description: Get Org Template Details
      operationId: getOrgTemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: template_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/template'
                - description: WLAN template configuration applied across sites or site groups
                  examples:
                  - 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
                contentMediaType: application/json
              examples:
                Example:
                  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
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/template'
                - description: WLAN template configuration applied across sites or site groups
                  examples:
                  - 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
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  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
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs WLAN Templates
      summary: updateOrgTemplate
      description: Update Org Template
      operationId: updateOrgTemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: template_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/template'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/template'
                - description: WLAN template configuration applied across sites or site groups
                  examples:
                  - 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
                contentMediaType: application/json
              examples:
                Example:
                  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
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/template'
                - description: WLAN template configuration applied across sites or site groups
                  examples:
                  - 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
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  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
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/templates/{template_id}/clone:
    post:
      tags:
      - Orgs WLAN Templates
      summary: cloneOrgTemplate
      description: Clone Org Template
      operationId: cloneOrgTemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: template_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/name_string'
              - description: Request Body
                examples:
                - name: Cloned
              contentMediaType: application/json
            examples:
              Example:
                value:
                  name: Cloned
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/template'
                - description: WLAN template configuration applied across sites or site groups
                  examples:
                  - 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
                contentMediaType: application/json
              examples:
                Example:
                  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
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/template'
                - description: WLAN template configuration applied across sites or site groups
                  examples:
                  - 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
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  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
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/tickets:
    get:
      tags:
      - Orgs Tickets
      summary: listOrgTickets
      description: Get List of Tickets of an Org
      operationId: listOrgTickets
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ticket'
                description: Support ticket records returned by a ticket list response
                examples:
                - - comments:
                    - attachments:
                      - content_type: string
                        content_url: string
                      author: string
                      comment: string
                      created_at: 0
                    created_at: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    requester: string
                    status: open
                    subject: string
                    type: string
                    updated_at: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - comments:
                    - attachments:
                      - content_type: string
                        content_url: string
                      author: string
                      comment: string
                      created_at: 0
                    created_at: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    requester: string
                    status: open
                    subject: string
                    type: string
                    updated_at: 0
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ticket'
                description: Support ticket records returned by a ticket list response
                examples:
                - - comments:
                    - attachments:
                      - content_type: string
                        content_url: string
                      author: string
                      comment: string
                      created_at: 0
                    created_at: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    requester: string
                    status: open
                    subject: string
                    type: string
                    updated_at: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - comments:
                    - attachments:
                      - content_type: string
                        content_url: string
                      author: string
                      comment: string
                      created_at: 0
                    created_at: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    requester: string
                    status: open
                    subject: string
                    type: string
                    updated_at: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs Tickets
      summary: createOrgTicket
      description: Create a support ticket
      operationId: createOrgTicket
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ticket'
              - description: Request Body
                examples:
                - comment: string
                  subject: string
                  type: question
              contentMediaType: application/json
            examples:
              Example:
                value:
                  comment: string
                  subject: string
                  type: question
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ticket'
                - description: Support ticket record with status, comments, and metadata
                  examples:
                  - comments:
                    - attachments:
                      - content_type: string
                        content_url: string
                      author: string
                      comment: string
                      created_at: 0
                    created_at: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    requester: string
                    status: open
                    subject: string
                    type: string
                    updated_at: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    comments:
                    - attachments:
                      - content_type: string
                        content_url: string
                      author: string
                      comment: string
                      created_at: 0
                    created_at: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    requester: string
                    status: open
                    subject: string
                    type: string
                    updated_at: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ticket'
                - description: Support ticket record with status, comments, and metadata
                  examples:
                  - comments:
                    - attachments:
                      - content_type: string
                        content_url: string
                      author: string
                      comment: string
                      created_at: 0
                    created_at: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    requester: string
                    status: open
                    subject: string
                    type: string
                    updated_at: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    comments:
                    - attachments:
                      - content_type: string
                        content_url: string
                      author: string
                      comment: string
                      created_at: 0
                    created_at: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    requester: string
                    status: open
                    subject: string
                    type: string
                    updated_at: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/tickets/count:
    get:
      tags:
      - Orgs Tickets
      summary: countOrgTickets
      description: Count by Distinct Attributes of Org Tickets
      operationId: countOrgTickets
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `status`, `type`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/org_tickets_count_distinct'
          - description: 'Field used to group this count response. enum: `status`, `type`'
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/tickets/{ticket_id}:
    get:
      tags:
      - Orgs Tickets
      summary: getOrgTicket
      description: Get support ticket details
      operationId: getOrgTicket
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: ticket_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ticket'
                - description: Support ticket record with status, comments, and metadata
                  examples:
                  - comments:
                    - attachments:
                      - content_type: string
                        content_url: string
                      author: string
                      comment: string
                      created_at: 0
                    created_at: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    requester: string
                    status: open
                    subject: string
                    type: string
                    updated_at: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    comments:
                    - attachments:
                      - content_type: string
                        content_url: string
                      author: string
                      comment: string
                      created_at: 0
                    created_at: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    requester: string
                    status: open
                    subject: string
                    type: string
                    updated_at: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ticket'
                - description: Support ticket record with status, comments, and metadata
                  examples:
                  - comments:
                    - attachments:
                      - content_type: string
                        content_url: string
                      author: string
                      comment: string
                      created_at: 0
                    created_at: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    requester: string
                    status: open
                    subject: string
                    type: string
                    updated_at: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    comments:
                    - attachments:
                      - content_type: string
                        content_url: string
                      author: string
                      comment: string
                      created_at: 0
                    created_at: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    requester: string
                    status: open
                    subject: string
                    type: string
                    updated_at: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs Tickets
      summary: updateOrgTicket
      description: Update support ticket
      operationId: updateOrgTicket
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: ticket_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ticket'
              - description: Request Body
                examples:
                - comment: string
                  subject: string
                  type: question
              contentMediaType: application/json
            examples:
              Example:
                value:
                  comment: string
                  subject: string
                  type: question
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ticket'
                - description: Support ticket record with status, comments, and metadata
                  examples:
                  - comments:
                    - attachments:
                      - content_type: string
                        content_url: string
                      author: string
                      comment: string
                      created_at: 0
                    created_at: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    requester: string
                    status: open
                    subject: string
                    type: string
                    updated_at: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    comments:
                    - attachments:
                      - content_type: string
                        content_url: string
                      author: string
                      comment: string
                      created_at: 0
                    created_at: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    requester: string
                    status: open
                    subject: string
                    type: string
                    updated_at: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ticket'
                - description: Support ticket record with status, comments, and metadata
                  examples:
                  - comments:
                    - attachments:
                      - content_type: string
                        content_url: string
                      author: string
                      comment: string
                      created_at: 0
                    created_at: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    requester: string
                    status: open
                    subject: string
                    type: string
                    updated_at: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    comments:
                    - attachments:
                      - content_type: string
                        content_url: string
                      author: string
                      comment: string
                      created_at: 0
                    created_at: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    requester: string
                    status: open
                    subject: string
                    type: string
                    updated_at: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/tickets/{ticket_id}/attachments:
    post:
      tags:
      - Orgs Tickets
      summary: UploadOrgTicketAttachment
      description: Get Org ticket Attachment
      operationId: UploadOrgTicketAttachment
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: ticket_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              type: object
              properties:
                file:
                  type: string
                  description: Ekahau or ibwave file
                  contentEncoding: base64
              contentMediaType: multipart/form-data
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/tickets/{ticket_id}/attachments/{attachment_id}:
    get:
      tags:
      - Orgs Tickets
      summary: GetOrgTicketAttachment
      description: Get Org ticket Attachment
      operationId: GetOrgTicketAttachment
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: ticket_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: attachment_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ticket_attachment'
                - description: Download information for a support ticket attachment
                  examples:
                  - content_url: https://api.mist.com/api/v1/forward/download?jwt=...
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    content_url: https://api.mist.com/api/v1/forward/download?jwt=...
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ticket_attachment'
                - description: Download information for a support ticket attachment
                  examples:
                  - content_url: https://api.mist.com/api/v1/forward/download?jwt=...
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    content_url: https://api.mist.com/api/v1/forward/download?jwt=...
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/tickets/{ticket_id}/comments:
    post:
      tags:
      - Orgs Tickets
      summary: addOrgTicketComment
      description: Add Comment to support ticket
      operationId: addOrgTicketComment
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: ticket_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              type: object
              properties:
                comment:
                  type: string
                  description: Text body for the ticket comment submitted with the uploaded file
                  examples:
                  - this is urgent
                file:
                  type: string
                  description: Binary file payload to attach to the ticket comment
                  contentEncoding: base64
              contentMediaType: multipart/form-data
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ticket'
                - description: Support ticket record with status, comments, and metadata
                  examples:
                  - comments:
                    - attachments:
                      - content_type: string
                        content_url: string
                      author: string
                      comment: string
                      created_at: 0
                    created_at: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    requester: string
                    status: open
                    subject: string
                    type: string
                    updated_at: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    comments:
                    - attachments:
                      - content_type: string
                        content_url: string
                      author: string
                      comment: string
                      created_at: 0
                    created_at: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    requester: string
                    status: open
                    subject: string
                    type: string
                    updated_at: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ticket'
                - description: Support ticket record with status, comments, and metadata
                  examples:
                  - comments:
                    - attachments:
                      - content_type: string
                        content_url: string
                      author: string
                      comment: string
                      created_at: 0
                    created_at: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    requester: string
                    status: open
                    subject: string
                    type: string
                    updated_at: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    comments:
                    - attachments:
                      - content_type: string
                        content_url: string
                      author: string
                      comment: string
                      created_at: 0
                    created_at: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    requester: string
                    status: open
                    subject: string
                    type: string
                    updated_at: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/usermacs:
    post:
      tags:
      - Orgs User MACs
      summary: createOrgUserMac
      description: "Create Org User MACs\n\n### Usermacs import CSV file format\nmac,labels,vlan,notes \n921b638445cd,\"bldg1,flor1\",vlan-100 \n721b638445ef,\"bldg2,flor2\",vlan-101,Canon Printers \n721b638445ee,\"bldg3,flor3\",vlan-102 \n921b638445ce,\"bldg4,flor4\",vlan-103 \n921b638445cf,\"bldg5,flor5\",vlan-104"
      operationId: createOrgUserMac
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/user_mac'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/user_mac'
                - description: Organization user MAC entry
                  examples:
                  - id: 111cafd2-ba1b-5169-bfcb-9cdf1d473ddb
                    labels:
                    - flor1
                    - bld4
                    mac: 921b638445cd
                    notes: MAC address refers to Canon printers
                    site_ids:
                    - 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    - 52f4347e-3e4b-186c-21ca-ad5b70eb23d6
                    vlan: '30'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    id: 111cafd2-ba1b-5169-bfcb-9cdf1d473ddb
                    labels:
                    - flor1
                    - bld4
                    mac: 921b638445cd
                    notes: MAC address refers to Canon printers
                    site_ids:
                    - 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    - 52f4347e-3e4b-186c-21ca-ad5b70eb23d6
                    vlan: '30'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/user_mac'
                - description: Organization user MAC entry
                  examples:
                  - id: 111cafd2-ba1b-5169-bfcb-9cdf1d473ddb
                    labels:
                    - flor1
                    - bld4
                    mac: 921b638445cd
                    notes: MAC address refers to Canon printers
                    site_ids:
                    - 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    - 52f4347e-3e4b-186c-21ca-ad5b70eb23d6
                    vlan: '30'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    id: 111cafd2-ba1b-5169-bfcb-9cdf1d473ddb
                    labels:
                    - flor1
                    - bld4
                    mac: 921b638445cd
                    notes: MAC address refers to Canon printers
                    site_ids:
                    - 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    - 52f4347e-3e4b-186c-21ca-ad5b70eb23d6
                    vlan: '30'
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs User MACs
      summary: updateOrgMultipleUserMacs
      description: Update Multiple Org User MACs. Accepts a JSON array of user MAC objects where `id` is required for each entry.
      operationId: updateOrgMultipleUserMacs
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/user_mac'
              description: ''
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/user_macs_update'
                - description: Result of a bulk user MAC update
                  examples:
                  - '{"detail":"batch update in progress"}'
                  - '{"errors":["2feacc8e-5893-418a-acaa-4d7c1afd01fe - invalid id"],"updated":["1041c16c-ca87-4d3f-bb94-b97c5819fc09","a016cc8e-5893-418a-acaa-4d7c1af6ac0f"]}'
                contentMediaType: application/json
              examples:
                Async:
                  value:
                    detail: batch update in progress
                Sync:
                  value:
                    errors:
                    - 2feacc8e-5893-418a-acaa-4d7c1afd01fe - invalid id
                    updated:
                    - 1041c16c-ca87-4d3f-bb94-b97c5819fc09
                    - a016cc8e-5893-418a-acaa-4d7c1af6ac0f
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/user_macs_update'
                - description: Result of a bulk user MAC update
                  examples:
                  - '{"detail":"batch update in progress"}'
                  - '{"errors":["2feacc8e-5893-418a-acaa-4d7c1afd01fe - invalid id"],"updated":["1041c16c-ca87-4d3f-bb94-b97c5819fc09","a016cc8e-5893-418a-acaa-4d7c1af6ac0f"]}'
                contentMediaType: application/vnd.api+json
              examples:
                Async:
                  value:
                    detail: batch update in progress
                Sync:
                  value:
                    errors:
                    - 2feacc8e-5893-418a-acaa-4d7c1afd01fe - invalid id
                    updated:
                    - 1041c16c-ca87-4d3f-bb94-b97c5819fc09
                    - a016cc8e-5893-418a-acaa-4d7c1af6ac0f
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/usermacs/count:
    get:
      tags:
      - Orgs User MACs
      summary: countOrgUserMacs
      description: Count by Distinct Attributes of User MACs
      operationId: countOrgUserMacs
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Attribute to count by. enum: `mac`, `name`, `labels`, `org_id`'
        required: true
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/count_usermac_distinct'
          - description: 'Attribute to count by. enum: `mac`, `name`, `labels`, `org_id`'
            examples:
            - org_id
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/user_macs_count'
                - description: User MACs count response
                  examples:
                  - end: 1723651268
                    limit: 10
                    results:
                    - id: 111cafd2-ba1b-5169-bfcb-9cdf1d473ddb
                      labels:
                      - flor1
                      - bld4
                      mac: 921b638445cd
                      name: Printer2
                      notes: mac address refers to Canon printers
                      radius_group: VIP
                      site_ids:
                      - 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      - 52f4347e-3e4b-186c-21ca-ad5b70eb23d6
                      vlan: '30'
                    - id: abecafd2-ba1b-5169-bfcb-9cdf1d473123
                      labels:
                      - blgd-cupe
                      - old
                      mac: 921b638445ce
                      name: os mac
                      notes: mac devices
                      radius_group: rg-1
                      vlan: vlan-2
                    start: 1723651267
                    total: 2
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1723651268
                    limit: 10
                    results:
                    - id: 111cafd2-ba1b-5169-bfcb-9cdf1d473ddb
                      labels:
                      - flor1
                      - bld4
                      mac: 921b638445cd
                      name: Printer2
                      notes: mac address refers to Canon printers
                      radius_group: VIP
                      site_ids:
                      - 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      - 52f4347e-3e4b-186c-21ca-ad5b70eb23d6
                      vlan: '30'
                    - id: abecafd2-ba1b-5169-bfcb-9cdf1d473123
                      labels:
                      - blgd-cupe
                      - old
                      mac: 921b638445ce
                      name: os mac
                      notes: mac devices
                      radius_group: rg-1
                      vlan: vlan-2
                    start: 1723651267
                    total: 2
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/user_macs_count'
                - description: User MACs count response
                  examples:
                  - end: 1723651268
                    limit: 10
                    results:
                    - id: 111cafd2-ba1b-5169-bfcb-9cdf1d473ddb
                      labels:
                      - flor1
                      - bld4
                      mac: 921b638445cd
                      name: Printer2
                      notes: mac address refers to Canon printers
                      radius_group: VIP
                      site_ids:
                      - 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      - 52f4347e-3e4b-186c-21ca-ad5b70eb23d6
                      vlan: '30'
                    - id: abecafd2-ba1b-5169-bfcb-9cdf1d473123
                      labels:
                      - blgd-cupe
                      - old
                      mac: 921b638445ce
                      name: os mac
                      notes: mac devices
                      radius_group: rg-1
                      vlan: vlan-2
                    start: 1723651267
                    total: 2
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1723651268
                    limit: 10
                    results:
                    - id: 111cafd2-ba1b-5169-bfcb-9cdf1d473ddb
                      labels:
                      - flor1
                      - bld4
                      mac: 921b638445cd
                      name: Printer2
                      notes: mac address refers to Canon printers
                      radius_group: VIP
                      site_ids:
                      - 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      - 52f4347e-3e4b-186c-21ca-ad5b70eb23d6
                      vlan: '30'
                    - id: abecafd2-ba1b-5169-bfcb-9cdf1d473123
                      labels:
                      - blgd-cupe
                      - old
                      mac: 921b638445ce
                      name: os mac
                      notes: mac devices
                      radius_group: rg-1
                      vlan: vlan-2
                    start: 1723651267
                    total: 2
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/usermacs/delete:
    post:
      tags:
      - Orgs User MACs
      summary: deleteOrgMultipleUserMacs
      description: Delete Multiple Org User MACs
      operationId: deleteOrgMultipleUserMacs
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/usermacs_id'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/usermacs/import:
    post:
      tags:
      - Orgs User MACs
      summary: importOrgUserMacs
      description: >-
        Import Org User MACs. Accepts JSON or CSV upload.


        **JSON — Array form** (asynchronous by default):

        ```json

        [
          {"mac": "921b638445cd", "labels": ["label1"], "vlan": "vlan-1"},
          {"mac": "721b638445ef", "labels": ["label2", "label3"], "notes": "mac address refers to Canon printers"}
        ]

        ```


        **CSV upload**: multipart/form-data with `file` field.


        ### CSV file format

        ```csv

        mac,labels,vlan,notes,name,radius_group

        921b638445cd,"bldg1,flor1",vlan-100

        721b638445ef,"bldg2,flor2",vlan-101,Canon Printers

        721b638445ee,"bldg3,flor3",vlan-102,Printer2,VIP

        921b638445ce,"bldg4,flor4",vlan-103

        921b638445cf,"bldg5,flor5",vlan-104

        ```
      operationId: importOrgUserMacs
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              required:
              - file
              type: object
              properties:
                file:
                  type: string
                  description: CSV file containing user MAC entries to import
                  contentEncoding: base64
              contentMediaType: multipart/form-data
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/user_mac_import'
                - description: Result of importing user MAC entries
                  examples:
                  - '{"detail":"import in progress"}'
                  - '{"added":["921b638445cd"],"errors":["921b638445ce - mac invalid","921b638445cf - mac already provided"],"updated":["721b638445ef","721b638445ee"]}'
                contentMediaType: application/json
              examples:
                Async:
                  value:
                    detail: import in progress
                Sync:
                  value:
                    added:
                    - 921b638445cd
                    errors:
                    - 921b638445ce - mac invalid
                    - 921b638445cf - mac already provided
                    updated:
                    - 721b638445ef
                    - 721b638445ee
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/user_mac_import'
                - description: Result of importing user MAC entries
                  examples:
                  - '{"detail":"import in progress"}'
                  - '{"added":["921b638445cd"],"errors":["921b638445ce - mac invalid","921b638445cf - mac already provided"],"updated":["721b638445ef","721b638445ee"]}'
                contentMediaType: application/vnd.api+json
              examples:
                Async:
                  value:
                    detail: import in progress
                Sync:
                  value:
                    added:
                    - 921b638445cd
                    errors:
                    - 921b638445ce - mac invalid
                    - 921b638445cf - mac already provided
                    updated:
                    - 721b638445ef
                    - 721b638445ee
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/usermacs/search:
    get:
      tags:
      - Orgs User MACs
      summary: searchOrgUserMacs
      description: Search Org User MACs
      operationId: searchOrgUserMacs
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mac
        in: query
        description: Partial / full Client MAC address. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `aabbcc*` and `*bbcc*` match `aabbccddeeff`). Suffix-only wildcards (e.g. `*bccddeeff`) are not supported
        style: form
        explode: true
        schema:
          type: string
          examples:
          - aabbccddeeff
          - aabbcc*
          - '*bbcc*'
        examples:
          Untitled Example1:
            value: aabbccddeeff
          Untitled Example2:
            value: aabbcc*
          Untitled Example3:
            value: '*bbcc*'
      - name: labels
        in: query
        description: Optional, array of strings of labels
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/user_mac'
                description: List of user MAC entries
                examples:
                - - id: 111cafd2-ba1b-5169-bfcb-9cdf1d473ddb
                    labels:
                    - flor1
                    - bld4
                    mac: 921b638445cd
                    notes: MAC address refers to Canon printers
                    site_ids:
                    - 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    - 52f4347e-3e4b-186c-21ca-ad5b70eb23d6
                    vlan: '30'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - id: 111cafd2-ba1b-5169-bfcb-9cdf1d473ddb
                    labels:
                    - flor1
                    - bld4
                    mac: 921b638445cd
                    notes: MAC address refers to Canon printers
                    site_ids:
                    - 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    - 52f4347e-3e4b-186c-21ca-ad5b70eb23d6
                    vlan: '30'
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/user_mac'
                description: List of user MAC entries
                examples:
                - - id: 111cafd2-ba1b-5169-bfcb-9cdf1d473ddb
                    labels:
                    - flor1
                    - bld4
                    mac: 921b638445cd
                    notes: MAC address refers to Canon printers
                    site_ids:
                    - 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    - 52f4347e-3e4b-186c-21ca-ad5b70eb23d6
                    vlan: '30'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - id: 111cafd2-ba1b-5169-bfcb-9cdf1d473ddb
                    labels:
                    - flor1
                    - bld4
                    mac: 921b638445cd
                    notes: MAC address refers to Canon printers
                    site_ids:
                    - 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    - 52f4347e-3e4b-186c-21ca-ad5b70eb23d6
                    vlan: '30'
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/usermacs/{usermac_id}:
    delete:
      tags:
      - Orgs User MACs
      summary: deleteOrgUserMac
      description: Delete Org User MAC
      operationId: deleteOrgUserMac
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: usermac_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs User MACs
      summary: getOrgUserMac
      description: Get Org User MAC
      operationId: getOrgUserMac
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: usermac_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/user_mac'
                - description: Organization user MAC entry
                  examples:
                  - id: 111cafd2-ba1b-5169-bfcb-9cdf1d473ddb
                    labels:
                    - flor1
                    - bld4
                    mac: 921b638445cd
                    notes: MAC address refers to Canon printers
                    site_ids:
                    - 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    - 52f4347e-3e4b-186c-21ca-ad5b70eb23d6
                    vlan: '30'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    id: 111cafd2-ba1b-5169-bfcb-9cdf1d473ddb
                    labels:
                    - flor1
                    - bld4
                    mac: 921b638445cd
                    notes: MAC address refers to Canon printers
                    site_ids:
                    - 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    - 52f4347e-3e4b-186c-21ca-ad5b70eb23d6
                    vlan: '30'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/user_mac'
                - description: Organization user MAC entry
                  examples:
                  - id: 111cafd2-ba1b-5169-bfcb-9cdf1d473ddb
                    labels:
                    - flor1
                    - bld4
                    mac: 921b638445cd
                    notes: MAC address refers to Canon printers
                    site_ids:
                    - 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    - 52f4347e-3e4b-186c-21ca-ad5b70eb23d6
                    vlan: '30'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    id: 111cafd2-ba1b-5169-bfcb-9cdf1d473ddb
                    labels:
                    - flor1
                    - bld4
                    mac: 921b638445cd
                    notes: MAC address refers to Canon printers
                    site_ids:
                    - 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    - 52f4347e-3e4b-186c-21ca-ad5b70eb23d6
                    vlan: '30'
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs User MACs
      summary: updateOrgUserMac
      description: Update Org User MAC
      operationId: updateOrgUserMac
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: usermac_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/user_mac'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/user_mac'
                - description: Organization user MAC entry
                  examples:
                  - id: 111cafd2-ba1b-5169-bfcb-9cdf1d473ddb
                    labels:
                    - flor1
                    - bld4
                    mac: 921b638445cd
                    notes: MAC address refers to Canon printers
                    site_ids:
                    - 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    - 52f4347e-3e4b-186c-21ca-ad5b70eb23d6
                    vlan: '30'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    id: 111cafd2-ba1b-5169-bfcb-9cdf1d473ddb
                    labels:
                    - flor1
                    - bld4
                    mac: 921b638445cd
                    notes: MAC address refers to Canon printers
                    site_ids:
                    - 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    - 52f4347e-3e4b-186c-21ca-ad5b70eb23d6
                    vlan: '30'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/user_mac'
                - description: Organization user MAC entry
                  examples:
                  - id: 111cafd2-ba1b-5169-bfcb-9cdf1d473ddb
                    labels:
                    - flor1
                    - bld4
                    mac: 921b638445cd
                    notes: MAC address refers to Canon printers
                    site_ids:
                    - 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    - 52f4347e-3e4b-186c-21ca-ad5b70eb23d6
                    vlan: '30'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    id: 111cafd2-ba1b-5169-bfcb-9cdf1d473ddb
                    labels:
                    - flor1
                    - bld4
                    mac: 921b638445cd
                    notes: MAC address refers to Canon printers
                    site_ids:
                    - 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    - 52f4347e-3e4b-186c-21ca-ad5b70eb23d6
                    vlan: '30'
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/vars/search:
    get:
      tags:
      - Orgs Vars
      summary: searchOrgVars
      description: >-
        Search vars


        Example: /api/v1/orgs/{org_id}/vars/search?vars=*
      operationId: searchOrgVars
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: site_id
        in: query
        description: Filter results by site identifier. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002
      - name: var
        in: query
        description: Filter variable results by variable name. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - guest_end,guest_net
      - name: src
        in: query
        description: 'Filter results by source. enum: `deviceprofile`, `site`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/var_source'
          - description: 'Filter results by source. enum: `deviceprofile`, `site`'
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_search_var'
                - description: Paginated response for organization variable search results
                  examples:
                  - end: 1693952979
                    limit: 10
                    results:
                    - created_time: 1618457655.384858
                      modified_time: 1693610886.477805
                      org_id: 0c160b7f-1027-4cd1-923b-744534c4b070
                      site_id: 1519f016-4e41-47c0-a396-cce4d04bac0b
                      src: site
                      var: mvp
                    start: 1693949379
                    total: 1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1693952979
                    limit: 10
                    results:
                    - created_time: 1618457655.384858
                      modified_time: 1693610886.477805
                      org_id: 0c160b7f-1027-4cd1-923b-744534c4b070
                      site_id: 1519f016-4e41-47c0-a396-cce4d04bac0b
                      src: site
                      var: mvp
                    start: 1693949379
                    total: 1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_search_var'
                - description: Paginated response for organization variable search results
                  examples:
                  - end: 1693952979
                    limit: 10
                    results:
                    - created_time: 1618457655.384858
                      modified_time: 1693610886.477805
                      org_id: 0c160b7f-1027-4cd1-923b-744534c4b070
                      site_id: 1519f016-4e41-47c0-a396-cce4d04bac0b
                      src: site
                      var: mvp
                    start: 1693949379
                    total: 1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1693952979
                    limit: 10
                    results:
                    - created_time: 1618457655.384858
                      modified_time: 1693610886.477805
                      org_id: 0c160b7f-1027-4cd1-923b-744534c4b070
                      site_id: 1519f016-4e41-47c0-a396-cce4d04bac0b
                      src: site
                      var: mvp
                    start: 1693949379
                    total: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/vpns:
    get:
      tags:
      - Orgs VPNs
      summary: listOrgVpns
      description: Get List of Org VPNs
      operationId: listOrgVpns
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/vpn'
                description: VPN records returned by a list response
                examples:
                - - name: string
                    paths:
                      property1:
                        bfd_profile: broadband
                        ip: string
                      property2:
                        bfd_profile: lte
                        ip: string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - name: string
                    paths:
                      property1:
                        bfd_profile: broadband
                        ip: string
                      property2:
                        bfd_profile: lte
                        ip: string
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/vpn'
                description: VPN records returned by a list response
                examples:
                - - name: string
                    paths:
                      property1:
                        bfd_profile: broadband
                        ip: string
                      property2:
                        bfd_profile: lte
                        ip: string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - name: string
                    paths:
                      property1:
                        bfd_profile: broadband
                        ip: string
                      property2:
                        bfd_profile: lte
                        ip: string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs VPNs
      summary: createOrgVpn
      description: Create Org VPN
      operationId: createOrgVpn
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/vpn'
              - examples:
                - name: string
                  paths:
                    property1:
                      bfd_profile: broadband
                      ip: string
                    property2:
                      bfd_profile: lte
                      ip: string
              contentMediaType: application/json
            examples:
              Example:
                value:
                  name: string
                  paths:
                    property1:
                      bfd_profile: broadband
                      ip: string
                    property2:
                      bfd_profile: lte
                      ip: string
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vpn'
                - description: Organization VPN overlay configuration
                  examples:
                  - created_time: 0
                    id: 497f6eca-6276-5009-bfeb-53cbbbba6f1b
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    paths:
                      property1:
                        bfd_profile: broadband
                        ip: string
                      property2:
                        bfd_profile: broadband
                        ip: string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: 497f6eca-6276-5009-bfeb-53cbbbba6f1b
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    paths:
                      property1:
                        bfd_profile: broadband
                        ip: string
                      property2:
                        bfd_profile: broadband
                        ip: string
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vpn'
                - description: Organization VPN overlay configuration
                  examples:
                  - created_time: 0
                    id: 497f6eca-6276-5009-bfeb-53cbbbba6f1b
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    paths:
                      property1:
                        bfd_profile: broadband
                        ip: string
                      property2:
                        bfd_profile: broadband
                        ip: string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: 497f6eca-6276-5009-bfeb-53cbbbba6f1b
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    paths:
                      property1:
                        bfd_profile: broadband
                        ip: string
                      property2:
                        bfd_profile: broadband
                        ip: string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/vpns/{vpn_id}:
    delete:
      tags:
      - Orgs VPNs
      summary: deleteOrgVpn
      description: Delete Org Vpn
      operationId: deleteOrgVpn
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: vpn_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs VPNs
      summary: getOrgVpn
      description: Get Org Vpn
      operationId: getOrgVpn
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: vpn_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vpn'
                - description: Organization VPN overlay configuration
                  examples:
                  - created_time: 0
                    id: 497f6eca-6276-5009-bfeb-53cbbbba6f1b
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    paths:
                      property1:
                        bfd_profile: broadband
                        ip: string
                      property2:
                        bfd_profile: broadband
                        ip: string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: 497f6eca-6276-5009-bfeb-53cbbbba6f1b
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    paths:
                      property1:
                        bfd_profile: broadband
                        ip: string
                      property2:
                        bfd_profile: broadband
                        ip: string
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vpn'
                - description: Organization VPN overlay configuration
                  examples:
                  - created_time: 0
                    id: 497f6eca-6276-5009-bfeb-53cbbbba6f1b
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    paths:
                      property1:
                        bfd_profile: broadband
                        ip: string
                      property2:
                        bfd_profile: broadband
                        ip: string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: 497f6eca-6276-5009-bfeb-53cbbbba6f1b
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    paths:
                      property1:
                        bfd_profile: broadband
                        ip: string
                      property2:
                        bfd_profile: broadband
                        ip: string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs VPNs
      summary: updateOrgVpn
      description: Update Org Vpn
      operationId: updateOrgVpn
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: vpn_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/vpn'
              - examples:
                - name: string
                  paths:
                    property1:
                      bfd_profile: broadband
                      ip: string
                    property2:
                      bfd_profile: broadband
                      ip: string
              contentMediaType: application/json
            examples:
              Example:
                value:
                  name: string
                  paths:
                    property1:
                      bfd_profile: broadband
                      ip: string
                    property2:
                      bfd_profile: broadband
                      ip: string
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vpn'
                - description: Organization VPN overlay configuration
                  examples:
                  - created_time: 0
                    id: 497f6eca-6276-5009-bfeb-53cbbbba6f1b
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    paths:
                      property1:
                        bfd_profile: broadband
                        ip: string
                      property2:
                        bfd_profile: broadband
                        ip: string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: 497f6eca-6276-5009-bfeb-53cbbbba6f1b
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    paths:
                      property1:
                        bfd_profile: broadband
                        ip: string
                      property2:
                        bfd_profile: broadband
                        ip: string
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vpn'
                - description: Organization VPN overlay configuration
                  examples:
                  - created_time: 0
                    id: 497f6eca-6276-5009-bfeb-53cbbbba6f1b
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    paths:
                      property1:
                        bfd_profile: broadband
                        ip: string
                      property2:
                        bfd_profile: broadband
                        ip: string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: 497f6eca-6276-5009-bfeb-53cbbbba6f1b
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    paths:
                      property1:
                        bfd_profile: broadband
                        ip: string
                      property2:
                        bfd_profile: broadband
                        ip: string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/webhooks:
    get:
      tags:
      - Orgs Webhooks
      summary: listOrgWebhooks
      description: Get List of Org Webhooks
      operationId: listOrgWebhooks
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/webhook'
                description: Webhook configuration records returned by a list response
                examples:
                - - created_time: 0
                    enabled: true
                    headers: {}
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    splunk_token: string
                    topics:
                    - location
                    type: http-post
                    url: string
                    verify_cert: true
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 0
                    enabled: true
                    headers: {}
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    splunk_token: string
                    topics:
                    - location
                    type: http-post
                    url: string
                    verify_cert: true
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/webhook'
                description: Webhook configuration records returned by a list response
                examples:
                - - created_time: 0
                    enabled: true
                    headers: {}
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    splunk_token: string
                    topics:
                    - location
                    type: http-post
                    url: string
                    verify_cert: true
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 0
                    enabled: true
                    headers: {}
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    splunk_token: string
                    topics:
                    - location
                    type: http-post
                    url: string
                    verify_cert: true
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs Webhooks
      summary: createOrgWebhook
      description: "**N.B**. For org webhooks, only alarms/audits/client-info/client-join/client-sessions/device_events/device-updowns/mxedge_events Infrastructure topics are supported.\n\n\nWebhook defines a webhook, modeled after [github\\u2019s model](https://developer.github.com/webhooks/).\n\n\nThere is two types of webhooks:\n* webhooks ([examples](https://www.postman.com/juniper-mist/workspace/mist-systems-s-public-workspace/folder/224925-be01e694-7253-4195-8563-78e2a745e114))        \n* raw data webhooks ([examples](https://www.postman.com/juniper-mist/workspace/mist-systems-s-public-workspace/folder/224925-e2d5d5f8-4bdb-4efc-93e4-90f4b33d0b2b))\n\n\n##### Webhooks\nWebhooks can be configured at the org level (subset of topics only) and at the site level. It is possible to have multiple topics in the same webhook configuration and/or to have multiple webhooks configured at the same time.\n"
      operationId: createOrgWebhook
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/webhook'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/webhook'
                - description: Webhook configuration for delivering selected Mist events to an external destination
                  examples:
                  - created_time: 0
                    enabled: true
                    headers: {}
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    splunk_token: string
                    topics:
                    - location
                    type: http-post
                    url: string
                    verify_cert: true
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    enabled: true
                    headers: {}
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    splunk_token: string
                    topics:
                    - location
                    type: http-post
                    url: string
                    verify_cert: true
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/webhook'
                - description: Webhook configuration for delivering selected Mist events to an external destination
                  examples:
                  - created_time: 0
                    enabled: true
                    headers: {}
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    splunk_token: string
                    topics:
                    - location
                    type: http-post
                    url: string
                    verify_cert: true
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    enabled: true
                    headers: {}
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    splunk_token: string
                    topics:
                    - location
                    type: http-post
                    url: string
                    verify_cert: true
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400_webhook'
                - description: Webhook-specific HTTP 400 bad request error response
                  examples:
                  - '{"detail":"invalid field: assetfilter_ids","reason":"contains duplicate uuids"}'
                  - '{"detail":"invalid field: assetfilter_ids"}'
                  - '{"detail":"invalid field: assetfilter_ids"}'
                  - '{"detail":"Webhook already configured for special location topic"}'
                  - '{"detail":"Only one location topic can be configured per URL"}'
                  - '{"detail":"invalid field: topics","reason":"filtered asset webhooks must be associated with a site"}'
                contentMediaType: application/json
              examples:
                Duplicate_assetfilter_id:
                  value:
                    detail: 'invalid field: assetfilter_ids'
                    reason: contains duplicate uuids
                Invalid_assetfilter_id:
                  value:
                    detail: 'invalid field: assetfilter_ids'
                Malformed_assetfilter_id:
                  value:
                    detail: 'invalid field: assetfilter_ids'
                RawDataWebhook_already_created:
                  value:
                    detail: Webhook already configured for special location topic
                RawDataWebhook_multiple_topics:
                  value:
                    detail: Only one location topic can be configured per URL
                org_level_filter_webhook:
                  value:
                    detail: 'invalid field: topics'
                    reason: filtered asset webhooks must be associated with a site
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400_webhook'
                - description: Webhook-specific HTTP 400 bad request error response
                  examples:
                  - '{"detail":"invalid field: assetfilter_ids","reason":"contains duplicate uuids"}'
                  - '{"detail":"invalid field: assetfilter_ids"}'
                  - '{"detail":"invalid field: assetfilter_ids"}'
                  - '{"detail":"Webhook already configured for special location topic"}'
                  - '{"detail":"Only one location topic can be configured per URL"}'
                  - '{"detail":"invalid field: topics","reason":"filtered asset webhooks must be associated with a site"}'
                contentMediaType: application/vnd.api+json
              examples:
                Duplicate_assetfilter_id:
                  value:
                    detail: 'invalid field: assetfilter_ids'
                    reason: contains duplicate uuids
                Invalid_assetfilter_id:
                  value:
                    detail: 'invalid field: assetfilter_ids'
                Malformed_assetfilter_id:
                  value:
                    detail: 'invalid field: assetfilter_ids'
                RawDataWebhook_already_created:
                  value:
                    detail: Webhook already configured for special location topic
                RawDataWebhook_multiple_topics:
                  value:
                    detail: Only one location topic can be configured per URL
                org_level_filter_webhook:
                  value:
                    detail: 'invalid field: topics'
                    reason: filtered asset webhooks must be associated with a site
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/webhooks/{webhook_id}:
    delete:
      tags:
      - Orgs Webhooks
      summary: deleteOrgWebhook
      description: Delete Org Webhook
      operationId: deleteOrgWebhook
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: webhook_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs Webhooks
      summary: getOrgWebhook
      description: Get Org Webhook Details
      operationId: getOrgWebhook
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: webhook_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/webhook'
                - description: Webhook configuration for delivering selected Mist events to an external destination
                  examples:
                  - created_time: 0
                    enabled: true
                    headers: {}
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    splunk_token: string
                    topics:
                    - location
                    type: http-post
                    url: string
                    verify_cert: true
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    enabled: true
                    headers: {}
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    splunk_token: string
                    topics:
                    - location
                    type: http-post
                    url: string
                    verify_cert: true
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/webhook'
                - description: Webhook configuration for delivering selected Mist events to an external destination
                  examples:
                  - created_time: 0
                    enabled: true
                    headers: {}
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    splunk_token: string
                    topics:
                    - location
                    type: http-post
                    url: string
                    verify_cert: true
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    enabled: true
                    headers: {}
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    splunk_token: string
                    topics:
                    - location
                    type: http-post
                    url: string
                    verify_cert: true
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs Webhooks
      summary: updateOrgWebhook
      description: Update Org Webhook
      operationId: updateOrgWebhook
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: webhook_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/webhook'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/webhook'
                - description: Webhook configuration for delivering selected Mist events to an external destination
                  examples:
                  - created_time: 0
                    enabled: true
                    headers: {}
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    splunk_token: string
                    topics:
                    - location
                    type: http-post
                    url: string
                    verify_cert: true
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    enabled: true
                    headers: {}
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    splunk_token: string
                    topics:
                    - location
                    type: http-post
                    url: string
                    verify_cert: true
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/webhook'
                - description: Webhook configuration for delivering selected Mist events to an external destination
                  examples:
                  - created_time: 0
                    enabled: true
                    headers: {}
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    splunk_token: string
                    topics:
                    - location
                    type: http-post
                    url: string
                    verify_cert: true
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    enabled: true
                    headers: {}
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    splunk_token: string
                    topics:
                    - location
                    type: http-post
                    url: string
                    verify_cert: true
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/webhooks/{webhook_id}/events/count:
    get:
      tags:
      - Orgs Webhooks
      summary: countOrgWebhooksDeliveries
      description: >-
        Count Org Webhooks deliveries



        Topics Supported:

        - alarms

        - audits

        - device-updowns

        - occupancy-alerts

        - ping
      operationId: countOrgWebhooksDeliveries
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: webhook_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: error
        in: query
        description: Filter webhook delivery results by error message
        style: form
        explode: true
        schema:
          type: string
      - name: status_code
        in: query
        description: Filter webhook delivery results by HTTP status code
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: status
        in: query
        description: 'Webhook delivery status used to filter results. enum: `failure`, `success`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/webhook_delivery_status'
          - description: 'Webhook delivery status used to filter results. enum: `failure`, `success`'
            examples:
            - failure
      - name: topic
        in: query
        description: 'Webhook topic used to filter results. enum: `alarms`, `audits`, `device-updowns`, `occupancy-alerts`, `ping`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/webhook_delivery_topic'
          - description: 'Webhook topic used to filter results. enum: `alarms`, `audits`, `device-updowns`, `occupancy-alerts`, `ping`'
            examples:
            - audits
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `status`, `status_code`, `topic`, `webhook_id`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/webhook_delivery_distinct'
          - description: 'Field used to group this count response. enum: `status`, `status_code`, `topic`, `webhook_id`'
            examples:
            - webhook_id
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/webhooks/{webhook_id}/events/search:
    get:
      tags:
      - Orgs Webhooks
      summary: searchOrgWebhooksDeliveries
      description: >-
        Search Org Webhooks deliveries



        Topics Supported:

        - alarms

        - audits

        - device-updowns

        - occupancy-alerts

        - ping
      operationId: searchOrgWebhooksDeliveries
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: webhook_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: error
        in: query
        description: Filter webhook delivery results by error message
        style: form
        explode: true
        schema:
          type: string
      - name: status_code
        in: query
        description: Filter webhook delivery results by HTTP status code
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: status
        in: query
        description: 'Webhook delivery status used to filter results. enum: `failure`, `success`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/webhook_delivery_status'
          - description: 'Webhook delivery status used to filter results. enum: `failure`, `success`'
            examples:
            - failure
      - name: topic
        in: query
        description: 'Webhook topic used to filter results. enum: `alarms`, `audits`, `device-updowns`, `occupancy-alerts`, `ping`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/webhook_delivery_topic'
          - description: 'Webhook topic used to filter results. enum: `alarms`, `audits`, `device-updowns`, `occupancy-alerts`, `ping`'
            examples:
            - audits
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/search_webhook_delivery'
                - description: Paginated response for webhook delivery searches
                  examples:
                  - end: 1688035193
                    limit: 10
                    results:
                    - error: string
                      id: 55b0f02f-ebf6-4ad2-8b10-200508a97581
                      org_id: fc7e2967-e7ef-41e6-b007-1217713de05a
                      req_headers: '{\"Content-Type\":[\"application/json\"],\"User-Agent\":[\"Mist-webhook\"]}'
                      req_payload: '{\"topic\":\"audits\",\"events\":[{\"admin_name\":\"John Doe john.doe@juniper.net\",\"after\":\"{\\"radio_config\\": {\\"band_24\\": {\\"disabled\\": false, \\"allow_rrm_disable\\": false, \\"power_min\\": null, \\"power_max\\": null, \\"power\\": 10, \\"preamble\\": \\"short\\", \\"channels\\": [1, 10], \\"bandwidth\\": 20}}}\",\"before\":\"{\\"radio_config\\": {\\"band_24\\": {\\"disabled\\": false, \\"allow_rrm_disable\\": false, \\"power_min\\": 8, \\"power_max\\": 18, \\"power\\": null, \\"preamble\\": \\"long\\", \\"channels\\": [1, 10], \\"bandwidth\\": 20}}}\",\"id\":\"737909a2-04ff-4aeb-b9da-cc924e74a4dd\",\"message\":\"Update Site Settings\",\"org_id\":\"fc7e2967-e7ef-41e6-b007-1217713de05a\",\"site_id\":\"256c3a35-9cb7-436e-bc6d-314972645d95\",\"site_name\":\"Test Site\",\"src_ip\":\"1.2.3.4\",\"timestamp\":1685956576.923601,\"user_agent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/112.0.0.0 Safari/537.36\"}]}'
                      req_url: https://example.com
                      resp_body: Ok
                      resp_headers: string
                      site_id: 256c3a35-9cb7-436e-bc6d-314972645d95
                      status: success
                      status_code: 200
                      timestamp: 1687962508.583656
                      topic: audits
                      webhook_id: 7a11b901-f719-4c91-8aef-deb8699a6364
                    start: 1687948793
                    total: 0
                contentMediaType: application/json
              examples:
                Webhook Deliveries:
                  value:
                    end: 1688035193
                    limit: 10
                    results:
                    - error: string
                      id: 55b0f02f-ebf6-4ad2-8b10-200508a97581
                      org_id: fc7e2967-e7ef-41e6-b007-1217713de05a
                      req_headers: '{\"Content-Type\":[\"application/json\"],\"User-Agent\":[\"Mist-webhook\"]}'
                      req_payload: '{\"topic\":\"audits\",\"events\":[{\"admin_name\":\"John Doe john.doe@juniper.net\",\"after\":\"{\\"radio_config\\": {\\"band_24\\": {\\"disabled\\": false, \\"allow_rrm_disable\\": false, \\"power_min\\": null, \\"power_max\\": null, \\"power\\": 10, \\"preamble\\": \\"short\\", \\"channels\\": [1, 10], \\"bandwidth\\": 20}}}\",\"before\":\"{\\"radio_config\\": {\\"band_24\\": {\\"disabled\\": false, \\"allow_rrm_disable\\": false, \\"power_min\\": 8, \\"power_max\\": 18, \\"power\\": null, \\"preamble\\": \\"long\\", \\"channels\\": [1, 10], \\"bandwidth\\": 20}}}\",\"id\":\"737909a2-04ff-4aeb-b9da-cc924e74a4dd\",\"message\":\"Update Site Settings\",\"org_id\":\"fc7e2967-e7ef-41e6-b007-1217713de05a\",\"site_id\":\"256c3a35-9cb7-436e-bc6d-314972645d95\",\"site_name\":\"Test Site\",\"src_ip\":\"1.2.3.4\",\"timestamp\":1685956576.923601,\"user_agent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/112.0.0.0 Safari/537.36\"}]}'
                      req_url: https://example.com
                      resp_body: Ok
                      resp_headers: string
                      site_id: 256c3a35-9cb7-436e-bc6d-314972645d95
                      status: success
                      status_code: 200
                      timestamp: 1687962508.583656
                      topic: audits
                      webhook_id: 7a11b901-f719-4c91-8aef-deb8699a6364
                    start: 1687948793
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/search_webhook_delivery'
                - description: Paginated response for webhook delivery searches
                  examples:
                  - end: 1688035193
                    limit: 10
                    results:
                    - error: string
                      id: 55b0f02f-ebf6-4ad2-8b10-200508a97581
                      org_id: fc7e2967-e7ef-41e6-b007-1217713de05a
                      req_headers: '{\"Content-Type\":[\"application/json\"],\"User-Agent\":[\"Mist-webhook\"]}'
                      req_payload: '{\"topic\":\"audits\",\"events\":[{\"admin_name\":\"John Doe john.doe@juniper.net\",\"after\":\"{\\"radio_config\\": {\\"band_24\\": {\\"disabled\\": false, \\"allow_rrm_disable\\": false, \\"power_min\\": null, \\"power_max\\": null, \\"power\\": 10, \\"preamble\\": \\"short\\", \\"channels\\": [1, 10], \\"bandwidth\\": 20}}}\",\"before\":\"{\\"radio_config\\": {\\"band_24\\": {\\"disabled\\": false, \\"allow_rrm_disable\\": false, \\"power_min\\": 8, \\"power_max\\": 18, \\"power\\": null, \\"preamble\\": \\"long\\", \\"channels\\": [1, 10], \\"bandwidth\\": 20}}}\",\"id\":\"737909a2-04ff-4aeb-b9da-cc924e74a4dd\",\"message\":\"Update Site Settings\",\"org_id\":\"fc7e2967-e7ef-41e6-b007-1217713de05a\",\"site_id\":\"256c3a35-9cb7-436e-bc6d-314972645d95\",\"site_name\":\"Test Site\",\"src_ip\":\"1.2.3.4\",\"timestamp\":1685956576.923601,\"user_agent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/112.0.0.0 Safari/537.36\"}]}'
                      req_url: https://example.com
                      resp_body: Ok
                      resp_headers: string
                      site_id: 256c3a35-9cb7-436e-bc6d-314972645d95
                      status: success
                      status_code: 200
                      timestamp: 1687962508.583656
                      topic: audits
                      webhook_id: 7a11b901-f719-4c91-8aef-deb8699a6364
                    start: 1687948793
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Webhook Deliveries:
                  value:
                    end: 1688035193
                    limit: 10
                    results:
                    - error: string
                      id: 55b0f02f-ebf6-4ad2-8b10-200508a97581
                      org_id: fc7e2967-e7ef-41e6-b007-1217713de05a
                      req_headers: '{\"Content-Type\":[\"application/json\"],\"User-Agent\":[\"Mist-webhook\"]}'
                      req_payload: '{\"topic\":\"audits\",\"events\":[{\"admin_name\":\"John Doe john.doe@juniper.net\",\"after\":\"{\\"radio_config\\": {\\"band_24\\": {\\"disabled\\": false, \\"allow_rrm_disable\\": false, \\"power_min\\": null, \\"power_max\\": null, \\"power\\": 10, \\"preamble\\": \\"short\\", \\"channels\\": [1, 10], \\"bandwidth\\": 20}}}\",\"before\":\"{\\"radio_config\\": {\\"band_24\\": {\\"disabled\\": false, \\"allow_rrm_disable\\": false, \\"power_min\\": 8, \\"power_max\\": 18, \\"power\\": null, \\"preamble\\": \\"long\\", \\"channels\\": [1, 10], \\"bandwidth\\": 20}}}\",\"id\":\"737909a2-04ff-4aeb-b9da-cc924e74a4dd\",\"message\":\"Update Site Settings\",\"org_id\":\"fc7e2967-e7ef-41e6-b007-1217713de05a\",\"site_id\":\"256c3a35-9cb7-436e-bc6d-314972645d95\",\"site_name\":\"Test Site\",\"src_ip\":\"1.2.3.4\",\"timestamp\":1685956576.923601,\"user_agent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/112.0.0.0 Safari/537.36\"}]}'
                      req_url: https://example.com
                      resp_body: Ok
                      resp_headers: string
                      site_id: 256c3a35-9cb7-436e-bc6d-314972645d95
                      status: success
                      status_code: 200
                      timestamp: 1687962508.583656
                      topic: audits
                      webhook_id: 7a11b901-f719-4c91-8aef-deb8699a6364
                    start: 1687948793
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/webhooks/{webhook_id}/ping:
    post:
      tags:
      - Orgs Webhooks
      summary: pingOrgWebhook
      description: Send a Ping event to the webhook
      operationId: pingOrgWebhook
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: webhook_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/wlans:
    get:
      tags:
      - Orgs Wlans
      summary: listOrgWlans
      description: Get List of Org Wlans
      operationId: listOrgWlans
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/wlan'
                description: WLAN records returned by a list response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/wlan'
                description: WLAN records returned by a list response
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs Wlans
      summary: createOrgWlan
      description: Create Org Wlan
      operationId: createOrgWlan
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/wlan'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wlan'
                - description: '**Note**: portal_template will be forked out of wlan objects soon. To fetch portal_template, please query portal_template_url. To update portal_template, use Wlan Portal Template.'
                  examples:
                  - allow_ipv6_ndp: true
                    allow_mdns: false
                    allow_ssdp: false
                    arp_filter: false
                    band_steer: false
                    band_steer_force_band5: false
                    bands:
                    - '24'
                    - '5'
                    block_blacklist_clients: false
                    bonjour:
                      additional_vlan_ids: 10, 20
                      enabled: false
                      services:
                        airplay:
                          radius_groups:
                          - teachers
                          scope: same_ap
                    client_limit_down: 1000
                    client_limit_down_enabled: false
                    client_limit_up: 512
                    client_limit_up_enabled: false
                    disable_11ax: false
                    disable_ht_vht_rates: false
                    disable_uapsd: false
                    disable_v1_roam_notify: false
                    disable_v2_roam_notify: false
                    disable_wmm: false
                    dynamic_vlan:
                      default_vlan_id: 999
                      enabled: false
                      local_vlan_ids:
                      - 1
                      type: airespace-interface-name
                      vlans:
                        '131': default
                        '322': fast,video
                    enable_local_keycaching: false
                    enable_wireless_bridging: false
                    enabled: true
                    fast_dot1x_timers: false
                    hide_ssid: false
                    hostname_ie: false
                    ssid: demo
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    allow_ipv6_ndp: true
                    allow_mdns: false
                    allow_ssdp: false
                    arp_filter: false
                    band_steer: false
                    band_steer_force_band5: false
                    bands:
                    - '24'
                    - '5'
                    block_blacklist_clients: false
                    bonjour:
                      additional_vlan_ids: 10, 20
                      enabled: false
                      services:
                        airplay:
                          radius_groups:
                          - teachers
                          scope: same_ap
                    client_limit_down: 1000
                    client_limit_down_enabled: false
                    client_limit_up: 512
                    client_limit_up_enabled: false
                    disable_11ax: false
                    disable_ht_vht_rates: false
                    disable_uapsd: false
                    disable_v1_roam_notify: false
                    disable_v2_roam_notify: false
                    disable_wmm: false
                    dynamic_vlan:
                      default_vlan_id: 999
                      enabled: false
                      local_vlan_ids:
                      - 1
                      type: airespace-interface-name
                      vlans:
                        '131': default
                        '322': fast,video
                    enable_local_keycaching: false
                    enable_wireless_bridging: false
                    enabled: true
                    fast_dot1x_timers: false
                    hide_ssid: false
                    hostname_ie: false
                    ssid: demo
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wlan'
                - description: '**Note**: portal_template will be forked out of wlan objects soon. To fetch portal_template, please query portal_template_url. To update portal_template, use Wlan Portal Template.'
                  examples:
                  - allow_ipv6_ndp: true
                    allow_mdns: false
                    allow_ssdp: false
                    arp_filter: false
                    band_steer: false
                    band_steer_force_band5: false
                    bands:
                    - '24'
                    - '5'
                    block_blacklist_clients: false
                    bonjour:
                      additional_vlan_ids: 10, 20
                      enabled: false
                      services:
                        airplay:
                          radius_groups:
                          - teachers
                          scope: same_ap
                    client_limit_down: 1000
                    client_limit_down_enabled: false
                    client_limit_up: 512
                    client_limit_up_enabled: false
                    disable_11ax: false
                    disable_ht_vht_rates: false
                    disable_uapsd: false
                    disable_v1_roam_notify: false
                    disable_v2_roam_notify: false
                    disable_wmm: false
                    dynamic_vlan:
                      default_vlan_id: 999
                      enabled: false
                      local_vlan_ids:
                      - 1
                      type: airespace-interface-name
                      vlans:
                        '131': default
                        '322': fast,video
                    enable_local_keycaching: false
                    enable_wireless_bridging: false
                    enabled: true
                    fast_dot1x_timers: false
                    hide_ssid: false
                    hostname_ie: false
                    ssid: demo
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    allow_ipv6_ndp: true
                    allow_mdns: false
                    allow_ssdp: false
                    arp_filter: false
                    band_steer: false
                    band_steer_force_band5: false
                    bands:
                    - '24'
                    - '5'
                    block_blacklist_clients: false
                    bonjour:
                      additional_vlan_ids: 10, 20
                      enabled: false
                      services:
                        airplay:
                          radius_groups:
                          - teachers
                          scope: same_ap
                    client_limit_down: 1000
                    client_limit_down_enabled: false
                    client_limit_up: 512
                    client_limit_up_enabled: false
                    disable_11ax: false
                    disable_ht_vht_rates: false
                    disable_uapsd: false
                    disable_v1_roam_notify: false
                    disable_v2_roam_notify: false
                    disable_wmm: false
                    dynamic_vlan:
                      default_vlan_id: 999
                      enabled: false
                      local_vlan_ids:
                      - 1
                      type: airespace-interface-name
                      vlans:
                        '131': default
                        '322': fast,video
                    enable_local_keycaching: false
                    enable_wireless_bridging: false
                    enabled: true
                    fast_dot1x_timers: false
                    hide_ssid: false
                    hostname_ie: false
                    ssid: demo
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/wlans/{wlan_id}:
    delete:
      tags:
      - Orgs Wlans
      summary: deleteOrgWlan
      description: Delete Org WLAN
      operationId: deleteOrgWlan
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wlan_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs Wlans
      summary: getOrgWLAN
      description: Get Org Wlan Detail
      operationId: getOrgWLAN
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wlan_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wlan'
                - description: '**Note**: portal_template will be forked out of wlan objects soon. To fetch portal_template, please query portal_template_url. To update portal_template, use Wlan Portal Template.'
                  examples:
                  - allow_ipv6_ndp: true
                    allow_mdns: false
                    allow_ssdp: false
                    arp_filter: false
                    band_steer: false
                    band_steer_force_band5: false
                    bands:
                    - '24'
                    - '5'
                    block_blacklist_clients: false
                    bonjour:
                      additional_vlan_ids: 10, 20
                      enabled: false
                      services:
                        airplay:
                          radius_groups:
                          - teachers
                          scope: same_ap
                    client_limit_down: 1000
                    client_limit_down_enabled: false
                    client_limit_up: 512
                    client_limit_up_enabled: false
                    disable_11ax: false
                    disable_ht_vht_rates: false
                    disable_uapsd: false
                    disable_v1_roam_notify: false
                    disable_v2_roam_notify: false
                    disable_wmm: false
                    dynamic_vlan:
                      default_vlan_id: 999
                      enabled: false
                      local_vlan_ids:
                      - 1
                      type: airespace-interface-name
                      vlans:
                        '131': default
                        '322': fast,video
                    enable_local_keycaching: false
                    enable_wireless_bridging: false
                    enabled: true
                    fast_dot1x_timers: false
                    hide_ssid: false
                    hostname_ie: false
                    ssid: demo
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    allow_ipv6_ndp: true
                    allow_mdns: false
                    allow_ssdp: false
                    arp_filter: false
                    band_steer: false
                    band_steer_force_band5: false
                    bands:
                    - '24'
                    - '5'
                    block_blacklist_clients: false
                    bonjour:
                      additional_vlan_ids: 10, 20
                      enabled: false
                      services:
                        airplay:
                          radius_groups:
                          - teachers
                          scope: same_ap
                    client_limit_down: 1000
                    client_limit_down_enabled: false
                    client_limit_up: 512
                    client_limit_up_enabled: false
                    disable_11ax: false
                    disable_ht_vht_rates: false
                    disable_uapsd: false
                    disable_v1_roam_notify: false
                    disable_v2_roam_notify: false
                    disable_wmm: false
                    dynamic_vlan:
                      default_vlan_id: 999
                      enabled: false
                      local_vlan_ids:
                      - 1
                      type: airespace-interface-name
                      vlans:
                        '131': default
                        '322': fast,video
                    enable_local_keycaching: false
                    enable_wireless_bridging: false
                    enabled: true
                    fast_dot1x_timers: false
                    hide_ssid: false
                    hostname_ie: false
                    ssid: demo
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wlan'
                - description: '**Note**: portal_template will be forked out of wlan objects soon. To fetch portal_template, please query portal_template_url. To update portal_template, use Wlan Portal Template.'
                  examples:
                  - allow_ipv6_ndp: true
                    allow_mdns: false
                    allow_ssdp: false
                    arp_filter: false
                    band_steer: false
                    band_steer_force_band5: false
                    bands:
                    - '24'
                    - '5'
                    block_blacklist_clients: false
                    bonjour:
                      additional_vlan_ids: 10, 20
                      enabled: false
                      services:
                        airplay:
                          radius_groups:
                          - teachers
                          scope: same_ap
                    client_limit_down: 1000
                    client_limit_down_enabled: false
                    client_limit_up: 512
                    client_limit_up_enabled: false
                    disable_11ax: false
                    disable_ht_vht_rates: false
                    disable_uapsd: false
                    disable_v1_roam_notify: false
                    disable_v2_roam_notify: false
                    disable_wmm: false
                    dynamic_vlan:
                      default_vlan_id: 999
                      enabled: false
                      local_vlan_ids:
                      - 1
                      type: airespace-interface-name
                      vlans:
                        '131': default
                        '322': fast,video
                    enable_local_keycaching: false
                    enable_wireless_bridging: false
                    enabled: true
                    fast_dot1x_timers: false
                    hide_ssid: false
                    hostname_ie: false
                    ssid: demo
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    allow_ipv6_ndp: true
                    allow_mdns: false
                    allow_ssdp: false
                    arp_filter: false
                    band_steer: false
                    band_steer_force_band5: false
                    bands:
                    - '24'
                    - '5'
                    block_blacklist_clients: false
                    bonjour:
                      additional_vlan_ids: 10, 20
                      enabled: false
                      services:
                        airplay:
                          radius_groups:
                          - teachers
                          scope: same_ap
                    client_limit_down: 1000
                    client_limit_down_enabled: false
                    client_limit_up: 512
                    client_limit_up_enabled: false
                    disable_11ax: false
                    disable_ht_vht_rates: false
                    disable_uapsd: false
                    disable_v1_roam_notify: false
                    disable_v2_roam_notify: false
                    disable_wmm: false
                    dynamic_vlan:
                      default_vlan_id: 999
                      enabled: false
                      local_vlan_ids:
                      - 1
                      type: airespace-interface-name
                      vlans:
                        '131': default
                        '322': fast,video
                    enable_local_keycaching: false
                    enable_wireless_bridging: false
                    enabled: true
                    fast_dot1x_timers: false
                    hide_ssid: false
                    hostname_ie: false
                    ssid: demo
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs Wlans
      summary: updateOrgWlan
      description: Update Org Wlan
      operationId: updateOrgWlan
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wlan_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/wlan'
              - description: Request Body
                examples:
                - allow_ipv6_ndp: true
                  allow_mdns: false
                  allow_ssdp: false
                  arp_filter: false
                  band_steer: false
                  band_steer_force_band5: false
                  bands:
                  - '24'
                  - '5'
                  block_blacklist_clients: false
                  bonjour:
                    additional_vlan_ids: 10,20
                    enabled: false
                    services:
                      airplay:
                        radius_groups:
                        - teachers
                        scope: same_ap
                  client_limit_down: 1000
                  client_limit_down_enabled: false
                  client_limit_up: 512
                  client_limit_up_enabled: false
                  disable_11ax: false
                  disable_ht_vht_rates: false
                  disable_uapsd: false
                  disable_v1_roam_notify: false
                  disable_v2_roam_notify: false
                  disable_wmm: false
                  dynamic_vlan:
                    default_vlan_id: 999
                    enabled: false
                    local_vlan_ids:
                    - 1
                    type: airespace-interface-name
                    vlans:
                      '131': default
                      '322': fast,video
                  enable_local_keycaching: false
                  enable_wireless_bridging: false
                  enabled: true
                  fast_dot1x_timers: false
                  hide_ssid: false
                  hostname_ie: false
                  ssid: demo
              contentMediaType: application/json
            examples:
              Example:
                value:
                  allow_ipv6_ndp: true
                  allow_mdns: false
                  allow_ssdp: false
                  arp_filter: false
                  band_steer: false
                  band_steer_force_band5: false
                  bands:
                  - '24'
                  - '5'
                  block_blacklist_clients: false
                  bonjour:
                    additional_vlan_ids: 10,20
                    enabled: false
                    services:
                      airplay:
                        radius_groups:
                        - teachers
                        scope: same_ap
                  client_limit_down: 1000
                  client_limit_down_enabled: false
                  client_limit_up: 512
                  client_limit_up_enabled: false
                  disable_11ax: false
                  disable_ht_vht_rates: false
                  disable_uapsd: false
                  disable_v1_roam_notify: false
                  disable_v2_roam_notify: false
                  disable_wmm: false
                  dynamic_vlan:
                    default_vlan_id: 999
                    enabled: false
                    local_vlan_ids:
                    - 1
                    type: airespace-interface-name
                    vlans:
                      '131': default
                      '322': fast,video
                  enable_local_keycaching: false
                  enable_wireless_bridging: false
                  enabled: true
                  fast_dot1x_timers: false
                  hide_ssid: false
                  hostname_ie: false
                  ssid: demo
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wlan'
                - description: '**Note**: portal_template will be forked out of wlan objects soon. To fetch portal_template, please query portal_template_url. To update portal_template, use Wlan Portal Template.'
                  examples:
                  - allow_ipv6_ndp: true
                    allow_mdns: false
                    allow_ssdp: false
                    arp_filter: false
                    band_steer: false
                    band_steer_force_band5: false
                    bands:
                    - '24'
                    - '5'
                    block_blacklist_clients: false
                    bonjour:
                      additional_vlan_ids: 10, 20
                      enabled: false
                      services:
                        airplay:
                          radius_groups:
                          - teachers
                          scope: same_ap
                    client_limit_down: 1000
                    client_limit_down_enabled: false
                    client_limit_up: 512
                    client_limit_up_enabled: false
                    disable_11ax: false
                    disable_ht_vht_rates: false
                    disable_uapsd: false
                    disable_v1_roam_notify: false
                    disable_v2_roam_notify: false
                    disable_wmm: false
                    dynamic_vlan:
                      default_vlan_id: 999
                      enabled: false
                      local_vlan_ids:
                      - 1
                      type: airespace-interface-name
                      vlans:
                        '131': default
                        '322': fast,video
                    enable_local_keycaching: false
                    enable_wireless_bridging: false
                    enabled: true
                    fast_dot1x_timers: false
                    hide_ssid: false
                    hostname_ie: false
                    ssid: demo
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    allow_ipv6_ndp: true
                    allow_mdns: false
                    allow_ssdp: false
                    arp_filter: false
                    band_steer: false
                    band_steer_force_band5: false
                    bands:
                    - '24'
                    - '5'
                    block_blacklist_clients: false
                    bonjour:
                      additional_vlan_ids: 10, 20
                      enabled: false
                      services:
                        airplay:
                          radius_groups:
                          - teachers
                          scope: same_ap
                    client_limit_down: 1000
                    client_limit_down_enabled: false
                    client_limit_up: 512
                    client_limit_up_enabled: false
                    disable_11ax: false
                    disable_ht_vht_rates: false
                    disable_uapsd: false
                    disable_v1_roam_notify: false
                    disable_v2_roam_notify: false
                    disable_wmm: false
                    dynamic_vlan:
                      default_vlan_id: 999
                      enabled: false
                      local_vlan_ids:
                      - 1
                      type: airespace-interface-name
                      vlans:
                        '131': default
                        '322': fast,video
                    enable_local_keycaching: false
                    enable_wireless_bridging: false
                    enabled: true
                    fast_dot1x_timers: false
                    hide_ssid: false
                    hostname_ie: false
                    ssid: demo
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wlan'
                - description: '**Note**: portal_template will be forked out of wlan objects soon. To fetch portal_template, please query portal_template_url. To update portal_template, use Wlan Portal Template.'
                  examples:
                  - allow_ipv6_ndp: true
                    allow_mdns: false
                    allow_ssdp: false
                    arp_filter: false
                    band_steer: false
                    band_steer_force_band5: false
                    bands:
                    - '24'
                    - '5'
                    block_blacklist_clients: false
                    bonjour:
                      additional_vlan_ids: 10, 20
                      enabled: false
                      services:
                        airplay:
                          radius_groups:
                          - teachers
                          scope: same_ap
                    client_limit_down: 1000
                    client_limit_down_enabled: false
                    client_limit_up: 512
                    client_limit_up_enabled: false
                    disable_11ax: false
                    disable_ht_vht_rates: false
                    disable_uapsd: false
                    disable_v1_roam_notify: false
                    disable_v2_roam_notify: false
                    disable_wmm: false
                    dynamic_vlan:
                      default_vlan_id: 999
                      enabled: false
                      local_vlan_ids:
                      - 1
                      type: airespace-interface-name
                      vlans:
                        '131': default
                        '322': fast,video
                    enable_local_keycaching: false
                    enable_wireless_bridging: false
                    enabled: true
                    fast_dot1x_timers: false
                    hide_ssid: false
                    hostname_ie: false
                    ssid: demo
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    allow_ipv6_ndp: true
                    allow_mdns: false
                    allow_ssdp: false
                    arp_filter: false
                    band_steer: false
                    band_steer_force_band5: false
                    bands:
                    - '24'
                    - '5'
                    block_blacklist_clients: false
                    bonjour:
                      additional_vlan_ids: 10, 20
                      enabled: false
                      services:
                        airplay:
                          radius_groups:
                          - teachers
                          scope: same_ap
                    client_limit_down: 1000
                    client_limit_down_enabled: false
                    client_limit_up: 512
                    client_limit_up_enabled: false
                    disable_11ax: false
                    disable_ht_vht_rates: false
                    disable_uapsd: false
                    disable_v1_roam_notify: false
                    disable_v2_roam_notify: false
                    disable_wmm: false
                    dynamic_vlan:
                      default_vlan_id: 999
                      enabled: false
                      local_vlan_ids:
                      - 1
                      type: airespace-interface-name
                      vlans:
                        '131': default
                        '322': fast,video
                    enable_local_keycaching: false
                    enable_wireless_bridging: false
                    enabled: true
                    fast_dot1x_timers: false
                    hide_ssid: false
                    hostname_ie: false
                    ssid: demo
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/wlans/{wlan_id}/portal_image:
    delete:
      tags:
      - Orgs Wlans
      summary: deleteOrgWlanPortalImage
      description: Delete Org WLAN Portal Image
      operationId: deleteOrgWlanPortalImage
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wlan_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs Wlans
      summary: uploadOrgWlanPortalImage
      description: Upload Org WLAN Portal Image
      operationId: uploadOrgWlanPortalImage
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wlan_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              required:
              - file
              type: object
              properties:
                file:
                  type: string
                  description: Image file content uploaded as multipart form data
                  contentEncoding: base64
                json:
                  type: string
                  description: Optional JSON metadata submitted with the image upload
              contentMediaType: multipart/form-data
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/wlans/{wlan_id}/portal_template:
    put:
      tags:
      - Orgs Wlans
      summary: updateOrgWlanPortalTemplate
      description: >-
        Update a Portal Template


        #### Sponsor Email Template

        Sponsor Email Template supports following template variables:


        | **Name** | **Description** |

        | --- | --- |

        | approve_url | Renders URL to approve the request; optionally &minutes=N query param can be appended to change the Authorization period of the guest, where N is a valid integer denoting number of minutes a guest remains authorized |

        | deny_url | Renders URL to reject the request |

        | guest_email | Renders Email ID of the guest |

        | guest_name | Renders Name of the guest |

        | field1 | Renders value of the Custom Field 1 |

        | field2 | Renders value of the Custom Field 2 |

        | company | Renders value of the Company field |

        | sponsor_link_validity_duration | Renders validity time of the request (i.e. Approve/Deny URL) |

        | auth_expire_minutes | Renders Wlan-level configured Guest Authorization Expiration time period (in minutes), If not configured then default (1 day in minutes) |
      operationId: updateOrgWlanPortalTemplate
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wlan_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/wlan_portal_template'
              - description: Request Body
                examples:
                - portal_template:
                    accessCodeAlternateEmail: string
                    alignment: left
                    authButtonAmazon: string
                    authButtonAzure: string
                    authButtonEmail: string
                    authButtonFacebook: string
                    authButtonGoogle: string
                    authButtonMicrosoft: string
                    authButtonPassphrase: string
                    authButtonSms: string
                    authButtonSponsor: string
                    authLabel: string
                    backLink: string
                    color: string
                    colorDark: string
                    colorLight: string
                    company: true
                    companyError: string
                    companyLabel: string
                    email: true
                    emailAccessDomainError: string
                    emailCancel: string
                    emailCodeError: string
                    emailError: string
                    emailFieldLabel: string
                    emailLabel: string
                    emailMessage: string
                    emailSubmit: string
                    emailTitle: string
                    field1: true
                    field1Error: string
                    field1Label: string
                    field1Required: true
                    field2: true
                    field2Error: string
                    field2Label: string
                    field2Required: true
                    field3: true
                    field3Error: string
                    field3Label: string
                    field3Required: true
                    field4: true
                    field4Error: string
                    field4Label: string
                    field4Required: true
                    message: string
                    name: true
                    nameError: string
                    nameLabel: string
                    optout: true
                    optoutLabel: string
                    pageTitle: string
                    passphraseCancel: string
                    passphraseError: string
                    passphraseLabel: string
                    passphraseMessage: string
                    passphraseSubmit: string
                    passphraseTitle: string
                    poweredBy: true
                    requiredFieldLabel: string
                    signInLabel: string
                    smsCarrierDefault: string
                    smsCarrierError: string
                    smsCarrierFieldLabel: string
                    smsCodeCancel: string
                    smsCodeError: string
                    smsCodeFieldLabel: string
                    smsCodeMessage: string
                    smsCodeSubmit: string
                    smsCodeTitle: string
                    smsCountryFieldLabel: string
                    smsCountryFormat: string
                    smsHaveAccessCode: string
                    smsMessageFormat: string
                    smsNumberCancel: string
                    smsNumberError: string
                    smsNumberFieldLabel: string
                    smsNumberFormat: string
                    smsNumberMessage: string
                    smsNumberSubmit: string
                    smsNumberTitle: string
                    smsUsernameFormat: string
                    smsValidityDuration: 30
                    sponsorBackLink: string
                    sponsorCancel: string
                    sponsorEmail: string
                    sponsorEmailError: string
                    sponsorEmailTemplate: string
                    sponsorInfoApproved: string
                    sponsorInfoDenied: string
                    sponsorInfoPending: string
                    sponsorName: string
                    sponsorNameError: string
                    sponsorNotePending: string
                    sponsorStatusApproved: string
                    sponsorStatusDenied: string
                    sponsorStatusPending: string
                    sponsorSubmit: string
                    sponsorsFieldLabel: string
                    tos: true
                    tosAcceptLabel: string
                    tosError: string
                    tosLink: string
                    tosText: string
              contentMediaType: application/json
            examples:
              Example:
                value:
                  portal_template:
                    accessCodeAlternateEmail: string
                    alignment: left
                    authButtonAmazon: string
                    authButtonAzure: string
                    authButtonEmail: string
                    authButtonFacebook: string
                    authButtonGoogle: string
                    authButtonMicrosoft: string
                    authButtonPassphrase: string
                    authButtonSms: string
                    authButtonSponsor: string
                    authLabel: string
                    backLink: string
                    color: string
                    colorDark: string
                    colorLight: string
                    company: true
                    companyError: string
                    companyLabel: string
                    email: true
                    emailAccessDomainError: string
                    emailCancel: string
                    emailCodeError: string
                    emailError: string
                    emailFieldLabel: string
                    emailLabel: string
                    emailMessage: string
                    emailSubmit: string
                    emailTitle: string
                    field1: true
                    field1Error: string
                    field1Label: string
                    field1Required: true
                    field2: true
                    field2Error: string
                    field2Label: string
                    field2Required: true
                    field3: true
                    field3Error: string
                    field3Label: string
                    field3Required: true
                    field4: true
                    field4Error: string
                    field4Label: string
                    field4Required: true
                    message: string
                    name: true
                    nameError: string
                    nameLabel: string
                    optout: true
                    optoutLabel: string
                    pageTitle: string
                    passphraseCancel: string
                    passphraseError: string
                    passphraseLabel: string
                    passphraseMessage: string
                    passphraseSubmit: string
                    passphraseTitle: string
                    poweredBy: true
                    requiredFieldLabel: string
                    signInLabel: string
                    smsCarrierDefault: string
                    smsCarrierError: string
                    smsCarrierFieldLabel: string
                    smsCodeCancel: string
                    smsCodeError: string
                    smsCodeFieldLabel: string
                    smsCodeMessage: string
                    smsCodeSubmit: string
                    smsCodeTitle: string
                    smsCountryFieldLabel: string
                    smsCountryFormat: string
                    smsHaveAccessCode: string
                    smsMessageFormat: string
                    smsNumberCancel: string
                    smsNumberError: string
                    smsNumberFieldLabel: string
                    smsNumberFormat: string
                    smsNumberMessage: string
                    smsNumberSubmit: string
                    smsNumberTitle: string
                    smsUsernameFormat: string
                    smsValidityDuration: 30
                    sponsorBackLink: string
                    sponsorCancel: string
                    sponsorEmail: string
                    sponsorEmailError: string
                    sponsorEmailTemplate: string
                    sponsorInfoApproved: string
                    sponsorInfoDenied: string
                    sponsorInfoPending: string
                    sponsorName: string
                    sponsorNameError: string
                    sponsorNotePending: string
                    sponsorStatusApproved: string
                    sponsorStatusDenied: string
                    sponsorStatusPending: string
                    sponsorSubmit: string
                    sponsorsFieldLabel: string
                    tos: true
                    tosAcceptLabel: string
                    tosError: string
                    tosLink: string
                    tosText: string
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wlan_portal_template'
                - description: Guest portal template payload for a WLAN
                  examples:
                  - portal_template:
                      accessCodeAlternateEmail: string
                      alignment: left
                      authButtonAmazon: string
                      authButtonAzure: string
                      authButtonEmail: string
                      authButtonFacebook: string
                      authButtonGoogle: string
                      authButtonMicrosoft: string
                      authButtonPassphrase: string
                      authButtonSms: string
                      authButtonSponsor: string
                      authLabel: string
                      backLink: string
                      color: string
                      colorDark: string
                      colorLight: string
                      company: true
                      companyError: string
                      companyLabel: string
                      email: true
                      emailAccessDomainError: string
                      emailCancel: string
                      emailCodeError: string
                      emailError: string
                      emailFieldLabel: string
                      emailLabel: string
                      emailMessage: string
                      emailSubmit: string
                      emailTitle: string
                      field1: true
                      field1Error: string
                      field1Label: string
                      field1Required: true
                      field2: true
                      field2Error: string
                      field2Label: string
                      field2Required: true
                      field3: true
                      field3Error: string
                      field3Label: string
                      field3Required: true
                      field4: true
                      field4Error: string
                      field4Label: string
                      field4Required: true
                      message: string
                      name: true
                      nameError: string
                      nameLabel: string
                      optout: true
                      optoutLabel: string
                      pageTitle: string
                      passphraseCancel: string
                      passphraseError: string
                      passphraseLabel: string
                      passphraseMessage: string
                      passphraseSubmit: string
                      passphraseTitle: string
                      poweredBy: true
                      requiredFieldLabel: string
                      signInLabel: string
                      smsCarrierDefault: string
                      smsCarrierError: string
                      smsCarrierFieldLabel: string
                      smsCodeCancel: string
                      smsCodeError: string
                      smsCodeFieldLabel: string
                      smsCodeMessage: string
                      smsCodeSubmit: string
                      smsCodeTitle: string
                      smsCountryFieldLabel: string
                      smsCountryFormat: string
                      smsHaveAccessCode: string
                      smsMessageFormat: string
                      smsNumberCancel: string
                      smsNumberError: string
                      smsNumberFieldLabel: string
                      smsNumberFormat: string
                      smsNumberMessage: string
                      smsNumberSubmit: string
                      smsNumberTitle: string
                      smsUsernameFormat: string
                      smsValidityDuration: 5
                      sponsorBackLink: string
                      sponsorCancel: string
                      sponsorEmail: string
                      sponsorEmailError: string
                      sponsorEmailTemplate: string
                      sponsorInfoApproved: string
                      sponsorInfoDenied: string
                      sponsorInfoPending: string
                      sponsorName: string
                      sponsorNameError: string
                      sponsorNotePending: string
                      sponsorStatusApproved: string
                      sponsorStatusDenied: string
                      sponsorStatusPending: string
                      sponsorSubmit: string
                      tos: true
                      tosAcceptLabel: string
                      tosError: string
                      tosLink: string
                      tosText: string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    portal_template:
                      accessCodeAlternateEmail: string
                      alignment: left
                      authButtonAmazon: string
                      authButtonAzure: string
                      authButtonEmail: string
                      authButtonFacebook: string
                      authButtonGoogle: string
                      authButtonMicrosoft: string
                      authButtonPassphrase: string
                      authButtonSms: string
                      authButtonSponsor: string
                      authLabel: string
                      backLink: string
                      color: string
                      colorDark: string
                      colorLight: string
                      company: true
                      companyError: string
                      companyLabel: string
                      email: true
                      emailAccessDomainError: string
                      emailCancel: string
                      emailCodeError: string
                      emailError: string
                      emailFieldLabel: string
                      emailLabel: string
                      emailMessage: string
                      emailSubmit: string
                      emailTitle: string
                      field1: true
                      field1Error: string
                      field1Label: string
                      field1Required: true
                      field2: true
                      field2Error: string
                      field2Label: string
                      field2Required: true
                      field3: true
                      field3Error: string
                      field3Label: string
                      field3Required: true
                      field4: true
                      field4Error: string
                      field4Label: string
                      field4Required: true
                      message: string
                      name: true
                      nameError: string
                      nameLabel: string
                      optout: true
                      optoutLabel: string
                      pageTitle: string
                      passphraseCancel: string
                      passphraseError: string
                      passphraseLabel: string
                      passphraseMessage: string
                      passphraseSubmit: string
                      passphraseTitle: string
                      poweredBy: true
                      requiredFieldLabel: string
                      signInLabel: string
                      smsCarrierDefault: string
                      smsCarrierError: string
                      smsCarrierFieldLabel: string
                      smsCodeCancel: string
                      smsCodeError: string
                      smsCodeFieldLabel: string
                      smsCodeMessage: string
                      smsCodeSubmit: string
                      smsCodeTitle: string
                      smsCountryFieldLabel: string
                      smsCountryFormat: string
                      smsHaveAccessCode: string
                      smsMessageFormat: string
                      smsNumberCancel: string
                      smsNumberError: string
                      smsNumberFieldLabel: string
                      smsNumberFormat: string
                      smsNumberMessage: string
                      smsNumberSubmit: string
                      smsNumberTitle: string
                      smsUsernameFormat: string
                      smsValidityDuration: 5
                      sponsorBackLink: string
                      sponsorCancel: string
                      sponsorEmail: string
                      sponsorEmailError: string
                      sponsorEmailTemplate: string
                      sponsorInfoApproved: string
                      sponsorInfoDenied: string
                      sponsorInfoPending: string
                      sponsorName: string
                      sponsorNameError: string
                      sponsorNotePending: string
                      sponsorStatusApproved: string
                      sponsorStatusDenied: string
                      sponsorStatusPending: string
                      sponsorSubmit: string
                      tos: true
                      tosAcceptLabel: string
                      tosError: string
                      tosLink: string
                      tosText: string
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wlan_portal_template'
                - description: Guest portal template payload for a WLAN
                  examples:
                  - portal_template:
                      accessCodeAlternateEmail: string
                      alignment: left
                      authButtonAmazon: string
                      authButtonAzure: string
                      authButtonEmail: string
                      authButtonFacebook: string
                      authButtonGoogle: string
                      authButtonMicrosoft: string
                      authButtonPassphrase: string
                      authButtonSms: string
                      authButtonSponsor: string
                      authLabel: string
                      backLink: string
                      color: string
                      colorDark: string
                      colorLight: string
                      company: true
                      companyError: string
                      companyLabel: string
                      email: true
                      emailAccessDomainError: string
                      emailCancel: string
                      emailCodeError: string
                      emailError: string
                      emailFieldLabel: string
                      emailLabel: string
                      emailMessage: string
                      emailSubmit: string
                      emailTitle: string
                      field1: true
                      field1Error: string
                      field1Label: string
                      field1Required: true
                      field2: true
                      field2Error: string
                      field2Label: string
                      field2Required: true
                      field3: true
                      field3Error: string
                      field3Label: string
                      field3Required: true
                      field4: true
                      field4Error: string
                      field4Label: string
                      field4Required: true
                      message: string
                      name: true
                      nameError: string
                      nameLabel: string
                      optout: true
                      optoutLabel: string
                      pageTitle: string
                      passphraseCancel: string
                      passphraseError: string
                      passphraseLabel: string
                      passphraseMessage: string
                      passphraseSubmit: string
                      passphraseTitle: string
                      poweredBy: true
                      requiredFieldLabel: string
                      signInLabel: string
                      smsCarrierDefault: string
                      smsCarrierError: string
                      smsCarrierFieldLabel: string
                      smsCodeCancel: string
                      smsCodeError: string
                      smsCodeFieldLabel: string
                      smsCodeMessage: string
                      smsCodeSubmit: string
                      smsCodeTitle: string
                      smsCountryFieldLabel: string
                      smsCountryFormat: string
                      smsHaveAccessCode: string
                      smsMessageFormat: string
                      smsNumberCancel: string
                      smsNumberError: string
                      smsNumberFieldLabel: string
                      smsNumberFormat: string
                      smsNumberMessage: string
                      smsNumberSubmit: string
                      smsNumberTitle: string
                      smsUsernameFormat: string
                      smsValidityDuration: 5
                      sponsorBackLink: string
                      sponsorCancel: string
                      sponsorEmail: string
                      sponsorEmailError: string
                      sponsorEmailTemplate: string
                      sponsorInfoApproved: string
                      sponsorInfoDenied: string
                      sponsorInfoPending: string
                      sponsorName: string
                      sponsorNameError: string
                      sponsorNotePending: string
                      sponsorStatusApproved: string
                      sponsorStatusDenied: string
                      sponsorStatusPending: string
                      sponsorSubmit: string
                      tos: true
                      tosAcceptLabel: string
                      tosError: string
                      tosLink: string
                      tosText: string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    portal_template:
                      accessCodeAlternateEmail: string
                      alignment: left
                      authButtonAmazon: string
                      authButtonAzure: string
                      authButtonEmail: string
                      authButtonFacebook: string
                      authButtonGoogle: string
                      authButtonMicrosoft: string
                      authButtonPassphrase: string
                      authButtonSms: string
                      authButtonSponsor: string
                      authLabel: string
                      backLink: string
                      color: string
                      colorDark: string
                      colorLight: string
                      company: true
                      companyError: string
                      companyLabel: string
                      email: true
                      emailAccessDomainError: string
                      emailCancel: string
                      emailCodeError: string
                      emailError: string
                      emailFieldLabel: string
                      emailLabel: string
                      emailMessage: string
                      emailSubmit: string
                      emailTitle: string
                      field1: true
                      field1Error: string
                      field1Label: string
                      field1Required: true
                      field2: true
                      field2Error: string
                      field2Label: string
                      field2Required: true
                      field3: true
                      field3Error: string
                      field3Label: string
                      field3Required: true
                      field4: true
                      field4Error: string
                      field4Label: string
                      field4Required: true
                      message: string
                      name: true
                      nameError: string
                      nameLabel: string
                      optout: true
                      optoutLabel: string
                      pageTitle: string
                      passphraseCancel: string
                      passphraseError: string
                      passphraseLabel: string
                      passphraseMessage: string
                      passphraseSubmit: string
                      passphraseTitle: string
                      poweredBy: true
                      requiredFieldLabel: string
                      signInLabel: string
                      smsCarrierDefault: string
                      smsCarrierError: string
                      smsCarrierFieldLabel: string
                      smsCodeCancel: string
                      smsCodeError: string
                      smsCodeFieldLabel: string
                      smsCodeMessage: string
                      smsCodeSubmit: string
                      smsCodeTitle: string
                      smsCountryFieldLabel: string
                      smsCountryFormat: string
                      smsHaveAccessCode: string
                      smsMessageFormat: string
                      smsNumberCancel: string
                      smsNumberError: string
                      smsNumberFieldLabel: string
                      smsNumberFormat: string
                      smsNumberMessage: string
                      smsNumberSubmit: string
                      smsNumberTitle: string
                      smsUsernameFormat: string
                      smsValidityDuration: 5
                      sponsorBackLink: string
                      sponsorCancel: string
                      sponsorEmail: string
                      sponsorEmailError: string
                      sponsorEmailTemplate: string
                      sponsorInfoApproved: string
                      sponsorInfoDenied: string
                      sponsorInfoPending: string
                      sponsorName: string
                      sponsorNameError: string
                      sponsorNotePending: string
                      sponsorStatusApproved: string
                      sponsorStatusDenied: string
                      sponsorStatusPending: string
                      sponsorSubmit: string
                      tos: true
                      tosAcceptLabel: string
                      tosError: string
                      tosLink: string
                      tosText: string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/wxrules:
    get:
      tags:
      - Orgs WxRules
      summary: listOrgWxRules
      description: Get List of Org WxRules
      operationId: listOrgWxRules
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: List of WxRules
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/wxlan_rule'
                description: WxLAN policy rules returned by a list response
                examples:
                - - action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-bfeb-53ebbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-bfeb-53ebbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/wxlan_rule'
                description: WxLAN policy rules returned by a list response
                examples:
                - - action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-bfeb-53ebbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-bfeb-53ebbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs WxRules
      summary: createOrgWxRule
      description: Create Org WxRule
      operationId: createOrgWxRule
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/wxlan_rule'
              - description: Request Body
                examples:
                - action: allow
                  apply_tags:
                  - c049dfcd-0c73-5014-1c64-062e9903f1e5
                  blocked_apps:
                  - mist
                  - all-videos
                  dst_allow_wxtags:
                  - fff34466-eec0-3756-6765-381c728a6037
                  - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                  dst_deny_wxtags:
                  - aaa34466-eec0-3756-6765-381c728a6037
                  - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                  enabled: true
                  order: 1
                  src_wxtags:
                  - 8bfc2490-d726-3587-038d-cb2e71bd2330
                  - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
              contentMediaType: application/json
            examples:
              Example:
                value:
                  action: allow
                  apply_tags:
                  - c049dfcd-0c73-5014-1c64-062e9903f1e5
                  blocked_apps:
                  - mist
                  - all-videos
                  dst_allow_wxtags:
                  - fff34466-eec0-3756-6765-381c728a6037
                  - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                  dst_deny_wxtags:
                  - aaa34466-eec0-3756-6765-381c728a6037
                  - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                  enabled: true
                  order: 1
                  src_wxtags:
                  - 8bfc2490-d726-3587-038d-cb2e71bd2330
                  - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
        required: false
      responses:
        '200':
          description: Wrule
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_rule'
                - description: WxLAN policy rule controlling traffic between WxLAN tags
                  examples:
                  - action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-9feb-53cbbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-9feb-53cbbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_rule'
                - description: WxLAN policy rule controlling traffic between WxLAN tags
                  examples:
                  - action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-9feb-53cbbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-9feb-53cbbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/wxrules/{wxrule_id}:
    delete:
      tags:
      - Orgs WxRules
      summary: deleteOrgWxRule
      description: Delete Org WxRule
      operationId: deleteOrgWxRule
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wxrule_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs WxRules
      summary: getOrgWxRule
      description: Get Org WxRule Details
      operationId: getOrgWxRule
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wxrule_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Wrule
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_rule'
                - description: WxLAN policy rule controlling traffic between WxLAN tags
                  examples:
                  - action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-9feb-53cbbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-9feb-53cbbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_rule'
                - description: WxLAN policy rule controlling traffic between WxLAN tags
                  examples:
                  - action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-9feb-53cbbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-9feb-53cbbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs WxRules
      summary: updateOrgWxRule
      description: Update Org WxRule
      operationId: updateOrgWxRule
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wxrule_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/wxlan_rule'
              - description: Request Body
                examples:
                - action: allow
                  apply_tags:
                  - c049dfcd-0c73-5014-1c64-062e9903f1e5
                  blocked_apps:
                  - mist
                  - all-videos
                  dst_allow_wxtags:
                  - fff34466-eec0-3756-6765-381c728a6037
                  - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                  dst_deny_wxtags:
                  - aaa34466-eec0-3756-6765-381c728a6037
                  - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                  enabled: true
                  order: 1
                  src_wxtags:
                  - 8bfc2490-d726-3587-038d-cb2e71bd2330
                  - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
              contentMediaType: application/json
            examples:
              Example:
                value:
                  action: allow
                  apply_tags:
                  - c049dfcd-0c73-5014-1c64-062e9903f1e5
                  blocked_apps:
                  - mist
                  - all-videos
                  dst_allow_wxtags:
                  - fff34466-eec0-3756-6765-381c728a6037
                  - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                  dst_deny_wxtags:
                  - aaa34466-eec0-3756-6765-381c728a6037
                  - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                  enabled: true
                  order: 1
                  src_wxtags:
                  - 8bfc2490-d726-3587-038d-cb2e71bd2330
                  - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
        required: false
      responses:
        '200':
          description: Wrule
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_rule'
                - description: WxLAN policy rule controlling traffic between WxLAN tags
                  examples:
                  - action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-9feb-53cbbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-9feb-53cbbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_rule'
                - description: WxLAN policy rule controlling traffic between WxLAN tags
                  examples:
                  - action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-9feb-53cbbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-9feb-53cbbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/wxtags:
    get:
      tags:
      - Orgs WxTags
      summary: listOrgWxTags
      description: Get List of Org WxLAN Tags
      operationId: listOrgWxTags
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/wxlan_tag'
                description: WxLAN tag records returned by a list response
                examples:
                - - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    last_ips:
                    - string
                    mac: string
                    match: wlan_id
                    modified_time: 0
                    name: string
                    op: in
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    resource_mac: string
                    services:
                    - string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    specs:
                    - port_range: string
                      protocol: tcp
                      subnets:
                      - string
                    subnet: string
                    type: match
                    values:
                    - string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    last_ips:
                    - string
                    mac: string
                    match: wlan_id
                    modified_time: 0
                    name: string
                    op: in
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    resource_mac: string
                    services:
                    - string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    specs:
                    - port_range: string
                      protocol: tcp
                      subnets:
                      - string
                    subnet: string
                    type: match
                    values:
                    - string
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/wxlan_tag'
                description: WxLAN tag records returned by a list response
                examples:
                - - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    last_ips:
                    - string
                    mac: string
                    match: wlan_id
                    modified_time: 0
                    name: string
                    op: in
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    resource_mac: string
                    services:
                    - string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    specs:
                    - port_range: string
                      protocol: tcp
                      subnets:
                      - string
                    subnet: string
                    type: match
                    values:
                    - string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    last_ips:
                    - string
                    mac: string
                    match: wlan_id
                    modified_time: 0
                    name: string
                    op: in
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    resource_mac: string
                    services:
                    - string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    specs:
                    - port_range: string
                      protocol: tcp
                      subnets:
                      - string
                    subnet: string
                    type: match
                    values:
                    - string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs WxTags
      summary: createOrgWxTag
      description: Create WxLAN Tag
      operationId: createOrgWxTag
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/wxlan_tag'
              - description: Request Body
                examples:
                - '{"match":"app","name":"match app","type":"match","values":["gmail","dropbox"]}'
                - '{"match":"client_mac","name":"file_servers","type":"match","values":["b0c4e7001543","a0c4e7001543","00c4e7001543"]}'
                - '{"match":"hostname","name":"mist","type":"match","values":["mist.com"]}'
                - '{"match":"ip_range_subnet","name":"file_servers","type":"match","values":["10.1.2.1","10.2.3.4/24","10.1.2.5-10.2.3.4"]}'
                - '{"match":"port","name":"web-ports","type":"match","values":["80","8000","8080"]}'
                - '{"match":"psk_name","name":"VIP","type":"match","values":["test_key1","test_key2"]}'
                - '{"match":"psk_role","name":"VIP","type":"match","values":["test_role"]}'
                - '{"match":"radius_group","name":"VIP","type":"match","values":["vip"]}'
                - '{"match":"radius_username","name":"VIP","type":"match","values":["john@abc.com","eric@abc.com"]}'
                - '{"name":"protocol-subnet-port","specs":[{"port_range":"80","protocol":"tcp","subnets":["10.1.2.0/24"]}],"type":"spec"}'
                - '{"name":"vlan-assignment","type":"vlan","vlan_id":1055}'
                - '{"match":"wlan_id","name":"guest-wlan","type":"match","values":["be22bba78e22e1cf5185b880816fe2cf"]}'
              contentMediaType: application/json
            examples:
              app:
                value:
                  match: app
                  name: match app
                  type: match
                  values:
                  - gmail
                  - dropbox
              client_mac:
                value:
                  match: client_mac
                  name: file_servers
                  type: match
                  values:
                  - b0c4e7001543
                  - a0c4e7001543
                  - 00c4e7001543
              hostnames:
                value:
                  match: hostname
                  name: mist
                  type: match
                  values:
                  - mist.com
              ip_range_subnets:
                value:
                  match: ip_range_subnet
                  name: file_servers
                  type: match
                  values:
                  - 10.1.2.1
                  - 10.2.3.4/24
                  - 10.1.2.5-10.2.3.4
              ports:
                value:
                  match: port
                  name: web-ports
                  type: match
                  values:
                  - '80'
                  - '8000'
                  - '8080'
              psk_name:
                value:
                  match: psk_name
                  name: VIP
                  type: match
                  values:
                  - test_key1
                  - test_key2
              psk_role:
                value:
                  match: psk_role
                  name: VIP
                  type: match
                  values:
                  - test_role
              radius_group:
                value:
                  match: radius_group
                  name: VIP
                  type: match
                  values:
                  - vip
              radius_username:
                value:
                  match: radius_username
                  name: VIP
                  type: match
                  values:
                  - john@abc.com
                  - eric@abc.com
              traffic-spec:
                value:
                  name: protocol-subnet-port
                  specs:
                  - port_range: '80'
                    protocol: tcp
                    subnets:
                    - 10.1.2.0/24
                  type: spec
              vlan:
                value:
                  name: vlan-assignment
                  type: vlan
                  vlan_id: 1055
              wlan_id:
                value:
                  match: wlan_id
                  name: guest-wlan
                  type: match
                  values:
                  - be22bba78e22e1cf5185b880816fe2cf
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_tag'
                - description: >-
                    WxLAN Tag
                      * type:
                        * client: created manually (e.g. on wireless client table, when they spot a device of interest, they can create a wxlan tag for it
                        * resource: created automatically when we discover a network resource
                        * subnet: create automatically when a subnet is discovered
                      * match:
                        * wlan_id, ap_id: values are a list of Wlan / Device ids
                        * client_mac: values are a list of MAC addresses
                      * radius_group: this is a smart tag that matches RADIUS-Filter-ID, Airespace-ACL-Name (VendorID=14179, VendorType=6) / Aruba-User-Role (VendorID=14823, VendorType=1)
                      * radius_username: this matches the ATTR-User-Name(1)
                      * radius_class: the matches the ATTR-Class(25)
                      * radius_attr: the values are [ "6=1" , "26=10.2.3.4" ], this support other RADIUS attributes where we know the type
                      * radius_vendor: the values are [ "14179.10=1" , "14178.16=1.2.3.4" ], this matches vendor attributes and will be dynamically evaluated
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    last_ips:
                    - string
                    mac: string
                    match: wlan_id
                    modified_time: 0
                    name: string
                    op: in
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    resource_mac: string
                    services:
                    - string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    specs:
                    - port_range: string
                      protocol: tcp
                      subnets:
                      - string
                    subnet: string
                    type: match
                    values:
                    - string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    last_ips:
                    - string
                    mac: string
                    match: wlan_id
                    modified_time: 0
                    name: string
                    op: in
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    resource_mac: string
                    services:
                    - string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    specs:
                    - port_range: string
                      protocol: tcp
                      subnets:
                      - string
                    subnet: string
                    type: match
                    values:
                    - string
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_tag'
                - description: >-
                    WxLAN Tag
                      * type:
                        * client: created manually (e.g. on wireless client table, when they spot a device of interest, they can create a wxlan tag for it
                        * resource: created automatically when we discover a network resource
                        * subnet: create automatically when a subnet is discovered
                      * match:
                        * wlan_id, ap_id: values are a list of Wlan / Device ids
                        * client_mac: values are a list of MAC addresses
                      * radius_group: this is a smart tag that matches RADIUS-Filter-ID, Airespace-ACL-Name (VendorID=14179, VendorType=6) / Aruba-User-Role (VendorID=14823, VendorType=1)
                      * radius_username: this matches the ATTR-User-Name(1)
                      * radius_class: the matches the ATTR-Class(25)
                      * radius_attr: the values are [ "6=1" , "26=10.2.3.4" ], this support other RADIUS attributes where we know the type
                      * radius_vendor: the values are [ "14179.10=1" , "14178.16=1.2.3.4" ], this matches vendor attributes and will be dynamically evaluated
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    last_ips:
                    - string
                    mac: string
                    match: wlan_id
                    modified_time: 0
                    name: string
                    op: in
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    resource_mac: string
                    services:
                    - string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    specs:
                    - port_range: string
                      protocol: tcp
                      subnets:
                      - string
                    subnet: string
                    type: match
                    values:
                    - string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    last_ips:
                    - string
                    mac: string
                    match: wlan_id
                    modified_time: 0
                    name: string
                    op: in
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    resource_mac: string
                    services:
                    - string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    specs:
                    - port_range: string
                      protocol: tcp
                      subnets:
                      - string
                    subnet: string
                    type: match
                    values:
                    - string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/wxtags/apps:
    get:
      tags:
      - Orgs WxTags
      summary: getOrgApplicationList
      description: Get Application List
      operationId: getOrgApplicationList
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: List of Applications
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/search_wxtag_apps_item'
                description: Applications that can be referenced by WxTag rules
                examples:
                - - group: Emails
                    key: gmail
                    name: Gmail - web/app
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - group: Emails
                    key: gmail
                    name: Gmail - web/app
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/search_wxtag_apps_item'
                description: Applications that can be referenced by WxTag rules
                examples:
                - - group: Emails
                    key: gmail
                    name: Gmail - web/app
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - group: Emails
                    key: gmail
                    name: Gmail - web/app
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/wxtags/{wxtag_id}:
    delete:
      tags:
      - Orgs WxTags
      summary: deleteOrgWxTag
      description: Delete WxLAN Tag
      operationId: deleteOrgWxTag
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wxtag_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs WxTags
      summary: getOrgWxTag
      description: Get WxLAN Tag Details
      operationId: getOrgWxTag
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wxtag_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_tag'
                - description: >-
                    WxLAN Tag
                      * type:
                        * client: created manually (e.g. on wireless client table, when they spot a device of interest, they can create a wxlan tag for it
                        * resource: created automatically when we discover a network resource
                        * subnet: create automatically when a subnet is discovered
                      * match:
                        * wlan_id, ap_id: values are a list of Wlan / Device ids
                        * client_mac: values are a list of MAC addresses
                      * radius_group: this is a smart tag that matches RADIUS-Filter-ID, Airespace-ACL-Name (VendorID=14179, VendorType=6) / Aruba-User-Role (VendorID=14823, VendorType=1)
                      * radius_username: this matches the ATTR-User-Name(1)
                      * radius_class: the matches the ATTR-Class(25)
                      * radius_attr: the values are [ "6=1" , "26=10.2.3.4" ], this support other RADIUS attributes where we know the type
                      * radius_vendor: the values are [ "14179.10=1" , "14178.16=1.2.3.4" ], this matches vendor attributes and will be dynamically evaluated
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    last_ips:
                    - string
                    mac: string
                    match: wlan_id
                    modified_time: 0
                    name: string
                    op: in
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    resource_mac: string
                    services:
                    - string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    specs:
                    - port_range: string
                      protocol: tcp
                      subnets:
                      - string
                    subnet: string
                    type: match
                    values:
                    - string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    last_ips:
                    - string
                    mac: string
                    match: wlan_id
                    modified_time: 0
                    name: string
                    op: in
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    resource_mac: string
                    services:
                    - string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    specs:
                    - port_range: string
                      protocol: tcp
                      subnets:
                      - string
                    subnet: string
                    type: match
                    values:
                    - string
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_tag'
                - description: >-
                    WxLAN Tag
                      * type:
                        * client: created manually (e.g. on wireless client table, when they spot a device of interest, they can create a wxlan tag for it
                        * resource: created automatically when we discover a network resource
                        * subnet: create automatically when a subnet is discovered
                      * match:
                        * wlan_id, ap_id: values are a list of Wlan / Device ids
                        * client_mac: values are a list of MAC addresses
                      * radius_group: this is a smart tag that matches RADIUS-Filter-ID, Airespace-ACL-Name (VendorID=14179, VendorType=6) / Aruba-User-Role (VendorID=14823, VendorType=1)
                      * radius_username: this matches the ATTR-User-Name(1)
                      * radius_class: the matches the ATTR-Class(25)
                      * radius_attr: the values are [ "6=1" , "26=10.2.3.4" ], this support other RADIUS attributes where we know the type
                      * radius_vendor: the values are [ "14179.10=1" , "14178.16=1.2.3.4" ], this matches vendor attributes and will be dynamically evaluated
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    last_ips:
                    - string
                    mac: string
                    match: wlan_id
                    modified_time: 0
                    name: string
                    op: in
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    resource_mac: string
                    services:
                    - string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    specs:
                    - port_range: string
                      protocol: tcp
                      subnets:
                      - string
                    subnet: string
                    type: match
                    values:
                    - string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    last_ips:
                    - string
                    mac: string
                    match: wlan_id
                    modified_time: 0
                    name: string
                    op: in
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    resource_mac: string
                    services:
                    - string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    specs:
                    - port_range: string
                      protocol: tcp
                      subnets:
                      - string
                    subnet: string
                    type: match
                    values:
                    - string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs WxTags
      summary: updateOrgWxTag
      description: Update WxLAN Tag
      operationId: updateOrgWxTag
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wxtag_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/wxlan_tag'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_tag'
                - description: >-
                    WxLAN Tag
                      * type:
                        * client: created manually (e.g. on wireless client table, when they spot a device of interest, they can create a wxlan tag for it
                        * resource: created automatically when we discover a network resource
                        * subnet: create automatically when a subnet is discovered
                      * match:
                        * wlan_id, ap_id: values are a list of Wlan / Device ids
                        * client_mac: values are a list of MAC addresses
                      * radius_group: this is a smart tag that matches RADIUS-Filter-ID, Airespace-ACL-Name (VendorID=14179, VendorType=6) / Aruba-User-Role (VendorID=14823, VendorType=1)
                      * radius_username: this matches the ATTR-User-Name(1)
                      * radius_class: the matches the ATTR-Class(25)
                      * radius_attr: the values are [ "6=1" , "26=10.2.3.4" ], this support other RADIUS attributes where we know the type
                      * radius_vendor: the values are [ "14179.10=1" , "14178.16=1.2.3.4" ], this matches vendor attributes and will be dynamically evaluated
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    last_ips:
                    - string
                    mac: string
                    match: wlan_id
                    modified_time: 0
                    name: string
                    op: in
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    resource_mac: string
                    services:
                    - string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    specs:
                    - port_range: string
                      protocol: tcp
                      subnets:
                      - string
                    subnet: string
                    type: match
                    values:
                    - string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    last_ips:
                    - string
                    mac: string
                    match: wlan_id
                    modified_time: 0
                    name: string
                    op: in
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    resource_mac: string
                    services:
                    - string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    specs:
                    - port_range: string
                      protocol: tcp
                      subnets:
                      - string
                    subnet: string
                    type: match
                    values:
                    - string
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_tag'
                - description: >-
                    WxLAN Tag
                      * type:
                        * client: created manually (e.g. on wireless client table, when they spot a device of interest, they can create a wxlan tag for it
                        * resource: created automatically when we discover a network resource
                        * subnet: create automatically when a subnet is discovered
                      * match:
                        * wlan_id, ap_id: values are a list of Wlan / Device ids
                        * client_mac: values are a list of MAC addresses
                      * radius_group: this is a smart tag that matches RADIUS-Filter-ID, Airespace-ACL-Name (VendorID=14179, VendorType=6) / Aruba-User-Role (VendorID=14823, VendorType=1)
                      * radius_username: this matches the ATTR-User-Name(1)
                      * radius_class: the matches the ATTR-Class(25)
                      * radius_attr: the values are [ "6=1" , "26=10.2.3.4" ], this support other RADIUS attributes where we know the type
                      * radius_vendor: the values are [ "14179.10=1" , "14178.16=1.2.3.4" ], this matches vendor attributes and will be dynamically evaluated
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    last_ips:
                    - string
                    mac: string
                    match: wlan_id
                    modified_time: 0
                    name: string
                    op: in
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    resource_mac: string
                    services:
                    - string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    specs:
                    - port_range: string
                      protocol: tcp
                      subnets:
                      - string
                    subnet: string
                    type: match
                    values:
                    - string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    last_ips:
                    - string
                    mac: string
                    match: wlan_id
                    modified_time: 0
                    name: string
                    op: in
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    resource_mac: string
                    services:
                    - string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    specs:
                    - port_range: string
                      protocol: tcp
                      subnets:
                      - string
                    subnet: string
                    type: match
                    values:
                    - string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/wxtags/{wxtag_id}/clients:
    get:
      tags:
      - Orgs WxTags
      summary: getOrgCurrentMatchingClientsOfAWxTag
      description: Get Current Matching Clients of a WXLAN Tag
      operationId: getOrgCurrentMatchingClientsOfAWxTag
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wxtag_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                uniqueItems: true
                type: array
                items:
                  $ref: '#/components/schemas/wxtag_client'
                description: Clients associated with a WxLAN tag
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                uniqueItems: true
                type: array
                items:
                  $ref: '#/components/schemas/wxtag_client'
                description: Clients associated with a WxLAN tag
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/wxtunnels:
    get:
      tags:
      - Orgs WxTunnels
      summary: listOrgWxTunnels
      description: Get List of Org WxLAN Tunnels
      operationId: listOrgWxTunnels
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/wxlan_tunnel'
                description: WxLAN tunnel records returned by a list response
                examples:
                - - created_time: 0
                    dmvpn:
                      enabled: true
                      holding_time: 0
                      host_routes:
                      - string
                    for_mgmt: true
                    hello_interval: 1
                    hello_retries: 3
                    hostname: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      enabled: true
                      psk: string123
                    is_static: true
                    modified_time: 0
                    mtu: 1500
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    peers:
                    - string
                    router_id: string
                    secret: string
                    sessions:
                    - ap_as_session_id: string
                      comment: string
                      enable_cookie: true
                      ethertype: ethernet
                      local_session_id: 1
                      pseudo_802.1ad_enabled: true
                      remote_id: string
                      remote_session_id: 1
                      use_ap_as_session_ids: true
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    udp_port: 0
                    use_udp: true
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 0
                    dmvpn:
                      enabled: true
                      holding_time: 0
                      host_routes:
                      - string
                    for_mgmt: true
                    hello_interval: 1
                    hello_retries: 3
                    hostname: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      enabled: true
                      psk: string123
                    is_static: true
                    modified_time: 0
                    mtu: 1500
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    peers:
                    - string
                    router_id: string
                    secret: string
                    sessions:
                    - ap_as_session_id: string
                      comment: string
                      enable_cookie: true
                      ethertype: ethernet
                      local_session_id: 1
                      pseudo_802.1ad_enabled: true
                      remote_id: string
                      remote_session_id: 1
                      use_ap_as_session_ids: true
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    udp_port: 0
                    use_udp: true
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/wxlan_tunnel'
                description: WxLAN tunnel records returned by a list response
                examples:
                - - created_time: 0
                    dmvpn:
                      enabled: true
                      holding_time: 0
                      host_routes:
                      - string
                    for_mgmt: true
                    hello_interval: 1
                    hello_retries: 3
                    hostname: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      enabled: true
                      psk: string123
                    is_static: true
                    modified_time: 0
                    mtu: 1500
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    peers:
                    - string
                    router_id: string
                    secret: string
                    sessions:
                    - ap_as_session_id: string
                      comment: string
                      enable_cookie: true
                      ethertype: ethernet
                      local_session_id: 1
                      pseudo_802.1ad_enabled: true
                      remote_id: string
                      remote_session_id: 1
                      use_ap_as_session_ids: true
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    udp_port: 0
                    use_udp: true
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 0
                    dmvpn:
                      enabled: true
                      holding_time: 0
                      host_routes:
                      - string
                    for_mgmt: true
                    hello_interval: 1
                    hello_retries: 3
                    hostname: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      enabled: true
                      psk: string123
                    is_static: true
                    modified_time: 0
                    mtu: 1500
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    peers:
                    - string
                    router_id: string
                    secret: string
                    sessions:
                    - ap_as_session_id: string
                      comment: string
                      enable_cookie: true
                      ethertype: ethernet
                      local_session_id: 1
                      pseudo_802.1ad_enabled: true
                      remote_id: string
                      remote_session_id: 1
                      use_ap_as_session_ids: true
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    udp_port: 0
                    use_udp: true
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs WxTunnels
      summary: createOrgWxTunnel
      description: Create Org WxAN Tunnel
      operationId: createOrgWxTunnel
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/wxlan_tunnel'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_tunnel'
                - description: WxLAN tunnel configuration for L2TPv3 or DMVPN connectivity
                  examples:
                  - created_time: 0
                    dmvpn:
                      enabled: true
                      holding_time: 0
                      host_routes:
                      - string
                    for_mgmt: true
                    hello_interval: 1
                    hello_retries: 3
                    hostname: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      enabled: true
                      psk: string123
                    is_static: true
                    modified_time: 0
                    mtu: 1500
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    peers:
                    - string
                    router_id: string
                    secret: string
                    sessions:
                    - ap_as_session_id: string
                      comment: string
                      enable_cookie: true
                      ethertype: ethernet
                      local_session_id: 1
                      pseudo_802.1ad_enabled: true
                      remote_id: string
                      remote_session_id: 1
                      use_ap_as_session_ids: true
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    udp_port: 0
                    use_udp: true
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    dmvpn:
                      enabled: true
                      holding_time: 0
                      host_routes:
                      - string
                    for_mgmt: true
                    hello_interval: 1
                    hello_retries: 3
                    hostname: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      enabled: true
                      psk: string123
                    is_static: true
                    modified_time: 0
                    mtu: 1500
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    peers:
                    - string
                    router_id: string
                    secret: string
                    sessions:
                    - ap_as_session_id: string
                      comment: string
                      enable_cookie: true
                      ethertype: ethernet
                      local_session_id: 1
                      pseudo_802.1ad_enabled: true
                      remote_id: string
                      remote_session_id: 1
                      use_ap_as_session_ids: true
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    udp_port: 0
                    use_udp: true
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_tunnel'
                - description: WxLAN tunnel configuration for L2TPv3 or DMVPN connectivity
                  examples:
                  - created_time: 0
                    dmvpn:
                      enabled: true
                      holding_time: 0
                      host_routes:
                      - string
                    for_mgmt: true
                    hello_interval: 1
                    hello_retries: 3
                    hostname: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      enabled: true
                      psk: string123
                    is_static: true
                    modified_time: 0
                    mtu: 1500
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    peers:
                    - string
                    router_id: string
                    secret: string
                    sessions:
                    - ap_as_session_id: string
                      comment: string
                      enable_cookie: true
                      ethertype: ethernet
                      local_session_id: 1
                      pseudo_802.1ad_enabled: true
                      remote_id: string
                      remote_session_id: 1
                      use_ap_as_session_ids: true
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    udp_port: 0
                    use_udp: true
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    dmvpn:
                      enabled: true
                      holding_time: 0
                      host_routes:
                      - string
                    for_mgmt: true
                    hello_interval: 1
                    hello_retries: 3
                    hostname: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      enabled: true
                      psk: string123
                    is_static: true
                    modified_time: 0
                    mtu: 1500
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    peers:
                    - string
                    router_id: string
                    secret: string
                    sessions:
                    - ap_as_session_id: string
                      comment: string
                      enable_cookie: true
                      ethertype: ethernet
                      local_session_id: 1
                      pseudo_802.1ad_enabled: true
                      remote_id: string
                      remote_session_id: 1
                      use_ap_as_session_ids: true
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    udp_port: 0
                    use_udp: true
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/wxtunnels/{wxtunnel_id}:
    delete:
      tags:
      - Orgs WxTunnels
      summary: deleteOrgWxTunnel
      description: Delete Org WxLAN Tunnel
      operationId: deleteOrgWxTunnel
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wxtunnel_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs WxTunnels
      summary: getOrgWxTunnel
      description: Get Org WxLAN Tunnel Details
      operationId: getOrgWxTunnel
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wxtunnel_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_tunnel'
                - description: WxLAN tunnel configuration for L2TPv3 or DMVPN connectivity
                  examples:
                  - created_time: 0
                    dmvpn:
                      enabled: true
                      holding_time: 0
                      host_routes:
                      - string
                    for_mgmt: true
                    hello_interval: 1
                    hello_retries: 3
                    hostname: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      enabled: true
                      psk: string123
                    is_static: true
                    modified_time: 0
                    mtu: 1500
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    peers:
                    - string
                    router_id: string
                    secret: string
                    sessions:
                    - ap_as_session_id: string
                      comment: string
                      enable_cookie: true
                      ethertype: ethernet
                      local_session_id: 1
                      pseudo_802.1ad_enabled: true
                      remote_id: string
                      remote_session_id: 1
                      use_ap_as_session_ids: true
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    udp_port: 0
                    use_udp: true
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    dmvpn:
                      enabled: true
                      holding_time: 0
                      host_routes:
                      - string
                    for_mgmt: true
                    hello_interval: 1
                    hello_retries: 3
                    hostname: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      enabled: true
                      psk: string123
                    is_static: true
                    modified_time: 0
                    mtu: 1500
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    peers:
                    - string
                    router_id: string
                    secret: string
                    sessions:
                    - ap_as_session_id: string
                      comment: string
                      enable_cookie: true
                      ethertype: ethernet
                      local_session_id: 1
                      pseudo_802.1ad_enabled: true
                      remote_id: string
                      remote_session_id: 1
                      use_ap_as_session_ids: true
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    udp_port: 0
                    use_udp: true
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_tunnel'
                - description: WxLAN tunnel configuration for L2TPv3 or DMVPN connectivity
                  examples:
                  - created_time: 0
                    dmvpn:
                      enabled: true
                      holding_time: 0
                      host_routes:
                      - string
                    for_mgmt: true
                    hello_interval: 1
                    hello_retries: 3
                    hostname: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      enabled: true
                      psk: string123
                    is_static: true
                    modified_time: 0
                    mtu: 1500
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    peers:
                    - string
                    router_id: string
                    secret: string
                    sessions:
                    - ap_as_session_id: string
                      comment: string
                      enable_cookie: true
                      ethertype: ethernet
                      local_session_id: 1
                      pseudo_802.1ad_enabled: true
                      remote_id: string
                      remote_session_id: 1
                      use_ap_as_session_ids: true
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    udp_port: 0
                    use_udp: true
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    dmvpn:
                      enabled: true
                      holding_time: 0
                      host_routes:
                      - string
                    for_mgmt: true
                    hello_interval: 1
                    hello_retries: 3
                    hostname: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      enabled: true
                      psk: string123
                    is_static: true
                    modified_time: 0
                    mtu: 1500
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    peers:
                    - string
                    router_id: string
                    secret: string
                    sessions:
                    - ap_as_session_id: string
                      comment: string
                      enable_cookie: true
                      ethertype: ethernet
                      local_session_id: 1
                      pseudo_802.1ad_enabled: true
                      remote_id: string
                      remote_session_id: 1
                      use_ap_as_session_ids: true
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    udp_port: 0
                    use_udp: true
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Orgs WxTunnels
      summary: updateOrgWxTunnel
      description: Update Org WxLAN Tunnel
      operationId: updateOrgWxTunnel
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wxtunnel_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/wxlan_tunnel'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_tunnel'
                - description: WxLAN tunnel configuration for L2TPv3 or DMVPN connectivity
                  examples:
                  - created_time: 0
                    dmvpn:
                      enabled: true
                      holding_time: 0
                      host_routes:
                      - string
                    for_mgmt: true
                    hello_interval: 1
                    hello_retries: 3
                    hostname: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      enabled: true
                      psk: string123
                    is_static: true
                    modified_time: 0
                    mtu: 1500
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    peers:
                    - string
                    router_id: string
                    secret: string
                    sessions:
                    - ap_as_session_id: string
                      comment: string
                      enable_cookie: true
                      ethertype: ethernet
                      local_session_id: 1
                      pseudo_802.1ad_enabled: true
                      remote_id: string
                      remote_session_id: 1
                      use_ap_as_session_ids: true
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    udp_port: 0
                    use_udp: true
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    dmvpn:
                      enabled: true
                      holding_time: 0
                      host_routes:
                      - string
                    for_mgmt: true
                    hello_interval: 1
                    hello_retries: 3
                    hostname: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      enabled: true
                      psk: string123
                    is_static: true
                    modified_time: 0
                    mtu: 1500
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    peers:
                    - string
                    router_id: string
                    secret: string
                    sessions:
                    - ap_as_session_id: string
                      comment: string
                      enable_cookie: true
                      ethertype: ethernet
                      local_session_id: 1
                      pseudo_802.1ad_enabled: true
                      remote_id: string
                      remote_session_id: 1
                      use_ap_as_session_ids: true
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    udp_port: 0
                    use_udp: true
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_tunnel'
                - description: WxLAN tunnel configuration for L2TPv3 or DMVPN connectivity
                  examples:
                  - created_time: 0
                    dmvpn:
                      enabled: true
                      holding_time: 0
                      host_routes:
                      - string
                    for_mgmt: true
                    hello_interval: 1
                    hello_retries: 3
                    hostname: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      enabled: true
                      psk: string123
                    is_static: true
                    modified_time: 0
                    mtu: 1500
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    peers:
                    - string
                    router_id: string
                    secret: string
                    sessions:
                    - ap_as_session_id: string
                      comment: string
                      enable_cookie: true
                      ethertype: ethernet
                      local_session_id: 1
                      pseudo_802.1ad_enabled: true
                      remote_id: string
                      remote_session_id: 1
                      use_ap_as_session_ids: true
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    udp_port: 0
                    use_udp: true
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    dmvpn:
                      enabled: true
                      holding_time: 0
                      host_routes:
                      - string
                    for_mgmt: true
                    hello_interval: 1
                    hello_retries: 3
                    hostname: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      enabled: true
                      psk: string123
                    is_static: true
                    modified_time: 0
                    mtu: 1500
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    peers:
                    - string
                    router_id: string
                    secret: string
                    sessions:
                    - ap_as_session_id: string
                      comment: string
                      enable_cookie: true
                      ethertype: ethernet
                      local_session_id: 1
                      pseudo_802.1ad_enabled: true
                      remote_id: string
                      remote_session_id: 1
                      use_ap_as_session_ids: true
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    udp_port: 0
                    use_udp: true
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/analyze_spectrum:
    get:
      tags:
      - Sites Spectrum Analysis
      summary: getSiteRunningSpectrumAnalysis
      description: Get the running spectrum analysis for a site
      operationId: getSiteRunningSpectrumAnalysis
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_running_spectrum_analysis'
                - description: Running spectrum analysis session for a site
                  examples:
                  - band: '5'
                    channels:
                    - 36
                    - 40
                    - 44
                    - 48
                    device_id: 00000000-0000-0000-1000-5c5b35bd76bb
                    duration: 600
                    format: stream
                    started_time: 1435080709
                    width: 20
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    band: '5'
                    channels:
                    - 36
                    - 40
                    - 44
                    - 48
                    device_id: 00000000-0000-0000-1000-5c5b35bd76bb
                    duration: 600
                    format: stream
                    started_time: 1435080709
                    width: 20
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_running_spectrum_analysis'
                - description: Running spectrum analysis session for a site
                  examples:
                  - band: '5'
                    channels:
                    - 36
                    - 40
                    - 44
                    - 48
                    device_id: 00000000-0000-0000-1000-5c5b35bd76bb
                    duration: 600
                    format: stream
                    started_time: 1435080709
                    width: 20
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    band: '5'
                    channels:
                    - 36
                    - 40
                    - 44
                    - 48
                    device_id: 00000000-0000-0000-1000-5c5b35bd76bb
                    duration: 600
                    format: stream
                    started_time: 1435080709
                    width: 20
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites Spectrum Analysis
      summary: initiateSiteAnalyzeSpectrum
      description: "Initiate a spectrum analysis for a site\n\n\nThe output will be available through websocket. As there can be multiple command\nissued against the same device at the same time and the output all goes through\nthe same websocket stream, session is introduced for demux.\n\n\n\n#### Subscribe to Device Command outputs\n\n`WS /api-ws/v1/stream`\n\n\n```json { \"subscribe\": \"/sites/{site_id}/analyze_spectrum\" } ```\n\n#### Example output from ws stream\n\n```json\n{\n  \"event\": \"data\",\n  \"channel\": \"/sites/4ac1dcf4-9d8b-7211-65c4-057819f0862b/analyze_spectrum\",\n  \"data\": {\n      \"session\": \"session_id\",\n\n      \"fft_samples\": [\n          {\n              \"frequency\": 2437.0,\n              \"rssi / signal ?\": -93\n          },\n          ...\n      ],\n\n      \"channel_usage\": [\n          {\n              \"channel\": 36,\n              \"noise\": -78,\n\n              \"wifi\": 0.13,\n              \"non_wifi\": 0.08\n          },\n          ...\n      ]\n  }\n}     \n```\n"
      operationId: initiateSiteAnalyzeSpectrum
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/spectrum_analysis'
              - description: Request Body
                examples:
                - band: '5'
                  channels:
                  - 36
                  - 40
                  - 44
                  - 48
                  device_id: 00000000-0000-0000-1000-5c5b35bd76bb
                  duration: 600
                  format: stream
              contentMediaType: application/json
            examples:
              Example:
                value:
                  band: '5'
                  channels:
                  - 36
                  - 40
                  - 44
                  - 48
                  device_id: 00000000-0000-0000-1000-5c5b35bd76bb
                  duration: 600
                  format: stream
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/analyze_spectrum:
    get:
      tags:
      - Sites Spectrum Analysis
      summary: listSiteSpectrumAnalysis
      description: List the past spectrum analysis for a site
      operationId: listSiteSpectrumAnalysis
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_past_spectrum_analysis'
                - description: Paginated response for past site spectrum analysis records
                  examples:
                  - end: 1694708579
                    limit: 10
                    results:
                    - band: '5'
                      channel_usage:
                      - channel: 36
                        noise: -78
                        non_wifi: 0.08
                        wifi: 0.13
                      fft_samples:
                      - frequency: 2437
                        rssi: -92
                        signal7: -93
                      mac: 5c5b35bd76bb
                      org_id: f2695c32-0e83-4936-b1b2-96fc88051213
                      timestamp: 1694098696
                    start: 1694622179
                    total: 4
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1694708579
                    limit: 10
                    results:
                    - band: '5'
                      channel_usage:
                      - channel: 36
                        noise: -78
                        non_wifi: 0.08
                        wifi: 0.13
                      fft_samples:
                      - frequency: 2437
                        rssi: -92
                        signal7: -93
                      mac: 5c5b35bd76bb
                      org_id: f2695c32-0e83-4936-b1b2-96fc88051213
                      timestamp: 1694098696
                    start: 1694622179
                    total: 4
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_past_spectrum_analysis'
                - description: Paginated response for past site spectrum analysis records
                  examples:
                  - end: 1694708579
                    limit: 10
                    results:
                    - band: '5'
                      channel_usage:
                      - channel: 36
                        noise: -78
                        non_wifi: 0.08
                        wifi: 0.13
                      fft_samples:
                      - frequency: 2437
                        rssi: -92
                        signal7: -93
                      mac: 5c5b35bd76bb
                      org_id: f2695c32-0e83-4936-b1b2-96fc88051213
                      timestamp: 1694098696
                    start: 1694622179
                    total: 4
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1694708579
                    limit: 10
                    results:
                    - band: '5'
                      channel_usage:
                      - channel: 36
                        noise: -78
                        non_wifi: 0.08
                        wifi: 0.13
                      fft_samples:
                      - frequency: 2437
                        rssi: -92
                        signal7: -93
                      mac: 5c5b35bd76bb
                      org_id: f2695c32-0e83-4936-b1b2-96fc88051213
                      timestamp: 1694098696
                    start: 1694622179
                    total: 4
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}:
    delete:
      tags:
      - Sites
      summary: deleteSite
      description: Delete Site
      operationId: deleteSite
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Sites
      summary: getSiteInfo
      description: >-
        Provides information about the site, including its name, address,

        timezone, and associated templates. This endpoint is useful for retrieving

        the current configuration and details of a specific site.
      operationId: getSiteInfo
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/site'
                - description: Site configuration and metadata within an organization
                  examples:
                  - address: 1601 S. Deanza Blvd., Cupertino, CA, 95014
                    alarmtemplate_id: 684dfc5c-fe77-2290-eb1d-ef3d677fe168
                    aptemplate_id: 16bdf952-ade2-4491-80b0-85ce506c760b
                    country_code: US
                    created_time: 0
                    gatewaytemplate_id: 6f9b2e75-9b2f-b5ae-81e3-e14c76f1a90f
                    id: 497f6eca-6276-5005-bfeb-53cbbbba6f17
                    latlng:
                      lat: 37.295833
                      lng: -122.032946
                    modified_time: 0
                    name: Mist Office
                    networktemplate_id: 12ae9bd2-e0ab-107b-72e8-a7a005565ec2
                    notes: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    rftemplate_id: bb8a9017-1e36-5d6c-6f2b-551abe8a76a2
                    secpolicy_id: 3bcd0beb-5d0a-4cbd-92c1-14aea91e98ef
                    sitegroup_ids:
                    - 497f6eca-6276-5006-bfeb-53cbbbba6f18
                    timezone: America/Los_Angeles
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    address: 1601 S. Deanza Blvd., Cupertino, CA, 95014
                    alarmtemplate_id: 684dfc5c-fe77-2290-eb1d-ef3d677fe168
                    aptemplate_id: 16bdf952-ade2-4491-80b0-85ce506c760b
                    country_code: US
                    created_time: 0
                    gatewaytemplate_id: 6f9b2e75-9b2f-b5ae-81e3-e14c76f1a90f
                    id: 497f6eca-6276-5005-bfeb-53cbbbba6f17
                    latlng:
                      lat: 37.295833
                      lng: -122.032946
                    modified_time: 0
                    name: Mist Office
                    networktemplate_id: 12ae9bd2-e0ab-107b-72e8-a7a005565ec2
                    notes: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    rftemplate_id: bb8a9017-1e36-5d6c-6f2b-551abe8a76a2
                    secpolicy_id: 3bcd0beb-5d0a-4cbd-92c1-14aea91e98ef
                    sitegroup_ids:
                    - 497f6eca-6276-5006-bfeb-53cbbbba6f18
                    timezone: America/Los_Angeles
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/site'
                - description: Site configuration and metadata within an organization
                  examples:
                  - address: 1601 S. Deanza Blvd., Cupertino, CA, 95014
                    alarmtemplate_id: 684dfc5c-fe77-2290-eb1d-ef3d677fe168
                    aptemplate_id: 16bdf952-ade2-4491-80b0-85ce506c760b
                    country_code: US
                    created_time: 0
                    gatewaytemplate_id: 6f9b2e75-9b2f-b5ae-81e3-e14c76f1a90f
                    id: 497f6eca-6276-5005-bfeb-53cbbbba6f17
                    latlng:
                      lat: 37.295833
                      lng: -122.032946
                    modified_time: 0
                    name: Mist Office
                    networktemplate_id: 12ae9bd2-e0ab-107b-72e8-a7a005565ec2
                    notes: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    rftemplate_id: bb8a9017-1e36-5d6c-6f2b-551abe8a76a2
                    secpolicy_id: 3bcd0beb-5d0a-4cbd-92c1-14aea91e98ef
                    sitegroup_ids:
                    - 497f6eca-6276-5006-bfeb-53cbbbba6f18
                    timezone: America/Los_Angeles
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    address: 1601 S. Deanza Blvd., Cupertino, CA, 95014
                    alarmtemplate_id: 684dfc5c-fe77-2290-eb1d-ef3d677fe168
                    aptemplate_id: 16bdf952-ade2-4491-80b0-85ce506c760b
                    country_code: US
                    created_time: 0
                    gatewaytemplate_id: 6f9b2e75-9b2f-b5ae-81e3-e14c76f1a90f
                    id: 497f6eca-6276-5005-bfeb-53cbbbba6f17
                    latlng:
                      lat: 37.295833
                      lng: -122.032946
                    modified_time: 0
                    name: Mist Office
                    networktemplate_id: 12ae9bd2-e0ab-107b-72e8-a7a005565ec2
                    notes: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    rftemplate_id: bb8a9017-1e36-5d6c-6f2b-551abe8a76a2
                    secpolicy_id: 3bcd0beb-5d0a-4cbd-92c1-14aea91e98ef
                    sitegroup_ids:
                    - 497f6eca-6276-5006-bfeb-53cbbbba6f18
                    timezone: America/Los_Angeles
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Sites
      summary: updateSiteInfo
      description: "Updates the configuration and metadata for an existing site. \n\n\nThis endpoint allows modification of site properties including location details (address, coordinates, timezone), template associations (alarm, network, RF, security policy templates), site group memberships, and general information (name, notes).\n\n\nAll fields are optional and only provided fields will be updated."
      operationId: updateSiteInfo
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/site'
              - description: Request Body
                examples:
                - address: string
                  alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  country_code: string
                  latlng:
                    lat: 0
                    lng: 0
                  name: string
                  networktemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  notes: string
                  rftemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  secpolicy_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  sitegroup_ids:
                  - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  timezone: string
              contentMediaType: application/json
            examples:
              Example:
                value:
                  address: string
                  alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  country_code: string
                  latlng:
                    lat: 0
                    lng: 0
                  name: string
                  networktemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  notes: string
                  rftemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  secpolicy_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  sitegroup_ids:
                  - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  timezone: string
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/site'
                - description: Site configuration and metadata within an organization
                  examples:
                  - address: 1601 S. Deanza Blvd., Cupertino, CA, 95014
                    alarmtemplate_id: 684dfc5c-fe77-2290-eb1d-ef3d677fe168
                    aptemplate_id: 16bdf952-ade2-4491-80b0-85ce506c760b
                    country_code: US
                    created_time: 0
                    gatewaytemplate_id: 6f9b2e75-9b2f-b5ae-81e3-e14c76f1a90f
                    id: 497f6eca-6276-5005-bfeb-53cbbbba6f17
                    latlng:
                      lat: 37.295833
                      lng: -122.032946
                    modified_time: 0
                    name: Mist Office
                    networktemplate_id: 12ae9bd2-e0ab-107b-72e8-a7a005565ec2
                    notes: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    rftemplate_id: bb8a9017-1e36-5d6c-6f2b-551abe8a76a2
                    secpolicy_id: 3bcd0beb-5d0a-4cbd-92c1-14aea91e98ef
                    sitegroup_ids:
                    - 497f6eca-6276-5006-bfeb-53cbbbba6f18
                    timezone: America/Los_Angeles
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    address: 1601 S. Deanza Blvd., Cupertino, CA, 95014
                    alarmtemplate_id: 684dfc5c-fe77-2290-eb1d-ef3d677fe168
                    aptemplate_id: 16bdf952-ade2-4491-80b0-85ce506c760b
                    country_code: US
                    created_time: 0
                    gatewaytemplate_id: 6f9b2e75-9b2f-b5ae-81e3-e14c76f1a90f
                    id: 497f6eca-6276-5005-bfeb-53cbbbba6f17
                    latlng:
                      lat: 37.295833
                      lng: -122.032946
                    modified_time: 0
                    name: Mist Office
                    networktemplate_id: 12ae9bd2-e0ab-107b-72e8-a7a005565ec2
                    notes: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    rftemplate_id: bb8a9017-1e36-5d6c-6f2b-551abe8a76a2
                    secpolicy_id: 3bcd0beb-5d0a-4cbd-92c1-14aea91e98ef
                    sitegroup_ids:
                    - 497f6eca-6276-5006-bfeb-53cbbbba6f18
                    timezone: America/Los_Angeles
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/site'
                - description: Site configuration and metadata within an organization
                  examples:
                  - address: 1601 S. Deanza Blvd., Cupertino, CA, 95014
                    alarmtemplate_id: 684dfc5c-fe77-2290-eb1d-ef3d677fe168
                    aptemplate_id: 16bdf952-ade2-4491-80b0-85ce506c760b
                    country_code: US
                    created_time: 0
                    gatewaytemplate_id: 6f9b2e75-9b2f-b5ae-81e3-e14c76f1a90f
                    id: 497f6eca-6276-5005-bfeb-53cbbbba6f17
                    latlng:
                      lat: 37.295833
                      lng: -122.032946
                    modified_time: 0
                    name: Mist Office
                    networktemplate_id: 12ae9bd2-e0ab-107b-72e8-a7a005565ec2
                    notes: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    rftemplate_id: bb8a9017-1e36-5d6c-6f2b-551abe8a76a2
                    secpolicy_id: 3bcd0beb-5d0a-4cbd-92c1-14aea91e98ef
                    sitegroup_ids:
                    - 497f6eca-6276-5006-bfeb-53cbbbba6f18
                    timezone: America/Los_Angeles
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    address: 1601 S. Deanza Blvd., Cupertino, CA, 95014
                    alarmtemplate_id: 684dfc5c-fe77-2290-eb1d-ef3d677fe168
                    aptemplate_id: 16bdf952-ade2-4491-80b0-85ce506c760b
                    country_code: US
                    created_time: 0
                    gatewaytemplate_id: 6f9b2e75-9b2f-b5ae-81e3-e14c76f1a90f
                    id: 497f6eca-6276-5005-bfeb-53cbbbba6f17
                    latlng:
                      lat: 37.295833
                      lng: -122.032946
                    modified_time: 0
                    name: Mist Office
                    networktemplate_id: 12ae9bd2-e0ab-107b-72e8-a7a005565ec2
                    notes: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    rftemplate_id: bb8a9017-1e36-5d6c-6f2b-551abe8a76a2
                    secpolicy_id: 3bcd0beb-5d0a-4cbd-92c1-14aea91e98ef
                    sitegroup_ids:
                    - 497f6eca-6276-5006-bfeb-53cbbbba6f18
                    timezone: America/Los_Angeles
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/alarms/ack:
    post:
      tags:
      - Sites Alarms
      summary: AckSiteMultipleAlarms
      description: Ack multiple Site Alarms
      operationId: AckSiteMultipleAlarms
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/alarm_ack'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/alarms/ack_all:
    post:
      tags:
      - Sites Alarms
      summary: ackSiteAllAlarms
      description: >-
        Ack all Site Alarms


        **N.B.**: Batch size for multiple alarm ack and unack has to be less or or equal to 1000.
      operationId: ackSiteAllAlarms
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/note_string'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/alarms/count:
    get:
      tags:
      - Sites Alarms
      summary: countSiteAlarms
      description: Count alarms for a site, optionally grouped by the `distinct` field and filtered by time range. Use [Count Org Alarms]($e/Orgs%20Alarms/countOrgAlarms) to count alarms across the organization.
      operationId: countSiteAlarms
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `acked`, `group`, `severity`, `type`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/alarm_count_distinct'
          - description: 'Field used to group this count response. enum: `acked`, `group`, `severity`, `type`'
      - name: ack_admin_name
        in: query
        description: Name of the admins who have acked the alarms; accepts multiple values separated by comma
        style: form
        explode: true
        schema:
          type: string
      - name: acked
        in: query
        description: Filter alarm results by whether the alarm has been acknowledged
        style: form
        explode: true
        schema:
          type: boolean
      - name: type
        in: query
        description: Key-name of the alarms; accepts multiple values separated by comma
        style: form
        explode: true
        schema:
          type: string
      - name: severity
        in: query
        description: Alarm severity; accepts multiple values separated by comma
        style: form
        explode: true
        schema:
          type: string
      - name: group
        in: query
        description: Alarm group name; accepts multiple values separated by comma
        style: form
        explode: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/alarms/search:
    get:
      tags:
      - Sites Alarms
      summary: searchSiteAlarms
      description: Search alarms for a site with filters for alarm group, severity, type, acknowledgement state, acknowledgement admin, and time range. Use [Search Org Alarms]($e/Orgs%20Alarms/searchOrgAlarms) to search alarms across the organization.
      operationId: searchSiteAlarms
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: group
        in: query
        description: 'Alarm group used to filter alarm results. enum: `certificate_expiry`, `infrastructure`, `marvis`, `security`. The `marvis` group is used to retrieve AI-driven network issue detections. Known Marvis alarm types include: `bad_cable`, `bad_wan_uplink`, `dns_failure`, `arp_failure`, `auth_failure`, `dhcp_failure`, `missing_vlan`, `negotiation_mismatch`, `port_flap`. Results include resolution status (`status`, `resolved_time`) and affected entity details.'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/alarm_group'
          - description: 'Alarm group used to filter alarm results. enum: `certificate_expiry`, `infrastructure`, `marvis`, `security`. The `marvis` group is used to retrieve AI-driven network issue detections. Known Marvis alarm types include: `bad_cable`, `bad_wan_uplink`, `dns_failure`, `arp_failure`, `auth_failure`, `dhcp_failure`, `missing_vlan`, `negotiation_mismatch`, `port_flap`. Results include resolution status (`status`, `resolved_time`) and affected entity details.'
      - name: severity
        in: query
        description: 'Alarm severity used to filter results. enum: `critical`, `info`, `warn`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/alarm_severity'
          - description: 'Alarm severity used to filter results. enum: `critical`, `info`, `warn`'
      - name: type
        in: query
        description: Filter alarms by alarm type. Accepts multiple values separated by comma. Use [List Alarm Definitions](/#operations/listAlarmDefinitions) to get the list of possible alarm types
        style: form
        explode: true
        schema:
          type: string
          examples:
          - infra_dhcp_failure,missing_vlan
      - name: ack_admin_name
        in: query
        description: Name of the admins who have acked the alarms; accepts multiple values separated by comma
        style: form
        explode: true
        schema:
          type: string
      - name: acked
        in: query
        description: Filter alarm results by whether the alarm has been acknowledged
        style: form
        explode: true
        schema:
          type: boolean
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/alarm_search_result'
                - description: Paginated response returned by an alarm search
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/alarm_search_result'
                - description: Paginated response returned by an alarm search
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/alarms/unack:
    post:
      tags:
      - Sites Alarms
      summary: unackSiteMultipleAlarms
      description: Unack multiple Site Alarms
      operationId: unackSiteMultipleAlarms
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/alarm_ack'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/alarms/unack_all:
    post:
      tags:
      - Sites Alarms
      summary: unackSiteAllAlarms
      description: >-
        Unack all Site Alarms


        **N.B.**: Batch size for multiple alarm ack and unack has to be less or or equal to 1000.
      operationId: unackSiteAllAlarms
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/note_string'
              - description: Request Body
                examples:
                - note: maintenance window
              contentMediaType: application/json
            examples:
              Example:
                value:
                  note: maintenance window
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/alarms/{alarm_id}/ack:
    post:
      tags:
      - Sites Alarms
      summary: ackSiteAlarm
      description: Ack Site Alarm
      operationId: ackSiteAlarm
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: alarm_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/note_string'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/alarms/{alarm_id}/unack:
    post:
      tags:
      - Sites Alarms
      summary: unackSiteAlarm
      description: Unack Site Alarm
      operationId: unackSiteAlarm
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: alarm_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/note_string'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/subscriptions:
    delete:
      tags:
      - Sites Alarms
      summary: UnsubscribeSiteAlarms
      description: Unsubscribe to Site Alarms
      operationId: UnsubscribeSiteAlarms
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites Alarms
      summary: SubscribeSiteAlarms
      description: Subscribe to Site Alarms
      operationId: SubscribeSiteAlarms
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/aptemplates/derived:
    get:
      tags:
      - Sites AP Templates
      summary: listSiteApTemplatesDerived
      description: Get the list of derived AP Templates for a site
      operationId: listSiteApTemplatesDerived
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: resolve
        in: query
        description: Whether resolve the site variables
        style: form
        explode: true
        schema:
          type: boolean
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ap_template'
                description: List of AP templates
                examples:
                - - ap_matching:
                      enabled: true
                      rules:
                      - match_model: string
                        name: string
                        port_config:
                          eth1,eth2:
                            disabled: true
                            dynamic_vlan:
                              default_vlan_id: 999
                              enabled: true
                            port_vlan_id: 1
                            vlan_id: 9
                            vlan_ids: 1, 10, 50
                    created_time: 0
                    for_site: true
                    id: 497f6eca-6276-4993-bfeb-53cbbbba9f08
                    modified_time: 0
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    wifi:
                      cisco_enabled: true
                      disable_11k: false
                      disable_radios_when_power_constrained: true
                      enable_arp_spoof: true
                      enable_shared_radio_scanning: false
                      enabled: true
                      locate_connected: false
                      locate_unconnected: false
                      mesh_allow_dfs: false
                      mesh_enable_crm: true
                      mesh_enabled: true
                      proxy_arp: false
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - ap_matching:
                      enabled: true
                      rules:
                      - match_model: string
                        name: string
                        port_config:
                          eth1,eth2:
                            disabled: true
                            dynamic_vlan:
                              default_vlan_id: 999
                              enabled: true
                            port_vlan_id: 1
                            vlan_id: 9
                            vlan_ids: 1, 10, 50
                    created_time: 0
                    for_site: true
                    id: 497f6eca-6276-4993-bfeb-53cbbbba9f08
                    modified_time: 0
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    wifi:
                      cisco_enabled: true
                      disable_11k: false
                      disable_radios_when_power_constrained: true
                      enable_arp_spoof: true
                      enable_shared_radio_scanning: false
                      enabled: true
                      locate_connected: false
                      locate_unconnected: false
                      mesh_allow_dfs: false
                      mesh_enable_crm: true
                      mesh_enabled: true
                      proxy_arp: false
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ap_template'
                description: List of AP templates
                examples:
                - - ap_matching:
                      enabled: true
                      rules:
                      - match_model: string
                        name: string
                        port_config:
                          eth1,eth2:
                            disabled: true
                            dynamic_vlan:
                              default_vlan_id: 999
                              enabled: true
                            port_vlan_id: 1
                            vlan_id: 9
                            vlan_ids: 1, 10, 50
                    created_time: 0
                    for_site: true
                    id: 497f6eca-6276-4993-bfeb-53cbbbba9f08
                    modified_time: 0
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    wifi:
                      cisco_enabled: true
                      disable_11k: false
                      disable_radios_when_power_constrained: true
                      enable_arp_spoof: true
                      enable_shared_radio_scanning: false
                      enabled: true
                      locate_connected: false
                      locate_unconnected: false
                      mesh_allow_dfs: false
                      mesh_enable_crm: true
                      mesh_enabled: true
                      proxy_arp: false
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - ap_matching:
                      enabled: true
                      rules:
                      - match_model: string
                        name: string
                        port_config:
                          eth1,eth2:
                            disabled: true
                            dynamic_vlan:
                              default_vlan_id: 999
                              enabled: true
                            port_vlan_id: 1
                            vlan_id: 9
                            vlan_ids: 1, 10, 50
                    created_time: 0
                    for_site: true
                    id: 497f6eca-6276-4993-bfeb-53cbbbba9f08
                    modified_time: 0
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    wifi:
                      cisco_enabled: true
                      disable_11k: false
                      disable_radios_when_power_constrained: true
                      enable_arp_spoof: true
                      enable_shared_radio_scanning: false
                      enabled: true
                      locate_connected: false
                      locate_unconnected: false
                      mesh_allow_dfs: false
                      mesh_enable_crm: true
                      mesh_enabled: true
                      proxy_arp: false
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/apps:
    get:
      tags:
      - Sites Applications
      summary: listSiteApps
      description: Get List of Site Applications
      operationId: listSiteApps
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                uniqueItems: true
                type: array
                items:
                  $ref: '#/components/schemas/site_app'
                description: Application summaries returned for a site
                examples:
                - - group: string
                    key: string
                    name: string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - group: string
                    key: string
                    name: string
            application/vnd.api+json:
              schema:
                uniqueItems: true
                type: array
                items:
                  $ref: '#/components/schemas/site_app'
                description: Application summaries returned for a site
                examples:
                - - group: string
                    key: string
                    name: string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - group: string
                    key: string
                    name: string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/anomaly/client/{client_mac}/{metric}:
    get:
      tags:
      - Sites Anomaly
      summary: getSiteAnomalyEventsForClient
      description: Get Client Anomaly Events
      operationId: getSiteAnomalyEventsForClient
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: client_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      - name: metric
        in: path
        description: See [List Insight Metrics]($e/Constants%20Definitions/listInsightMetrics) for available metrics
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_anomaly_search'
                - description: Paginated anomaly search response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_anomaly_search'
                - description: Paginated anomaly search response
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/anomaly/device/{device_mac}/{metric}:
    get:
      tags:
      - Sites Anomaly
      summary: getSiteAnomalyEventsForDevice
      description: Get Device Anomaly Events
      operationId: getSiteAnomalyEventsForDevice
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: metric
        in: path
        description: See [List Insight Metrics]($e/Constants%20Definitions/listInsightMetrics) for available metrics
        required: true
        schema:
          type: string
      - name: device_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_anomaly_search'
                - description: Paginated anomaly search response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_anomaly_search'
                - description: Paginated anomaly search response
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/anomaly/{metric}:
    get:
      tags:
      - Sites Anomaly
      summary: listSiteAnomalyEvents
      description: List Site Anomaly Events
      operationId: listSiteAnomalyEvents
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: metric
        in: path
        description: See [List Insight Metrics]($e/Constants%20Definitions/listInsightMetrics) for available metrics
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_anomaly_search'
                - description: Paginated anomaly search response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_anomaly_search'
                - description: Paginated anomaly search response
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/apply_auto_map_assignment:
    post:
      tags:
      - Sites Auto Map Assignment
      summary: applySiteAutoMapAssignment
      description: Apply (accept) auto map assignment results for a site. Devices are associated with their assigned maps. Omit `map_ids` or provide an empty list to accept all pending assignments; provide specific `map_ids` for a partial accept.
      operationId: applySiteAutoMapAssignment
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/auto_map_assignment_request'
              - description: Request Body
                examples:
                - '{}'
                - '{"map_ids":["d3c42998-9012-4859-9743-6b9bee475309","f7a21456-7891-4abc-def0-123456789abc"]}'
              contentMediaType: application/json
            examples:
              Accept_All:
                value: {}
              Accept_Specific_Maps:
                value:
                  map_ids:
                  - d3c42998-9012-4859-9743-6b9bee475309
                  - f7a21456-7891-4abc-def0-123456789abc
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_auto_map_assignment_apply'
                - description: Result returned after applying accepted auto map assignments
                  examples:
                  - accepted_maps:
                    - d3c42998-9012-4859-9743-6b9bee475309
                    - f7a21456-7891-4abc-def0-123456789abc
                    message: "Accepted map assignments for map_ids: ['d3c42998-9012-4859-9743-6b9bee475309', 'f7a21456-7891-4abc-def0-123456789abc']"
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    accepted_maps:
                    - d3c42998-9012-4859-9743-6b9bee475309
                    - f7a21456-7891-4abc-def0-123456789abc
                    message: "Accepted map assignments for map_ids: ['d3c42998-9012-4859-9743-6b9bee475309', 'f7a21456-7891-4abc-def0-123456789abc']"
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_auto_map_assignment_apply'
                - description: Result returned after applying accepted auto map assignments
                  examples:
                  - accepted_maps:
                    - d3c42998-9012-4859-9743-6b9bee475309
                    - f7a21456-7891-4abc-def0-123456789abc
                    message: "Accepted map assignments for map_ids: ['d3c42998-9012-4859-9743-6b9bee475309', 'f7a21456-7891-4abc-def0-123456789abc']"
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    accepted_maps:
                    - d3c42998-9012-4859-9743-6b9bee475309
                    - f7a21456-7891-4abc-def0-123456789abc
                    message: "Accepted map assignments for map_ids: ['d3c42998-9012-4859-9743-6b9bee475309', 'f7a21456-7891-4abc-def0-123456789abc']"
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/auto_map_assignment:
    delete:
      tags:
      - Sites Auto Map Assignment
      summary: cancelSiteAutoMapAssignment
      description: Cancel an in-progress auto map assignment operation for the site. Validates that auto map assignment is currently running, notifies all APs to fetch new configuration, and sends a cancel command to the orchestration service.
      operationId: cancelSiteAutoMapAssignment
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Auto map assignment not in progress
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Sites Auto Map Assignment
      summary: getSiteAutoMapAssignmentStatus
      description: Get the current status of auto map assignment for the site.
      operationId: getSiteAutoMapAssignmentStatus
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_auto_map_assignment_info'
                - description: Auto map assignment status response
                  examples:
                  - est_time_left: 280.5
                    start_time: 1678900062
                    status: in_progress
                    time_updated: 1678900100
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    est_time_left: 280.5
                    start_time: 1678900062
                    status: in_progress
                    time_updated: 1678900100
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_auto_map_assignment_info'
                - description: Auto map assignment status response
                  examples:
                  - est_time_left: 280.5
                    start_time: 1678900062
                    status: in_progress
                    time_updated: 1678900100
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    est_time_left: 280.5
                    start_time: 1678900062
                    status: in_progress
                    time_updated: 1678900100
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites Auto Map Assignment
      summary: startSiteAutoMapAssignment
      description: >-
        Start the auto map assignment process for a site. The service automatically assigns APs to maps based on BLE ranging data and requires at least 3 APs with compatible firmware and model support for BLE.


        Repeated POST requests while a site assignment is still running will be rejected.
      operationId: startSiteAutoMapAssignment
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/auto_map_assignment'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_auto_map_assignment'
                - description: Auto map assignment start response
                  examples:
                  - devices:
                      5c5b35000001:
                        reason: Device meets the minimum requirements for auto map assignment
                        valid: true
                      5c5b35000002:
                        reason: Device meets the minimum requirements for auto map assignment
                        valid: true
                      5c5b35000003:
                        reason: Device meets the minimum requirements for auto map assignment
                        valid: true
                    estimated_runtime: 300
                    reason: Started auto map assignment
                    started: true
                    valid: true
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    devices:
                      5c5b35000001:
                        reason: Device meets the minimum requirements for auto map assignment
                        valid: true
                      5c5b35000002:
                        reason: Device meets the minimum requirements for auto map assignment
                        valid: true
                      5c5b35000003:
                        reason: Device meets the minimum requirements for auto map assignment
                        valid: true
                    estimated_runtime: 300
                    reason: Started auto map assignment
                    started: true
                    valid: true
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_auto_map_assignment'
                - description: Auto map assignment start response
                  examples:
                  - devices:
                      5c5b35000001:
                        reason: Device meets the minimum requirements for auto map assignment
                        valid: true
                      5c5b35000002:
                        reason: Device meets the minimum requirements for auto map assignment
                        valid: true
                      5c5b35000003:
                        reason: Device meets the minimum requirements for auto map assignment
                        valid: true
                    estimated_runtime: 300
                    reason: Started auto map assignment
                    started: true
                    valid: true
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    devices:
                      5c5b35000001:
                        reason: Device meets the minimum requirements for auto map assignment
                        valid: true
                      5c5b35000002:
                        reason: Device meets the minimum requirements for auto map assignment
                        valid: true
                      5c5b35000003:
                        reason: Device meets the minimum requirements for auto map assignment
                        valid: true
                    estimated_runtime: 300
                    reason: Started auto map assignment
                    started: true
                    valid: true
        '400':
          description: Auto map assignment already in progress
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/clear_auto_map_assignment:
    post:
      tags:
      - Sites Auto Map Assignment
      summary: clearSiteAutoMapAssignment
      description: Clear (reject) auto map assignment results for a site without applying them. The cached assignment results are cleared. Omit `map_ids` or provide an empty list to reject all pending assignments; provide specific `map_ids` for a partial reject.
      operationId: clearSiteAutoMapAssignment
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/auto_map_assignment_request'
              - description: Request Body
                examples:
                - '{}'
                - '{"map_ids":["d3c42998-9012-4859-9743-6b9bee475309","f7a21456-7891-4abc-def0-123456789abc"]}'
              contentMediaType: application/json
            examples:
              Clear_All:
                value: {}
              Clear_Specific_Maps:
                value:
                  map_ids:
                  - d3c42998-9012-4859-9743-6b9bee475309
                  - f7a21456-7891-4abc-def0-123456789abc
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_auto_map_assignment_clear'
                - description: Result returned after clearing auto map assignment candidates
                  examples:
                  - message: "Rejected map assignments for map_ids: ['d3c42998-9012-4859-9743-6b9bee475309', 'f7a21456-7891-4abc-def0-123456789abc']"
                    rejected_maps:
                    - d3c42998-9012-4859-9743-6b9bee475309
                    - f7a21456-7891-4abc-def0-123456789abc
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    message: "Rejected map assignments for map_ids: ['d3c42998-9012-4859-9743-6b9bee475309', 'f7a21456-7891-4abc-def0-123456789abc']"
                    rejected_maps:
                    - d3c42998-9012-4859-9743-6b9bee475309
                    - f7a21456-7891-4abc-def0-123456789abc
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_auto_map_assignment_clear'
                - description: Result returned after clearing auto map assignment candidates
                  examples:
                  - message: "Rejected map assignments for map_ids: ['d3c42998-9012-4859-9743-6b9bee475309', 'f7a21456-7891-4abc-def0-123456789abc']"
                    rejected_maps:
                    - d3c42998-9012-4859-9743-6b9bee475309
                    - f7a21456-7891-4abc-def0-123456789abc
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    message: "Rejected map assignments for map_ids: ['d3c42998-9012-4859-9743-6b9bee475309', 'f7a21456-7891-4abc-def0-123456789abc']"
                    rejected_maps:
                    - d3c42998-9012-4859-9743-6b9bee475309
                    - f7a21456-7891-4abc-def0-123456789abc
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/assetfilters:
    get:
      tags:
      - Sites Asset Filters
      summary: listSiteAssetFilters
      description: Get List of Site Asset Filters
      operationId: listSiteAssetFilters
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/asset_filter'
                description: List of BLE asset filters
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/asset_filter'
                description: List of BLE asset filters
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites Asset Filters
      summary: createSiteAssetFilter
      description: Create Site Asset Filter
      operationId: createSiteAssetFilter
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/asset_filter'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/asset_filter'
                - description: BLE asset filter definition; all specified criteria must match
                  examples:
                  - created_time: 0
                    disabled: true
                    eddystone_uid_namespace: string
                    eddystone_url: string
                    for_site: true
                    ibeacon_major: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mfg_company_id: 0
                    modified_time: 0
                    mqtt_topic: xxxxx
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    disabled: true
                    eddystone_uid_namespace: string
                    eddystone_url: string
                    for_site: true
                    ibeacon_major: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mfg_company_id: 0
                    modified_time: 0
                    mqtt_topic: xxxxx
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/asset_filter'
                - description: BLE asset filter definition; all specified criteria must match
                  examples:
                  - created_time: 0
                    disabled: true
                    eddystone_uid_namespace: string
                    eddystone_url: string
                    for_site: true
                    ibeacon_major: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mfg_company_id: 0
                    modified_time: 0
                    mqtt_topic: xxxxx
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    disabled: true
                    eddystone_uid_namespace: string
                    eddystone_url: string
                    for_site: true
                    ibeacon_major: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mfg_company_id: 0
                    modified_time: 0
                    mqtt_topic: xxxxx
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/assetfilters/{assetfilter_id}:
    delete:
      tags:
      - Sites Asset Filters
      summary: deleteSiteAssetFilter
      description: Deletes an existing BLE asset filter for the given site.
      operationId: deleteSiteAssetFilter
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: assetfilter_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Sites Asset Filters
      summary: getSiteAssetFilter
      description: Get Site Asset Filter Details
      operationId: getSiteAssetFilter
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: assetfilter_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/asset_filter'
                - description: BLE asset filter definition; all specified criteria must match
                  examples:
                  - created_time: 0
                    disabled: true
                    eddystone_uid_namespace: string
                    eddystone_url: string
                    for_site: true
                    ibeacon_major: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mfg_company_id: 0
                    modified_time: 0
                    mqtt_topic: xxxxx
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    disabled: true
                    eddystone_uid_namespace: string
                    eddystone_url: string
                    for_site: true
                    ibeacon_major: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mfg_company_id: 0
                    modified_time: 0
                    mqtt_topic: xxxxx
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/asset_filter'
                - description: BLE asset filter definition; all specified criteria must match
                  examples:
                  - created_time: 0
                    disabled: true
                    eddystone_uid_namespace: string
                    eddystone_url: string
                    for_site: true
                    ibeacon_major: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mfg_company_id: 0
                    modified_time: 0
                    mqtt_topic: xxxxx
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    disabled: true
                    eddystone_uid_namespace: string
                    eddystone_url: string
                    for_site: true
                    ibeacon_major: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mfg_company_id: 0
                    modified_time: 0
                    mqtt_topic: xxxxx
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Sites Asset Filters
      summary: updateSiteAssetFilter
      description: Updates an existing BLE asset filter for the given site.
      operationId: updateSiteAssetFilter
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: assetfilter_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/asset_filter'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/asset_filter'
                - description: BLE asset filter definition; all specified criteria must match
                  examples:
                  - created_time: 0
                    disabled: true
                    eddystone_uid_namespace: string
                    eddystone_url: string
                    for_site: true
                    ibeacon_major: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mfg_company_id: 0
                    modified_time: 0
                    mqtt_topic: xxxxx
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    disabled: true
                    eddystone_uid_namespace: string
                    eddystone_url: string
                    for_site: true
                    ibeacon_major: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mfg_company_id: 0
                    modified_time: 0
                    mqtt_topic: xxxxx
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/asset_filter'
                - description: BLE asset filter definition; all specified criteria must match
                  examples:
                  - created_time: 0
                    disabled: true
                    eddystone_uid_namespace: string
                    eddystone_url: string
                    for_site: true
                    ibeacon_major: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mfg_company_id: 0
                    modified_time: 0
                    mqtt_topic: xxxxx
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    disabled: true
                    eddystone_uid_namespace: string
                    eddystone_url: string
                    for_site: true
                    ibeacon_major: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mfg_company_id: 0
                    modified_time: 0
                    mqtt_topic: xxxxx
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/assets:
    get:
      tags:
      - Sites Assets
      summary: listSiteAssets
      description: List assets for a site. Use [List Org Assets]($e/Orgs%20Assets/listOrgAssets) to retrieve assets across the organization.
      operationId: listSiteAssets
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/asset'
                description: List of named BLE asset records
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/asset'
                description: List of named BLE asset records
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites Assets
      summary: createSiteAsset
      description: Create Site Asset
      operationId: createSiteAsset
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/asset'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/asset'
                - description: Named Bluetooth Low Energy asset record
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    tag_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    tag_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/asset'
                - description: Named Bluetooth Low Energy asset record
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    tag_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    tag_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/assets/import:
    post:
      tags:
      - Sites Assets
      summary: importSiteAssets
      description: "Import Site Assets. \n\nIt can be done via a CSV file or a JSON payload.\n\n## CSV File Format\n```csv\nname,mac\n\"asset_name\",5c5b53010101\n```"
      operationId: importSiteAssets
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: upsert
        in: query
        description: 'Whether to replace existing assets with the same MAC address during import. enum: `False`, `True`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/import_site_assets_upsert'
          - description: 'Whether to replace existing assets with the same MAC address during import. enum: `False`, `True`'
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              type: object
              properties:
                file:
                  type: string
                  description: CSV file containing asset records to import
                  contentEncoding: base64
              contentMediaType: multipart/form-data
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/assets/{asset_id}:
    delete:
      tags:
      - Sites Assets
      summary: deleteSiteAsset
      description: Delete Site Asset
      operationId: deleteSiteAsset
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: asset_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '201':
          description: Created
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Sites Assets
      summary: getSiteAsset
      description: Get Site Asset Details
      operationId: getSiteAsset
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: asset_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/asset'
                - description: Named Bluetooth Low Energy asset record
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    tag_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    tag_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/asset'
                - description: Named Bluetooth Low Energy asset record
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    tag_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    tag_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Sites Assets
      summary: updateSiteAsset
      description: Update Site Asset
      operationId: updateSiteAsset
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: asset_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/asset'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/asset'
                - description: Named Bluetooth Low Energy asset record
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    tag_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    tag_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/asset'
                - description: Named Bluetooth Low Energy asset record
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    tag_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    tag_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/assets/{asset_id}/image:
    delete:
      tags:
      - Sites Assets
      summary: deleteSiteAssetImage
      description: Delete Site Asset Image
      operationId: deleteSiteAssetImage
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: asset_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites Assets
      summary: attachSiteAssetImage
      description: Attach Image to Site Asset
      operationId: attachSiteAssetImage
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: asset_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              required:
              - file
              type: object
              properties:
                file:
                  type: string
                  description: Image file content uploaded as multipart form data
                  contentEncoding: base64
                json:
                  type: string
                  description: Optional JSON metadata submitted with the image upload
              contentMediaType: multipart/form-data
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/beacons:
    get:
      tags:
      - Sites Beacons
      summary: listSiteBeacons
      description: Get List of Site Beacons
      operationId: listSiteBeacons
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/beacon'
                description: List of beacon configuration records
                examples:
                - - created_time: 0
                    eddystone_instance: string
                    eddystone_namespace: string
                    eddystone_url: string
                    ibeacon_major: 1
                    ibeacon_minor: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    power: 0
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: eddystone-uid
                    x: 0
                    y: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 0
                    eddystone_instance: string
                    eddystone_namespace: string
                    eddystone_url: string
                    ibeacon_major: 1
                    ibeacon_minor: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    power: 0
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: eddystone-uid
                    x: 0
                    y: 0
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/beacon'
                description: List of beacon configuration records
                examples:
                - - created_time: 0
                    eddystone_instance: string
                    eddystone_namespace: string
                    eddystone_url: string
                    ibeacon_major: 1
                    ibeacon_minor: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    power: 0
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: eddystone-uid
                    x: 0
                    y: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 0
                    eddystone_instance: string
                    eddystone_namespace: string
                    eddystone_url: string
                    ibeacon_major: 1
                    ibeacon_minor: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    power: 0
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: eddystone-uid
                    x: 0
                    y: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites Beacons
      summary: createSiteBeacon
      description: Create Site Beacon
      operationId: createSiteBeacon
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/beacon'
              - description: Request Body
                examples:
                - eddystone_instance: string
                  eddystone_namespace: string
                  eddystone_url: string
                  ibeacon_major: 1
                  ibeacon_minor: 1
                  ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  mac: string
                  name: string
                  power: 0
                  type: eddystone-uid
                  x: 0
                  y: 0
              contentMediaType: application/json
            examples:
              Example:
                value:
                  eddystone_instance: string
                  eddystone_namespace: string
                  eddystone_url: string
                  ibeacon_major: 1
                  ibeacon_minor: 1
                  ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  mac: string
                  name: string
                  power: 0
                  type: eddystone-uid
                  x: 0
                  y: 0
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/beacon'
                - description: Beacon configuration and placement data
                  examples:
                  - created_time: 0
                    eddystone_instance: string
                    eddystone_namespace: string
                    eddystone_url: string
                    ibeacon_major: 1
                    ibeacon_minor: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    power: 0
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: eddystone-uid
                    x: 0
                    y: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    eddystone_instance: string
                    eddystone_namespace: string
                    eddystone_url: string
                    ibeacon_major: 1
                    ibeacon_minor: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    power: 0
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: eddystone-uid
                    x: 0
                    y: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/beacon'
                - description: Beacon configuration and placement data
                  examples:
                  - created_time: 0
                    eddystone_instance: string
                    eddystone_namespace: string
                    eddystone_url: string
                    ibeacon_major: 1
                    ibeacon_minor: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    power: 0
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: eddystone-uid
                    x: 0
                    y: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    eddystone_instance: string
                    eddystone_namespace: string
                    eddystone_url: string
                    ibeacon_major: 1
                    ibeacon_minor: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    power: 0
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: eddystone-uid
                    x: 0
                    y: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/beacons/{beacon_id}:
    delete:
      tags:
      - Sites Beacons
      summary: deleteSiteBeacon
      description: Delete Site Beacon
      operationId: deleteSiteBeacon
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: beacon_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Sites Beacons
      summary: getSiteBeacon
      description: Get Site Beacon Details
      operationId: getSiteBeacon
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: beacon_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/beacon'
                - description: Beacon configuration and placement data
                  examples:
                  - created_time: 0
                    eddystone_instance: string
                    eddystone_namespace: string
                    eddystone_url: string
                    ibeacon_major: 1
                    ibeacon_minor: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    power: 0
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: eddystone-uid
                    x: 0
                    y: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    eddystone_instance: string
                    eddystone_namespace: string
                    eddystone_url: string
                    ibeacon_major: 1
                    ibeacon_minor: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    power: 0
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: eddystone-uid
                    x: 0
                    y: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/beacon'
                - description: Beacon configuration and placement data
                  examples:
                  - created_time: 0
                    eddystone_instance: string
                    eddystone_namespace: string
                    eddystone_url: string
                    ibeacon_major: 1
                    ibeacon_minor: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    power: 0
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: eddystone-uid
                    x: 0
                    y: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    eddystone_instance: string
                    eddystone_namespace: string
                    eddystone_url: string
                    ibeacon_major: 1
                    ibeacon_minor: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    power: 0
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: eddystone-uid
                    x: 0
                    y: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Sites Beacons
      summary: updateSiteBeacon
      description: Update Site Beacon
      operationId: updateSiteBeacon
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: beacon_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/beacon'
              - description: Request Body
                examples:
                - eddystone_instance: string
                  eddystone_namespace: string
                  eddystone_url: string
                  ibeacon_major: 1
                  ibeacon_minor: 1
                  ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  mac: string
                  name: string
                  power: 0
                  type: eddystone-uid
                  x: 0
                  y: 0
              contentMediaType: application/json
            examples:
              Example:
                value:
                  eddystone_instance: string
                  eddystone_namespace: string
                  eddystone_url: string
                  ibeacon_major: 1
                  ibeacon_minor: 1
                  ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  mac: string
                  name: string
                  power: 0
                  type: eddystone-uid
                  x: 0
                  y: 0
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/beacon'
                - description: Beacon configuration and placement data
                  examples:
                  - created_time: 0
                    eddystone_instance: string
                    eddystone_namespace: string
                    eddystone_url: string
                    ibeacon_major: 1
                    ibeacon_minor: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    power: 0
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: eddystone-uid
                    x: 0
                    y: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    eddystone_instance: string
                    eddystone_namespace: string
                    eddystone_url: string
                    ibeacon_major: 1
                    ibeacon_minor: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    power: 0
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: eddystone-uid
                    x: 0
                    y: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/beacon'
                - description: Beacon configuration and placement data
                  examples:
                  - created_time: 0
                    eddystone_instance: string
                    eddystone_namespace: string
                    eddystone_url: string
                    ibeacon_major: 1
                    ibeacon_minor: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    power: 0
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: eddystone-uid
                    x: 0
                    y: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    eddystone_instance: string
                    eddystone_namespace: string
                    eddystone_url: string
                    ibeacon_major: 1
                    ibeacon_minor: 1
                    ibeacon_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    power: 0
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    type: eddystone-uid
                    x: 0
                    y: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/nac_clients/count:
    get:
      tags:
      - Sites Clients - NAC
      summary: countSiteNacClients
      description: Count NAC clients for a site, optionally grouped by the `distinct` field and filtered by authentication, identity, endpoint, network, and time attributes. Use [Count Org NAC Clients]($e/Orgs%20Clients%20-%20NAC/countOrgNacClients) to count NAC clients across the organization.
      operationId: countSiteNacClients
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `ap`, `auth_type`, `device_mac`, `edr_managed`, `edr_provider`, `edr_status`, `family`, `hostname`, `idp_id`, `mfg`, `mdm_compliance`, `mdm_managed`, `mdm_provider`, `model`, `mxedge_id`, `nacrule_matched`, `nacrule_name`, `nacrule_id`, `nas_ip`, `nas_vendor`, `os`, `ssid`, `status`, `type`, `usermac_label`, `username`, `vlan`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/site_nac_clients_count_distinct'
          - description: 'Field used to group this count response. enum: `ap`, `auth_type`, `device_mac`, `edr_managed`, `edr_provider`, `edr_status`, `family`, `hostname`, `idp_id`, `mfg`, `mdm_compliance`, `mdm_managed`, `mdm_provider`, `model`, `mxedge_id`, `nacrule_matched`, `nacrule_name`, `nacrule_id`, `nas_ip`, `nas_vendor`, `os`, `ssid`, `status`, `type`, `usermac_label`, `username`, `vlan`'
      - name: last_nacrule_id
        in: query
        description: NAC Policy Rule ID, if matched
        style: form
        explode: true
        schema:
          type: string
      - name: nacrule_matched
        in: query
        description: NAC Policy Rule Matched
        style: form
        explode: true
        schema:
          type: boolean
      - name: auth_type
        in: query
        description: Authentication type, e.g. "eap-tls", "eap-peap", "eap-ttls", "eap-teap", "mab", "psk", "device-auth"
        style: form
        explode: true
        schema:
          type: string
      - name: last_vlan_id
        in: query
        description: Filter results by last VLAN ID
        style: form
        explode: true
        schema:
          type: string
      - name: last_nas_vendor
        in: query
        description: Vendor of NAS device
        style: form
        explode: true
        schema:
          type: string
      - name: idp_id
        in: query
        description: SSO ID, if present and used
        style: form
        explode: true
        schema:
          type: string
      - name: last_ssid
        in: query
        description: Filter results by last SSID
        style: form
        explode: true
        schema:
          type: string
      - name: last_username
        in: query
        description: Username presented by the client
        style: form
        explode: true
        schema:
          type: string
      - name: last_ap
        in: query
        description: AP MAC connected to by client
        style: form
        explode: true
        schema:
          type: string
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: last_status
        in: query
        description: Connection status of client i.e "permitted", "denied, "session_ended"
        style: form
        explode: true
        schema:
          type: string
      - name: type
        in: query
        description: Client type i.e. "wireless", "wired" etc.
        style: form
        explode: true
        schema:
          type: string
      - name: mdm_compliance_status
        in: query
        description: MDM compliance of client i.e "compliant", "not compliant"
        style: form
        explode: true
        schema:
          type: string
      - name: mdm_provider
        in: query
        description: MDM provider of client’s organization eg "intune", "jamf"
        style: form
        explode: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/nac_clients/events/count:
    get:
      tags:
      - Sites Clients - NAC
      summary: countSiteNacClientEvents
      description: Count NAC client events for a site, optionally grouped by the `distinct` field and filtered by event type and time range. Use [Count Org NAC Client Events]($e/Orgs%20Clients%20-%20NAC/countOrgNacClientEvents) to count NAC client events across the organization.
      operationId: countSiteNacClientEvents
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `ap`, `auth_type`, `dryrun_nacrule_id`, `mac`, `nacrule_id`, `nas_vendor`, `ssid`, `type`, `username`, `vlan`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/site_nac_client_events_count_distinct'
          - description: 'Field used to group this count response. enum: `ap`, `auth_type`, `dryrun_nacrule_id`, `mac`, `nacrule_id`, `nas_vendor`, `ssid`, `type`, `username`, `vlan`'
      - name: type
        in: query
        description: See [List Device Events Definitions]($e/Constants%20Events/listNacEventsDefinitions)
        style: form
        explode: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/nac_clients/events/search:
    get:
      tags:
      - Sites Clients - NAC
      summary: searchSiteNacClientEvents
      description: Search NAC client events for a site with filters for authentication, NAC rule, identity provider, RADIUS, network, endpoint, and time attributes. Use [Search Org NAC Client Events]($e/Orgs%20Clients%20-%20NAC/searchOrgNacClientEvents) to search NAC client events across the organization.
      operationId: searchSiteNacClientEvents
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: type
        in: query
        description: See [List Device Events Definitions]($e/Constants%20Events/listNacEventsDefinitions)
        style: form
        explode: true
        schema:
          type: string
      - name: nacrule_id
        in: query
        description: NAC Policy Rule ID, if matched
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: uuid
      - name: nacrule_matched
        in: query
        description: NAC Policy Rule Matched
        style: form
        explode: true
        schema:
          type: boolean
      - name: dryrun_nacrule_id
        in: query
        description: NAC Policy Dry Run Rule ID, if present and matched
        style: form
        explode: true
        schema:
          type: string
      - name: dryrun_nacrule_matched
        in: query
        description: True - if dryrun rule present and matched with priority, False - if not matched or not present
        style: form
        explode: true
        schema:
          type: boolean
      - name: auth_type
        in: query
        description: Authentication type, e.g. "eap-tls", "eap-peap", "eap-ttls", "eap-teap", "mab", "psk", "device-auth"
        style: form
        explode: true
        schema:
          type: string
      - name: vlan
        in: query
        description: Filter results by VLAN ID
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: nas_vendor
        in: query
        description: Vendor of NAS device
        style: form
        explode: true
        schema:
          type: string
      - name: bssid
        in: query
        description: Filter results by BSSID
        style: form
        explode: true
        schema:
          type: string
      - name: idp_id
        in: query
        description: SSO ID, if present and used
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: uuid
      - name: idp_role
        in: query
        description: IDP returned roles/groups for the user
        style: form
        explode: true
        schema:
          type: string
      - name: idp_username
        in: query
        description: Username presented to the Identity Provider
        style: form
        explode: true
        schema:
          type: string
      - name: resp_attrs
        in: query
        description: RADIUS attributes returned by NAC to NAS Devive
        style: form
        explode: true
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
          examples:
          - - Tunnel-Type=VLAN
            - Tunnel-Medium-Type=IEEE-802
            - Tunnel-Private-Group-Id=750
            - User-Name=anonymous
      - name: ssid
        in: query
        description: Filter results by SSID
        style: form
        explode: true
        schema:
          type: string
      - name: username
        in: query
        description: Filter results by username
        style: form
        explode: true
        schema:
          type: string
      - name: ap
        in: query
        description: Filter results by AP MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: random_mac
        in: query
        description: Filter results by whether the client is using a randomized MAC address
        style: form
        explode: true
        schema:
          type: boolean
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: usermac_label
        in: query
        description: Labels derived from usermac entry
        style: form
        explode: true
        schema:
          type: string
      - name: text
        in: query
        description: Partial / full MAC address, username, device_mac or ap. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `aabbcc*` and `*bbcc*` match `aabbccddeeff`). Suffix-only wildcards (e.g. `*bccddeeff`) are not supported
        style: form
        explode: true
        schema:
          type: string
      - name: nas_ip
        in: query
        description: IP address of NAS device
        style: form
        explode: true
        schema:
          type: string
      - name: ingress_vlan
        in: query
        description: Vendor specific VLAN ID in RADIUS requests
        style: form
        explode: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order.
        style: form
        explode: true
        schema:
          type: string
          default: wxid
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: NAC Client Events
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_events_nac_client_search'
                - description: Paginated response for NAC client event search results
                  examples:
                  - end: 1513176951
                    limit: 10
                    results:
                    - ap: 5c5b35513227
                      auth_type: eap-ttls
                      bssid: 5c5b355fafcc
                      dryrun_nacrule_id: 32f27e7d-ff26-4a9b-b3d1-ff9bcb264012
                      dryrun_nacrule_matched: true
                      idp_id: 912ef72e-2239-4996-b81e-469e87a27cd6
                      idp_role:
                      - itsuperusers
                      - vip
                      mac: ac3eb179e535
                      nacrule_id: 32f27e7d-ff26-4a9b-b3d1-ff9bcb264c62
                      nacrule_matched: true
                      nas_vendor: juniper-mist
                      org_id: 27547ac2-d114-4e04-beb1-f3f1e6e81ec6
                      random_mac: 'false'
                      resp_attrs:
                      - Tunnel-Type=VLAN
                      - Tunnel-Medium-Type=IEEE-802
                      - Tunnel-Private-Group-Id=750
                      - User-Name=anonymous
                      site_id: 441a1214-6928-442a-8e92-e1d34b8ec6a6
                      ssid: mist_nac
                      timestamp: 1691512031.358188
                      type: NAC_CLIENT_PERMIT
                      username: user@deaflyz.net
                      vlan: '750'
                    start: 1512572151
                    total: 1
                contentMediaType: application/json
              examples:
                NAC-client_events:
                  value:
                    end: 1513176951
                    limit: 10
                    results:
                    - ap: 5c5b35513227
                      auth_type: eap-ttls
                      bssid: 5c5b355fafcc
                      dryrun_nacrule_id: 32f27e7d-ff26-4a9b-b3d1-ff9bcb264012
                      dryrun_nacrule_matched: true
                      idp_id: 912ef72e-2239-4996-b81e-469e87a27cd6
                      idp_role:
                      - itsuperusers
                      - vip
                      mac: ac3eb179e535
                      nacrule_id: 32f27e7d-ff26-4a9b-b3d1-ff9bcb264c62
                      nacrule_matched: true
                      nas_vendor: juniper-mist
                      org_id: 27547ac2-d114-4e04-beb1-f3f1e6e81ec6
                      random_mac: 'false'
                      resp_attrs:
                      - Tunnel-Type=VLAN
                      - Tunnel-Medium-Type=IEEE-802
                      - Tunnel-Private-Group-Id=750
                      - User-Name=anonymous
                      site_id: 441a1214-6928-442a-8e92-e1d34b8ec6a6
                      ssid: mist_nac
                      timestamp: 1691512031.358188
                      type: NAC_CLIENT_PERMIT
                      username: user@deaflyz.net
                      vlan: '750'
                    start: 1512572151
                    total: 1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_events_nac_client_search'
                - description: Paginated response for NAC client event search results
                  examples:
                  - end: 1513176951
                    limit: 10
                    results:
                    - ap: 5c5b35513227
                      auth_type: eap-ttls
                      bssid: 5c5b355fafcc
                      dryrun_nacrule_id: 32f27e7d-ff26-4a9b-b3d1-ff9bcb264012
                      dryrun_nacrule_matched: true
                      idp_id: 912ef72e-2239-4996-b81e-469e87a27cd6
                      idp_role:
                      - itsuperusers
                      - vip
                      mac: ac3eb179e535
                      nacrule_id: 32f27e7d-ff26-4a9b-b3d1-ff9bcb264c62
                      nacrule_matched: true
                      nas_vendor: juniper-mist
                      org_id: 27547ac2-d114-4e04-beb1-f3f1e6e81ec6
                      random_mac: 'false'
                      resp_attrs:
                      - Tunnel-Type=VLAN
                      - Tunnel-Medium-Type=IEEE-802
                      - Tunnel-Private-Group-Id=750
                      - User-Name=anonymous
                      site_id: 441a1214-6928-442a-8e92-e1d34b8ec6a6
                      ssid: mist_nac
                      timestamp: 1691512031.358188
                      type: NAC_CLIENT_PERMIT
                      username: user@deaflyz.net
                      vlan: '750'
                    start: 1512572151
                    total: 1
                contentMediaType: application/vnd.api+json
              examples:
                NAC-client_events:
                  value:
                    end: 1513176951
                    limit: 10
                    results:
                    - ap: 5c5b35513227
                      auth_type: eap-ttls
                      bssid: 5c5b355fafcc
                      dryrun_nacrule_id: 32f27e7d-ff26-4a9b-b3d1-ff9bcb264012
                      dryrun_nacrule_matched: true
                      idp_id: 912ef72e-2239-4996-b81e-469e87a27cd6
                      idp_role:
                      - itsuperusers
                      - vip
                      mac: ac3eb179e535
                      nacrule_id: 32f27e7d-ff26-4a9b-b3d1-ff9bcb264c62
                      nacrule_matched: true
                      nas_vendor: juniper-mist
                      org_id: 27547ac2-d114-4e04-beb1-f3f1e6e81ec6
                      random_mac: 'false'
                      resp_attrs:
                      - Tunnel-Type=VLAN
                      - Tunnel-Medium-Type=IEEE-802
                      - Tunnel-Private-Group-Id=750
                      - User-Name=anonymous
                      site_id: 441a1214-6928-442a-8e92-e1d34b8ec6a6
                      ssid: mist_nac
                      timestamp: 1691512031.358188
                      type: NAC_CLIENT_PERMIT
                      username: user@deaflyz.net
                      vlan: '750'
                    start: 1512572151
                    total: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/nac_clients/search:
    get:
      tags:
      - Sites Clients - NAC
      summary: searchSiteNacClients
      description: Search NAC clients for a site with filters for authentication, endpoint posture, identity, network, NAC rule, and time attributes. Use [Search Org NAC Clients]($e/Orgs%20Clients%20-%20NAC/searchOrgNacClients) to search NAC clients across the organization.
      operationId: searchSiteNacClients
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: ap
        in: query
        description: MAC address of the AP the client is/was connected to
        style: form
        explode: true
        schema:
          type: string
      - name: auth_type
        in: query
        description: Authentication type, e.g. "eap-tls", "eap-peap", "eap-ttls", "eap-teap", "mab", "psk", "device-auth"
        style: form
        explode: true
        schema:
          type: string
      - name: cert_expiry_duration
        in: query
        description: Filter by certificate expiry within a specific duration from now (e.g., "7d" for 7 days, "1m" for 1 month)
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 7d
          - 1m
        examples:
          Untitled Example1:
            value: 7d
          Untitled Example2:
            value: 1m
      - name: edr_managed
        in: query
        description: Filters NAC clients that are integrated with EDR providers
        style: form
        explode: true
        schema:
          type: boolean
      - name: edr_provider
        in: query
        description: 'EDR provider used to filter NAC clients. enum: `crowdstrike`, `sentinelone`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/edr_provider'
          - description: 'EDR provider used to filter NAC clients. enum: `crowdstrike`, `sentinelone`'
      - name: edr_status
        in: query
        description: 'EDR status used to filter NAC clients. enum: `sentinelone_healthy`, `sentinelone_infected`, `crowdstrike_low`, `crowdstrike_medium`, `crowdstrike_high`, `crowdstrike_critical`, `crowdstrike_informational`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/edr_status'
          - description: 'EDR status used to filter NAC clients. enum: `sentinelone_healthy`, `sentinelone_infected`, `crowdstrike_low`, `crowdstrike_medium`, `crowdstrike_high`, `crowdstrike_critical`, `crowdstrike_informational`'
      - name: family
        in: query
        description: Partial / full Client family (e.g. "Phone/Tablet/Wearable", "Access Point"). Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `Surveillance*` and `*urveillance*` match `Surveillance Camera`). Suffix-only wildcards (e.g. `*Camera`) are not supported
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Surveillance Camera
          - Surveillance*
          - '*urveillance*'
        examples:
          Untitled Example1:
            value: Surveillance Camera
          Untitled Example2:
            value: Surveillance*
          Untitled Example3:
            value: '*urveillance*'
      - name: hostname
        in: query
        description: Partial / full Client hostname. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `everest*` and `*rest*` match `my-everest-client`). Suffix-only wildcards (e.g. `*everest`) are not supported
        style: form
        explode: true
        schema:
          type: string
          examples:
          - my-everest-client
          - my-everest*
          - '*everest*'
        examples:
          Untitled Example1:
            value: my-everest-client
          Untitled Example2:
            value: my-everest*
          Untitled Example3:
            value: '*everest*'
      - name: idp_id
        in: query
        description: SSO ID, if present and used
        style: form
        explode: true
        schema:
          type: string
      - name: mac
        in: query
        description: Partial / full Client MAC address. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `aabbcc*` and `*bbcc*` match `aabbccddeeff`). Suffix-only wildcards (e.g. `*bccddeeff`) are not supported
        style: form
        explode: true
        schema:
          type: string
          examples:
          - aabbccddeeff
          - aabbcc*
          - '*bbcc*'
        examples:
          Untitled Example1:
            value: aabbccddeeff
          Untitled Example2:
            value: aabbcc*
          Untitled Example3:
            value: '*bbcc*'
      - name: mdm_compliance
        in: query
        description: MDM compliance of client i.e "compliant", "not compliant"
        style: form
        explode: true
        schema:
          type: string
      - name: mdm_provider
        in: query
        description: MDM provider of client’s organization eg "intune", "jamf"
        style: form
        explode: true
        schema:
          type: string
      - name: mdm_managed
        in: query
        description: Filters NAC clients that are managed by MDM providers
        style: form
        explode: true
        schema:
          type: boolean
      - name: mfg
        in: query
        description: Partial / full Client manufacturer (e.g. "apple", "cisco", "juniper"). Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `Raspberry Pi*` and `*Pi*` match `Raspberry Pi Trading Ltd`). Suffix-only wildcards (e.g. `*Ltd`) are not supported
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Raspberry Pi Trading Ltd
          - Raspberry Pi*
          - '*Pi*'
        examples:
          Untitled Example1:
            value: Raspberry Pi Trading Ltd
          Untitled Example2:
            value: Raspberry Pi*
          Untitled Example3:
            value: '*Pi*'
      - name: model
        in: query
        description: Client model, e.g. "iPhone 12", "MX100"
        style: form
        explode: true
        schema:
          type: string
      - name: nacrule_name
        in: query
        description: NAC Policy Rule Name matched
        style: form
        explode: true
        schema:
          type: string
      - name: nacrule_id
        in: query
        description: NAC Policy Rule ID, if matched
        style: form
        explode: true
        schema:
          type: string
      - name: nacrule_matched
        in: query
        description: NAC Policy Rule Matched
        style: form
        explode: true
        schema:
          type: boolean
      - name: nas_vendor
        in: query
        description: Vendor of NAS device
        style: form
        explode: true
        schema:
          type: string
      - name: nas_ip
        in: query
        description: IP address of NAS device
        style: form
        explode: true
        schema:
          type: string
      - name: ingress_vlan
        in: query
        description: Vendor specific VLAN ID in RADIUS requests
        style: form
        explode: true
        schema:
          type: string
      - name: os
        in: query
        description: Client OS, e.g. "iOS 18.1", "Android", "Windows", "Linux"
        style: form
        explode: true
        schema:
          type: string
      - name: ssid
        in: query
        description: Filter results by SSID
        style: form
        explode: true
        schema:
          type: string
      - name: status
        in: query
        description: 'Client connection status used to filter results. enum: `permitted`, `session_started`, `session_stopped`, `denied`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/nac_client_last_status'
          - description: 'Client connection status used to filter results. enum: `permitted`, `session_started`, `session_stopped`, `denied`'
            examples:
            - permitted
      - name: text
        in: query
        description: partial / full MAC address, last_username, device_mac, nas_ip. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `aabbcc*` and `*bbcc*` match `aabbccddeeff`). Suffix-only wildcards (e.g. `*bccddeeff`) are not supported.
        style: form
        explode: true
        schema:
          type: string
      - name: type
        in: query
        description: Client type i.e. "wireless", "wired" etc.
        style: form
        explode: true
        schema:
          type: string
      - name: usermac_label
        in: query
        description: Labels derived from usermac entry
        style: form
        explode: true
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: username
        in: query
        description: Filter results by username
        style: form
        explode: true
        schema:
          type: string
      - name: vlan
        in: query
        description: Filter results by VLAN ID
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order.
        style: form
        explode: true
        schema:
          type: string
          default: wxid
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_client_nac_search'
                - description: Paginated NAC client search response
                  examples:
                  - end: 1513362753
                    limit: 3
                    results:
                    - ap:
                      - 5c5b35bf16bb
                      - d4dc090041b4
                      auth_type: eap-tls
                      cert_cn:
                      - john@mycorp.net
                      cert_issuer:
                      - /C=US/ST=CA/CN=MyCorp
                      client_ip:
                      - 10.7.51.74
                      edr_managed: true
                      edr_providers:
                      - sentinelone
                      edr_status:
                      - sentinelone_healthy
                      idp_id: string
                      idp_role:
                      - string
                      last_ap: string
                      last_cert_cn: john@mycorp.net
                      last_cert_expiry: 1746711240
                      last_cert_issuer: /C=US/ST=CA/CN=MyCorp
                      last_cert_serial: 2c63510123456789
                      last_cert_subject: /C=US/O=MyCorp/CN=john@mycorp.net/emailAddress=john@mycorp.net
                      last_client_ip: 10.7.51.74
                      last_nacrule_id: 603b62db-d839-4152-9f7f-f2578443de8d
                      last_nacrule_name: Wireless Cert Auth
                      last_nas_vendor: juniper-mist
                      last_ssid: string
                      last_status: permitted
                      mac: string
                      nacrule_id:
                      - 603b62db-d839-4152-9f7f-f2578443de8d
                      nacrule_matched: true
                      nacrule_name:
                      - Wireless Cert Auth
                      nas_vendor:
                      - juniper-mist
                      org_id: 31f27122-68a9-47a4-b526-8fb8a62a8acb
                      random_mac: 'true'
                      site_id: 832b1d74-9531-409b-ae37-4d7f3edbde92
                      ssid:
                      - string
                      timestamp: 1694689718.612
                      type: wireless
                      usermac_label:
                      - non-compliant
                      - building26
                      - floor52
                    start: 1513276353
                    total: 2
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1513362753
                    limit: 3
                    results:
                    - ap:
                      - 5c5b35bf16bb
                      - d4dc090041b4
                      auth_type: eap-tls
                      cert_cn:
                      - john@mycorp.net
                      cert_issuer:
                      - /C=US/ST=CA/CN=MyCorp
                      client_ip:
                      - 10.7.51.74
                      edr_managed: true
                      edr_providers:
                      - sentinelone
                      edr_status:
                      - sentinelone_healthy
                      idp_id: string
                      idp_role:
                      - string
                      last_ap: string
                      last_cert_cn: john@mycorp.net
                      last_cert_expiry: 1746711240
                      last_cert_issuer: /C=US/ST=CA/CN=MyCorp
                      last_cert_serial: 2c63510123456789
                      last_cert_subject: /C=US/O=MyCorp/CN=john@mycorp.net/emailAddress=john@mycorp.net
                      last_client_ip: 10.7.51.74
                      last_nacrule_id: 603b62db-d839-4152-9f7f-f2578443de8d
                      last_nacrule_name: Wireless Cert Auth
                      last_nas_vendor: juniper-mist
                      last_ssid: string
                      last_status: permitted
                      mac: string
                      nacrule_id:
                      - 603b62db-d839-4152-9f7f-f2578443de8d
                      nacrule_matched: true
                      nacrule_name:
                      - Wireless Cert Auth
                      nas_vendor:
                      - juniper-mist
                      org_id: 31f27122-68a9-47a4-b526-8fb8a62a8acb
                      random_mac: 'true'
                      site_id: 832b1d74-9531-409b-ae37-4d7f3edbde92
                      ssid:
                      - string
                      timestamp: 1694689718.612
                      type: wireless
                      usermac_label:
                      - non-compliant
                      - building26
                      - floor52
                    start: 1513276353
                    total: 2
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_client_nac_search'
                - description: Paginated NAC client search response
                  examples:
                  - end: 1513362753
                    limit: 3
                    results:
                    - ap:
                      - 5c5b35bf16bb
                      - d4dc090041b4
                      auth_type: eap-tls
                      cert_cn:
                      - john@mycorp.net
                      cert_issuer:
                      - /C=US/ST=CA/CN=MyCorp
                      client_ip:
                      - 10.7.51.74
                      edr_managed: true
                      edr_providers:
                      - sentinelone
                      edr_status:
                      - sentinelone_healthy
                      idp_id: string
                      idp_role:
                      - string
                      last_ap: string
                      last_cert_cn: john@mycorp.net
                      last_cert_expiry: 1746711240
                      last_cert_issuer: /C=US/ST=CA/CN=MyCorp
                      last_cert_serial: 2c63510123456789
                      last_cert_subject: /C=US/O=MyCorp/CN=john@mycorp.net/emailAddress=john@mycorp.net
                      last_client_ip: 10.7.51.74
                      last_nacrule_id: 603b62db-d839-4152-9f7f-f2578443de8d
                      last_nacrule_name: Wireless Cert Auth
                      last_nas_vendor: juniper-mist
                      last_ssid: string
                      last_status: permitted
                      mac: string
                      nacrule_id:
                      - 603b62db-d839-4152-9f7f-f2578443de8d
                      nacrule_matched: true
                      nacrule_name:
                      - Wireless Cert Auth
                      nas_vendor:
                      - juniper-mist
                      org_id: 31f27122-68a9-47a4-b526-8fb8a62a8acb
                      random_mac: 'true'
                      site_id: 832b1d74-9531-409b-ae37-4d7f3edbde92
                      ssid:
                      - string
                      timestamp: 1694689718.612
                      type: wireless
                      usermac_label:
                      - non-compliant
                      - building26
                      - floor52
                    start: 1513276353
                    total: 2
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1513362753
                    limit: 3
                    results:
                    - ap:
                      - 5c5b35bf16bb
                      - d4dc090041b4
                      auth_type: eap-tls
                      cert_cn:
                      - john@mycorp.net
                      cert_issuer:
                      - /C=US/ST=CA/CN=MyCorp
                      client_ip:
                      - 10.7.51.74
                      edr_managed: true
                      edr_providers:
                      - sentinelone
                      edr_status:
                      - sentinelone_healthy
                      idp_id: string
                      idp_role:
                      - string
                      last_ap: string
                      last_cert_cn: john@mycorp.net
                      last_cert_expiry: 1746711240
                      last_cert_issuer: /C=US/ST=CA/CN=MyCorp
                      last_cert_serial: 2c63510123456789
                      last_cert_subject: /C=US/O=MyCorp/CN=john@mycorp.net/emailAddress=john@mycorp.net
                      last_client_ip: 10.7.51.74
                      last_nacrule_id: 603b62db-d839-4152-9f7f-f2578443de8d
                      last_nacrule_name: Wireless Cert Auth
                      last_nas_vendor: juniper-mist
                      last_ssid: string
                      last_status: permitted
                      mac: string
                      nacrule_id:
                      - 603b62db-d839-4152-9f7f-f2578443de8d
                      nacrule_matched: true
                      nacrule_name:
                      - Wireless Cert Auth
                      nas_vendor:
                      - juniper-mist
                      org_id: 31f27122-68a9-47a4-b526-8fb8a62a8acb
                      random_mac: 'true'
                      site_id: 832b1d74-9531-409b-ae37-4d7f3edbde92
                      ssid:
                      - string
                      timestamp: 1694689718.612
                      type: wireless
                      usermac_label:
                      - non-compliant
                      - building26
                      - floor52
                    start: 1513276353
                    total: 2
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/nac_clients/{client_mac}/coa:
    post:
      tags:
      - Sites Clients - NAC
      summary: sendSiteNacClientCoA
      description: Sends CoA (Change of Authorization) command to a NAC client.
      operationId: sendSiteNacClientCoA
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: client_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/nac_client_coa'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/nac_client_coa_response'
                - description: Response returned after sending a NAC client CoA command
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/nac_client_coa_response'
                - description: Response returned after sending a NAC client CoA command
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/wan_client/events/count:
    get:
      tags:
      - Sites Clients - Wan
      summary: countSiteWanClientEvents
      description: Count WAN client events for a site, optionally grouped by the `distinct` field and filtered by event type and time range. Use [Count Org WAN Client Events]($e/Orgs%20Clients%20-%20Wan/countOrgWanClientEvents) to count WAN client events across the organization.
      operationId: countSiteWanClientEvents
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `hostname`, `ip`, `mac`, `mfg`, `type`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/site_wan_client_events_distinct'
          - description: 'Field used to group this count response. enum: `hostname`, `ip`, `mac`, `mfg`, `type`'
      - name: type
        in: query
        description: See [List Device Events Definitions]($e/Constants%20Events/listDeviceEventsDefinitions)
        style: form
        explode: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/wan_clients/count:
    get:
      tags:
      - Sites Clients - Wan
      summary: countSiteWanClients
      description: Count WAN clients for a site, optionally grouped by the `distinct` field and filtered by time range. Use [Count Org WAN Clients]($e/Orgs%20Clients%20-%20Wan/countOrgWanClients) to count WAN clients across the organization.
      operationId: countSiteWanClients
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `hostname`, `ip`, `mac`, `mfg`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/site_wan_clients_count_distinct'
          - description: 'Field used to group this count response. enum: `hostname`, `ip`, `mac`, `mfg`'
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/wan_clients/events/search:
    get:
      tags:
      - Sites Clients - Wan
      summary: searchSiteWanClientEvents
      description: Search WAN client events for a site with filters for client identity, manufacturer, NAC rule, event type, and time range. Use [Search Org WAN Client Events]($e/Orgs%20Clients%20-%20Wan/searchOrgWanClientEvents) to search WAN client events across the organization.
      operationId: searchSiteWanClientEvents
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: type
        in: query
        description: See [List Device Events Definitions]($e/Constants%20Events/listDeviceEventsDefinitions)
        style: form
        explode: true
        schema:
          type: string
      - name: mac
        in: query
        description: Partial / full Client MAC address. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `aabbcc*` and `*bbcc*` match `aabbccddeeff`). Suffix-only wildcards (e.g. `*bccddeeff`) are not supported
        style: form
        explode: true
        schema:
          type: string
          examples:
          - aabbccddeeff
          - aabbcc*
          - '*bbcc*'
        examples:
          Untitled Example1:
            value: aabbccddeeff
          Untitled Example2:
            value: aabbcc*
          Untitled Example3:
            value: '*bbcc*'
      - name: hostname
        in: query
        description: Partial / full Client hostname. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `everest*` and `*rest*` match `my-everest-client`). Suffix-only wildcards (e.g. `*everest`) are not supported
        style: form
        explode: true
        schema:
          type: string
          examples:
          - my-everest-client
          - my-everest*
          - '*everest*'
        examples:
          Untitled Example1:
            value: my-everest-client
          Untitled Example2:
            value: my-everest*
          Untitled Example3:
            value: '*everest*'
      - name: ip
        in: query
        description: Filter results by IP address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 10.4.2.4
      - name: mfg
        in: query
        description: Filter results by manufacturer
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Juniper
      - name: nacrule_id
        in: query
        description: Filter results by NAC rule identifier
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 00000000-0000-0000-0000-000000000000
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/search_events_wan_client'
                - description: Paginated response for WAN client event searches
                  examples:
                  - end: 0
                    limit: 0
                    results:
                    - When: 2022-12-31 23:59:59.293000+00:00
                      ev_type: CLIENT_IP_ASSIGNED
                      metadata: {}
                      org_id: b0b9f142-aaba-11e6-aafc-0242ac110002
                      random_mac: true
                      site_id: fc656275-b157-43fd-b922-5f4f341c19bf
                      text: DHCP Ack IP 192.168.88.216
                      wcid: 62bbfb75-10d8-49d1-dec7-d2df91624287
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 0
                    limit: 0
                    results:
                    - When: 2022-12-31 23:59:59.293000+00:00
                      ev_type: CLIENT_IP_ASSIGNED
                      metadata: {}
                      org_id: b0b9f142-aaba-11e6-aafc-0242ac110002
                      random_mac: true
                      site_id: fc656275-b157-43fd-b922-5f4f341c19bf
                      text: DHCP Ack IP 192.168.88.216
                      wcid: 62bbfb75-10d8-49d1-dec7-d2df91624287
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/search_events_wan_client'
                - description: Paginated response for WAN client event searches
                  examples:
                  - end: 0
                    limit: 0
                    results:
                    - When: 2022-12-31 23:59:59.293000+00:00
                      ev_type: CLIENT_IP_ASSIGNED
                      metadata: {}
                      org_id: b0b9f142-aaba-11e6-aafc-0242ac110002
                      random_mac: true
                      site_id: fc656275-b157-43fd-b922-5f4f341c19bf
                      text: DHCP Ack IP 192.168.88.216
                      wcid: 62bbfb75-10d8-49d1-dec7-d2df91624287
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 0
                    limit: 0
                    results:
                    - When: 2022-12-31 23:59:59.293000+00:00
                      ev_type: CLIENT_IP_ASSIGNED
                      metadata: {}
                      org_id: b0b9f142-aaba-11e6-aafc-0242ac110002
                      random_mac: true
                      site_id: fc656275-b157-43fd-b922-5f4f341c19bf
                      text: DHCP Ack IP 192.168.88.216
                      wcid: 62bbfb75-10d8-49d1-dec7-d2df91624287
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/wan_clients/search:
    get:
      tags:
      - Sites Clients - Wan
      summary: searchSiteWanClients
      description: Search WAN clients for a site with filters for hostname, IP address, source IP, MAC address, manufacturer, network, and time range. Use [Search Org WAN Clients]($e/Orgs%20Clients%20-%20Wan/searchOrgWanClients) to search WAN clients across the organization.
      operationId: searchSiteWanClients
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: hostname
        in: query
        description: Partial / full Client hostname. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `everest*` and `*rest*` match `my-everest-client`). Suffix-only wildcards (e.g. `*everest`) are not supported
        style: form
        explode: true
        schema:
          type: string
          examples:
          - my-everest-client
          - my-everest*
          - '*everest*'
        examples:
          Untitled Example1:
            value: my-everest-client
          Untitled Example2:
            value: my-everest*
          Untitled Example3:
            value: '*everest*'
      - name: ip
        in: query
        description: Partial / full Client IP address. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `10.100.10.*` and `*100.10.*` match `10.100.10.54`). Suffix-only wildcards (e.g. `*.54`) are not supported
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 10.100.10.54
          - 10.100.10.*
          - '*100.10.*'
        examples:
          Untitled Example1:
            value: 10.100.10.54
          Untitled Example2:
            value: 10.100.10.*
          Untitled Example3:
            value: '*100.10.*'
      - name: ip_src
        in: query
        description: Filter results by source IP address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - dhcp
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b53010101
      - name: mfg
        in: query
        description: Filter results by manufacturer
        style: form
        explode: true
        schema:
          type: string
      - name: network
        in: query
        description: Partial / full Name of the network the client is/was connected to. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `my-corp*` and `*corp*` match `my-corp-network`). Suffix-only wildcards (e.g. `*corp`) are not supported
        style: form
        explode: true
        schema:
          type: string
          examples:
          - my-corp-network
          - my-corp*
          - '*corp*'
        examples:
          Untitled Example1:
            value: my-corp-network
          Untitled Example2:
            value: my-corp*
          Untitled Example3:
            value: '*corp*'
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/search_wan_client'
                - description: Paginated response for WAN client searches
                  examples:
                  - end: 0
                    limit: 0
                    results:
                    - hostname:
                      - sonoszp
                      ip:
                      - 192.168.1.139
                      last_hostname: sonoszp
                      last_ip: 192.168.1.139
                      mfg: Sonos
                      org_id: b4e16c72-d50e-4c03-a952-a3217e231e2c
                      site_id: f688779c-e335-4f88-8d7c-9c5e9964528b
                      wcid: 8bbe7389-212b-c65d-2208-00fab2017936
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 0
                    limit: 0
                    results:
                    - hostname:
                      - sonoszp
                      ip:
                      - 192.168.1.139
                      last_hostname: sonoszp
                      last_ip: 192.168.1.139
                      mfg: Sonos
                      org_id: b4e16c72-d50e-4c03-a952-a3217e231e2c
                      site_id: f688779c-e335-4f88-8d7c-9c5e9964528b
                      wcid: 8bbe7389-212b-c65d-2208-00fab2017936
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/search_wan_client'
                - description: Paginated response for WAN client searches
                  examples:
                  - end: 0
                    limit: 0
                    results:
                    - hostname:
                      - sonoszp
                      ip:
                      - 192.168.1.139
                      last_hostname: sonoszp
                      last_ip: 192.168.1.139
                      mfg: Sonos
                      org_id: b4e16c72-d50e-4c03-a952-a3217e231e2c
                      site_id: f688779c-e335-4f88-8d7c-9c5e9964528b
                      wcid: 8bbe7389-212b-c65d-2208-00fab2017936
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 0
                    limit: 0
                    results:
                    - hostname:
                      - sonoszp
                      ip:
                      - 192.168.1.139
                      last_hostname: sonoszp
                      last_ip: 192.168.1.139
                      mfg: Sonos
                      org_id: b4e16c72-d50e-4c03-a952-a3217e231e2c
                      site_id: f688779c-e335-4f88-8d7c-9c5e9964528b
                      wcid: 8bbe7389-212b-c65d-2208-00fab2017936
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/wired_clients/count:
    get:
      tags:
      - Sites Clients - Wired
      summary: countSiteWiredClients
      description: Count wired clients for a site, optionally grouped by the `distinct` field and filtered by MAC address, switch port, VLAN, and time range. Use [Count Org Wired Clients]($e/Orgs%20Clients%20-%20Wired/countOrgWiredClients) to count wired clients across the organization.
      operationId: countSiteWiredClients
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `mac`, `port_id`, `vlan`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/site_wired_clients_count_distinct'
          - description: 'Field used to group this count response. enum: `mac`, `port_id`, `vlan`'
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 0123456789ab
      - name: device_mac
        in: query
        description: Filter results by device MAC address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 0123456789ab
      - name: port_id
        in: query
        description: Filter results by port identifier
        style: form
        explode: true
        schema:
          type: string
          examples:
          - ge-1/1/1
      - name: vlan
        in: query
        description: Filter results by VLAN ID
        style: form
        explode: true
        schema:
          type: string
          examples:
          - '10'
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/wired_clients/search:
    get:
      tags:
      - Sites Clients - Wired
      summary: searchSiteWiredClients
      description: Search wired clients for a site with filters for device MAC address, client MAC address, IP address, switch port, VLAN, manufacturer, DHCP attributes, NAC rule, and time range. Use [Search Org Wired Clients]($e/Orgs%20Clients%20-%20Wired/searchOrgWiredClients) to search wired clients across the organization.
      operationId: searchSiteWiredClients
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_mac
        in: query
        description: Filter results by device MAC address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 0123456789ab
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 0123456789ab
      - name: ip
        in: query
        description: Filter results by IP address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 10.3.5.12
      - name: port_id
        in: query
        description: Filter results by port identifier
        style: form
        explode: true
        schema:
          type: string
          examples:
          - ge-1/1/1
      - name: source
        in: query
        description: 'Filter results by client learning source. enum: `lldp`, `mac`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/client_info_source'
          - description: 'Filter results by client learning source. enum: `lldp`, `mac`'
      - name: vlan
        in: query
        description: Filter results by VLAN ID
        style: form
        explode: true
        schema:
          type: string
          examples:
          - '10'
      - name: manufacture
        in: query
        description: Filter results by manufacturer
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Juniper-Mist
      - name: text
        in: query
        description: Single entry of hostname/mac
        style: form
        explode: true
        schema:
          type: string
          examples:
          - client-hostname
      - name: nacrule_id
        in: query
        description: Filter results by NAC rule identifier
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 8bfc2490-d726-3587-038d-cb2e71bd2330
      - name: dhcp_hostname
        in: query
        description: Filter results by DHCP hostname
        style: form
        explode: true
        schema:
          type: string
          examples:
          - client-hostname
      - name: dhcp_fqdn
        in: query
        description: Filter results by DHCP FQDN
        style: form
        explode: true
        schema:
          type: string
          examples:
          - client.example.com
      - name: dhcp_client_identifier
        in: query
        description: Filter results by DHCP client identifier
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 01:23:45:67:89:ab
      - name: dhcp_vendor_class_identifier
        in: query
        description: DHCP Vendor Class Identifier
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Juniper-Mist-AP,Juniper-Mist-Client
      - name: dhcp_request_params
        in: query
        description: Filter results by DHCP request parameters
        style: form
        explode: true
        schema:
          type: string
          examples:
          - hostname,domain-name,domain-name-servers
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/search_wired_client'
                - description: Paginated response for wired client searches
                  examples:
                  - end: 1648529800.8221116
                    limit: 1000
                    results:
                    - auth_method: mac_auth
                      auth_state: authenticated
                      device_mac:
                      - '001122334455'
                      dhcp_client_identifier: MAC address 00155df6d500
                      dhcp_client_options:
                      - code: DHO_DHCP_MESSAGE_TYPE(53)
                        data: DHCPREQUEST
                      - code: DHO_DHCP_CLIENT_IDENTIFIER(61)
                        data: MAC address 00155df6d500
                      - code: DHO_DHCP_REQUESTED_ADDRESS(50)
                        data: 172.17.10.255
                      - code: DHO_DHCP_SERVER_IDENTIFIER(54)
                        data: 172.17.8.1
                      - code: DHO_DHCP_MAX_MESSAGE_SIZE(57)
                        data: '1280'
                      - code: DHO_DHCP_PARAMETER_REQUEST_LIST(55)
                        data: ' 1 3 6 12 15 28 43 180'
                      - code: DHO_VENDOR_CLASS_IDENTIFIER(60)
                        data: MSFT 5.0
                      - code: DHO_HOST_NAME(12)
                        data: ITS-VMMT0-D1N02
                      dhcp_fqdn: ITS-VMMT0-D1N02.mgthub.local
                      dhcp_hostname: ITS-VMMT0-D1N02
                      dhcp_request_params: 1 3 6 15 31 33 43 44 46 47 119 121 249 252
                      dhcp_vendor_class_identifier: MSFT 5.0
                      mac: '112233445566'
                      org_id: c168ddee-c14c-11e5-8e81-1258369c38a9
                      port_id:
                      - et-0/0/1
                      site_id: c168ddee-c14c-11e5-8e81-1258369c38a9
                      timestamp: 1571174567.807
                      vlan:
                      - 0
                      - 1001
                    start: 1648443400.8221116
                    total: 1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1648529800.8221116
                    limit: 1000
                    results:
                    - auth_method: mac_auth
                      auth_state: authenticated
                      device_mac:
                      - '001122334455'
                      dhcp_client_identifier: MAC address 00155df6d500
                      dhcp_client_options:
                      - code: DHO_DHCP_MESSAGE_TYPE(53)
                        data: DHCPREQUEST
                      - code: DHO_DHCP_CLIENT_IDENTIFIER(61)
                        data: MAC address 00155df6d500
                      - code: DHO_DHCP_REQUESTED_ADDRESS(50)
                        data: 172.17.10.255
                      - code: DHO_DHCP_SERVER_IDENTIFIER(54)
                        data: 172.17.8.1
                      - code: DHO_DHCP_MAX_MESSAGE_SIZE(57)
                        data: '1280'
                      - code: DHO_DHCP_PARAMETER_REQUEST_LIST(55)
                        data: ' 1 3 6 12 15 28 43 180'
                      - code: DHO_VENDOR_CLASS_IDENTIFIER(60)
                        data: MSFT 5.0
                      - code: DHO_HOST_NAME(12)
                        data: ITS-VMMT0-D1N02
                      dhcp_fqdn: ITS-VMMT0-D1N02.mgthub.local
                      dhcp_hostname: ITS-VMMT0-D1N02
                      dhcp_request_params: 1 3 6 15 31 33 43 44 46 47 119 121 249 252
                      dhcp_vendor_class_identifier: MSFT 5.0
                      mac: '112233445566'
                      org_id: c168ddee-c14c-11e5-8e81-1258369c38a9
                      port_id:
                      - et-0/0/1
                      site_id: c168ddee-c14c-11e5-8e81-1258369c38a9
                      timestamp: 1571174567.807
                      vlan:
                      - 0
                      - 1001
                    start: 1648443400.8221116
                    total: 1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/search_wired_client'
                - description: Paginated response for wired client searches
                  examples:
                  - end: 1648529800.8221116
                    limit: 1000
                    results:
                    - auth_method: mac_auth
                      auth_state: authenticated
                      device_mac:
                      - '001122334455'
                      dhcp_client_identifier: MAC address 00155df6d500
                      dhcp_client_options:
                      - code: DHO_DHCP_MESSAGE_TYPE(53)
                        data: DHCPREQUEST
                      - code: DHO_DHCP_CLIENT_IDENTIFIER(61)
                        data: MAC address 00155df6d500
                      - code: DHO_DHCP_REQUESTED_ADDRESS(50)
                        data: 172.17.10.255
                      - code: DHO_DHCP_SERVER_IDENTIFIER(54)
                        data: 172.17.8.1
                      - code: DHO_DHCP_MAX_MESSAGE_SIZE(57)
                        data: '1280'
                      - code: DHO_DHCP_PARAMETER_REQUEST_LIST(55)
                        data: ' 1 3 6 12 15 28 43 180'
                      - code: DHO_VENDOR_CLASS_IDENTIFIER(60)
                        data: MSFT 5.0
                      - code: DHO_HOST_NAME(12)
                        data: ITS-VMMT0-D1N02
                      dhcp_fqdn: ITS-VMMT0-D1N02.mgthub.local
                      dhcp_hostname: ITS-VMMT0-D1N02
                      dhcp_request_params: 1 3 6 15 31 33 43 44 46 47 119 121 249 252
                      dhcp_vendor_class_identifier: MSFT 5.0
                      mac: '112233445566'
                      org_id: c168ddee-c14c-11e5-8e81-1258369c38a9
                      port_id:
                      - et-0/0/1
                      site_id: c168ddee-c14c-11e5-8e81-1258369c38a9
                      timestamp: 1571174567.807
                      vlan:
                      - 0
                      - 1001
                    start: 1648443400.8221116
                    total: 1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1648529800.8221116
                    limit: 1000
                    results:
                    - auth_method: mac_auth
                      auth_state: authenticated
                      device_mac:
                      - '001122334455'
                      dhcp_client_identifier: MAC address 00155df6d500
                      dhcp_client_options:
                      - code: DHO_DHCP_MESSAGE_TYPE(53)
                        data: DHCPREQUEST
                      - code: DHO_DHCP_CLIENT_IDENTIFIER(61)
                        data: MAC address 00155df6d500
                      - code: DHO_DHCP_REQUESTED_ADDRESS(50)
                        data: 172.17.10.255
                      - code: DHO_DHCP_SERVER_IDENTIFIER(54)
                        data: 172.17.8.1
                      - code: DHO_DHCP_MAX_MESSAGE_SIZE(57)
                        data: '1280'
                      - code: DHO_DHCP_PARAMETER_REQUEST_LIST(55)
                        data: ' 1 3 6 12 15 28 43 180'
                      - code: DHO_VENDOR_CLASS_IDENTIFIER(60)
                        data: MSFT 5.0
                      - code: DHO_HOST_NAME(12)
                        data: ITS-VMMT0-D1N02
                      dhcp_fqdn: ITS-VMMT0-D1N02.mgthub.local
                      dhcp_hostname: ITS-VMMT0-D1N02
                      dhcp_request_params: 1 3 6 15 31 33 43 44 46 47 119 121 249 252
                      dhcp_vendor_class_identifier: MSFT 5.0
                      mac: '112233445566'
                      org_id: c168ddee-c14c-11e5-8e81-1258369c38a9
                      port_id:
                      - et-0/0/1
                      site_id: c168ddee-c14c-11e5-8e81-1258369c38a9
                      timestamp: 1571174567.807
                      vlan:
                      - 0
                      - 1001
                    start: 1648443400.8221116
                    total: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/clients/count:
    get:
      tags:
      - Sites Clients - Wireless
      summary: countSiteWirelessClients
      description: Count wireless clients for a site, optionally grouped by the `distinct` field and filtered by client attributes and time range. Use [Count Org Wireless Clients]($e/Orgs%20Clients%20-%20Wireless/countOrgWirelessClients) to count wireless clients across the organization.
      operationId: countSiteWirelessClients
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `ap`, `device`, `hostname`, `ip`, `model`, `os`, `ssid`, `vlan`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/site_clients_count_distinct'
          - description: 'Field used to group this count response. enum: `ap`, `device`, `hostname`, `ip`, `model`, `os`, `ssid`, `vlan`'
            examples:
            - hostname
      - name: ssid
        in: query
        description: Filter results by SSID
        style: form
        explode: true
        schema:
          type: string
      - name: ap
        in: query
        description: Filter results by AP MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: ip
        in: query
        description: Filter results by IPv4 address
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: ipv4
          examples:
          - 192.168.1.1
      - name: vlan
        in: query
        description: Filter client results by VLAN ID
        style: form
        explode: true
        schema:
          type: string
      - name: hostname
        in: query
        description: Filter results by hostname
        style: form
        explode: true
        schema:
          type: string
      - name: os
        in: query
        description: Filter client results by operating system
        style: form
        explode: true
        schema:
          type: string
      - name: model
        in: query
        description: Filter results by device model
        style: form
        explode: true
        schema:
          type: string
      - name: device
        in: query
        description: Filter client results by device type
        style: form
        explode: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/clients/events/count:
    get:
      tags:
      - Sites Clients - Wireless
      summary: countSiteWirelessClientEvents
      description: Count wireless client events for a site, optionally grouped by the `distinct` field and filtered by event attributes and time range. Use [Count Org Wireless Client Events]($e/Orgs%20Clients%20-%20Wireless/countOrgWirelessClientEvents) to count wireless client events across the organization.
      operationId: countSiteWirelessClientEvents
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `band`, `channel`, `proto`, `ssid`, `type`, `wlan_id`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/site_client_events_count_distinct'
          - description: 'Field used to group this count response. enum: `band`, `channel`, `proto`, `ssid`, `type`, `wlan_id`'
            examples:
            - type
      - name: type
        in: query
        description: See [List Device Events Definitions]($e/Constants%20Events/listDeviceEventsDefinitions)
        style: form
        explode: true
        schema:
          type: string
      - name: reason_code
        in: query
        description: Reason code filter for association and disassociation events
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: ssid
        in: query
        description: Filter results by SSID
        style: form
        explode: true
        schema:
          type: string
      - name: ap
        in: query
        description: Filter results by AP MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: proto
        in: query
        description: '802.11 protocol used to filter results. enum: `a`, `ac`, `ax`, `b`, `be`, `g`, `n`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/dot11_proto'
          - description: '802.11 protocol used to filter results. enum: `a`, `ac`, `ax`, `b`, `be`, `g`, `n`'
      - name: band
        in: query
        description: '802.11 band used to filter radio results. enum: `24`, `5`, `5-dedicated`, `5-selectable`, `6`, `6-dedicated`, `6-selectable`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/dot11_band'
          - description: '802.11 band used to filter radio results. enum: `24`, `5`, `5-dedicated`, `5-selectable`, `6`, `6-dedicated`, `6-selectable`'
      - name: wlan_id
        in: query
        description: Filter results by WLAN identifier
        style: form
        explode: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/clients/events/search:
    get:
      tags:
      - Sites Clients - Wireless
      summary: searchSiteWirelessClientEvents
      description: Search wireless client events for a site with filters for event type, AP, SSID, WLAN, radio band, and time range. Use [Search Org Wireless Client Events]($e/Orgs%20Clients%20-%20Wireless/searchOrgWirelessClientEvents) to search wireless client events across the organization.
      operationId: searchSiteWirelessClientEvents
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: type
        in: query
        description: See [List Device Events Definitions]($e/Constants%20Events/listDeviceEventsDefinitions)
        style: form
        explode: true
        schema:
          type: string
      - name: reason_code
        in: query
        description: Reason code filter for association and disassociation events
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: ssid
        in: query
        description: Filter results by SSID
        style: form
        explode: true
        schema:
          type: string
      - name: ap
        in: query
        description: Filter results by AP MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: proto
        in: query
        description: '802.11 protocol used to filter results. enum: `a`, `ac`, `ax`, `b`, `be`, `g`, `n`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/dot11_proto'
          - description: '802.11 protocol used to filter results. enum: `a`, `ac`, `ax`, `b`, `be`, `g`, `n`'
      - name: band
        in: query
        description: '802.11 band used to filter radio results. enum: `24`, `5`, `5-dedicated`, `5-selectable`, `6`, `6-dedicated`, `6-selectable`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/dot11_band'
          - description: '802.11 band used to filter radio results. enum: `24`, `5`, `5-dedicated`, `5-selectable`, `6`, `6-dedicated`, `6-selectable`'
      - name: wlan_id
        in: query
        description: Filter results by WLAN identifier
        style: form
        explode: true
        schema:
          type: string
      - name: nacrule_id
        in: query
        description: Filter results by NAC rule identifier
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_events_search'
                - description: Paginated response for wireless client event search results
                  examples:
                  - end: 0
                    limit: 0
                    results:
                    - ap: string
                      band: '24'
                      bssid: string
                      channel: 0
                      proto: a
                      ssid: string
                      text: string
                      timestamp: 0
                      type: string
                      type_code: 0
                      wlan_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 0
                    limit: 0
                    results:
                    - ap: string
                      band: '24'
                      bssid: string
                      channel: 0
                      proto: a
                      ssid: string
                      text: string
                      timestamp: 0
                      type: string
                      type_code: 0
                      wlan_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_events_search'
                - description: Paginated response for wireless client event search results
                  examples:
                  - end: 0
                    limit: 0
                    results:
                    - ap: string
                      band: '24'
                      bssid: string
                      channel: 0
                      proto: a
                      ssid: string
                      text: string
                      timestamp: 0
                      type: string
                      type_code: 0
                      wlan_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 0
                    limit: 0
                    results:
                    - ap: string
                      band: '24'
                      bssid: string
                      channel: 0
                      proto: a
                      ssid: string
                      text: string
                      timestamp: 0
                      type: string
                      type_code: 0
                      wlan_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/clients/search:
    get:
      tags:
      - Sites Clients - Wireless
      summary: searchSiteWirelessClients
      description: Search wireless clients connected to a site with filters for client identity, AP, SSID, VLAN, radio band, and time range. Fuzzy matching with `*` is supported on `mac`, `hostname`, `device`, `os`, and `model`, for example `/clients/search?device=Mac*&hostname=jerry`. Use [Search Org Wireless Clients]($e/Orgs%20Clients%20-%20Wireless/searchOrgWirelessClients) to search wireless clients across the organization.
      operationId: searchSiteWirelessClients
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: ap
        in: query
        description: Filter results by AP MAC address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b53010101
      - name: band
        in: query
        description: 'Comma separated list of Radio band (e.g. `24,5`). enum: `24`, `5`, `6`'
        style: form
        explode: true
        schema:
          type: string
          examples:
          - '5'
      - name: device
        in: query
        description: Comma separated list of Device type (e.g. `Mac,iPhone`). Case sensitive
        style: form
        explode: true
        schema:
          type: string
          examples:
          - iPhone
      - name: hostname
        in: query
        description: Partial / full Client hostname. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `everest*` and `*rest*` match `my-everest-client`). Suffix-only wildcards (e.g. `*everest`) are not supported
        style: form
        explode: true
        schema:
          type: string
          examples:
          - my-everest-client
          - my-everest*
          - '*everest*'
        examples:
          Untitled Example1:
            value: my-everest-client
          Untitled Example2:
            value: my-everest*
          Untitled Example3:
            value: '*everest*'
      - name: ip
        in: query
        description: Partial / full Client IP address. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `10.100.10.*` and `*100.10.*` match `10.100.10.54`). Suffix-only wildcards (e.g. `*.54`) are not supported
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 10.100.10.54
          - 10.100.10.*
          - '*100.10.*'
        examples:
          Untitled Example1:
            value: 10.100.10.54
          Untitled Example2:
            value: 10.100.10.*
          Untitled Example3:
            value: '*100.10.*'
      - name: mac
        in: query
        description: Partial / full Client MAC address. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `aabbcc*` and `*bbcc*` match `aabbccddeeff`). Suffix-only wildcards (e.g. `*bccddeeff`) are not supported
        style: form
        explode: true
        schema:
          type: string
          examples:
          - aabbccddeeff
          - aabbcc*
          - '*bbcc*'
        examples:
          Untitled Example1:
            value: aabbccddeeff
          Untitled Example2:
            value: aabbcc*
          Untitled Example3:
            value: '*bbcc*'
      - name: model
        in: query
        description: Only available for clients running the Marvis Client app, model, e.g. "MBP 15 late 2013", 6, 6s, "8+ GSM"
        style: form
        explode: true
        schema:
          type: string
          examples:
          - iPhone 8
      - name: os
        in: query
        description: Only available for clients running the Marvis Client app, os, e.g. Sierra, Yosemite, Windows 10
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Windows 10
      - name: psk_id
        in: query
        description: PSK identifier used to filter the results
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: psk_name
        in: query
        description: Only available for clients using PPSK authentication, the Name of the PSK
        style: form
        explode: true
        schema:
          type: string
          examples:
          - MyPPSK
      - name: ssid
        in: query
        description: Filter results by SSID
        style: form
        explode: true
        schema:
          type: string
          examples:
          - MySSID
      - name: text
        in: query
        description: Partial / full MAC address, hostname, username, psk_name or ip. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `everest*` and `*rest*` match `my-everest-client`). Suffix-only wildcards (e.g. `*client`) are not supported
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b530
      - name: username
        in: query
        description: Partial / full username. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `johndoe*` and `*mycorp*` match `johndoe@mycorp.com`). Suffix-only wildcards (e.g. `*mycorp.com`) are not supported
        style: form
        explode: true
        schema:
          type: string
          examples:
          - johndoe
          - johnd*
          - '*ohnd*'
        examples:
          Untitled Example1:
            value: johndoe
          Untitled Example2:
            value: johnd*
          Untitled Example3:
            value: '*ohnd*'
      - name: vlan
        in: query
        description: Filter results by VLAN ID
        style: form
        explode: true
        schema:
          type: string
          examples:
          - '10'
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_client_search'
                - description: Paginated wireless client search response
                  examples:
                  - end: 17141231418.812
                    limit: 118
                    next: next8
                    results:
                    - ap:
                      - a83a79a947ee
                      - 003e73170b4c
                      app_version:
                      - 0.100.3
                      band: '5'
                      device:
                      - Mac
                      ftc: false
                      hardware: Apple Wi-Fi adapter
                      hostname:
                      - hostname-a
                      - hostname-b
                      ip:
                      - 10.5.23.43
                      - 192.168.0.2
                      last_ap: a83a79a947ee
                      last_device: Mac
                      last_firmware: 'wl0: Jan 20 2024 04:08:41 version 20.103.12.0.8.7.171 FWID 01-e09d2675'
                      last_hostname: hostname-a
                      last_ip: 10.5.23.43
                      last_model: MBP 16\" M1 2021
                      last_os: Sonoma
                      last_os_version: 14.4.1 (Build 23E224)
                      last_psk_id: abf7dc5c-bb51-4bb7-93b6-5547400ffe11
                      last_psk_name: iot
                      last_ssid: IoT SSID
                      last_username: user@corp.com
                      last_vlan: 10
                      last_wlan_id: e5d67b07-aae8-494b-8584-cbc20c8110aa
                      mac: bcd074000000
                      mfg: Apple
                      model: MBP 16\" M1 2021
                      org_id: 1abff1aa-4571-4c1f-a409-153a1e7a7a24
                      os:
                      - Sonoma
                      os_version:
                      - 14.4.1 (Build 23E224)
                      protocol: ax
                      psk_id:
                      - abf7dc5c-bb51-4bb7-93b6-5547400ffe11
                      psk_name:
                      - iot
                      sdk_version:
                      - 0.100.3
                      site_id: 25ff5219-9be7-4db9-907d-0c9b60445147
                      site_ids:
                      - 25ff5219-9be7-4db9-907d-0c9b60445147
                      ssid:
                      - IoT SSID
                      timestamp: 1714124722.113
                      username:
                      - user@corp.com
                      vlan:
                      - 10
                    start: 10
                    total: 44
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 17141231418.812
                    limit: 118
                    next: next8
                    results:
                    - ap:
                      - a83a79a947ee
                      - 003e73170b4c
                      app_version:
                      - 0.100.3
                      band: '5'
                      device:
                      - Mac
                      ftc: false
                      hardware: Apple Wi-Fi adapter
                      hostname:
                      - hostname-a
                      - hostname-b
                      ip:
                      - 10.5.23.43
                      - 192.168.0.2
                      last_ap: a83a79a947ee
                      last_device: Mac
                      last_firmware: 'wl0: Jan 20 2024 04:08:41 version 20.103.12.0.8.7.171 FWID 01-e09d2675'
                      last_hostname: hostname-a
                      last_ip: 10.5.23.43
                      last_model: MBP 16\" M1 2021
                      last_os: Sonoma
                      last_os_version: 14.4.1 (Build 23E224)
                      last_psk_id: abf7dc5c-bb51-4bb7-93b6-5547400ffe11
                      last_psk_name: iot
                      last_ssid: IoT SSID
                      last_username: user@corp.com
                      last_vlan: 10
                      last_wlan_id: e5d67b07-aae8-494b-8584-cbc20c8110aa
                      mac: bcd074000000
                      mfg: Apple
                      model: MBP 16\" M1 2021
                      org_id: 1abff1aa-4571-4c1f-a409-153a1e7a7a24
                      os:
                      - Sonoma
                      os_version:
                      - 14.4.1 (Build 23E224)
                      protocol: ax
                      psk_id:
                      - abf7dc5c-bb51-4bb7-93b6-5547400ffe11
                      psk_name:
                      - iot
                      sdk_version:
                      - 0.100.3
                      site_id: 25ff5219-9be7-4db9-907d-0c9b60445147
                      site_ids:
                      - 25ff5219-9be7-4db9-907d-0c9b60445147
                      ssid:
                      - IoT SSID
                      timestamp: 1714124722.113
                      username:
                      - user@corp.com
                      vlan:
                      - 10
                    start: 10
                    total: 44
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_client_search'
                - description: Paginated wireless client search response
                  examples:
                  - end: 17141231418.812
                    limit: 118
                    next: next8
                    results:
                    - ap:
                      - a83a79a947ee
                      - 003e73170b4c
                      app_version:
                      - 0.100.3
                      band: '5'
                      device:
                      - Mac
                      ftc: false
                      hardware: Apple Wi-Fi adapter
                      hostname:
                      - hostname-a
                      - hostname-b
                      ip:
                      - 10.5.23.43
                      - 192.168.0.2
                      last_ap: a83a79a947ee
                      last_device: Mac
                      last_firmware: 'wl0: Jan 20 2024 04:08:41 version 20.103.12.0.8.7.171 FWID 01-e09d2675'
                      last_hostname: hostname-a
                      last_ip: 10.5.23.43
                      last_model: MBP 16\" M1 2021
                      last_os: Sonoma
                      last_os_version: 14.4.1 (Build 23E224)
                      last_psk_id: abf7dc5c-bb51-4bb7-93b6-5547400ffe11
                      last_psk_name: iot
                      last_ssid: IoT SSID
                      last_username: user@corp.com
                      last_vlan: 10
                      last_wlan_id: e5d67b07-aae8-494b-8584-cbc20c8110aa
                      mac: bcd074000000
                      mfg: Apple
                      model: MBP 16\" M1 2021
                      org_id: 1abff1aa-4571-4c1f-a409-153a1e7a7a24
                      os:
                      - Sonoma
                      os_version:
                      - 14.4.1 (Build 23E224)
                      protocol: ax
                      psk_id:
                      - abf7dc5c-bb51-4bb7-93b6-5547400ffe11
                      psk_name:
                      - iot
                      sdk_version:
                      - 0.100.3
                      site_id: 25ff5219-9be7-4db9-907d-0c9b60445147
                      site_ids:
                      - 25ff5219-9be7-4db9-907d-0c9b60445147
                      ssid:
                      - IoT SSID
                      timestamp: 1714124722.113
                      username:
                      - user@corp.com
                      vlan:
                      - 10
                    start: 10
                    total: 44
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 17141231418.812
                    limit: 118
                    next: next8
                    results:
                    - ap:
                      - a83a79a947ee
                      - 003e73170b4c
                      app_version:
                      - 0.100.3
                      band: '5'
                      device:
                      - Mac
                      ftc: false
                      hardware: Apple Wi-Fi adapter
                      hostname:
                      - hostname-a
                      - hostname-b
                      ip:
                      - 10.5.23.43
                      - 192.168.0.2
                      last_ap: a83a79a947ee
                      last_device: Mac
                      last_firmware: 'wl0: Jan 20 2024 04:08:41 version 20.103.12.0.8.7.171 FWID 01-e09d2675'
                      last_hostname: hostname-a
                      last_ip: 10.5.23.43
                      last_model: MBP 16\" M1 2021
                      last_os: Sonoma
                      last_os_version: 14.4.1 (Build 23E224)
                      last_psk_id: abf7dc5c-bb51-4bb7-93b6-5547400ffe11
                      last_psk_name: iot
                      last_ssid: IoT SSID
                      last_username: user@corp.com
                      last_vlan: 10
                      last_wlan_id: e5d67b07-aae8-494b-8584-cbc20c8110aa
                      mac: bcd074000000
                      mfg: Apple
                      model: MBP 16\" M1 2021
                      org_id: 1abff1aa-4571-4c1f-a409-153a1e7a7a24
                      os:
                      - Sonoma
                      os_version:
                      - 14.4.1 (Build 23E224)
                      protocol: ax
                      psk_id:
                      - abf7dc5c-bb51-4bb7-93b6-5547400ffe11
                      psk_name:
                      - iot
                      sdk_version:
                      - 0.100.3
                      site_id: 25ff5219-9be7-4db9-907d-0c9b60445147
                      site_ids:
                      - 25ff5219-9be7-4db9-907d-0c9b60445147
                      ssid:
                      - IoT SSID
                      timestamp: 1714124722.113
                      username:
                      - user@corp.com
                      vlan:
                      - 10
                    start: 10
                    total: 44
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/clients/sessions/count:
    get:
      tags:
      - Sites Clients - Wireless
      summary: countSiteWirelessClientSessions
      description: Count wireless client sessions for a site, optionally grouped by the `distinct` field and filtered by AP, SSID, WLAN, client attributes, and time range. Use [Count Org Wireless Client Sessions]($e/Orgs%20Clients%20-%20Wireless/countOrgWirelessClientsSessions) to count wireless client sessions across the organization.
      operationId: countSiteWirelessClientSessions
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `ap`, `client_family`, `client_manufacture`, `client_model`, `client_os`, `mac`, `ssid`, `wlan_id`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/site_client_sessions_count_distinct'
          - description: 'Field used to group this count response. enum: `ap`, `client_family`, `client_manufacture`, `client_model`, `client_os`, `mac`, `ssid`, `wlan_id`'
      - name: ap
        in: query
        description: Filter results by AP MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: band
        in: query
        description: '802.11 band used to filter radio results. enum: `24`, `5`, `5-dedicated`, `5-selectable`, `6`, `6-dedicated`, `6-selectable`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/dot11_band'
          - description: '802.11 band used to filter radio results. enum: `24`, `5`, `5-dedicated`, `5-selectable`, `6`, `6-dedicated`, `6-selectable`'
      - name: client_family
        in: query
        description: E.g. "Mac", "iPhone", "Apple watch"
        style: form
        explode: true
        schema:
          type: string
      - name: client_manufacture
        in: query
        description: Filter results by client manufacturer, e.g. "Apple"
        style: form
        explode: true
        schema:
          type: string
      - name: client_model
        in: query
        description: Filter results by client model, e.g. "8+", "XS"
        style: form
        explode: true
        schema:
          type: string
      - name: client_os
        in: query
        description: E.g. "Mojave", "Windows 10", "Linux"
        style: form
        explode: true
        schema:
          type: string
      - name: ssid
        in: query
        description: Filter results by SSID
        style: form
        explode: true
        schema:
          type: string
      - name: wlan_id
        in: query
        description: Filter results by WLAN identifier
        style: form
        explode: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/clients/sessions/search:
    get:
      tags:
      - Sites Clients - Wireless
      summary: searchSiteWirelessClientSessions
      description: Search wireless client sessions for a site with filters for AP, SSID, WLAN, client attributes, PSK, and time range. Use [Search Org Wireless Client Sessions]($e/Orgs%20Clients%20-%20Wireless/searchOrgWirelessClientSessions) to search wireless client sessions across the organization.
      operationId: searchSiteWirelessClientSessions
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: ap
        in: query
        description: Filter results by AP MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: band
        in: query
        description: '802.11 band used to filter radio results. enum: `24`, `5`, `5-dedicated`, `5-selectable`, `6`, `6-dedicated`, `6-selectable`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/dot11_band'
          - description: '802.11 band used to filter radio results. enum: `24`, `5`, `5-dedicated`, `5-selectable`, `6`, `6-dedicated`, `6-selectable`'
      - name: client_family
        in: query
        description: E.g. "Mac", "iPhone", "Apple watch"
        style: form
        explode: true
        schema:
          type: string
      - name: client_manufacture
        in: query
        description: Filter results by client manufacturer, e.g. "Apple"
        style: form
        explode: true
        schema:
          type: string
      - name: client_model
        in: query
        description: Filter results by client model, e.g. "8+", "XS"
        style: form
        explode: true
        schema:
          type: string
      - name: client_username
        in: query
        description: Filter results by client username
        style: form
        explode: true
        schema:
          type: string
      - name: client_os
        in: query
        description: E.g. "Mojave", "Windows 10", "Linux"
        style: form
        explode: true
        schema:
          type: string
      - name: ssid
        in: query
        description: Filter results by SSID
        style: form
        explode: true
        schema:
          type: string
      - name: wlan_id
        in: query
        description: Filter results by WLAN identifier
        style: form
        explode: true
        schema:
          type: string
      - name: psk_id
        in: query
        description: PSK identifier used to filter the results
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: psk_name
        in: query
        description: Filter results by PSK name
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_client_sessions_search'
                - description: Paginated wireless client session search response
                  examples:
                  - end: 1513177200
                    limit: 10
                    results:
                    - ap: 5c5b350e0262
                      band: '5'
                      client_manufacture: Apple
                      connect: 1565208388
                      disconnect: 1565208448
                      duration: 60.09423865
                      mac: b019c66c8348
                      org_id: 3139f2c2-fac6-11e5-8156-0242ac110006
                      site_id: 70e0f468-fc13-11e5-85ad-0242ac110008
                      ssid: Dummy WLAN 2
                      tags:
                      - disassociate
                      timestamp: 1565208448.662
                      wlan_id: 99bb4c74-f954-4f36-b844-6b030faffabc
                    start: 1511967600
                    total: 100
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1513177200
                    limit: 10
                    results:
                    - ap: 5c5b350e0262
                      band: '5'
                      client_manufacture: Apple
                      connect: 1565208388
                      disconnect: 1565208448
                      duration: 60.09423865
                      mac: b019c66c8348
                      org_id: 3139f2c2-fac6-11e5-8156-0242ac110006
                      site_id: 70e0f468-fc13-11e5-85ad-0242ac110008
                      ssid: Dummy WLAN 2
                      tags:
                      - disassociate
                      timestamp: 1565208448.662
                      wlan_id: 99bb4c74-f954-4f36-b844-6b030faffabc
                    start: 1511967600
                    total: 100
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_client_sessions_search'
                - description: Paginated wireless client session search response
                  examples:
                  - end: 1513177200
                    limit: 10
                    results:
                    - ap: 5c5b350e0262
                      band: '5'
                      client_manufacture: Apple
                      connect: 1565208388
                      disconnect: 1565208448
                      duration: 60.09423865
                      mac: b019c66c8348
                      org_id: 3139f2c2-fac6-11e5-8156-0242ac110006
                      site_id: 70e0f468-fc13-11e5-85ad-0242ac110008
                      ssid: Dummy WLAN 2
                      tags:
                      - disassociate
                      timestamp: 1565208448.662
                      wlan_id: 99bb4c74-f954-4f36-b844-6b030faffabc
                    start: 1511967600
                    total: 100
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1513177200
                    limit: 10
                    results:
                    - ap: 5c5b350e0262
                      band: '5'
                      client_manufacture: Apple
                      connect: 1565208388
                      disconnect: 1565208448
                      duration: 60.09423865
                      mac: b019c66c8348
                      org_id: 3139f2c2-fac6-11e5-8156-0242ac110006
                      site_id: 70e0f468-fc13-11e5-85ad-0242ac110008
                      ssid: Dummy WLAN 2
                      tags:
                      - disassociate
                      timestamp: 1565208448.662
                      wlan_id: 99bb4c74-f954-4f36-b844-6b030faffabc
                    start: 1511967600
                    total: 100
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/clients/{client_mac}/events:
    get:
      tags:
      - Sites Clients - Wireless
      summary: getSiteEventsForClient
      description: Get the list of events for a specific client
      operationId: getSiteEventsForClient
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: client_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      - name: type
        in: query
        description: Filter results by type, e.g. MARVIS_EVENT_CLIENT_DHCP_STUCK
        style: form
        explode: true
        schema:
          type: string
      - name: proto
        in: query
        description: '802.11 protocol used to filter results. enum: `a`, `ac`, `ax`, `b`, `be`, `g`, `n`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/dot11_proto'
          - description: '802.11 protocol used to filter results. enum: `a`, `ac`, `ax`, `b`, `be`, `g`, `n`'
      - name: band
        in: query
        description: '802.11 band used to filter radio results. enum: `24`, `5`, `5-dedicated`, `5-selectable`, `6`, `6-dedicated`, `6-selectable`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/dot11_band'
          - description: '802.11 band used to filter radio results. enum: `24`, `5`, `5-dedicated`, `5-selectable`, `6`, `6-dedicated`, `6-selectable`'
      - name: channel
        in: query
        description: Filter available versions by release channel
        style: form
        explode: true
        schema:
          type: string
      - name: wlan_id
        in: query
        description: Filter results by WLAN identifier
        style: form
        explode: true
        schema:
          type: string
      - name: ssid
        in: query
        description: Filter results by SSID
        style: form
        explode: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_client_events_search'
                - description: Paginated client event search response
                  examples:
                  - end: 1513176951
                    limit: 10
                    results:
                    - ap: 5c5b350eb31b
                      band: '5'
                      bssid: 5c5b350918f1
                      channel: 149
                      proto: ac
                      ssid: Guest
                      text: Status code 0 "Successful"
                      timestamp: 1513358874.667
                      type: CLIENT_DNS_OK
                      type_code: 15
                      wlan_id: be22bba7-8e22-e1cf-5185-b880816fe2cf
                    start: 1512572151
                    total: 1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1513176951
                    limit: 10
                    results:
                    - ap: 5c5b350eb31b
                      band: '5'
                      bssid: 5c5b350918f1
                      channel: 149
                      proto: ac
                      ssid: Guest
                      text: Status code 0 "Successful"
                      timestamp: 1513358874.667
                      type: CLIENT_DNS_OK
                      type_code: 15
                      wlan_id: be22bba7-8e22-e1cf-5185-b880816fe2cf
                    start: 1512572151
                    total: 1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_client_events_search'
                - description: Paginated client event search response
                  examples:
                  - end: 1513176951
                    limit: 10
                    results:
                    - ap: 5c5b350eb31b
                      band: '5'
                      bssid: 5c5b350918f1
                      channel: 149
                      proto: ac
                      ssid: Guest
                      text: Status code 0 "Successful"
                      timestamp: 1513358874.667
                      type: CLIENT_DNS_OK
                      type_code: 15
                      wlan_id: be22bba7-8e22-e1cf-5185-b880816fe2cf
                    start: 1512572151
                    total: 1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1513176951
                    limit: 10
                    results:
                    - ap: 5c5b350eb31b
                      band: '5'
                      bssid: 5c5b350918f1
                      channel: 149
                      proto: ac
                      ssid: Guest
                      text: Status code 0 "Successful"
                      timestamp: 1513358874.667
                      type: CLIENT_DNS_OK
                      type_code: 15
                      wlan_id: be22bba7-8e22-e1cf-5185-b880816fe2cf
                    start: 1512572151
                    total: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices:
    get:
      tags:
      - Sites Devices
      summary: listSiteDevices
      description: List devices in a site. Use [List Org Devices]($e/Orgs%20Devices/listOrgDevices) to retrieve devices across the organization, or [Search Org Devices]($e/Orgs%20Devices/searchOrgDevices) when filters are needed.
      operationId: listSiteDevices
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: type
        in: query
        description: Filter results by type
        style: form
        explode: true
        schema:
          type: string
          default: ap
      - name: name
        in: query
        description: Filter results by name
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/config_device'
                description: List of device configuration objects
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/config_device'
                description: List of device configuration objects
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/config_history/count:
    get:
      tags:
      - Sites Devices
      summary: countSiteDeviceConfigHistory
      description: Counts the number of entries in device config history for distinct field with given filters
      operationId: countSiteDeviceConfigHistory
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: Field used to group this count response
        style: form
        explode: true
        schema:
          type: string
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/config_history/search:
    get:
      tags:
      - Sites Devices
      summary: searchSiteDeviceConfigHistory
      description: Search for entries in device config history
      operationId: searchSiteDeviceConfigHistory
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: type
        in: query
        description: 'Filter results by type. enum: `ap`, `gateway`, `switch`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/device_type_default_ap'
          - description: 'Filter results by type. enum: `ap`, `gateway`, `switch`'
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_config_history_search'
                - description: Paginated device config history search response
                  examples:
                  - end: 1531862583
                    limit: 10
                    results:
                    - channel_24: 11
                      channel_5: 100
                      radio_macs:
                      - 5c5b352e000a
                      - 5c5b352e000b
                      - 5c5b352e000c
                      radios:
                      - band: '24'
                        channel: 11
                      - band: '5'
                        channel: 100
                      secpolicy_violated: false
                      ssids:
                      - test24
                      - test5
                      ssids_24:
                      - test24
                      ssids_5:
                      - test5
                      timestamp: 1531855856.643369
                      version: apfw-0.2.14754-cersei-75c8
                      wlans:
                      - auth: psk
                        bands:
                        - '24'
                        id: be22bba7-8e22-e1cf-5185-b880816fe2cf
                        ssid: test24
                        vlan_ids:
                        - '1'
                      - auth: psk
                        bands:
                        - '5'
                        id: f8c18724-4118-3487-811a-f98964988604
                        ssid: test5
                        vlan_ids:
                        - '1'
                    start: 1531776183
                    total: 1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1531862583
                    limit: 10
                    results:
                    - channel_24: 11
                      channel_5: 100
                      radio_macs:
                      - 5c5b352e000a
                      - 5c5b352e000b
                      - 5c5b352e000c
                      radios:
                      - band: '24'
                        channel: 11
                      - band: '5'
                        channel: 100
                      secpolicy_violated: false
                      ssids:
                      - test24
                      - test5
                      ssids_24:
                      - test24
                      ssids_5:
                      - test5
                      timestamp: 1531855856.643369
                      version: apfw-0.2.14754-cersei-75c8
                      wlans:
                      - auth: psk
                        bands:
                        - '24'
                        id: be22bba7-8e22-e1cf-5185-b880816fe2cf
                        ssid: test24
                        vlan_ids:
                        - '1'
                      - auth: psk
                        bands:
                        - '5'
                        id: f8c18724-4118-3487-811a-f98964988604
                        ssid: test5
                        vlan_ids:
                        - '1'
                    start: 1531776183
                    total: 1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_config_history_search'
                - description: Paginated device config history search response
                  examples:
                  - end: 1531862583
                    limit: 10
                    results:
                    - channel_24: 11
                      channel_5: 100
                      radio_macs:
                      - 5c5b352e000a
                      - 5c5b352e000b
                      - 5c5b352e000c
                      radios:
                      - band: '24'
                        channel: 11
                      - band: '5'
                        channel: 100
                      secpolicy_violated: false
                      ssids:
                      - test24
                      - test5
                      ssids_24:
                      - test24
                      ssids_5:
                      - test5
                      timestamp: 1531855856.643369
                      version: apfw-0.2.14754-cersei-75c8
                      wlans:
                      - auth: psk
                        bands:
                        - '24'
                        id: be22bba7-8e22-e1cf-5185-b880816fe2cf
                        ssid: test24
                        vlan_ids:
                        - '1'
                      - auth: psk
                        bands:
                        - '5'
                        id: f8c18724-4118-3487-811a-f98964988604
                        ssid: test5
                        vlan_ids:
                        - '1'
                    start: 1531776183
                    total: 1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1531862583
                    limit: 10
                    results:
                    - channel_24: 11
                      channel_5: 100
                      radio_macs:
                      - 5c5b352e000a
                      - 5c5b352e000b
                      - 5c5b352e000c
                      radios:
                      - band: '24'
                        channel: 11
                      - band: '5'
                        channel: 100
                      secpolicy_violated: false
                      ssids:
                      - test24
                      - test5
                      ssids_24:
                      - test24
                      ssids_5:
                      - test5
                      timestamp: 1531855856.643369
                      version: apfw-0.2.14754-cersei-75c8
                      wlans:
                      - auth: psk
                        bands:
                        - '24'
                        id: be22bba7-8e22-e1cf-5185-b880816fe2cf
                        ssid: test24
                        vlan_ids:
                        - '1'
                      - auth: psk
                        bands:
                        - '5'
                        id: f8c18724-4118-3487-811a-f98964988604
                        ssid: test5
                        vlan_ids:
                        - '1'
                    start: 1531776183
                    total: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/count:
    get:
      tags:
      - Sites Devices
      summary: countSiteDevices
      description: Count devices for a site, optionally grouped by the `distinct` field and filtered by device inventory attributes and time range. Use [Count Org Devices]($e/Orgs%20Devices/countOrgDevices) to count devices across the organization.
      operationId: countSiteDevices
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `hostname`, `lldp_mgmt_addr`, `lldp_port_id`, `lldp_system_desc`, `lldp_system_name`, `map_id`, `model`, `mxedge_id`, `mxtunnel_status`, `version`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/site_devices_count_distinct'
          - description: 'Field used to group this count response. enum: `hostname`, `lldp_mgmt_addr`, `lldp_port_id`, `lldp_system_desc`, `lldp_system_name`, `map_id`, `model`, `mxedge_id`, `mxtunnel_status`, `version`'
      - name: hostname
        in: query
        description: Filter results by hostname
        style: form
        explode: true
        schema:
          type: string
      - name: model
        in: query
        description: Filter results by device model
        style: form
        explode: true
        schema:
          type: string
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: version
        in: query
        description: Filter results by software version
        style: form
        explode: true
        schema:
          type: string
      - name: mxtunnel_status
        in: query
        description: Filter AP results by Mist Tunnel status
        style: form
        explode: true
        schema:
          type: string
      - name: mxedge_id
        in: query
        description: Filter results by Mist Edge identifier
        style: form
        explode: true
        schema:
          type: string
      - name: lldp_system_name
        in: query
        description: Filter AP results by LLDP system name
        style: form
        explode: true
        schema:
          type: string
      - name: lldp_system_desc
        in: query
        description: Filter AP results by LLDP system description
        style: form
        explode: true
        schema:
          type: string
      - name: lldp_port_id
        in: query
        description: Filter AP results by LLDP port identifier
        style: form
        explode: true
        schema:
          type: string
      - name: lldp_mgmt_addr
        in: query
        description: Filter AP results by LLDP management IP address
        style: form
        explode: true
        schema:
          type: string
      - name: map_id
        in: query
        description: Filter results by map identifier
        style: form
        explode: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/events/count:
    get:
      tags:
      - Sites Devices
      summary: countSiteDeviceEvents
      description: Count device events for a site, optionally grouped by the `distinct` field and filtered by event attributes and time range. Use [Count Org Device Events]($e/Orgs%20Devices/countOrgDeviceEvents) to count device events across the organization.
      operationId: countSiteDeviceEvents
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `mac`, `model`, `type`, `type_code`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/site_device_events_count_distinct'
          - description: 'Field used to group this count response. enum: `mac`, `model`, `type`, `type_code`'
      - name: model
        in: query
        description: Filter results by device model
        style: form
        explode: true
        schema:
          type: string
      - name: type
        in: query
        description: See [List Device Events Definitions]($e/Constants%20Events/listDeviceEventsDefinitions)
        style: form
        explode: true
        schema:
          type: string
      - name: type_code
        in: query
        description: Filter results by event type code
        style: form
        explode: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/events/search:
    get:
      tags:
      - Sites Devices
      summary: searchSiteDeviceEvents
      description: Search device events for a site with filters for MAC address, model, event type, message text, and time range. Use [Search Org Device Events]($e/Orgs%20Devices/searchOrgDeviceEvents) to search device events across the organization.
      operationId: searchSiteDeviceEvents
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: model
        in: query
        description: Filter results by device model
        style: form
        explode: true
        schema:
          type: string
      - name: text
        in: query
        description: Filter results by event message text
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Device connected
      - name: type
        in: query
        description: See [List Device Events Definitions]($e/Constants%20Events/listDeviceEventsDefinitions)
        style: form
        explode: true
        schema:
          type: string
      - name: last_by
        in: query
        description: Return last/recent event for passed in field
        style: form
        explode: true
        schema:
          type: string
          examples:
          - port_id
      - name: includes
        in: query
        description: Keyword to include events from additional indices (e.g. ext_tunnel for prisma events)
        style: form
        explode: true
        schema:
          type: string
          examples:
          - ext_tunnel
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_events_devices'
                - description: Paginated response for site device event search results
                  examples:
                  - end: 1531862583
                    limit: 2
                    next: /api/v1/sites/8aaba0aa-09cc-44bd-9709-33b98040550c/devices/events/search?ap=5c5b350e0001&end=1531855849.000&limit=2&start=1531776183.0
                    results:
                    - chassis_mac: 60c78d939c0f
                      count: 1
                      device_type: switch
                      mac: 60c78d939c0f
                      model: EX4100-48MP
                      org_id: 9777c1a0-6ef6-11e6-8bbf-02e208b2d34f
                      port_id: ge-0/0/17
                      site_id: 978c48e6-6ef6-11e6-8bbf-02e208b2d34f
                      text: ifIndex 533, ifAdminStatus up(1), ifOperStatus down(2), ifName ge-0/0/17
                      timestamp: 1764236687.435
                      type: SW_PORT_DOWN
                      version: 23.4R2-S4.11
                    - ap: 5c5b35d0077b
                      device_type: ap
                      mac: 5c5b35d0077b
                      model: AP43
                      org_id: 9777c1a0-6ef6-11e6-8bbf-02e208b2d34f
                      site_id: 46fc665e-9706-4296-8fe2-78f42f2e67e4
                      timestamp: 1764235684.467825
                      type: AP_CONFIGURED
                    start: 1531776183
                    total: 14
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1531862583
                    limit: 2
                    next: /api/v1/sites/8aaba0aa-09cc-44bd-9709-33b98040550c/devices/events/search?ap=5c5b350e0001&end=1531855849.000&limit=2&start=1531776183.0
                    results:
                    - chassis_mac: 60c78d939c0f
                      count: 1
                      device_type: switch
                      mac: 60c78d939c0f
                      model: EX4100-48MP
                      org_id: 9777c1a0-6ef6-11e6-8bbf-02e208b2d34f
                      port_id: ge-0/0/17
                      site_id: 978c48e6-6ef6-11e6-8bbf-02e208b2d34f
                      text: ifIndex 533, ifAdminStatus up(1), ifOperStatus down(2), ifName ge-0/0/17
                      timestamp: 1764236687.435
                      type: SW_PORT_DOWN
                      version: 23.4R2-S4.11
                    - ap: 5c5b35d0077b
                      device_type: ap
                      mac: 5c5b35d0077b
                      model: AP43
                      org_id: 9777c1a0-6ef6-11e6-8bbf-02e208b2d34f
                      site_id: 46fc665e-9706-4296-8fe2-78f42f2e67e4
                      timestamp: 1764235684.467825
                      type: AP_CONFIGURED
                    start: 1531776183
                    total: 14
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_events_devices'
                - description: Paginated response for site device event search results
                  examples:
                  - end: 1531862583
                    limit: 2
                    next: /api/v1/sites/8aaba0aa-09cc-44bd-9709-33b98040550c/devices/events/search?ap=5c5b350e0001&end=1531855849.000&limit=2&start=1531776183.0
                    results:
                    - chassis_mac: 60c78d939c0f
                      count: 1
                      device_type: switch
                      mac: 60c78d939c0f
                      model: EX4100-48MP
                      org_id: 9777c1a0-6ef6-11e6-8bbf-02e208b2d34f
                      port_id: ge-0/0/17
                      site_id: 978c48e6-6ef6-11e6-8bbf-02e208b2d34f
                      text: ifIndex 533, ifAdminStatus up(1), ifOperStatus down(2), ifName ge-0/0/17
                      timestamp: 1764236687.435
                      type: SW_PORT_DOWN
                      version: 23.4R2-S4.11
                    - ap: 5c5b35d0077b
                      device_type: ap
                      mac: 5c5b35d0077b
                      model: AP43
                      org_id: 9777c1a0-6ef6-11e6-8bbf-02e208b2d34f
                      site_id: 46fc665e-9706-4296-8fe2-78f42f2e67e4
                      timestamp: 1764235684.467825
                      type: AP_CONFIGURED
                    start: 1531776183
                    total: 14
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1531862583
                    limit: 2
                    next: /api/v1/sites/8aaba0aa-09cc-44bd-9709-33b98040550c/devices/events/search?ap=5c5b350e0001&end=1531855849.000&limit=2&start=1531776183.0
                    results:
                    - chassis_mac: 60c78d939c0f
                      count: 1
                      device_type: switch
                      mac: 60c78d939c0f
                      model: EX4100-48MP
                      org_id: 9777c1a0-6ef6-11e6-8bbf-02e208b2d34f
                      port_id: ge-0/0/17
                      site_id: 978c48e6-6ef6-11e6-8bbf-02e208b2d34f
                      text: ifIndex 533, ifAdminStatus up(1), ifOperStatus down(2), ifName ge-0/0/17
                      timestamp: 1764236687.435
                      type: SW_PORT_DOWN
                      version: 23.4R2-S4.11
                    - ap: 5c5b35d0077b
                      device_type: ap
                      mac: 5c5b35d0077b
                      model: AP43
                      org_id: 9777c1a0-6ef6-11e6-8bbf-02e208b2d34f
                      site_id: 46fc665e-9706-4296-8fe2-78f42f2e67e4
                      timestamp: 1764235684.467825
                      type: AP_CONFIGURED
                    start: 1531776183
                    total: 14
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/export:
    get:
      tags:
      - Sites Devices
      summary: exportSiteDevices
      description: To download the exported device information
      operationId: exportSiteDevices
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: string
                description: File
                contentEncoding: base64
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                type: string
                description: File
                contentEncoding: base64
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/gbp_tag:
    post:
      tags:
      - Sites Devices
      summary: setSiteDevicesGbpTag
      description: Set GBP Tag for multiple devices
      operationId: setSiteDevicesGbpTag
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/devices_gbp_tag'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/import:
    post:
      tags:
      - Sites Devices
      summary: importSiteDevices
      description: >-
        Import Information for Multiple Devices


        CSV format:

        ```csv

        mac,name,map_id,x,y,height,orientation,labels,band_24.power,band_24.bandwidth,band_24.channel,band_24.disabled,band_5.power,band_5.bandwidth,band_5.channel,band_5.disabled,band_6.power,band_6.bandwidth,band_6.channel,band_6.disabled

        5c5b53010101,"AP 1",845a23bf-bed9-e43c-4c86-6fa474be7ae5,30,10,2.3,45,"guest, campus, vip",1,20,0,false,0,40,0,false,17,80,0,false

        ```
      operationId: importSiteDevices
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              required:
              - file
              type: object
              properties:
                file:
                  type: string
                  description: Binary file payload to upload with this request
                  contentEncoding: base64
              contentMediaType: multipart/form-data
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/config_device'
                description: List of device configuration objects
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/config_device'
                description: List of device configuration objects
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/last_config/count:
    get:
      tags:
      - Sites Devices
      summary: countSiteDeviceLastConfig
      description: Counts the number of entries in device config history for distinct field with given filters
      operationId: countSiteDeviceLastConfig
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `mac`, `name`, `site_id`, `version`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/site_device_last_config_count_distinct'
          - description: 'Field used to group this count response. enum: `mac`, `name`, `site_id`, `version`'
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/last_config/search:
    get:
      tags:
      - Sites Devices
      summary: searchSiteDeviceLastConfigs
      description: Search last known device configuration records for a site with filters for device type, MAC address, name, software version, certificate expiry, and time range. Use [Search Org Device Last Configs]($e/Orgs%20Devices/searchOrgDeviceLastConfigs) to search last known device configuration records across the organization.
      operationId: searchSiteDeviceLastConfigs
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: cert_expiry_duration
        in: query
        description: 'Duration for expiring cert queries (format: 2d/3h/172800 seconds)'
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 2d
      - name: device_type
        in: query
        description: 'Filter results by device type. enum: `ap`, `gateway`, `switch`, `mxedge`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/last_config_device_type'
          - description: 'Filter results by device type. enum: `ap`, `gateway`, `switch`, `mxedge`'
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: version
        in: query
        description: Filter results by software version
        style: form
        explode: true
        schema:
          type: string
      - name: name
        in: query
        description: Filter results by name
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_config_history_search'
                - description: Paginated device config history search response
                  examples:
                  - end: 1531862583
                    limit: 10
                    results:
                    - channel_24: 11
                      channel_5: 100
                      radio_macs:
                      - 5c5b352e000a
                      - 5c5b352e000b
                      - 5c5b352e000c
                      radios:
                      - band: '24'
                        channel: 11
                      - band: '5'
                        channel: 100
                      secpolicy_violated: false
                      ssids:
                      - test24
                      - test5
                      ssids_24:
                      - test24
                      ssids_5:
                      - test5
                      timestamp: 1531855856.643369
                      version: apfw-0.2.14754-cersei-75c8
                      wlans:
                      - auth: psk
                        bands:
                        - '24'
                        id: be22bba7-8e22-e1cf-5185-b880816fe2cf
                        ssid: test24
                        vlan_ids:
                        - '1'
                      - auth: psk
                        bands:
                        - '5'
                        id: f8c18724-4118-3487-811a-f98964988604
                        ssid: test5
                        vlan_ids:
                        - '1'
                    start: 1531776183
                    total: 1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1531862583
                    limit: 10
                    results:
                    - channel_24: 11
                      channel_5: 100
                      radio_macs:
                      - 5c5b352e000a
                      - 5c5b352e000b
                      - 5c5b352e000c
                      radios:
                      - band: '24'
                        channel: 11
                      - band: '5'
                        channel: 100
                      secpolicy_violated: false
                      ssids:
                      - test24
                      - test5
                      ssids_24:
                      - test24
                      ssids_5:
                      - test5
                      timestamp: 1531855856.643369
                      version: apfw-0.2.14754-cersei-75c8
                      wlans:
                      - auth: psk
                        bands:
                        - '24'
                        id: be22bba7-8e22-e1cf-5185-b880816fe2cf
                        ssid: test24
                        vlan_ids:
                        - '1'
                      - auth: psk
                        bands:
                        - '5'
                        id: f8c18724-4118-3487-811a-f98964988604
                        ssid: test5
                        vlan_ids:
                        - '1'
                    start: 1531776183
                    total: 1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_config_history_search'
                - description: Paginated device config history search response
                  examples:
                  - end: 1531862583
                    limit: 10
                    results:
                    - channel_24: 11
                      channel_5: 100
                      radio_macs:
                      - 5c5b352e000a
                      - 5c5b352e000b
                      - 5c5b352e000c
                      radios:
                      - band: '24'
                        channel: 11
                      - band: '5'
                        channel: 100
                      secpolicy_violated: false
                      ssids:
                      - test24
                      - test5
                      ssids_24:
                      - test24
                      ssids_5:
                      - test5
                      timestamp: 1531855856.643369
                      version: apfw-0.2.14754-cersei-75c8
                      wlans:
                      - auth: psk
                        bands:
                        - '24'
                        id: be22bba7-8e22-e1cf-5185-b880816fe2cf
                        ssid: test24
                        vlan_ids:
                        - '1'
                      - auth: psk
                        bands:
                        - '5'
                        id: f8c18724-4118-3487-811a-f98964988604
                        ssid: test5
                        vlan_ids:
                        - '1'
                    start: 1531776183
                    total: 1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1531862583
                    limit: 10
                    results:
                    - channel_24: 11
                      channel_5: 100
                      radio_macs:
                      - 5c5b352e000a
                      - 5c5b352e000b
                      - 5c5b352e000c
                      radios:
                      - band: '24'
                        channel: 11
                      - band: '5'
                        channel: 100
                      secpolicy_violated: false
                      ssids:
                      - test24
                      - test5
                      ssids_24:
                      - test24
                      ssids_5:
                      - test5
                      timestamp: 1531855856.643369
                      version: apfw-0.2.14754-cersei-75c8
                      wlans:
                      - auth: psk
                        bands:
                        - '24'
                        id: be22bba7-8e22-e1cf-5185-b880816fe2cf
                        ssid: test24
                        vlan_ids:
                        - '1'
                      - auth: psk
                        bands:
                        - '5'
                        id: f8c18724-4118-3487-811a-f98964988604
                        ssid: test5
                        vlan_ids:
                        - '1'
                    start: 1531776183
                    total: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/search:
    get:
      tags:
      - Sites Devices
      summary: searchSiteDevices
      description: Search devices in a site with filters for device type, identifiers, model, software version, radio settings, LLDP details, and other inventory attributes. Use [Search Org Devices]($e/Orgs%20Devices/searchOrgDevices) to search devices across the organization.
      operationId: searchSiteDevices
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: band_24_channel
        in: query
        description: When `type`==`ap`, Channel of band_24
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: band_5_channel
        in: query
        description: When `type`==`ap`, Channel of band_5
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: band_6_channel
        in: query
        description: When `type`==`ap`, Channel of band_6
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: band_24_bandwidth
        in: query
        description: When `type`==`ap`, Bandwidth of band_24
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: band_5_bandwidth
        in: query
        description: When `type`==`ap`, Bandwidth of band_5
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: band_6_bandwidth
        in: query
        description: When `type`==`ap`, Bandwidth of band_6
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: band_24_power
        in: query
        description: When `type`==`ap`, Power of band_24
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: band_5_power
        in: query
        description: When `type`==`ap`, Power of band_5
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: band_6_power
        in: query
        description: When `type`==`ap`, Power of band_6
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: clustered
        in: query
        description: When `type`==`gateway`, true / false
        style: form
        explode: true
        schema:
          type: boolean
      - name: eth0_port_speed
        in: query
        description: When `type`==`ap`, Port speed of eth0
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
          examples:
          - '100'
          - '1000'
        examples:
          Untitled Example1:
            value: 100
          Untitled Example2:
            value: 1000
      - name: evpntopo_id
        in: query
        description: When `type`==`switch`, EVPN topology id
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: uuid
      - name: ext_ip
        in: query
        description: Partial / full Device external ip. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `1.2.3.*` and `*.2.3.*` match `1.2.3.4`). Suffix-only wildcards (e.g. `*.2.3.4`) are not supported
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 1.2.3.4
          - 1.2.3.*
          - '*2.3.*'
        examples:
          Untitled Example1:
            value: 1.2.3.4
          Untitled Example2:
            value: 1.2.3.*
          Untitled Example3:
            value: '*2.3.*'
      - name: hostname
        in: query
        description: Partial / full Device hostname. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `my-london*` and `*london*` match `my-london-1`). Suffix-only wildcards (e.g. `*london-1`) are not supported
        style: form
        explode: true
        schema:
          type: string
          examples:
          - my-london-1
          - my-london*
          - '*london*'
        examples:
          Untitled Example1:
            value: my-london-1
          Untitled Example2:
            value: my-london*
          Untitled Example3:
            value: '*london*'
      - name: ip
        in: query
        description: Partial / full Device IP address. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `10.100.10.*` and `*100.10.*` match `10.100.10.54`). Suffix-only wildcards (e.g. `*.54`) are not supported
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 10.100.10.54
          - 10.100.10.*
          - '*100.10.*'
        examples:
          Untitled Example1:
            value: 10.100.10.54
          Untitled Example2:
            value: 10.100.10.*
          Untitled Example3:
            value: '*100.10.*'
      - name: last_config_status
        in: query
        description: When `type`==`switch` or `type`==`gateway`, last configuration status
        style: form
        explode: true
        schema:
          type: string
          examples:
          - success
      - name: last_hostname
        in: query
        description: Last hostname of the device.
        style: form
        explode: true
        schema:
          type: string
      - name: lldp_mgmt_addr
        in: query
        description: When `type`==`ap`, LLDP management IP address
        style: form
        explode: true
        schema:
          type: string
      - name: lldp_port_id
        in: query
        description: When `type`==`ap`, LLDP port id. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `ge-0/0/*` and `*-0/0/*` match `ge-0/0/30`). Suffix-only wildcards (e.g. `*switch-01`) are not supported
        style: form
        explode: true
        schema:
          type: string
      - name: lldp_system_desc
        in: query
        description: When `type`==`ap`, LLDP system description. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `Juniper Networks*` and `*Networks*` match `Juniper Networks, Inc.`). Suffix-only wildcards (e.g. `*switch-01`) are not supported
        style: form
        explode: true
        schema:
          type: string
      - name: lldp_system_name
        in: query
        description: When `type`==`ap`, LLDP system name. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `my-switch*` and `*switch*` match `my-switch-01`). Suffix-only wildcards (e.g. `*switch-01`) are not supported
        style: form
        explode: true
        schema:
          type: string
      - name: mac
        in: query
        description: Partial / full Device MAC address. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `001122*` and `*1122*` match `001122334455`). Suffix-only wildcards (e.g. `*4455`) are not supported
        style: form
        explode: true
        schema:
          type: string
          examples:
          - aabbccddeeff
          - aabbcc*
          - '*bbcc*'
        examples:
          Untitled Example1:
            value: aabbccddeeff
          Untitled Example2:
            value: aabbcc*
          Untitled Example3:
            value: '*bbcc*'
      - name: model
        in: query
        description: Partial / full Device model. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `AP4*` and `*P4*` match `AP43`). Suffix-only wildcards (e.g. `*43`) are not supported
        style: form
        explode: true
        schema:
          type: string
          examples:
          - AP43
          - AP4*
          - '*P4*'
        examples:
          Untitled Example1:
            value: AP43
          Untitled Example2:
            value: AP4*
          Untitled Example3:
            value: '*P4*'
      - name: mxedge_id
        in: query
        description: When `type`==`ap`, Mist Edge id, if AP is connecting to a Mist Edge
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: uuid
      - name: mxedge_ids
        in: query
        description: When `type`==`ap`, Comma separated list of Mist Edge id, if AP is connecting to a Mist Edge
        style: form
        explode: true
        schema:
          type: string
      - name: mxtunnel_status
        in: query
        description: 'When `type`==`ap`, Mist Tunnel status used to filter results. enum: `down`, `up`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/search_site_devices_mxtunnel_status'
          - description: 'When `type`==`ap`, Mist Tunnel status used to filter results. enum: `down`, `up`'
      - name: node
        in: query
        description: 'When `type`==`gateway`. enum: `node0`, `node1`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/ha_cluster_node_enum'
          - description: 'When `type`==`gateway`. enum: `node0`, `node1`'
      - name: node0_mac
        in: query
        description: When `type`==`gateway`, node0 MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: node1_mac
        in: query
        description: When `type`==`gateway`, node1 MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: power_constrained
        in: query
        description: When `type`==`ap`, whether the AP is power constrained
        style: form
        explode: true
        schema:
          type: boolean
      - name: radius_stats
        in: query
        description: >-
          When `type`==`switch` or `type`==`gateway`, Key-value pairs where the key

          is the RADIUS server address and the value contains authentication statistics:
            * <server_address> (string): IP address of the RADIUS server as the key
            * `auth_accepts` (long): Number of accepted authentication requests
            * `auth_rejects` (long): Number of rejected authentication requests
            * `auth_timeouts` (long): Number of authentication timeouts
            * `auth_server_status` (string): Status of the server. Possible values: `up`, `down`, `unreachable`
        style: form
        explode: true
        schema:
          type: string
      - name: stats
        in: query
        description: Whether to return device stats
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: t128agent_version
        in: query
        description: When `type`==`gateway` (SSR only), version of 128T agent
        style: form
        explode: true
        schema:
          type: string
      - name: type
        in: query
        description: 'Device type used to filter results. enum: `ap`, `gateway`, `switch`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/device_type_default_ap'
          - description: 'Device type used to filter results. enum: `ap`, `gateway`, `switch`'
      - name: version
        in: query
        description: Filter results by software version
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: 'Field used to sort results; a leading `-` indicates descending order. enum: `mac`, `model`, `sku`, `timestamp`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/search_site_devices_sort'
          - description: 'Field used to sort results; a leading `-` indicates descending order. enum: `mac`, `model`, `sku`, `timestamp`'
      - name: desc_sort
        in: query
        description: 'Field used to sort results in descending order. enum: `mac`, `model`, `sku`, `timestamp`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/search_site_devices_desc_sort'
          - description: 'Field used to sort results in descending order. enum: `mac`, `model`, `sku`, `timestamp`'
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_device_search'
                - description: Paginated response for organization or site device search results
                  examples:
                  - '{"end":0,"limit":0,"next":"string","results":[{"hostname":["AP41-STB-3E5299-WH-2001","AP41-STB-3E5299-WH-50","AP41-STB-3E5299","5c5b353e5299"],"ip":"10.2.16.205","lldp_mgmt_addr":"10.2.10.139","lldp_port_desc":"GigabitEthernet1/0/1","lldp_port_id":"Gi1/0/1","lldp_system_desc":"Cisco IOS Software, C2960S Software (C2960S-UNIVERSALK9-M), Version 15.2(1)E1, RELEASE SOFTWARE (fc2)\nTechnical Support: https://www.cisco.com/techsupport\nCopyright (c) 1986-2013 by Cisco Systems, Inc.\nCompiled Fri 22-Nov-13 07:10 by prod_rel_team","lldp_system_name":"ME-DC-1-ACC-SW","mac":"5c5b353e5299","model":"AP41","mxedge_id":"00000000-0000-0000-1000-43a81f238391","mxtunnel_status":"down","org_id":"6748cfa6-4e12-11e6-9188-0242ac110007","power_constrained":false,"power_opmode":"","site_id":"a8178443-ecb5-461c-b854-f16627619ab3","sku":"AP41-US","timestamp":1596588619.007,"uptime":85280,"version":"0.7.20216","wlans":[{"id":"28c36fc7-dc22-4960-9d81-34087511c2e5","ssid":"Live-Demo-NAC"},{"id":"51b82e2b-f9e8-470b-a32a-cecde5501b0f","ssid":"Live-Demo"}]}],"start":0,"total":0}'
                  - '{"end":0,"limit":0,"next":"string","results":[{"clustered":true,"evpn_missing_links":false,"evpntopo_id":"","ext_ip":"250.242.0.102","hostname":["wan-teleworker","00ec77599d00","router"],"ip":"250.242.0.102","last_config_status":"success","last_hostname":"wan-teleworker","mac":"00ec77599d00","mist_configured":true,"model":"SSR120","node":"node1","node0_mac":"00ec77599d00","node1_mac":"00ec77599d01","num_members":0,"org_id":"6748cfa6-4e12-11e6-9188-0242ac110007","role":"","site_id":"a8178443-ecb5-461c-b854-f16627619ab3","t128agent_version":"3.8.0-201","time_drifted":false,"timestamp":1734001399.025,"type":"gateway","uptime":3586951,"version":"6.2.5-5.r2"}],"start":0,"total":0}'
                  - '{"end":0,"limit":0,"next":"string","results":[{"clustered":false,"evpn_missing_links":false,"evpntopo_id":"","ext_ip":"0.0.0.0","hostname":["ld-cup-idf-bbb"],"ip":"10.0.0.217","last_config_status":"success","last_hostname":"ld-cup-idf-bbb","last_trouble_code":"106","last_trouble_timestamp":1719540,"mac":"00c78d939c00","mist_configured":true,"model":"EX4100-48MP","num_members":1,"org_id":"6748cfa6-4e12-11e6-9188-0242ac110007","role":"","site_id":"a8178443-ecb5-461c-b854-f16627619ab3","time_drifted":false,"timestamp":1733998766.256,"type":"switch","uptime":19287811,"version":"22.4R3.25"}],"start":0,"total":0}'
                contentMediaType: application/json
              examples:
                Ap:
                  value:
                    end: 0
                    limit: 0
                    next: string
                    results:
                    - hostname:
                      - AP41-STB-3E5299-WH-2001
                      - AP41-STB-3E5299-WH-50
                      - AP41-STB-3E5299
                      - 5c5b353e5299
                      ip: 10.2.16.205
                      lldp_mgmt_addr: 10.2.10.139
                      lldp_port_desc: GigabitEthernet1/0/1
                      lldp_port_id: Gi1/0/1
                      lldp_system_desc: >-
                        Cisco IOS Software, C2960S Software (C2960S-UNIVERSALK9-M), Version 15.2(1)E1, RELEASE SOFTWARE (fc2)

                        Technical Support: https://www.cisco.com/techsupport

                        Copyright (c) 1986-2013 by Cisco Systems, Inc.

                        Compiled Fri 22-Nov-13 07:10 by prod_rel_team
                      lldp_system_name: ME-DC-1-ACC-SW
                      mac: 5c5b353e5299
                      model: AP41
                      mxedge_id: 00000000-0000-0000-1000-43a81f238391
                      mxtunnel_status: down
                      org_id: 6748cfa6-4e12-11e6-9188-0242ac110007
                      power_constrained: false
                      power_opmode: ''
                      site_id: a8178443-ecb5-461c-b854-f16627619ab3
                      sku: AP41-US
                      timestamp: 1596588619.007
                      uptime: 85280
                      version: 0.7.20216
                      wlans:
                      - id: 28c36fc7-dc22-4960-9d81-34087511c2e5
                        ssid: Live-Demo-NAC
                      - id: 51b82e2b-f9e8-470b-a32a-cecde5501b0f
                        ssid: Live-Demo
                    start: 0
                    total: 0
                Gateway:
                  value:
                    end: 0
                    limit: 0
                    next: string
                    results:
                    - clustered: true
                      evpn_missing_links: false
                      evpntopo_id: ''
                      ext_ip: 250.242.0.102
                      hostname:
                      - wan-teleworker
                      - 00ec77599d00
                      - router
                      ip: 250.242.0.102
                      last_config_status: success
                      last_hostname: wan-teleworker
                      mac: 00ec77599d00
                      mist_configured: true
                      model: SSR120
                      node: node1
                      node0_mac: 00ec77599d00
                      node1_mac: 00ec77599d01
                      num_members: 0
                      org_id: 6748cfa6-4e12-11e6-9188-0242ac110007
                      role: ''
                      site_id: a8178443-ecb5-461c-b854-f16627619ab3
                      t128agent_version: 3.8.0-201
                      time_drifted: false
                      timestamp: 1734001399.025
                      type: gateway
                      uptime: 3586951
                      version: 6.2.5-5.r2
                    start: 0
                    total: 0
                Switch:
                  value:
                    end: 0
                    limit: 0
                    next: string
                    results:
                    - clustered: false
                      evpn_missing_links: false
                      evpntopo_id: ''
                      ext_ip: 0.0.0.0
                      hostname:
                      - ld-cup-idf-bbb
                      ip: 10.0.0.217
                      last_config_status: success
                      last_hostname: ld-cup-idf-bbb
                      last_trouble_code: '106'
                      last_trouble_timestamp: 1719540
                      mac: 00c78d939c00
                      mist_configured: true
                      model: EX4100-48MP
                      num_members: 1
                      org_id: 6748cfa6-4e12-11e6-9188-0242ac110007
                      role: ''
                      site_id: a8178443-ecb5-461c-b854-f16627619ab3
                      time_drifted: false
                      timestamp: 1733998766.256
                      type: switch
                      uptime: 19287811
                      version: 22.4R3.25
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_device_search'
                - description: Paginated response for organization or site device search results
                  examples:
                  - '{"end":0,"limit":0,"next":"string","results":[{"hostname":["AP41-STB-3E5299-WH-2001","AP41-STB-3E5299-WH-50","AP41-STB-3E5299","5c5b353e5299"],"ip":"10.2.16.205","lldp_mgmt_addr":"10.2.10.139","lldp_port_desc":"GigabitEthernet1/0/1","lldp_port_id":"Gi1/0/1","lldp_system_desc":"Cisco IOS Software, C2960S Software (C2960S-UNIVERSALK9-M), Version 15.2(1)E1, RELEASE SOFTWARE (fc2)\nTechnical Support: https://www.cisco.com/techsupport\nCopyright (c) 1986-2013 by Cisco Systems, Inc.\nCompiled Fri 22-Nov-13 07:10 by prod_rel_team","lldp_system_name":"ME-DC-1-ACC-SW","mac":"5c5b353e5299","model":"AP41","mxedge_id":"00000000-0000-0000-1000-43a81f238391","mxtunnel_status":"down","org_id":"6748cfa6-4e12-11e6-9188-0242ac110007","power_constrained":false,"power_opmode":"","site_id":"a8178443-ecb5-461c-b854-f16627619ab3","sku":"AP41-US","timestamp":1596588619.007,"uptime":85280,"version":"0.7.20216","wlans":[{"id":"28c36fc7-dc22-4960-9d81-34087511c2e5","ssid":"Live-Demo-NAC"},{"id":"51b82e2b-f9e8-470b-a32a-cecde5501b0f","ssid":"Live-Demo"}]}],"start":0,"total":0}'
                  - '{"end":0,"limit":0,"next":"string","results":[{"clustered":true,"evpn_missing_links":false,"evpntopo_id":"","ext_ip":"250.242.0.102","hostname":["wan-teleworker","00ec77599d00","router"],"ip":"250.242.0.102","last_config_status":"success","last_hostname":"wan-teleworker","mac":"00ec77599d00","mist_configured":true,"model":"SSR120","node":"node1","node0_mac":"00ec77599d00","node1_mac":"00ec77599d01","num_members":0,"org_id":"6748cfa6-4e12-11e6-9188-0242ac110007","role":"","site_id":"a8178443-ecb5-461c-b854-f16627619ab3","t128agent_version":"3.8.0-201","time_drifted":false,"timestamp":1734001399.025,"type":"gateway","uptime":3586951,"version":"6.2.5-5.r2"}],"start":0,"total":0}'
                  - '{"end":0,"limit":0,"next":"string","results":[{"clustered":false,"evpn_missing_links":false,"evpntopo_id":"","ext_ip":"0.0.0.0","hostname":["ld-cup-idf-bbb"],"ip":"10.0.0.217","last_config_status":"success","last_hostname":"ld-cup-idf-bbb","last_trouble_code":"106","last_trouble_timestamp":1719540,"mac":"00c78d939c00","mist_configured":true,"model":"EX4100-48MP","num_members":1,"org_id":"6748cfa6-4e12-11e6-9188-0242ac110007","role":"","site_id":"a8178443-ecb5-461c-b854-f16627619ab3","time_drifted":false,"timestamp":1733998766.256,"type":"switch","uptime":19287811,"version":"22.4R3.25"}],"start":0,"total":0}'
                contentMediaType: application/vnd.api+json
              examples:
                Ap:
                  value:
                    end: 0
                    limit: 0
                    next: string
                    results:
                    - hostname:
                      - AP41-STB-3E5299-WH-2001
                      - AP41-STB-3E5299-WH-50
                      - AP41-STB-3E5299
                      - 5c5b353e5299
                      ip: 10.2.16.205
                      lldp_mgmt_addr: 10.2.10.139
                      lldp_port_desc: GigabitEthernet1/0/1
                      lldp_port_id: Gi1/0/1
                      lldp_system_desc: >-
                        Cisco IOS Software, C2960S Software (C2960S-UNIVERSALK9-M), Version 15.2(1)E1, RELEASE SOFTWARE (fc2)

                        Technical Support: https://www.cisco.com/techsupport

                        Copyright (c) 1986-2013 by Cisco Systems, Inc.

                        Compiled Fri 22-Nov-13 07:10 by prod_rel_team
                      lldp_system_name: ME-DC-1-ACC-SW
                      mac: 5c5b353e5299
                      model: AP41
                      mxedge_id: 00000000-0000-0000-1000-43a81f238391
                      mxtunnel_status: down
                      org_id: 6748cfa6-4e12-11e6-9188-0242ac110007
                      power_constrained: false
                      power_opmode: ''
                      site_id: a8178443-ecb5-461c-b854-f16627619ab3
                      sku: AP41-US
                      timestamp: 1596588619.007
                      uptime: 85280
                      version: 0.7.20216
                      wlans:
                      - id: 28c36fc7-dc22-4960-9d81-34087511c2e5
                        ssid: Live-Demo-NAC
                      - id: 51b82e2b-f9e8-470b-a32a-cecde5501b0f
                        ssid: Live-Demo
                    start: 0
                    total: 0
                Gateway:
                  value:
                    end: 0
                    limit: 0
                    next: string
                    results:
                    - clustered: true
                      evpn_missing_links: false
                      evpntopo_id: ''
                      ext_ip: 250.242.0.102
                      hostname:
                      - wan-teleworker
                      - 00ec77599d00
                      - router
                      ip: 250.242.0.102
                      last_config_status: success
                      last_hostname: wan-teleworker
                      mac: 00ec77599d00
                      mist_configured: true
                      model: SSR120
                      node: node1
                      node0_mac: 00ec77599d00
                      node1_mac: 00ec77599d01
                      num_members: 0
                      org_id: 6748cfa6-4e12-11e6-9188-0242ac110007
                      role: ''
                      site_id: a8178443-ecb5-461c-b854-f16627619ab3
                      t128agent_version: 3.8.0-201
                      time_drifted: false
                      timestamp: 1734001399.025
                      type: gateway
                      uptime: 3586951
                      version: 6.2.5-5.r2
                    start: 0
                    total: 0
                Switch:
                  value:
                    end: 0
                    limit: 0
                    next: string
                    results:
                    - clustered: false
                      evpn_missing_links: false
                      evpntopo_id: ''
                      ext_ip: 0.0.0.0
                      hostname:
                      - ld-cup-idf-bbb
                      ip: 10.0.0.217
                      last_config_status: success
                      last_hostname: ld-cup-idf-bbb
                      last_trouble_code: '106'
                      last_trouble_timestamp: 1719540
                      mac: 00c78d939c00
                      mist_configured: true
                      model: EX4100-48MP
                      num_members: 1
                      org_id: 6748cfa6-4e12-11e6-9188-0242ac110007
                      role: ''
                      site_id: a8178443-ecb5-461c-b854-f16627619ab3
                      time_drifted: false
                      timestamp: 1733998766.256
                      type: switch
                      uptime: 19287811
                      version: 22.4R3.25
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}:
    get:
      tags:
      - Sites Devices
      summary: getSiteDevice
      description: Get Device Configuration
      operationId: getSiteDevice
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mist_device'
                - description: Mist-managed device object for an AP, switch, or gateway
                  examples:
                  - aeroscout:
                      enabled: false
                      host: aero.pvt.net
                      locate_connected: true
                    airista:
                      enabled: false
                    ble_config:
                      beacon_enabled: false
                      beacon_rate: 3
                      beacon_rate_mode: custom
                      beam_disabled:
                      - 1
                      - 3
                      - 6
                      custom_ble_packet_enabled: false
                      custom_ble_packet_frame: 0x........
                      custom_ble_packet_freq_msec: 300
                      eddystone_uid_adv_power: -65
                      eddystone_uid_beams: 2-4,7
                      eddystone_uid_enabled: false
                      eddystone_uid_freq_msec: 200
                      eddystone_uid_instance: 5c5b35000001
                      eddystone_uid_namespace: 2818e3868dec25629ede
                      eddystone_url_adv_power: -65
                      eddystone_url_beams: 2-4,7
                      eddystone_url_enabled: true
                      eddystone_url_freq_msec: 1000
                      eddystone_url_url: https://www.abc.com
                      ibeacon_adv_power: -65
                      ibeacon_beams: 2-4,7
                      ibeacon_enabled: false
                      ibeacon_freq_msec: 0
                      ibeacon_major: 13
                      ibeacon_minor: 138
                      ibeacon_uuid: f3f17139-704a-f03a-2786-0400279e37c3
                      power: 6
                      power_mode: custom
                    centrak:
                      enabled: false
                    client_bridge:
                      auth:
                        psk: foryoureyesonly
                        type: psk
                      enabled: false
                      ssid: Uplink-SSID
                    created_time: 0
                    deviceprofile_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                    disable_eth1: false
                    disable_eth2: false
                    disable_eth3: false
                    disable_module: false
                    esl_config:
                      cacert: string
                      channel: 3
                      enabled: false
                      host: 1.1.1.1
                      port: 0
                      type: imagotag
                      verify_cert: true
                      vlan_id: 1
                    for_site: true
                    height: 2.75
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6008
                    image1_url: string
                    image2_url: string
                    image3_url: string
                    iot_config:
                      A1:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                      A2:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                      A3:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                      A4:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                      DI1:
                        enabled: false
                        name: string
                        pullup: internal
                      DI2:
                        enabled: false
                        name: string
                        pullup: internal
                      DO:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                    ip_config:
                      dns:
                      - 8.8.8.8
                      - 4.4.4.4
                      dns_suffix:
                      - .mist.local
                      - .mist.com
                      gateway: 10.2.1.254
                      gateway6: 2607:f8b0:4005:808::1
                      ip: 10.2.1.1
                      ip6: 2607:f8b0:4005:808::2004
                      mtu: 1500
                      netmask: 255.255.255.0
                      netmask6: /32
                      type: static
                      type6: static
                      vlan_id: 1
                    led:
                      brightness: 255
                      enabled: true
                    locked: true
                    map_id: 63eda950-c6da-11e4-a628-60f81dd250cc
                    mesh:
                      enabled: false
                      group: 1
                      role: base
                    modified_time: 0
                    name: conference room
                    notes: slightly off center
                    ntp_servers:
                    - string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    orientation: 45
                    poe_passthrough: false
                    pwr_config:
                      base: 2000
                      prefer_usb_over_wifi: false
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    type: ap
                    uplink_port_config:
                      dot1x: false
                      keep_wlans_up_if_down: false
                    usb_config:
                      cacert: string
                      channel: 3
                      enabled: true
                      host: 1.1.1.1
                      port: 0
                      type: imagotag
                      verify_cert: true
                      vlan_id: 1
                    vars:
                      RADIUS_IP1: 172.31.2.5
                      RADIUS_SECRET: 11s64632d
                    x: 53.5
                    y: 173.1
                contentMediaType: application/json
              examples:
                Ap:
                  value:
                    aeroscout:
                      enabled: false
                      host: aero.pvt.net
                      locate_connected: true
                    airista:
                      enabled: false
                    ble_config:
                      beacon_enabled: false
                      beacon_rate: 3
                      beacon_rate_mode: custom
                      beam_disabled:
                      - 1
                      - 3
                      - 6
                      custom_ble_packet_enabled: false
                      custom_ble_packet_frame: 0x........
                      custom_ble_packet_freq_msec: 300
                      eddystone_uid_adv_power: -65
                      eddystone_uid_beams: 2-4,7
                      eddystone_uid_enabled: false
                      eddystone_uid_freq_msec: 200
                      eddystone_uid_instance: 5c5b35000001
                      eddystone_uid_namespace: 2818e3868dec25629ede
                      eddystone_url_adv_power: -65
                      eddystone_url_beams: 2-4,7
                      eddystone_url_enabled: true
                      eddystone_url_freq_msec: 1000
                      eddystone_url_url: https://www.abc.com
                      ibeacon_adv_power: -65
                      ibeacon_beams: 2-4,7
                      ibeacon_enabled: false
                      ibeacon_freq_msec: 0
                      ibeacon_major: 13
                      ibeacon_minor: 138
                      ibeacon_uuid: f3f17139-704a-f03a-2786-0400279e37c3
                      power: 6
                      power_mode: custom
                    centrak:
                      enabled: false
                    client_bridge:
                      auth:
                        psk: foryoureyesonly
                        type: psk
                      enabled: false
                      ssid: Uplink-SSID
                    created_time: 0
                    deviceprofile_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                    disable_eth1: false
                    disable_eth2: false
                    disable_eth3: false
                    disable_module: false
                    esl_config:
                      cacert: string
                      channel: 3
                      enabled: false
                      host: 1.1.1.1
                      port: 0
                      type: imagotag
                      verify_cert: true
                      vlan_id: 1
                    for_site: true
                    height: 2.75
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6008
                    image1_url: string
                    image2_url: string
                    image3_url: string
                    iot_config:
                      A1:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                      A2:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                      A3:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                      A4:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                      DI1:
                        enabled: false
                        name: string
                        pullup: internal
                      DI2:
                        enabled: false
                        name: string
                        pullup: internal
                      DO:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                    ip_config:
                      dns:
                      - 8.8.8.8
                      - 4.4.4.4
                      dns_suffix:
                      - .mist.local
                      - .mist.com
                      gateway: 10.2.1.254
                      gateway6: 2607:f8b0:4005:808::1
                      ip: 10.2.1.1
                      ip6: 2607:f8b0:4005:808::2004
                      mtu: 1500
                      netmask: 255.255.255.0
                      netmask6: /32
                      type: static
                      type6: static
                      vlan_id: 1
                    led:
                      brightness: 255
                      enabled: true
                    locked: true
                    map_id: 63eda950-c6da-11e4-a628-60f81dd250cc
                    mesh:
                      enabled: false
                      group: 1
                      role: base
                    modified_time: 0
                    name: conference room
                    notes: slightly off center
                    ntp_servers:
                    - string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    orientation: 45
                    poe_passthrough: false
                    pwr_config:
                      base: 2000
                      prefer_usb_over_wifi: false
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    type: ap
                    uplink_port_config:
                      dot1x: false
                      keep_wlans_up_if_down: false
                    usb_config:
                      cacert: string
                      channel: 3
                      enabled: true
                      host: 1.1.1.1
                      port: 0
                      type: imagotag
                      verify_cert: true
                      vlan_id: 1
                    vars:
                      RADIUS_IP1: 172.31.2.5
                      RADIUS_SECRET: 11s64632d
                    x: 53.5
                    y: 173.1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mist_device'
                - description: Mist-managed device object for an AP, switch, or gateway
                  examples:
                  - aeroscout:
                      enabled: false
                      host: aero.pvt.net
                      locate_connected: true
                    airista:
                      enabled: false
                    ble_config:
                      beacon_enabled: false
                      beacon_rate: 3
                      beacon_rate_mode: custom
                      beam_disabled:
                      - 1
                      - 3
                      - 6
                      custom_ble_packet_enabled: false
                      custom_ble_packet_frame: 0x........
                      custom_ble_packet_freq_msec: 300
                      eddystone_uid_adv_power: -65
                      eddystone_uid_beams: 2-4,7
                      eddystone_uid_enabled: false
                      eddystone_uid_freq_msec: 200
                      eddystone_uid_instance: 5c5b35000001
                      eddystone_uid_namespace: 2818e3868dec25629ede
                      eddystone_url_adv_power: -65
                      eddystone_url_beams: 2-4,7
                      eddystone_url_enabled: true
                      eddystone_url_freq_msec: 1000
                      eddystone_url_url: https://www.abc.com
                      ibeacon_adv_power: -65
                      ibeacon_beams: 2-4,7
                      ibeacon_enabled: false
                      ibeacon_freq_msec: 0
                      ibeacon_major: 13
                      ibeacon_minor: 138
                      ibeacon_uuid: f3f17139-704a-f03a-2786-0400279e37c3
                      power: 6
                      power_mode: custom
                    centrak:
                      enabled: false
                    client_bridge:
                      auth:
                        psk: foryoureyesonly
                        type: psk
                      enabled: false
                      ssid: Uplink-SSID
                    created_time: 0
                    deviceprofile_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                    disable_eth1: false
                    disable_eth2: false
                    disable_eth3: false
                    disable_module: false
                    esl_config:
                      cacert: string
                      channel: 3
                      enabled: false
                      host: 1.1.1.1
                      port: 0
                      type: imagotag
                      verify_cert: true
                      vlan_id: 1
                    for_site: true
                    height: 2.75
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6008
                    image1_url: string
                    image2_url: string
                    image3_url: string
                    iot_config:
                      A1:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                      A2:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                      A3:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                      A4:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                      DI1:
                        enabled: false
                        name: string
                        pullup: internal
                      DI2:
                        enabled: false
                        name: string
                        pullup: internal
                      DO:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                    ip_config:
                      dns:
                      - 8.8.8.8
                      - 4.4.4.4
                      dns_suffix:
                      - .mist.local
                      - .mist.com
                      gateway: 10.2.1.254
                      gateway6: 2607:f8b0:4005:808::1
                      ip: 10.2.1.1
                      ip6: 2607:f8b0:4005:808::2004
                      mtu: 1500
                      netmask: 255.255.255.0
                      netmask6: /32
                      type: static
                      type6: static
                      vlan_id: 1
                    led:
                      brightness: 255
                      enabled: true
                    locked: true
                    map_id: 63eda950-c6da-11e4-a628-60f81dd250cc
                    mesh:
                      enabled: false
                      group: 1
                      role: base
                    modified_time: 0
                    name: conference room
                    notes: slightly off center
                    ntp_servers:
                    - string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    orientation: 45
                    poe_passthrough: false
                    pwr_config:
                      base: 2000
                      prefer_usb_over_wifi: false
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    type: ap
                    uplink_port_config:
                      dot1x: false
                      keep_wlans_up_if_down: false
                    usb_config:
                      cacert: string
                      channel: 3
                      enabled: true
                      host: 1.1.1.1
                      port: 0
                      type: imagotag
                      verify_cert: true
                      vlan_id: 1
                    vars:
                      RADIUS_IP1: 172.31.2.5
                      RADIUS_SECRET: 11s64632d
                    x: 53.5
                    y: 173.1
                contentMediaType: application/vnd.api+json
              examples:
                Ap:
                  value:
                    aeroscout:
                      enabled: false
                      host: aero.pvt.net
                      locate_connected: true
                    airista:
                      enabled: false
                    ble_config:
                      beacon_enabled: false
                      beacon_rate: 3
                      beacon_rate_mode: custom
                      beam_disabled:
                      - 1
                      - 3
                      - 6
                      custom_ble_packet_enabled: false
                      custom_ble_packet_frame: 0x........
                      custom_ble_packet_freq_msec: 300
                      eddystone_uid_adv_power: -65
                      eddystone_uid_beams: 2-4,7
                      eddystone_uid_enabled: false
                      eddystone_uid_freq_msec: 200
                      eddystone_uid_instance: 5c5b35000001
                      eddystone_uid_namespace: 2818e3868dec25629ede
                      eddystone_url_adv_power: -65
                      eddystone_url_beams: 2-4,7
                      eddystone_url_enabled: true
                      eddystone_url_freq_msec: 1000
                      eddystone_url_url: https://www.abc.com
                      ibeacon_adv_power: -65
                      ibeacon_beams: 2-4,7
                      ibeacon_enabled: false
                      ibeacon_freq_msec: 0
                      ibeacon_major: 13
                      ibeacon_minor: 138
                      ibeacon_uuid: f3f17139-704a-f03a-2786-0400279e37c3
                      power: 6
                      power_mode: custom
                    centrak:
                      enabled: false
                    client_bridge:
                      auth:
                        psk: foryoureyesonly
                        type: psk
                      enabled: false
                      ssid: Uplink-SSID
                    created_time: 0
                    deviceprofile_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                    disable_eth1: false
                    disable_eth2: false
                    disable_eth3: false
                    disable_module: false
                    esl_config:
                      cacert: string
                      channel: 3
                      enabled: false
                      host: 1.1.1.1
                      port: 0
                      type: imagotag
                      verify_cert: true
                      vlan_id: 1
                    for_site: true
                    height: 2.75
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6008
                    image1_url: string
                    image2_url: string
                    image3_url: string
                    iot_config:
                      A1:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                      A2:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                      A3:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                      A4:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                      DI1:
                        enabled: false
                        name: string
                        pullup: internal
                      DI2:
                        enabled: false
                        name: string
                        pullup: internal
                      DO:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                    ip_config:
                      dns:
                      - 8.8.8.8
                      - 4.4.4.4
                      dns_suffix:
                      - .mist.local
                      - .mist.com
                      gateway: 10.2.1.254
                      gateway6: 2607:f8b0:4005:808::1
                      ip: 10.2.1.1
                      ip6: 2607:f8b0:4005:808::2004
                      mtu: 1500
                      netmask: 255.255.255.0
                      netmask6: /32
                      type: static
                      type6: static
                      vlan_id: 1
                    led:
                      brightness: 255
                      enabled: true
                    locked: true
                    map_id: 63eda950-c6da-11e4-a628-60f81dd250cc
                    mesh:
                      enabled: false
                      group: 1
                      role: base
                    modified_time: 0
                    name: conference room
                    notes: slightly off center
                    ntp_servers:
                    - string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    orientation: 45
                    poe_passthrough: false
                    pwr_config:
                      base: 2000
                      prefer_usb_over_wifi: false
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    type: ap
                    uplink_port_config:
                      dot1x: false
                      keep_wlans_up_if_down: false
                    usb_config:
                      cacert: string
                      channel: 3
                      enabled: true
                      host: 1.1.1.1
                      port: 0
                      type: imagotag
                      verify_cert: true
                      vlan_id: 1
                    vars:
                      RADIUS_IP1: 172.31.2.5
                      RADIUS_SECRET: 11s64632d
                    x: 53.5
                    y: 173.1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Sites Devices
      summary: updateSiteDevice
      description: Update Device Configuration
      operationId: updateSiteDevice
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/mist_device'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mist_device'
                - description: Mist-managed device object for an AP, switch, or gateway
                  examples:
                  - aeroscout:
                      enabled: false
                      host: aero.pvt.net
                      locate_connected: true
                    airista:
                      enabled: false
                    ble_config:
                      beacon_enabled: false
                      beacon_rate: 3
                      beacon_rate_mode: custom
                      beam_disabled:
                      - 1
                      - 3
                      - 6
                      custom_ble_packet_enabled: false
                      custom_ble_packet_frame: 0x........
                      custom_ble_packet_freq_msec: 300
                      eddystone_uid_adv_power: -65
                      eddystone_uid_beams: 2-4,7
                      eddystone_uid_enabled: false
                      eddystone_uid_freq_msec: 200
                      eddystone_uid_instance: 5c5b35000001
                      eddystone_uid_namespace: 2818e3868dec25629ede
                      eddystone_url_adv_power: -65
                      eddystone_url_beams: 2-4,7
                      eddystone_url_enabled: true
                      eddystone_url_freq_msec: 1000
                      eddystone_url_url: https://www.abc.com
                      ibeacon_adv_power: -65
                      ibeacon_beams: 2-4,7
                      ibeacon_enabled: false
                      ibeacon_freq_msec: 0
                      ibeacon_major: 13
                      ibeacon_minor: 138
                      ibeacon_uuid: f3f17139-704a-f03a-2786-0400279e37c3
                      power: 6
                      power_mode: custom
                    centrak:
                      enabled: false
                    client_bridge:
                      auth:
                        psk: foryoureyesonly
                        type: psk
                      enabled: false
                      ssid: Uplink-SSID
                    created_time: 0
                    deviceprofile_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                    disable_eth1: false
                    disable_eth2: false
                    disable_eth3: false
                    disable_module: false
                    esl_config:
                      cacert: string
                      channel: 3
                      enabled: false
                      host: 1.1.1.1
                      port: 0
                      type: imagotag
                      verify_cert: true
                      vlan_id: 1
                    for_site: true
                    height: 2.75
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6008
                    image1_url: string
                    image2_url: string
                    image3_url: string
                    iot_config:
                      A1:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                      A2:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                      A3:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                      A4:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                      DI1:
                        enabled: false
                        name: string
                        pullup: internal
                      DI2:
                        enabled: false
                        name: string
                        pullup: internal
                      DO:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                    ip_config:
                      dns:
                      - 8.8.8.8
                      - 4.4.4.4
                      dns_suffix:
                      - .mist.local
                      - .mist.com
                      gateway: 10.2.1.254
                      gateway6: 2607:f8b0:4005:808::1
                      ip: 10.2.1.1
                      ip6: 2607:f8b0:4005:808::2004
                      mtu: 1500
                      netmask: 255.255.255.0
                      netmask6: /32
                      type: static
                      type6: static
                      vlan_id: 1
                    led:
                      brightness: 255
                      enabled: true
                    locked: true
                    map_id: 63eda950-c6da-11e4-a628-60f81dd250cc
                    mesh:
                      enabled: false
                      group: 1
                      role: base
                    modified_time: 0
                    name: conference room
                    notes: slightly off center
                    ntp_servers:
                    - string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    orientation: 45
                    poe_passthrough: false
                    pwr_config:
                      base: 2000
                      prefer_usb_over_wifi: false
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    type: ap
                    uplink_port_config:
                      dot1x: false
                      keep_wlans_up_if_down: false
                    usb_config:
                      cacert: string
                      channel: 3
                      enabled: true
                      host: 1.1.1.1
                      port: 0
                      type: imagotag
                      verify_cert: true
                      vlan_id: 1
                    vars:
                      RADIUS_IP1: 172.31.2.5
                      RADIUS_SECRET: 11s64632d
                    x: 53.5
                    y: 173.1
                contentMediaType: application/json
              examples:
                Ap:
                  value:
                    aeroscout:
                      enabled: false
                      host: aero.pvt.net
                      locate_connected: true
                    airista:
                      enabled: false
                    ble_config:
                      beacon_enabled: false
                      beacon_rate: 3
                      beacon_rate_mode: custom
                      beam_disabled:
                      - 1
                      - 3
                      - 6
                      custom_ble_packet_enabled: false
                      custom_ble_packet_frame: 0x........
                      custom_ble_packet_freq_msec: 300
                      eddystone_uid_adv_power: -65
                      eddystone_uid_beams: 2-4,7
                      eddystone_uid_enabled: false
                      eddystone_uid_freq_msec: 200
                      eddystone_uid_instance: 5c5b35000001
                      eddystone_uid_namespace: 2818e3868dec25629ede
                      eddystone_url_adv_power: -65
                      eddystone_url_beams: 2-4,7
                      eddystone_url_enabled: true
                      eddystone_url_freq_msec: 1000
                      eddystone_url_url: https://www.abc.com
                      ibeacon_adv_power: -65
                      ibeacon_beams: 2-4,7
                      ibeacon_enabled: false
                      ibeacon_freq_msec: 0
                      ibeacon_major: 13
                      ibeacon_minor: 138
                      ibeacon_uuid: f3f17139-704a-f03a-2786-0400279e37c3
                      power: 6
                      power_mode: custom
                    centrak:
                      enabled: false
                    client_bridge:
                      auth:
                        psk: foryoureyesonly
                        type: psk
                      enabled: false
                      ssid: Uplink-SSID
                    created_time: 0
                    deviceprofile_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                    disable_eth1: false
                    disable_eth2: false
                    disable_eth3: false
                    disable_module: false
                    esl_config:
                      cacert: string
                      channel: 3
                      enabled: false
                      host: 1.1.1.1
                      port: 0
                      type: imagotag
                      verify_cert: true
                      vlan_id: 1
                    for_site: true
                    height: 2.75
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6008
                    image1_url: string
                    image2_url: string
                    image3_url: string
                    iot_config:
                      A1:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                      A2:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                      A3:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                      A4:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                      DI1:
                        enabled: false
                        name: string
                        pullup: internal
                      DI2:
                        enabled: false
                        name: string
                        pullup: internal
                      DO:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                    ip_config:
                      dns:
                      - 8.8.8.8
                      - 4.4.4.4
                      dns_suffix:
                      - .mist.local
                      - .mist.com
                      gateway: 10.2.1.254
                      gateway6: 2607:f8b0:4005:808::1
                      ip: 10.2.1.1
                      ip6: 2607:f8b0:4005:808::2004
                      mtu: 1500
                      netmask: 255.255.255.0
                      netmask6: /32
                      type: static
                      type6: static
                      vlan_id: 1
                    led:
                      brightness: 255
                      enabled: true
                    locked: true
                    map_id: 63eda950-c6da-11e4-a628-60f81dd250cc
                    mesh:
                      enabled: false
                      group: 1
                      role: base
                    modified_time: 0
                    name: conference room
                    notes: slightly off center
                    ntp_servers:
                    - string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    orientation: 45
                    poe_passthrough: false
                    pwr_config:
                      base: 2000
                      prefer_usb_over_wifi: false
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    type: ap
                    uplink_port_config:
                      dot1x: false
                      keep_wlans_up_if_down: false
                    usb_config:
                      cacert: string
                      channel: 3
                      enabled: true
                      host: 1.1.1.1
                      port: 0
                      type: imagotag
                      verify_cert: true
                      vlan_id: 1
                    vars:
                      RADIUS_IP1: 172.31.2.5
                      RADIUS_SECRET: 11s64632d
                    x: 53.5
                    y: 173.1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mist_device'
                - description: Mist-managed device object for an AP, switch, or gateway
                  examples:
                  - aeroscout:
                      enabled: false
                      host: aero.pvt.net
                      locate_connected: true
                    airista:
                      enabled: false
                    ble_config:
                      beacon_enabled: false
                      beacon_rate: 3
                      beacon_rate_mode: custom
                      beam_disabled:
                      - 1
                      - 3
                      - 6
                      custom_ble_packet_enabled: false
                      custom_ble_packet_frame: 0x........
                      custom_ble_packet_freq_msec: 300
                      eddystone_uid_adv_power: -65
                      eddystone_uid_beams: 2-4,7
                      eddystone_uid_enabled: false
                      eddystone_uid_freq_msec: 200
                      eddystone_uid_instance: 5c5b35000001
                      eddystone_uid_namespace: 2818e3868dec25629ede
                      eddystone_url_adv_power: -65
                      eddystone_url_beams: 2-4,7
                      eddystone_url_enabled: true
                      eddystone_url_freq_msec: 1000
                      eddystone_url_url: https://www.abc.com
                      ibeacon_adv_power: -65
                      ibeacon_beams: 2-4,7
                      ibeacon_enabled: false
                      ibeacon_freq_msec: 0
                      ibeacon_major: 13
                      ibeacon_minor: 138
                      ibeacon_uuid: f3f17139-704a-f03a-2786-0400279e37c3
                      power: 6
                      power_mode: custom
                    centrak:
                      enabled: false
                    client_bridge:
                      auth:
                        psk: foryoureyesonly
                        type: psk
                      enabled: false
                      ssid: Uplink-SSID
                    created_time: 0
                    deviceprofile_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                    disable_eth1: false
                    disable_eth2: false
                    disable_eth3: false
                    disable_module: false
                    esl_config:
                      cacert: string
                      channel: 3
                      enabled: false
                      host: 1.1.1.1
                      port: 0
                      type: imagotag
                      verify_cert: true
                      vlan_id: 1
                    for_site: true
                    height: 2.75
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6008
                    image1_url: string
                    image2_url: string
                    image3_url: string
                    iot_config:
                      A1:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                      A2:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                      A3:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                      A4:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                      DI1:
                        enabled: false
                        name: string
                        pullup: internal
                      DI2:
                        enabled: false
                        name: string
                        pullup: internal
                      DO:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                    ip_config:
                      dns:
                      - 8.8.8.8
                      - 4.4.4.4
                      dns_suffix:
                      - .mist.local
                      - .mist.com
                      gateway: 10.2.1.254
                      gateway6: 2607:f8b0:4005:808::1
                      ip: 10.2.1.1
                      ip6: 2607:f8b0:4005:808::2004
                      mtu: 1500
                      netmask: 255.255.255.0
                      netmask6: /32
                      type: static
                      type6: static
                      vlan_id: 1
                    led:
                      brightness: 255
                      enabled: true
                    locked: true
                    map_id: 63eda950-c6da-11e4-a628-60f81dd250cc
                    mesh:
                      enabled: false
                      group: 1
                      role: base
                    modified_time: 0
                    name: conference room
                    notes: slightly off center
                    ntp_servers:
                    - string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    orientation: 45
                    poe_passthrough: false
                    pwr_config:
                      base: 2000
                      prefer_usb_over_wifi: false
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    type: ap
                    uplink_port_config:
                      dot1x: false
                      keep_wlans_up_if_down: false
                    usb_config:
                      cacert: string
                      channel: 3
                      enabled: true
                      host: 1.1.1.1
                      port: 0
                      type: imagotag
                      verify_cert: true
                      vlan_id: 1
                    vars:
                      RADIUS_IP1: 172.31.2.5
                      RADIUS_SECRET: 11s64632d
                    x: 53.5
                    y: 173.1
                contentMediaType: application/vnd.api+json
              examples:
                Ap:
                  value:
                    aeroscout:
                      enabled: false
                      host: aero.pvt.net
                      locate_connected: true
                    airista:
                      enabled: false
                    ble_config:
                      beacon_enabled: false
                      beacon_rate: 3
                      beacon_rate_mode: custom
                      beam_disabled:
                      - 1
                      - 3
                      - 6
                      custom_ble_packet_enabled: false
                      custom_ble_packet_frame: 0x........
                      custom_ble_packet_freq_msec: 300
                      eddystone_uid_adv_power: -65
                      eddystone_uid_beams: 2-4,7
                      eddystone_uid_enabled: false
                      eddystone_uid_freq_msec: 200
                      eddystone_uid_instance: 5c5b35000001
                      eddystone_uid_namespace: 2818e3868dec25629ede
                      eddystone_url_adv_power: -65
                      eddystone_url_beams: 2-4,7
                      eddystone_url_enabled: true
                      eddystone_url_freq_msec: 1000
                      eddystone_url_url: https://www.abc.com
                      ibeacon_adv_power: -65
                      ibeacon_beams: 2-4,7
                      ibeacon_enabled: false
                      ibeacon_freq_msec: 0
                      ibeacon_major: 13
                      ibeacon_minor: 138
                      ibeacon_uuid: f3f17139-704a-f03a-2786-0400279e37c3
                      power: 6
                      power_mode: custom
                    centrak:
                      enabled: false
                    client_bridge:
                      auth:
                        psk: foryoureyesonly
                        type: psk
                      enabled: false
                      ssid: Uplink-SSID
                    created_time: 0
                    deviceprofile_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                    disable_eth1: false
                    disable_eth2: false
                    disable_eth3: false
                    disable_module: false
                    esl_config:
                      cacert: string
                      channel: 3
                      enabled: false
                      host: 1.1.1.1
                      port: 0
                      type: imagotag
                      verify_cert: true
                      vlan_id: 1
                    for_site: true
                    height: 2.75
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6008
                    image1_url: string
                    image2_url: string
                    image3_url: string
                    iot_config:
                      A1:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                      A2:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                      A3:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                      A4:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                      DI1:
                        enabled: false
                        name: string
                        pullup: internal
                      DI2:
                        enabled: false
                        name: string
                        pullup: internal
                      DO:
                        enabled: false
                        name: motion
                        output: true
                        pullup: internal
                        value: 0
                    ip_config:
                      dns:
                      - 8.8.8.8
                      - 4.4.4.4
                      dns_suffix:
                      - .mist.local
                      - .mist.com
                      gateway: 10.2.1.254
                      gateway6: 2607:f8b0:4005:808::1
                      ip: 10.2.1.1
                      ip6: 2607:f8b0:4005:808::2004
                      mtu: 1500
                      netmask: 255.255.255.0
                      netmask6: /32
                      type: static
                      type6: static
                      vlan_id: 1
                    led:
                      brightness: 255
                      enabled: true
                    locked: true
                    map_id: 63eda950-c6da-11e4-a628-60f81dd250cc
                    mesh:
                      enabled: false
                      group: 1
                      role: base
                    modified_time: 0
                    name: conference room
                    notes: slightly off center
                    ntp_servers:
                    - string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    orientation: 45
                    poe_passthrough: false
                    pwr_config:
                      base: 2000
                      prefer_usb_over_wifi: false
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    type: ap
                    uplink_port_config:
                      dot1x: false
                      keep_wlans_up_if_down: false
                    usb_config:
                      cacert: string
                      channel: 3
                      enabled: true
                      host: 1.1.1.1
                      port: 0
                      type: imagotag
                      verify_cert: true
                      vlan_id: 1
                    vars:
                      RADIUS_IP1: 172.31.2.5
                      RADIUS_SECRET: 11s64632d
                    x: 53.5
                    y: 173.1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/image/{image_number}:
    delete:
      tags:
      - Sites Devices
      summary: deleteSiteDeviceImage
      description: Delete image from a device
      operationId: deleteSiteDeviceImage
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: image_number
        in: path
        description: ''
        required: true
        schema:
          type: integer
          contentEncoding: int32
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites Devices
      summary: addSiteDeviceImage
      description: Attach up to 3 images to a device
      operationId: addSiteDeviceImage
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: image_number
        in: path
        description: ''
        required: true
        schema:
          type: integer
          contentEncoding: int32
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              required:
              - file
              type: object
              properties:
                file:
                  type: string
                  description: Image file content uploaded as multipart form data
                  contentEncoding: base64
                json:
                  type: string
                  description: Optional JSON metadata submitted with the image upload
              contentMediaType: multipart/form-data
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/ap_channels:
    get:
      tags:
      - Sites Devices - Wireless
      summary: listSiteDeviceRadioChannels
      description: Get a list of allowed channels (per channel width)
      operationId: listSiteDeviceRadioChannels
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: country_code
        in: query
        description: Country code for the site (for AP config generation), in [two-character](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
        style: form
        explode: true
        schema:
          type: string
          examples:
          - US
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_device_radio_channels'
                - description: Country and regulatory-domain channel capabilities for AP radios
                  examples:
                  - band24_40mhz_allowed: false
                    band24_channels:
                      '20':
                      - 1
                      - 2
                      - 3
                      - 4
                      - 5
                      - 6
                      - 7
                      - 8
                      - 9
                      - 10
                      - 11
                      '40':
                      - 1
                      - 2
                      - 3
                      - 4
                      - 5
                      - 6
                      - 7
                      - 8
                      - 9
                      - 10
                      - 11
                    band24_enabled: true
                    band5_channels:
                      '20':
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      - 149
                      - 153
                      - 157
                      - 161
                      - 165
                      '40':
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      - 149
                      - 153
                      - 157
                      - 161
                      '80':
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      - 149
                      - 153
                      - 157
                      - 161
                      dfs:
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      outdoor:
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      - 149
                      - 153
                      - 157
                      - 161
                      - 165
                    band5_enabled: true
                    certified: true
                    code: 840
                    dfs_ok: true
                    key: US
                    name: United States
                    uses: US_FCC
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    band24_40mhz_allowed: false
                    band24_channels:
                      '20':
                      - 1
                      - 2
                      - 3
                      - 4
                      - 5
                      - 6
                      - 7
                      - 8
                      - 9
                      - 10
                      - 11
                      '40':
                      - 1
                      - 2
                      - 3
                      - 4
                      - 5
                      - 6
                      - 7
                      - 8
                      - 9
                      - 10
                      - 11
                    band24_enabled: true
                    band5_channels:
                      '20':
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      - 149
                      - 153
                      - 157
                      - 161
                      - 165
                      '40':
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      - 149
                      - 153
                      - 157
                      - 161
                      '80':
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      - 149
                      - 153
                      - 157
                      - 161
                      dfs:
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      outdoor:
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      - 149
                      - 153
                      - 157
                      - 161
                      - 165
                    band5_enabled: true
                    certified: true
                    code: 840
                    dfs_ok: true
                    key: US
                    name: United States
                    uses: US_FCC
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_device_radio_channels'
                - description: Country and regulatory-domain channel capabilities for AP radios
                  examples:
                  - band24_40mhz_allowed: false
                    band24_channels:
                      '20':
                      - 1
                      - 2
                      - 3
                      - 4
                      - 5
                      - 6
                      - 7
                      - 8
                      - 9
                      - 10
                      - 11
                      '40':
                      - 1
                      - 2
                      - 3
                      - 4
                      - 5
                      - 6
                      - 7
                      - 8
                      - 9
                      - 10
                      - 11
                    band24_enabled: true
                    band5_channels:
                      '20':
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      - 149
                      - 153
                      - 157
                      - 161
                      - 165
                      '40':
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      - 149
                      - 153
                      - 157
                      - 161
                      '80':
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      - 149
                      - 153
                      - 157
                      - 161
                      dfs:
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      outdoor:
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      - 149
                      - 153
                      - 157
                      - 161
                      - 165
                    band5_enabled: true
                    certified: true
                    code: 840
                    dfs_ok: true
                    key: US
                    name: United States
                    uses: US_FCC
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    band24_40mhz_allowed: false
                    band24_channels:
                      '20':
                      - 1
                      - 2
                      - 3
                      - 4
                      - 5
                      - 6
                      - 7
                      - 8
                      - 9
                      - 10
                      - 11
                      '40':
                      - 1
                      - 2
                      - 3
                      - 4
                      - 5
                      - 6
                      - 7
                      - 8
                      - 9
                      - 10
                      - 11
                    band24_enabled: true
                    band5_channels:
                      '20':
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      - 149
                      - 153
                      - 157
                      - 161
                      - 165
                      '40':
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      - 149
                      - 153
                      - 157
                      - 161
                      '80':
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      - 149
                      - 153
                      - 157
                      - 161
                      dfs:
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      outdoor:
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      - 149
                      - 153
                      - 157
                      - 161
                      - 165
                    band5_enabled: true
                    certified: true
                    code: 840
                    dfs_ok: true
                    key: US
                    name: United States
                    uses: US_FCC
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/iot:
    get:
      tags:
      - Sites Devices - Wireless
      summary: getSiteDeviceIotPort
      description: Returns the current state of each enabled IoT pin configured as an output.
      operationId: getSiteDeviceIotPort
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: integer
                  format: int32
                description: Property key is the IoT port name (e.g. "A1"), value is the output state (0 or 1).
                examples:
                - A1: 1
                  DO: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    A1: 1
                    DO: 0
            application/vnd.api+json:
              schema:
                type: object
                additionalProperties:
                  type: integer
                  format: int32
                description: Property key is the IoT port name (e.g. "A1"), value is the output state (0 or 1).
                examples:
                - A1: 1
                  DO: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    A1: 1
                    DO: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Sites Devices - Wireless
      summary: setSiteDeviceIotPort
      description: >-
        **Note**: For each IoT pin referenced:
         * The pin must be enabled using the Device `iot_config` API
         * The pin must support the output direction
      operationId: setSiteDeviceIotPort
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              type: object
              additionalProperties:
                type: integer
                format: int32
              description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: integer
                  format: int32
                description: Property key is the IoT port name (e.g. "A1"), value is the output state (0 or 1).
                examples:
                - A1: 1
                  DO: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    A1: 1
                    DO: 0
            application/vnd.api+json:
              schema:
                type: object
                additionalProperties:
                  type: integer
                  format: int32
                description: Property key is the IoT port name (e.g. "A1"), value is the output state (0 or 1).
                examples:
                - A1: 1
                  DO: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    A1: 1
                    DO: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/zigbee_event_trail:
    post:
      tags:
      - Sites Devices - Wireless
      summary: startSiteDeviceZigbeeEventTrail
      description: Start a Zigbee event trail session on an AP. Returns a `session` that the UI can use to stream results.
      operationId: startSiteDeviceZigbeeEventTrail
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zigbee_trail_response'
                - description: Response containing the session identifier for a Zigbee event or packet trail operation
                  examples:
                  - session: 7a5f7796-83ee-11e5-95c6-1258369c38a9
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    session: 7a5f7796-83ee-11e5-95c6-1258369c38a9
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zigbee_trail_response'
                - description: Response containing the session identifier for a Zigbee event or packet trail operation
                  examples:
                  - session: 7a5f7796-83ee-11e5-95c6-1258369c38a9
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    session: 7a5f7796-83ee-11e5-95c6-1258369c38a9
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/zigbee_join:
    delete:
      tags:
      - Sites Devices - Wireless
      summary: stopSiteDeviceZigbeeJoin
      description: Stop allowing new Zigbee end devices to join the network through the specified AP.
      operationId: stopSiteDeviceZigbeeJoin
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites Devices - Wireless
      summary: enableSiteDeviceZigbeeJoin
      description: >-
        Allow Zigbee end devices to join the network for a configurable duration. After the duration expires, new joins will be blocked (unless `allow_join`==`always` is configured on the device).


        #### Subscribe to Zigbee Join Events

        `WS /api-ws/v1/stream`


        ```json

        {
            "subscribe": "/sites/{site_id}/devices/{device_id}/zigbee_join"
        }

        ```

        ##### Example output from ws stream

        ```json

        {
            "event": "data",
            "channel": "/sites/4ac1dcf4-9d8b-7211-65c4-057819f0862b/devices/00000000-0000-0000-1000-5c5b350e0060/cmd",
            "data": {
                "session": "19e73828-937f-05e6-f709-e29efdb0a82b",
                "zigbee_mac": "fd05eb86c04ac04a",
                "event_type": "associated",
                "detail": {
                    "lqi": 180
                }
            }
        }

        ```
      operationId: enableSiteDeviceZigbeeJoin
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/utils_zigbee_join'
              - description: Request Body
                examples:
                - duration: 600
              contentMediaType: application/json
            examples:
              Example:
                value:
                  duration: 600
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zigbee_join_response'
                - description: Response containing the session identifier for a Zigbee join operation
                  examples:
                  - session_id: 19e73828-937f-05e6-f709-e29efdb0a82b
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    session_id: 19e73828-937f-05e6-f709-e29efdb0a82b
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zigbee_join_response'
                - description: Response containing the session identifier for a Zigbee join operation
                  examples:
                  - session_id: 19e73828-937f-05e6-f709-e29efdb0a82b
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    session_id: 19e73828-937f-05e6-f709-e29efdb0a82b
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/zigbee_kick:
    post:
      tags:
      - Sites Devices - Wireless
      summary: kickSiteDeviceZigbeeClients
      description: Kick one or more Zigbee clients from a Zigbee-enabled AP. The AP must be connected.
      operationId: kickSiteDeviceZigbeeClients
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/utils_zigbee_kick'
              - description: Request Body
                examples:
                - macs:
                  - 00177a01060cae9f
                  - 00177a01060caea1
              contentMediaType: application/json
            examples:
              Example:
                value:
                  macs:
                  - 00177a01060cae9f
                  - 00177a01060caea1
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/zigbee_packet_trail:
    post:
      tags:
      - Sites Devices - Wireless
      summary: startSiteDeviceZigbeePacketTrail
      description: Start a Zigbee packet trail session on an AP. Returns a `session` that the UI can use to stream results.
      operationId: startSiteDeviceZigbeePacketTrail
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zigbee_trail_response'
                - description: Response containing the session identifier for a Zigbee event or packet trail operation
                  examples:
                  - session: 7a5f7796-83ee-11e5-95c6-1258369c38a9
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    session: 7a5f7796-83ee-11e5-95c6-1258369c38a9
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zigbee_trail_response'
                - description: Response containing the session identifier for a Zigbee event or packet trail operation
                  examples:
                  - session: 7a5f7796-83ee-11e5-95c6-1258369c38a9
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    session: 7a5f7796-83ee-11e5-95c6-1258369c38a9
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/otherdevices:
    get:
      tags:
      - Sites Devices - Others
      summary: listSiteOtherDevices
      description: List third-party devices in a site, such as devices discovered or tracked outside the managed Mist device inventory. Use [List Org Other Devices]($e/Orgs%20Devices%20-%20Others/listOrgOtherDevices) to retrieve third-party devices across the organization.
      operationId: listSiteOtherDevices
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: vendor
        in: query
        description: Filter results by vendor
        style: form
        explode: true
        schema:
          type: string
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: serial
        in: query
        description: Filter results by device serial number
        style: form
        explode: true
        schema:
          type: string
      - name: model
        in: query
        description: Filter results by device model
        style: form
        explode: true
        schema:
          type: string
      - name: name
        in: query
        description: Filter results by name
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/device_other'
                description: List of third-party devices reported by external integrations
                examples:
                - - created_time: 1676983730
                    device_mac: '001122334455'
                    id: ae9dee49-69e7-4710-a114-5b827a777738
                    mac: 5c5b35000018
                    model: AP41
                    modified_time: 1676983730
                    name: hallway
                    org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                    serial: FXLH2015150025
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    vendor: cradlepoint
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 1676983730
                    device_mac: '001122334455'
                    id: ae9dee49-69e7-4710-a114-5b827a777738
                    mac: 5c5b35000018
                    model: AP41
                    modified_time: 1676983730
                    name: hallway
                    org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                    serial: FXLH2015150025
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    vendor: cradlepoint
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/device_other'
                description: List of third-party devices reported by external integrations
                examples:
                - - created_time: 1676983730
                    device_mac: '001122334455'
                    id: ae9dee49-69e7-4710-a114-5b827a777738
                    mac: 5c5b35000018
                    model: AP41
                    modified_time: 1676983730
                    name: hallway
                    org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                    serial: FXLH2015150025
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    vendor: cradlepoint
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 1676983730
                    device_mac: '001122334455'
                    id: ae9dee49-69e7-4710-a114-5b827a777738
                    mac: 5c5b35000018
                    model: AP41
                    modified_time: 1676983730
                    name: hallway
                    org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                    serial: FXLH2015150025
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    vendor: cradlepoint
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/otherdevices/events/count:
    get:
      tags:
      - Sites Devices - Others
      summary: countSiteOtherDeviceEvents
      description: Count third-party device events for a site, optionally grouped by the `distinct` field and filtered by event type and time range. Use [Count Org Other Device Events]($e/Orgs%20Devices%20-%20Others/countOrgOtherDeviceEvents) to count third-party device events across the organization.
      operationId: countSiteOtherDeviceEvents
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `mac`, `site_id`, `type`, `vendor`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/site_other_device_events_count_distinct'
          - description: 'Field used to group this count response. enum: `mac`, `site_id`, `type`, `vendor`'
      - name: type
        in: query
        description: See [List Device Events Definitions]($e/Constants%20Events/listOtherDeviceEventsDefinitions)
        style: form
        explode: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/otherdevices/events/search:
    get:
      tags:
      - Sites Devices - Others
      summary: searchSiteOtherDeviceEvents
      description: Search third-party device events for a site with filters for device identifiers, model, vendor, event type, and time range. Use [Search Org Other Device Events]($e/Orgs%20Devices%20-%20Others/searchOrgOtherDeviceEvents) to search third-party device events across the organization.
      operationId: searchSiteOtherDeviceEvents
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: device_mac
        in: query
        description: MAC of attached device
        style: form
        explode: true
        schema:
          type: string
      - name: vendor
        in: query
        description: Filter results by vendor
        style: form
        explode: true
        schema:
          type: string
      - name: type
        in: query
        description: See [List Device Events Definitions]($e/Constants%20Events/listOtherDeviceEventsDefinitions)
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_events_other_devices_search'
                - description: Paginated response for other-device event search results
                  examples:
                  - end: 0
                    limit: 0
                    results:
                    - device_mac: string
                      mac: 5c5b351e13b5
                      org_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862a
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      text: 'Plugged: The Internal 5GB (SIM1) has been inserted into Internal 1.'
                      timestamp: 547235620.89
                      type: CELLULAR_EDGE_MODEM_WAN_PLUGGED
                      vendor: cradlepoint
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 0
                    limit: 0
                    results:
                    - device_mac: string
                      mac: 5c5b351e13b5
                      org_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862a
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      text: 'Plugged: The Internal 5GB (SIM1) has been inserted into Internal 1.'
                      timestamp: 547235620.89
                      type: CELLULAR_EDGE_MODEM_WAN_PLUGGED
                      vendor: cradlepoint
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_events_other_devices_search'
                - description: Paginated response for other-device event search results
                  examples:
                  - end: 0
                    limit: 0
                    results:
                    - device_mac: string
                      mac: 5c5b351e13b5
                      org_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862a
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      text: 'Plugged: The Internal 5GB (SIM1) has been inserted into Internal 1.'
                      timestamp: 547235620.89
                      type: CELLULAR_EDGE_MODEM_WAN_PLUGGED
                      vendor: cradlepoint
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 0
                    limit: 0
                    results:
                    - device_mac: string
                      mac: 5c5b351e13b5
                      org_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862a
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      text: 'Plugged: The Internal 5GB (SIM1) has been inserted into Internal 1.'
                      timestamp: 547235620.89
                      type: CELLULAR_EDGE_MODEM_WAN_PLUGGED
                      vendor: cradlepoint
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/local_port_config:
    delete:
      tags:
      - Sites Devices - Wired
      summary: deleteSiteLocalSwitchPortConfig
      description: "API Calls delete all the existing port config local overrides, and reapply the configured planed at the device level \n(with site / template heritance)."
      operationId: deleteSiteLocalSwitchPortConfig
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Sites Devices - Wired
      summary: updateSiteLocalSwitchPortConfig
      description: "API Calls to add port config local overrides. This can be used by Switch Port Operators or Helpdesk administrators\nto change a Switch Port configuration without having to change the switch configuration.\n\n\nThe local overrides configured for the switchports with `no_local_overwrite`==`true` won't be applied to the switch configuration. \n\n\n> NOTE:\n>\n> When using the API Call, it is required to put send all overrides in the PUT request Payload, even the existing once. \n>\n> The current overrides can be retrieved with the API Call [Get Site Device]($e/Sites%20Devices/getSiteDevice). The local overrides will show up separately from the `port_config` in the `local_port_config` so it can be easily identified (and cleared)"
      operationId: updateSiteLocalSwitchPortConfig
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: object
              additionalProperties:
                $ref: '#/components/schemas/junos_local_port_config'
              examples:
              - ge-0/0/0-1:
                  poe_disabled: true
                  usage: iot
              contentMediaType: application/json
            examples:
              Example:
                value:
                  ge-0/0/0-1:
                    poe_disabled: true
                    usage: iot
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/set_vc_port_mode:
    post:
      tags:
      - Sites Devices - Wired - Virtual Chassis
      summary: changeSiteSwitchVcPortMode
      description: >-
        Change VCP port mode



        Some switch model allows changing VCP port behaviors, e.g. - use them as regular network ports - change vcp protocol Note, this command will reboot the switch
      operationId: changeSiteSwitchVcPortMode
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/vc_port'
              - description: Request Body
                examples:
                - mode: network
              contentMediaType: application/json
            examples:
              Example:
                value:
                  mode: network
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/vc:
    delete:
      tags:
      - Sites Devices - Wired - Virtual Chassis
      summary: deleteSiteVirtualChassis
      description: >-
        When all the member switches of VC are removed and only member ID 0 is left, the cloud would detect this situation and automatically changes the single switch to non-VC role.


        For some unexpected cases that the VC is gone and disconnected, the API below could be used to change the state of VC’s switches to be standalone. After it is executed, all the switches will be shown as standalone switches under Inventory.
      operationId: deleteSiteVirtualChassis
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Sites Devices - Wired - Virtual Chassis
      summary: getSiteDeviceVirtualChassis
      description: >-
        Get VC Status


        The API returns a combined view of the VC status which includes topology and stats_
      operationId: getSiteDeviceVirtualChassis
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_virtual_chassis_config'
                - description: Combined virtual chassis status, topology, and member statistics
                  examples:
                  - config_type: nonprovisioned
                    id: 00000000-0000-0000-1000-52d9107af289
                    mac: 52d9107af289
                    members:
                    - boot_partition: junos
                      cpld_version: '6'
                      cpu_stat:
                        idle: 69
                        interrupt: 1
                        load_avg:
                        - 0.8
                        - 1.09
                        - 1.07
                        system: 11
                        user: 19
                      fans:
                      - airflow: out
                        name: Fan Tray 0 Fan 0
                        rpm: 0
                        status: ok
                      - airflow: out
                        name: Fan Tray 1 Fan 0
                        rpm: 0
                        status: ok
                      fpc_idx: 0
                      mac: 52d9107af289
                      memory_stat:
                        usage: 42
                      model: EX2300-48P
                      pics:
                      - index: 0
                        model_number: EX2300-48P
                        port_groups:
                        - count: 48
                          type: GE
                      - index: 1
                        model_number: EX2300-48P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      poe:
                        max_power: 750
                        power_draw: 40.4
                        status: AT_MODE
                      poe_version: 2.1.1.19.3 (type1)
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.4R3-S4.18
                      serial: JW0000000000
                      temperatures:
                      - celsius: 33
                        name: CPU Sensor
                        status: ok
                      - celsius: 29
                        name: PSU Sensor
                        status: ok
                      type: fpc
                      uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800)  1.3.2
                      uptime: 27636720
                      vc_links:
                      - neighbor_module_idx: 1
                        neighbor_port_id: vcp-1/1/0
                        port_id: vcp-0/1/0
                      vc_mode: HiGiG
                      vc_role: master
                      vc_state: present
                      version: 21.4R3-S4.18
                    - boot_partition: junos
                      cpld_version: '6'
                      cpu_stat:
                        idle: 76
                        interrupt: 0
                        load_avg:
                        - 0.96
                        - 0.87
                        - 0.76
                        system: 6
                        user: 17
                      fans:
                      - airflow: out
                        name: Fan Tray 0 Fan 0
                        rpm: 0
                        status: ok
                      - airflow: out
                        name: Fan Tray 1 Fan 0
                        rpm: 0
                        status: ok
                      fpc_idx: 1
                      mac: d0dd4991652d
                      memory_stat:
                        usage: 18
                      model: EX2300-48P
                      pics:
                      - index: 0
                        model_number: EX2300-48P
                        port_groups:
                        - count: 48
                          type: GE
                      - index: 1
                        model_number: EX2300-48P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      poe:
                        max_power: 750
                        power_draw: 21.2
                        status: AT_MODE
                      poe_version: 2.1.1.19.3 (type1)
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.4R3-S4.18
                      serial: JW3619300922
                      temperatures:
                      - celsius: 32
                        name: CPU Sensor
                        status: ok
                      - celsius: 29
                        name: PSU Sensor
                        status: ok
                      type: fpc
                      uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800)  1.3.2
                      uptime: 27636720
                      vc_links:
                      - neighbor_module_idx: 0
                        neighbor_port_id: vcp-0/1/0
                        port_id: vcp-1/1/0
                      vc_mode: HiGiG
                      vc_role: backup
                      vc_state: present
                      version: 21.4R3-S4.18
                    model: EX2300-48P
                    num_routing_engines: 1
                    org_id: 1e9a61a9-bc42-42ca-bf67-1ad87443d9b8
                    serial: JW3619300157
                    site_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b
                    status: connected
                    type: switch
                    vc_mac: 52d9107af289
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    config_type: nonprovisioned
                    id: 00000000-0000-0000-1000-52d9107af289
                    mac: 52d9107af289
                    members:
                    - boot_partition: junos
                      cpld_version: '6'
                      cpu_stat:
                        idle: 69
                        interrupt: 1
                        load_avg:
                        - 0.8
                        - 1.09
                        - 1.07
                        system: 11
                        user: 19
                      fans:
                      - airflow: out
                        name: Fan Tray 0 Fan 0
                        rpm: 0
                        status: ok
                      - airflow: out
                        name: Fan Tray 1 Fan 0
                        rpm: 0
                        status: ok
                      fpc_idx: 0
                      mac: 52d9107af289
                      memory_stat:
                        usage: 42
                      model: EX2300-48P
                      pics:
                      - index: 0
                        model_number: EX2300-48P
                        port_groups:
                        - count: 48
                          type: GE
                      - index: 1
                        model_number: EX2300-48P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      poe:
                        max_power: 750
                        power_draw: 40.4
                        status: AT_MODE
                      poe_version: 2.1.1.19.3 (type1)
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.4R3-S4.18
                      serial: JW0000000000
                      temperatures:
                      - celsius: 33
                        name: CPU Sensor
                        status: ok
                      - celsius: 29
                        name: PSU Sensor
                        status: ok
                      type: fpc
                      uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800)  1.3.2
                      uptime: 27636720
                      vc_links:
                      - neighbor_module_idx: 1
                        neighbor_port_id: vcp-1/1/0
                        port_id: vcp-0/1/0
                      vc_mode: HiGiG
                      vc_role: master
                      vc_state: present
                      version: 21.4R3-S4.18
                    - boot_partition: junos
                      cpld_version: '6'
                      cpu_stat:
                        idle: 76
                        interrupt: 0
                        load_avg:
                        - 0.96
                        - 0.87
                        - 0.76
                        system: 6
                        user: 17
                      fans:
                      - airflow: out
                        name: Fan Tray 0 Fan 0
                        rpm: 0
                        status: ok
                      - airflow: out
                        name: Fan Tray 1 Fan 0
                        rpm: 0
                        status: ok
                      fpc_idx: 1
                      mac: d0dd4991652d
                      memory_stat:
                        usage: 18
                      model: EX2300-48P
                      pics:
                      - index: 0
                        model_number: EX2300-48P
                        port_groups:
                        - count: 48
                          type: GE
                      - index: 1
                        model_number: EX2300-48P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      poe:
                        max_power: 750
                        power_draw: 21.2
                        status: AT_MODE
                      poe_version: 2.1.1.19.3 (type1)
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.4R3-S4.18
                      serial: JW3619300922
                      temperatures:
                      - celsius: 32
                        name: CPU Sensor
                        status: ok
                      - celsius: 29
                        name: PSU Sensor
                        status: ok
                      type: fpc
                      uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800)  1.3.2
                      uptime: 27636720
                      vc_links:
                      - neighbor_module_idx: 0
                        neighbor_port_id: vcp-0/1/0
                        port_id: vcp-1/1/0
                      vc_mode: HiGiG
                      vc_role: backup
                      vc_state: present
                      version: 21.4R3-S4.18
                    model: EX2300-48P
                    num_routing_engines: 1
                    org_id: 1e9a61a9-bc42-42ca-bf67-1ad87443d9b8
                    serial: JW3619300157
                    site_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b
                    status: connected
                    type: switch
                    vc_mac: 52d9107af289
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_virtual_chassis_config'
                - description: Combined virtual chassis status, topology, and member statistics
                  examples:
                  - config_type: nonprovisioned
                    id: 00000000-0000-0000-1000-52d9107af289
                    mac: 52d9107af289
                    members:
                    - boot_partition: junos
                      cpld_version: '6'
                      cpu_stat:
                        idle: 69
                        interrupt: 1
                        load_avg:
                        - 0.8
                        - 1.09
                        - 1.07
                        system: 11
                        user: 19
                      fans:
                      - airflow: out
                        name: Fan Tray 0 Fan 0
                        rpm: 0
                        status: ok
                      - airflow: out
                        name: Fan Tray 1 Fan 0
                        rpm: 0
                        status: ok
                      fpc_idx: 0
                      mac: 52d9107af289
                      memory_stat:
                        usage: 42
                      model: EX2300-48P
                      pics:
                      - index: 0
                        model_number: EX2300-48P
                        port_groups:
                        - count: 48
                          type: GE
                      - index: 1
                        model_number: EX2300-48P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      poe:
                        max_power: 750
                        power_draw: 40.4
                        status: AT_MODE
                      poe_version: 2.1.1.19.3 (type1)
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.4R3-S4.18
                      serial: JW0000000000
                      temperatures:
                      - celsius: 33
                        name: CPU Sensor
                        status: ok
                      - celsius: 29
                        name: PSU Sensor
                        status: ok
                      type: fpc
                      uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800)  1.3.2
                      uptime: 27636720
                      vc_links:
                      - neighbor_module_idx: 1
                        neighbor_port_id: vcp-1/1/0
                        port_id: vcp-0/1/0
                      vc_mode: HiGiG
                      vc_role: master
                      vc_state: present
                      version: 21.4R3-S4.18
                    - boot_partition: junos
                      cpld_version: '6'
                      cpu_stat:
                        idle: 76
                        interrupt: 0
                        load_avg:
                        - 0.96
                        - 0.87
                        - 0.76
                        system: 6
                        user: 17
                      fans:
                      - airflow: out
                        name: Fan Tray 0 Fan 0
                        rpm: 0
                        status: ok
                      - airflow: out
                        name: Fan Tray 1 Fan 0
                        rpm: 0
                        status: ok
                      fpc_idx: 1
                      mac: d0dd4991652d
                      memory_stat:
                        usage: 18
                      model: EX2300-48P
                      pics:
                      - index: 0
                        model_number: EX2300-48P
                        port_groups:
                        - count: 48
                          type: GE
                      - index: 1
                        model_number: EX2300-48P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      poe:
                        max_power: 750
                        power_draw: 21.2
                        status: AT_MODE
                      poe_version: 2.1.1.19.3 (type1)
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.4R3-S4.18
                      serial: JW3619300922
                      temperatures:
                      - celsius: 32
                        name: CPU Sensor
                        status: ok
                      - celsius: 29
                        name: PSU Sensor
                        status: ok
                      type: fpc
                      uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800)  1.3.2
                      uptime: 27636720
                      vc_links:
                      - neighbor_module_idx: 0
                        neighbor_port_id: vcp-0/1/0
                        port_id: vcp-1/1/0
                      vc_mode: HiGiG
                      vc_role: backup
                      vc_state: present
                      version: 21.4R3-S4.18
                    model: EX2300-48P
                    num_routing_engines: 1
                    org_id: 1e9a61a9-bc42-42ca-bf67-1ad87443d9b8
                    serial: JW3619300157
                    site_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b
                    status: connected
                    type: switch
                    vc_mac: 52d9107af289
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    config_type: nonprovisioned
                    id: 00000000-0000-0000-1000-52d9107af289
                    mac: 52d9107af289
                    members:
                    - boot_partition: junos
                      cpld_version: '6'
                      cpu_stat:
                        idle: 69
                        interrupt: 1
                        load_avg:
                        - 0.8
                        - 1.09
                        - 1.07
                        system: 11
                        user: 19
                      fans:
                      - airflow: out
                        name: Fan Tray 0 Fan 0
                        rpm: 0
                        status: ok
                      - airflow: out
                        name: Fan Tray 1 Fan 0
                        rpm: 0
                        status: ok
                      fpc_idx: 0
                      mac: 52d9107af289
                      memory_stat:
                        usage: 42
                      model: EX2300-48P
                      pics:
                      - index: 0
                        model_number: EX2300-48P
                        port_groups:
                        - count: 48
                          type: GE
                      - index: 1
                        model_number: EX2300-48P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      poe:
                        max_power: 750
                        power_draw: 40.4
                        status: AT_MODE
                      poe_version: 2.1.1.19.3 (type1)
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.4R3-S4.18
                      serial: JW0000000000
                      temperatures:
                      - celsius: 33
                        name: CPU Sensor
                        status: ok
                      - celsius: 29
                        name: PSU Sensor
                        status: ok
                      type: fpc
                      uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800)  1.3.2
                      uptime: 27636720
                      vc_links:
                      - neighbor_module_idx: 1
                        neighbor_port_id: vcp-1/1/0
                        port_id: vcp-0/1/0
                      vc_mode: HiGiG
                      vc_role: master
                      vc_state: present
                      version: 21.4R3-S4.18
                    - boot_partition: junos
                      cpld_version: '6'
                      cpu_stat:
                        idle: 76
                        interrupt: 0
                        load_avg:
                        - 0.96
                        - 0.87
                        - 0.76
                        system: 6
                        user: 17
                      fans:
                      - airflow: out
                        name: Fan Tray 0 Fan 0
                        rpm: 0
                        status: ok
                      - airflow: out
                        name: Fan Tray 1 Fan 0
                        rpm: 0
                        status: ok
                      fpc_idx: 1
                      mac: d0dd4991652d
                      memory_stat:
                        usage: 18
                      model: EX2300-48P
                      pics:
                      - index: 0
                        model_number: EX2300-48P
                        port_groups:
                        - count: 48
                          type: GE
                      - index: 1
                        model_number: EX2300-48P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      poe:
                        max_power: 750
                        power_draw: 21.2
                        status: AT_MODE
                      poe_version: 2.1.1.19.3 (type1)
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.4R3-S4.18
                      serial: JW3619300922
                      temperatures:
                      - celsius: 32
                        name: CPU Sensor
                        status: ok
                      - celsius: 29
                        name: PSU Sensor
                        status: ok
                      type: fpc
                      uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800)  1.3.2
                      uptime: 27636720
                      vc_links:
                      - neighbor_module_idx: 0
                        neighbor_port_id: vcp-0/1/0
                        port_id: vcp-1/1/0
                      vc_mode: HiGiG
                      vc_role: backup
                      vc_state: present
                      version: 21.4R3-S4.18
                    model: EX2300-48P
                    num_routing_engines: 1
                    org_id: 1e9a61a9-bc42-42ca-bf67-1ad87443d9b8
                    serial: JW3619300157
                    site_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b
                    status: connected
                    type: switch
                    vc_mac: 52d9107af289
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites Devices - Wired - Virtual Chassis
      summary: createSiteVirtualChassis
      description: "For models (e.g. EX3400 and up) having dedicated VC ports, it is easier to form a VC by just connecting cables with the dedicated VC ports. Cloud will detect the new VC and update the inventory.  \nIn case that the user would like to choose the dedicated switch as a VC master or for EX2300-C-12P and EX2300-C-12T which doesn't have dedicated VC ports, below are procedures to automate the VC creation:\n1. Power on the switch that is chosen as the VC master first, and then powering on the other member switches.\n2. Claim or adopt all these switches under the same organization's Inventory\n3. Assign these switches into the same Site\n4. Wait for all the switches to be connected to Mist\n5. Invoke vc command on the switch chosen to be the VC master. For EX2300-C-12P, VC ports will be created automatically.\n6. Connect the cables to the VC ports for these switches\n7. Wait for the VC to be formed. The Org's inventory will be updated for the new VC."
      operationId: createSiteVirtualChassis
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/virtual_chassis_config'
              - description: Request Body
                examples:
                - '{"members":[{"mac":"aff827549235","vc_ports":["xe-0/1/0"],"vc_role":"master"},{"mac":"8396cd006c8c","vc_ports":["xe-0/1/0","xe-0/1/1"],"vc_role":"backup"},{"mac":"8396cd00888c","vc_ports":["xe-0/1/0"],"vc_role":"linecard"}]}'
                - '{"members":[{"mac":"aff827549235","member_id":0,"vc_ports":["xe-0/1/0","xe-0/1/1"],"vc_role":"master"},{"mac":"8396cd006c8c","member_id":1,"vc_ports":["xe-0/1/0","xe-0/1/1"],"vc_role":"linecard"},{"mac":"8396cd00888c","member_id":2,"vc_ports":["xe-0/1/0","xe-0/1/1"],"vc_role":"backup"}],"preprovisioned":true}'
              contentMediaType: application/json
            examples:
              create-a-VC-with-three-members:
                value:
                  members:
                  - mac: aff827549235
                    vc_ports:
                    - xe-0/1/0
                    vc_role: master
                  - mac: 8396cd006c8c
                    vc_ports:
                    - xe-0/1/0
                    - xe-0/1/1
                    vc_role: backup
                  - mac: 8396cd00888c
                    vc_ports:
                    - xe-0/1/0
                    vc_role: linecard
              create-a-pre-provisioned-VC-with-three-members:
                value:
                  members:
                  - mac: aff827549235
                    member_id: 0
                    vc_ports:
                    - xe-0/1/0
                    - xe-0/1/1
                    vc_role: master
                  - mac: 8396cd006c8c
                    member_id: 1
                    vc_ports:
                    - xe-0/1/0
                    - xe-0/1/1
                    vc_role: linecard
                  - mac: 8396cd00888c
                    member_id: 2
                    vc_ports:
                    - xe-0/1/0
                    - xe-0/1/1
                    vc_role: backup
                  preprovisioned: true
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Sites Devices - Wired - Virtual Chassis
      summary: updateSiteVirtualChassisMember
      description: "The VC creation and adding member switch API will update the device' s virtual chassis config which is applied after VC is formed to create JUNOS pre-provisioned virtual chassis configuration.\n\n**Note:** Update Device's VC config can achieve similar purpose by directly modifying current virtual_chassis config. However, it cannot fulfill requests to enabling vc_ports on new members that are yet to belong to current VC.\n\n\n## Change to use preprovisioned VC\nTo switch the VC to use preprovisioned VC, enable preprovisioned in virtual_chassis config. Both vc_role master and backup will be matched to routing-engine role in Junos preprovisioned VC config.\n\nIn this config, fpc0 has to be the same as the mac of device_id. Use renumber if you want to replace fpc0 which involves device_id change.\n\n**Notice:** to configure preprovisioned VC, every member of the VC must be in the inventory.\n\n## Add new members\nFor models (e.g. EX4300 and up) having dedicated VC ports, it is easier to add new member switches into a VC by just connecting cables with the dedicated VC ports. Cloud will detect the new members and update the inventory.\n\nFor EX2300 VC, adding new members requires to follow the procedures below:\n1. Powering on the new member switches and ensuring cables are not connected to any VC ports.\n2. Claim or adopt all new member switches under the VC's organization Inventory\n3. Assign all new member switches to the same Site as the VC\n4. Invoke vc command to add switches to the VC.\n5. Connect the cables to the VC ports for these switches\n6. After a while, the Org's Inventory shows that new switches has been added into the VC.\n\n## Removing member switch\nTo remove a member switch from the VC, following the procedures below:\n\n1. Ensuring the VC is connected to the cloud first\n2. Unplug the cable from the VC port of the switch\n3. Waiting for the VC state (vc_state) of this switch is changed to not-present\n4. Invoke update_vc with remove to remove this switch from the VC\n5. The Org's Inventory shows the switch is removed.\n\nPlease notice that member ID 0 (fpc0) cannot be removed. When a VC has two switches left, unplugging the cable may result in the situation that fpc0 becomes a line card (LC). When this situation is happening, please re-plug in the cable, wait for both switches becoming present (show virtual-chassis) and then removing the cable again.\n\n## Renumber a member switch\nWhen a member switch doesn' t work properly and needed to be replaced, the renumber API could be used. The following two types of renumber are supported:\n\n1. Replace a non-fpc0 member switch\n2. Replace fpc0. When fpc0 is replaced, PAPI device config and JUNOS config will be both updated.\n\nFor renumber to work, the following procedures are needed: \n1. Ensuring the VC is connected to the cloud and the state of the member switch to be replaced must be non present. \n2. Adding the new member switch to the VC \n3. Waiting for the VC state (vc_state) of this VC to be updated to API server \n4. Invoke vc with renumber to replace\\ the new member switch from fpc X to\n\n## Perprovision VC members\nBy specifying \"preprovision\" op, you can convert the current VC to pre-provisioned mode, update VC members as well as specify vc_ports when adding new members for device models without dedicated vc ports. Use renumber for fpc0 replacement which involves device_id change.\n\nNote: \n1. vc_ports is used for adding new members and not needed if \n  * the device model has dedicated vc ports, or \n  * no new member is added \n2. New VC members to be added should exist in the same Site as the VC"
      operationId: updateSiteVirtualChassisMember
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/virtual_chassis_update'
              - description: Request Body
                examples:
                - '{"members":[{"mac":"aff827549235","member_id":2,"vc_ports":["xe-0/1/0","xe-0/1/1"],"vc_role":"linecard"},{"mac":"8396cd00777c","member_id":3,"vc_ports":["xe-0/1/0","xe-0/1/1"],"vc_role":"linecard"}],"op":"add"}'
                - '{"members":[{"mac":"aff827549235","member_id":0,"vc_ports":["xe-0/1/0","xe-0/1/1"]},{"mac":"8396cd00777c","member_id":1,"vc_ports":["xe-0/1/0","xe-0/1/1"],"vc_role":"backup"}],"op":"preprovision"}'
                - '{"members":[{"mac":"aff827549235","member_id":0,"vc_role":"master"},{"mac":"8396cd006c8c","member_id":1,"vc_role":"linecard"}],"op":"preprovision","remove_inventory":true}'
                - '{"members":[{"member":2},{"member":3}],"op":"remove"}'
                - '{"member":3,"new-member":2,"op":"renumber"}'
              contentMediaType: application/json
            examples:
              adding-two-new-switches-as-line-cards-into-the-VC:
                value:
                  members:
                  - mac: aff827549235
                    member_id: 2
                    vc_ports:
                    - xe-0/1/0
                    - xe-0/1/1
                    vc_role: linecard
                  - mac: 8396cd00777c
                    member_id: 3
                    vc_ports:
                    - xe-0/1/0
                    - xe-0/1/1
                    vc_role: linecard
                  op: add
              convert-to-pre-provisioned-VC:
                value:
                  members:
                  - mac: aff827549235
                    member_id: 0
                    vc_ports:
                    - xe-0/1/0
                    - xe-0/1/1
                  - mac: 8396cd00777c
                    member_id: 1
                    vc_ports:
                    - xe-0/1/0
                    - xe-0/1/1
                    vc_role: backup
                  op: preprovision
              remove-preprovision-members-and-clean-up-inventory:
                value:
                  members:
                  - mac: aff827549235
                    member_id: 0
                    vc_role: master
                  - mac: 8396cd006c8c
                    member_id: 1
                    vc_role: linecard
                  op: preprovision
                  remove_inventory: true
              removing-two-switches-from-VC:
                value:
                  members:
                  - member: 2
                  - member: 3
                  op: remove
              renumber-member-ID-3-to-member-ID-2:
                value:
                  member: 3
                  new-member: 2
                  op: renumber
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/vc/convert_to_virtualmac:
    post:
      tags:
      - Sites Devices - Wired - Virtual Chassis
      summary: convertSiteVirtualChassisToVirtualMac
      description: >-
        Converts an FPC0-based VC to a Virtualmac VC, removing the limitation where the device ID must change whenever FPC0 is renumbered or removed.



        HTTP400 Error possible reasons:
          - The device is not an OC device
          - Virtualmac VC is disabled in the Org Knob settings
          - The VC is already a Virtualmac VC
          - The VC is currently disconnected
          - The device is standalone
          - A new FPC0 exists with its own device config, causing ambiguity.
      operationId: convertSiteVirtualChassisToVirtualMac
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/vc/vc_port:
    post:
      tags:
      - Sites Devices - Wired - Virtual Chassis
      summary: setSiteVcPort
      description: Set VC port
      operationId: setSiteVcPort
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/virtual_chassis_port'
              - examples:
                - '{"members":[{"member":0,"vc_ports":["xe-0/1/1"]},{"member":2,"vc_ports":["xe-0/1/1"]}],"op":"delete"}'
                - '{"members":[{"member":0,"vc_ports":["xe-0/1/1"]},{"member":2,"vc_ports":["xe-0/1/1"]}],"op":"set"}'
              contentMediaType: application/json
            examples:
              delete-VC-port-of-xe-0/1/1-of-member-0-and-member-2:
                value:
                  members:
                  - member: 0
                    vc_ports:
                    - xe-0/1/1
                  - member: 2
                    vc_ports:
                    - xe-0/1/1
                  op: delete
              set-VC-port-of-xe-0/1/1-of-member-0-and-member-2:
                value:
                  members:
                  - member: 0
                    vc_ports:
                    - xe-0/1/1
                  - member: 2
                    vc_ports:
                    - xe-0/1/1
                  op: set
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/ha:
    delete:
      tags:
      - Sites Devices - WAN Cluster
      summary: deleteSiteDeviceHaCluster
      description: Delete HA Cluster
      operationId: deleteSiteDeviceHaCluster
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Sites Devices - WAN Cluster
      summary: GetSiteDeviceHaClusterNode
      description: Delete HA Cluster
      operationId: GetSiteDeviceHaClusterNode
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Ok
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/gateway_cluster'
                - description: Gateway HA cluster request or response body
                  examples:
                  - nodes:
                    - mac: aff827549235
                    - mac: 8396cd006c8c
                contentMediaType: application/json
              examples:
                Gateway Cluster:
                  value:
                    nodes:
                    - mac: aff827549235
                    - mac: 8396cd006c8c
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/gateway_cluster'
                - description: Gateway HA cluster request or response body
                  examples:
                  - nodes:
                    - mac: aff827549235
                    - mac: 8396cd006c8c
                contentMediaType: application/vnd.api+json
              examples:
                Gateway Cluster:
                  value:
                    nodes:
                    - mac: aff827549235
                    - mac: 8396cd006c8c
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites Devices - WAN Cluster
      summary: createSiteDeviceHaCluster
      description: "## Create HA Cluster\nBoth nodes has to be in the same site. We expect the user to configure ha_sync / ha_data port in port_configs already\n\n### SRX cabling\n\nsee [Chassis Cluster User Guide for SRX Series Devices](https://www.juniper.net/documentation/us/en/software/junos/chassis-cluster-security-devices/topics/concept/chassis-cluster-srx-series-node-interface-understanding.html) Here’s the recommended cabling.\n\n#### SRX300\n\nFrom ZTP / default state, ge-0/0/0 and ge-0/0/7 (SFP) are default WAN ports and will get DHCP IP. However, ge-0/0/0 becomes OOB/fxp0 after cluster is enabled (i.e. using it for reach Mist is not recommended)\n\n1. form cluster in UI\n2. configure ge-0/0/7,ge-1/0/7 for WAN (reth0)\n3. configure ge-0/0/2,ge-1/0/2 for ha_data\n4. configure ge-0/0/3- for LAN or additional WAN e.g.\n    \n\n``` json\n{\n    \"port_config\": {\n        \"ge-0/0/2,ge-1/0/2\": {\n            \"usage\": \"ha_data\"\n        },\n        \"ge-0/0/7,ge-1/0/7\": {\n            \"usage\": \"wan\",\n            \"redundant\": true,\n            \"reth_idx\": 0,\n            \"ip_config\": {\"type\": \"dhcp\"}\n        },\n    }\n}\n\n```\n\n1. connect ge-0/0/1 back to back for ha_control\n2. connect ge-0/0/2 back to back for ha_data\n3. connect both ge-0/0/7 to uplink switch to WAN and to reach Mist\n4. power up both devices\n5. it takes about 30 minutes for the cluster to form\n    \n\n#### SRX320\n\nFrom ZTP / default state, ge-0/0/0, ge-0/0/7 (SFP) and cl-1/0/0 (LTE) are default WAN ports and will get DHCP IP. However, ge-0/0/0 becomes OOB/fxp0 after cluster is enabled (i.e. using it for reach Mist is not recommended)\n\n##### ZTP via ge-0/0/7\n\nSimilar to SRX300\n\n##### ZTP via cl-1/0/0 (LTE)\n\n1. form cluster in UI\n2. configure cl-1/0/0, cl-3/0/0 as WAN (reth0)\n3. configure ge-0/0/2,ge-3/0/2 for ha_data\n4. same as above\n    \n\n#### SRX340 / SRX345 / SRX380\n\nSRX340/SRX345 has dedicated OOB/fxp0 ports\n\n1. form cluster in UI\n2. configure ge-0/0/0,ge-5/0/0 for WAN (reth0)\n3. configure ge-0/0/2,ge-5/0/2 for ha_data\n4. configure ge-0/0/3- for LAN or additional WAN\n5. connect ge-0/0/0 to uplink switch to WAN and to reach Mist\n6. connect ge-0/0/1 back-to-back for ha_control\n7. connect ge-0/0/2 back-to-back for ha_data (fabric); or for SRX380, xe-0/0/16 if 10G SFP+ is used\n8. connect ge-0/0/3- to LAN or additional WANs\n    \n\n#### SRX550\n\nge-0/0/0 becomes OOB/fxp0 after cluster is enabled, make enable oob_ip_config as dhcp to maintain cloud connectivity\n\n1. connect ge-0/0/0 to reach Mist (after cluster is fully up, this port becomes OOB/fxp0)\n2. connect ge-0/0/1 back-to-back for ha_control\n3. connect ge-0/0/2 back-to-back for ha_data (fabric)\n4. connect ge-0/0/3 to WAN (after cluster is up, intended to be used for reth0)\n5. connect ge-0/0/4- to LAN or additional WANs\n    \n\n#### SRX1500\n\nSRX1500 has, additionally, dedicated HA Control port\n\n1. form cluster in UI\n2. configure ge-0/0/0,ge-5/0/0 for WAN (reth0)\n3. configure ge-0/0/1,ge-5/0/1 for ha_data\n4. configure ge-0/0/2- for LAN or additional WAN\n5. connect dedicated ha_control back-to-back\n6. connect ge-0/0/0 to uplink switch to WAN and to reach Mist\n7. connect ge-0/0/1 back-to-back for ha_data\n8. connect ge-0/0/2- to LAN or additional WANs\n    \n\n#### SRX4100\n\nSRX4100 has dedicated ha_control and ha_data (fabric) ports\n\n1. connect dedicated ha_control back-to-back\n2. connect dedicated ha_data back-to-back\n3. connect xe-0/0/0 to WAN to reach Mist\n4. connect xe-0/0/1- to LAN or additional WANs\n    \n\n#### VSRX\n\nWhen standalone, VSRX has fxp0 as first Network Adapter, then ge-0/0/0-N When clustered, VSRX has fxp0, em0, then ge-0/0/0-N\n\n1. connect net0 (fxp0) to WAN to reach Mist\n2. connect net1 back-to-back for ha_control\n3.  connect net2 (ge-0/0/0) back-to-back for ha_data (fab0/fab1)\n4. connect net3 (ge-0/0/1) to WAN, intended to be used for reth0\n5. connect net4 (ge-0/0/2) to LAN\n    \n\nSRX340/SRX345 has dedicated OOB/fxp0 ports VSRX has fxp0 as first Network Adapter, then ge-0/0/0-N\n\n1. connect ge-0/0/0 to WAN to reach Mist\n2. connect ge-0/0/1 back-to-back for ha_control\n3. connect ge-0/0/2 back-to-back for ha_data (fabric); or for SRX380, xe-0/0/16 if 10G SFP+ is used\n4. connect ge-0/0/3- to LAN or additional WANs\n    \n\n#### SRX550\n\nge-0/0/0 becomes OOB/fxp0 after cluster is enabled, make enable oob_ip_config as dhcp to maintain cloud connectivity\n\n1.  connect ge-0/0/0 to reach Mist (after cluster is fully up, this port becomes OOB/fxp0)\n2. connect ge-0/0/1 back-to-back for ha_control\n3. connect ge-0/0/2 back-to-back for ha_data (fabric)\n4. connect ge-0/0/3 to WAN (after cluster is up, intended to be used for reth0)\n5. connect ge-0/0/4- to LAN or additional WANs\n    \n\n#### SRX1500\n\nSRX1500 has, additionally, dedicated HA Control port\n\n1. form cluster in UI\n2. configure ge-0/0/0,ge-7/0/0 for WAN (reth0)\n3. configure ge-0/0/1,ge-7/0/1 for ha_data\n4. configure ge-0/0/2- for LAN or additional WAN\n5. connect dedicated ha_control back-to-back\n6. connect ge-0/0/0 to uplink switch to WAN and to reach Mist\n7. connect ge-0/0/1 back-to-back for ha_data\n8. connect ge-0/0/2- to LAN or additional WANs\n\n    \n#### SRX1600\n\nSRX1600 has, additionally, two dedicated HA Control port\n\n1. form cluster in UI\n2. configure ge-0/0/0,ge-7/0/0 for WAN (reth0)\n3. configure ge-0/0/1,ge-7/0/1 for ha_data\n4. configure ge-0/0/2- for LAN or additional WAN\n5. connect dedicated both ha_control back-to-back\n6. connect ge-0/0/0 to uplink switch to WAN and to reach Mist\n7. connect ge-0/0/1 back-to-back for ha_data\n8. connect ge-0/0/2- to LAN or additional WANs\n\n\n#### SRX4100\n\nSRX4100 has dedicated ha_control and ha_data (fabric) ports\n\n1. connect dedicated ha_control back-to-back\n2. connect dedicated ha_data back-to-back\n3. connect xe-0/0/0 to WAN to reach Mist\n4. connect xe-0/0/1- to LAN or additional WANs\n\n\n## Replace a Node in a HA Cluster\nUsually Device Replacement is done by Device Replacement API. For a HA cluster, you can also replace a node by another device in the same site."
      operationId: createSiteDeviceHaCluster
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/gateway_cluster'
              - examples:
                - nodes:
                  - mac: aff827549235
                  - mac: 8396cd006c8c
              contentMediaType: application/json
            examples:
              Example:
                value:
                  nodes:
                  - mac: aff827549235
                  - mac: 8396cd006c8c
        required: false
      responses:
        '200':
          description: Ok
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/gateway_cluster'
                - description: Gateway HA cluster request or response body
                  examples:
                  - nodes:
                    - mac: aff827549235
                    - mac: 8396cd006c8c
                contentMediaType: application/json
              examples:
                Gateway Cluster:
                  value:
                    nodes:
                    - mac: aff827549235
                    - mac: 8396cd006c8c
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/gateway_cluster'
                - description: Gateway HA cluster request or response body
                  examples:
                  - nodes:
                    - mac: aff827549235
                    - mac: 8396cd006c8c
                contentMediaType: application/vnd.api+json
              examples:
                Gateway Cluster:
                  value:
                    nodes:
                    - mac: aff827549235
                    - mac: 8396cd006c8c
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/deviceprofiles/derived:
    get:
      tags:
      - Sites Device Profiles
      summary: listSiteDeviceProfilesDerived
      description: Get the list of derived Device Profiles for a Site
      operationId: listSiteDeviceProfilesDerived
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: resolve
        in: query
        description: Whether resolve the site variables
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/deviceprofile'
                description: List of device profile configurations
                examples:
                - '[{"aeroscout":{"enabled":true,"host":"string"},"created_time":0,"disable_eth1":true,"disable_module":true,"id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","ip_config":{"dns":["string"],"dns_suffix":["string"],"gateway":"192.168.0.1","gateway6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","ip":"192.168.0.1","ip6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","mtu":1500,"netmask":"192.168.0.1","netmask6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","type":"static","type6":"static","vlan_id":1},"mesh":{"enabled":true,"group":1,"role":"base"},"modified_time":0,"name":"string","org_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","poe_passthrough":true,"switch_config":{"enabled":true,"eth0":{"port_vlan_id":1,"vlan_ids":[1,10]},"eth1":{"port_vlan_id":1,"vlan_ids":[10]},"eth2":{"port_vlan_id":1,"vlan_ids":[10]},"eth3":{"port_vlan_id":1,"vlan_ids":[10]},"module":{"port_vlan_id":1,"vlan_ids":[10]},"wds":{"port_vlan_id":1,"vlan_ids":[10]}},"type":"ap","usb_config":{"cacert":"string","enabled":true,"host":"string","type":"imagotag","verify_cert":true}}]'
                - '[{"created_time":1680762730,"dhcpd_config":{"Corp-Mgmt":{"dns_servers":["8.8.8.8"],"dns_suffix":["stag.one"],"gateway":"10.3.172.9","ip_end":"10.3.172.99","ip_start":"10.3.172.50","type":"local"},"Corp-lan":{"dns_servers":["8.8.8.8"],"dns_suffix":["stag.one"],"gateway":"10.3.171.9","ip_end":"10.3.171.99","ip_start":"10.3.171.50","type":"local"}},"dnsOverride":true,"dns_servers":["10.3.20.201","10.3.51.222","1.1.1.1"],"dns_suffix":["example.com"],"extra_routes":{"10.101.0.0/16":{"via":"10.3.100.10"}},"id":"4ea55b5d-7313-4a81-a292-7ee125fd4ebb","ip_configs":{"Corp-Core":{"ip":"10.3.100.9","netmask":"/24","type":"static"},"Corp-Mgmt":{"ip":"10.3.172.9","netmask":"/24","type":"static"},"Corp-lan":{"ip":"10.3.171.9","netmask":"/24","type":"static"}},"modified_time":1680762890,"name":"ITParis","ntpOverride":true,"ntp_servers":["10.3.51.222"],"org_id":"93986f10-773b-42be-9438-8d3e6d127f1a","path_preferences":{"core":{"paths":[{"networks":["Corp-Core"],"type":"local"}],"strategy":"ordered"},"lab":{"paths":[{"networks":["Corp-lan"],"type":"local"}],"strategy":"ordered"},"mgmt":{"paths":[{"networks":["Corp-Mgmt"],"type":"local"}],"strategy":"ordered"},"untrust":{"paths":[{"name":"wan","type":"wan"}],"strategy":"ordered"}},"port_config":{"ge-0/0/0":{"aggregated":false,"ip_config":{"gateway":"192.168.1.1","ip":"192.168.1.9","netmask":"/24","type":"static"},"name":"wan","redundant":false,"traffic_shaping":{"enabled":false},"usage":"wan","wan_type":"broadband"},"ge-0/0/6-7":{"ae_disable_lacp":false,"ae_idx":"0","ae_lacp_force_up":true,"aggregated":true,"networks":["Corp-lan","Corp-Mgmt","Corp-Core"],"usage":"lan"}},"service_policies":[{"action":"allow","idp":{"enabled":false},"name":"ITParis-Internal","path_preference":"core","services":["internal_dns","drive"],"tenants":["ITParis"]},{"action":"deny","idp":{"enabled":false},"name":"ITParis-internet","path_preference":"untrust","services":["internet_any"],"tenants":["ITParis"]}],"type":"gateway"}]'
                contentMediaType: application/json
              examples:
                Deviceprofile Ap:
                  value:
                  - aeroscout:
                      enabled: true
                      host: string
                    created_time: 0
                    disable_eth1: true
                    disable_module: true
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ip_config:
                      dns:
                      - string
                      dns_suffix:
                      - string
                      gateway: 192.168.0.1
                      gateway6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
                      ip: 192.168.0.1
                      ip6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
                      mtu: 1500
                      netmask: 192.168.0.1
                      netmask6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
                      type: static
                      type6: static
                      vlan_id: 1
                    mesh:
                      enabled: true
                      group: 1
                      role: base
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    poe_passthrough: true
                    switch_config:
                      enabled: true
                      eth0:
                        port_vlan_id: 1
                        vlan_ids:
                        - 1
                        - 10
                      eth1:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      eth2:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      eth3:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      module:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      wds:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                    type: ap
                    usb_config:
                      cacert: string
                      enabled: true
                      host: string
                      type: imagotag
                      verify_cert: true
                Deviceprofile Hub:
                  value:
                  - created_time: 1680762730
                    dhcpd_config:
                      Corp-Mgmt:
                        dns_servers:
                        - 8.8.8.8
                        dns_suffix:
                        - stag.one
                        gateway: 10.3.172.9
                        ip_end: 10.3.172.99
                        ip_start: 10.3.172.50
                        type: local
                      Corp-lan:
                        dns_servers:
                        - 8.8.8.8
                        dns_suffix:
                        - stag.one
                        gateway: 10.3.171.9
                        ip_end: 10.3.171.99
                        ip_start: 10.3.171.50
                        type: local
                    dnsOverride: true
                    dns_servers:
                    - 10.3.20.201
                    - 10.3.51.222
                    - 1.1.1.1
                    dns_suffix:
                    - example.com
                    extra_routes:
                      10.101.0.0/16:
                        via: 10.3.100.10
                    id: 4ea55b5d-7313-4a81-a292-7ee125fd4ebb
                    ip_configs:
                      Corp-Core:
                        ip: 10.3.100.9
                        netmask: /24
                        type: static
                      Corp-Mgmt:
                        ip: 10.3.172.9
                        netmask: /24
                        type: static
                      Corp-lan:
                        ip: 10.3.171.9
                        netmask: /24
                        type: static
                    modified_time: 1680762890
                    name: ITParis
                    ntpOverride: true
                    ntp_servers:
                    - 10.3.51.222
                    org_id: 93986f10-773b-42be-9438-8d3e6d127f1a
                    path_preferences:
                      core:
                        paths:
                        - networks:
                          - Corp-Core
                          type: local
                        strategy: ordered
                      lab:
                        paths:
                        - networks:
                          - Corp-lan
                          type: local
                        strategy: ordered
                      mgmt:
                        paths:
                        - networks:
                          - Corp-Mgmt
                          type: local
                        strategy: ordered
                      untrust:
                        paths:
                        - name: wan
                          type: wan
                        strategy: ordered
                    port_config:
                      ge-0/0/0:
                        aggregated: false
                        ip_config:
                          gateway: 192.168.1.1
                          ip: 192.168.1.9
                          netmask: /24
                          type: static
                        name: wan
                        redundant: false
                        traffic_shaping:
                          enabled: false
                        usage: wan
                        wan_type: broadband
                      ge-0/0/6-7:
                        ae_disable_lacp: false
                        ae_idx: '0'
                        ae_lacp_force_up: true
                        aggregated: true
                        networks:
                        - Corp-lan
                        - Corp-Mgmt
                        - Corp-Core
                        usage: lan
                    service_policies:
                    - action: allow
                      idp:
                        enabled: false
                      name: ITParis-Internal
                      path_preference: core
                      services:
                      - internal_dns
                      - drive
                      tenants:
                      - ITParis
                    - action: deny
                      idp:
                        enabled: false
                      name: ITParis-internet
                      path_preference: untrust
                      services:
                      - internet_any
                      tenants:
                      - ITParis
                    type: gateway
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/deviceprofile'
                description: List of device profile configurations
                examples:
                - '[{"aeroscout":{"enabled":true,"host":"string"},"created_time":0,"disable_eth1":true,"disable_module":true,"id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","ip_config":{"dns":["string"],"dns_suffix":["string"],"gateway":"192.168.0.1","gateway6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","ip":"192.168.0.1","ip6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","mtu":1500,"netmask":"192.168.0.1","netmask6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","type":"static","type6":"static","vlan_id":1},"mesh":{"enabled":true,"group":1,"role":"base"},"modified_time":0,"name":"string","org_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","poe_passthrough":true,"switch_config":{"enabled":true,"eth0":{"port_vlan_id":1,"vlan_ids":[1,10]},"eth1":{"port_vlan_id":1,"vlan_ids":[10]},"eth2":{"port_vlan_id":1,"vlan_ids":[10]},"eth3":{"port_vlan_id":1,"vlan_ids":[10]},"module":{"port_vlan_id":1,"vlan_ids":[10]},"wds":{"port_vlan_id":1,"vlan_ids":[10]}},"type":"ap","usb_config":{"cacert":"string","enabled":true,"host":"string","type":"imagotag","verify_cert":true}}]'
                - '[{"created_time":1680762730,"dhcpd_config":{"Corp-Mgmt":{"dns_servers":["8.8.8.8"],"dns_suffix":["stag.one"],"gateway":"10.3.172.9","ip_end":"10.3.172.99","ip_start":"10.3.172.50","type":"local"},"Corp-lan":{"dns_servers":["8.8.8.8"],"dns_suffix":["stag.one"],"gateway":"10.3.171.9","ip_end":"10.3.171.99","ip_start":"10.3.171.50","type":"local"}},"dnsOverride":true,"dns_servers":["10.3.20.201","10.3.51.222","1.1.1.1"],"dns_suffix":["example.com"],"extra_routes":{"10.101.0.0/16":{"via":"10.3.100.10"}},"id":"4ea55b5d-7313-4a81-a292-7ee125fd4ebb","ip_configs":{"Corp-Core":{"ip":"10.3.100.9","netmask":"/24","type":"static"},"Corp-Mgmt":{"ip":"10.3.172.9","netmask":"/24","type":"static"},"Corp-lan":{"ip":"10.3.171.9","netmask":"/24","type":"static"}},"modified_time":1680762890,"name":"ITParis","ntpOverride":true,"ntp_servers":["10.3.51.222"],"org_id":"93986f10-773b-42be-9438-8d3e6d127f1a","path_preferences":{"core":{"paths":[{"networks":["Corp-Core"],"type":"local"}],"strategy":"ordered"},"lab":{"paths":[{"networks":["Corp-lan"],"type":"local"}],"strategy":"ordered"},"mgmt":{"paths":[{"networks":["Corp-Mgmt"],"type":"local"}],"strategy":"ordered"},"untrust":{"paths":[{"name":"wan","type":"wan"}],"strategy":"ordered"}},"port_config":{"ge-0/0/0":{"aggregated":false,"ip_config":{"gateway":"192.168.1.1","ip":"192.168.1.9","netmask":"/24","type":"static"},"name":"wan","redundant":false,"traffic_shaping":{"enabled":false},"usage":"wan","wan_type":"broadband"},"ge-0/0/6-7":{"ae_disable_lacp":false,"ae_idx":"0","ae_lacp_force_up":true,"aggregated":true,"networks":["Corp-lan","Corp-Mgmt","Corp-Core"],"usage":"lan"}},"service_policies":[{"action":"allow","idp":{"enabled":false},"name":"ITParis-Internal","path_preference":"core","services":["internal_dns","drive"],"tenants":["ITParis"]},{"action":"deny","idp":{"enabled":false},"name":"ITParis-internet","path_preference":"untrust","services":["internet_any"],"tenants":["ITParis"]}],"type":"gateway"}]'
                contentMediaType: application/vnd.api+json
              examples:
                Deviceprofile Ap:
                  value:
                  - aeroscout:
                      enabled: true
                      host: string
                    created_time: 0
                    disable_eth1: true
                    disable_module: true
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ip_config:
                      dns:
                      - string
                      dns_suffix:
                      - string
                      gateway: 192.168.0.1
                      gateway6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
                      ip: 192.168.0.1
                      ip6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
                      mtu: 1500
                      netmask: 192.168.0.1
                      netmask6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
                      type: static
                      type6: static
                      vlan_id: 1
                    mesh:
                      enabled: true
                      group: 1
                      role: base
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    poe_passthrough: true
                    switch_config:
                      enabled: true
                      eth0:
                        port_vlan_id: 1
                        vlan_ids:
                        - 1
                        - 10
                      eth1:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      eth2:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      eth3:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      module:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                      wds:
                        port_vlan_id: 1
                        vlan_ids:
                        - 10
                    type: ap
                    usb_config:
                      cacert: string
                      enabled: true
                      host: string
                      type: imagotag
                      verify_cert: true
                Deviceprofile Hub:
                  value:
                  - created_time: 1680762730
                    dhcpd_config:
                      Corp-Mgmt:
                        dns_servers:
                        - 8.8.8.8
                        dns_suffix:
                        - stag.one
                        gateway: 10.3.172.9
                        ip_end: 10.3.172.99
                        ip_start: 10.3.172.50
                        type: local
                      Corp-lan:
                        dns_servers:
                        - 8.8.8.8
                        dns_suffix:
                        - stag.one
                        gateway: 10.3.171.9
                        ip_end: 10.3.171.99
                        ip_start: 10.3.171.50
                        type: local
                    dnsOverride: true
                    dns_servers:
                    - 10.3.20.201
                    - 10.3.51.222
                    - 1.1.1.1
                    dns_suffix:
                    - example.com
                    extra_routes:
                      10.101.0.0/16:
                        via: 10.3.100.10
                    id: 4ea55b5d-7313-4a81-a292-7ee125fd4ebb
                    ip_configs:
                      Corp-Core:
                        ip: 10.3.100.9
                        netmask: /24
                        type: static
                      Corp-Mgmt:
                        ip: 10.3.172.9
                        netmask: /24
                        type: static
                      Corp-lan:
                        ip: 10.3.171.9
                        netmask: /24
                        type: static
                    modified_time: 1680762890
                    name: ITParis
                    ntpOverride: true
                    ntp_servers:
                    - 10.3.51.222
                    org_id: 93986f10-773b-42be-9438-8d3e6d127f1a
                    path_preferences:
                      core:
                        paths:
                        - networks:
                          - Corp-Core
                          type: local
                        strategy: ordered
                      lab:
                        paths:
                        - networks:
                          - Corp-lan
                          type: local
                        strategy: ordered
                      mgmt:
                        paths:
                        - networks:
                          - Corp-Mgmt
                          type: local
                        strategy: ordered
                      untrust:
                        paths:
                        - name: wan
                          type: wan
                        strategy: ordered
                    port_config:
                      ge-0/0/0:
                        aggregated: false
                        ip_config:
                          gateway: 192.168.1.1
                          ip: 192.168.1.9
                          netmask: /24
                          type: static
                        name: wan
                        redundant: false
                        traffic_shaping:
                          enabled: false
                        usage: wan
                        wan_type: broadband
                      ge-0/0/6-7:
                        ae_disable_lacp: false
                        ae_idx: '0'
                        ae_lacp_force_up: true
                        aggregated: true
                        networks:
                        - Corp-lan
                        - Corp-Mgmt
                        - Corp-Core
                        usage: lan
                    service_policies:
                    - action: allow
                      idp:
                        enabled: false
                      name: ITParis-Internal
                      path_preference: core
                      services:
                      - internal_dns
                      - drive
                      tenants:
                      - ITParis
                    - action: deny
                      idp:
                        enabled: false
                      name: ITParis-internet
                      path_preference: untrust
                      services:
                      - internet_any
                      tenants:
                      - ITParis
                    type: gateway
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/events/search:
    get:
      tags:
      - Orgs Events
      summary: searchOrgEvents
      description: >-
        Search Org events



        Supported Event Types:

        - CRADLEPOINT_SYNC_FAILED

        - ORG_CA_CERT_ADDED

        - ORG_CA_CERT_REGENERATED
      operationId: searchOrgEvents
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: type
        in: query
        description: Filter results by type. Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - CRADLEPOINT_MAINTENANCE_COMPLETED,CRADLEPOINT_MAINTENANCE_STARTED
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_events_orgs_search'
                - description: Paginated response for organization event search results
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_events_orgs_search'
                - description: Paginated response for organization event search results
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/events/system/count:
    get:
      tags:
      - Orgs Events
      summary: countOrgSystemEvents
      description: Count organization system event records, optionally grouped by `distinct` and filtered by time range.
      operationId: countOrgSystemEvents
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: Field used to group this count response
        style: form
        explode: true
        schema:
          type: string
          examples:
          - site_id
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/events/system/search:
    get:
      tags:
      - Orgs Events
      summary: searchOrgSystemEvents
      description: Search organization system event records with time range, sorting, and pagination controls.
      operationId: searchOrgSystemEvents
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_org_system_events_search'
                - description: Paginated response for organization system event search results
                  examples:
                  - end: 1741312800
                    limit: 1000
                    results:
                    - change_cat: admin_action
                      metadata: '{"\wlan_id\": \"None\",\"admin_name\": \"API Automation api_automation@mistsys.com\",\"desc\": \"Delete WLAN \\"Automation Test\\"\"}'
                      org_id: 268e599f-5379-473f-b18b-4384e9b3f244
                      scope: org
                      site_id: dc47920f-52d5-499c-af72-dcd646764f84
                      timestamp: 1741309621
                      type: delete-wlan
                    - change_cat: admin_action
                      metadata: '{\"wlan_id\": \"3855dc19-63fb-4490-b113-0176dc1cc8f4\",\"admin_name\": \"API Automation api_automation@mistsys.com\",\"desc\": \"Add WLAN \\"Automation Test\\"\"}'
                      org_id: 268e599f-5379-473f-b18b-4384e9b3f244
                      scope: org
                      site_id: dc47920f-52d5-499c-af72-dcd646764f84
                      timestamp: 1741309601
                      type: add-wlan
                    - change_cat: admin_action
                      metadata: '{\"template_id\": \"7e49acf4-6841-4e56-ad7d-68d0801cbba8\",\"admin_name\": \"API Automation api_automation@mistsys.com\",\"desc\": \"Add Template \\"Automation template\\"\"}'
                      org_id: 268e599f-5379-473f-b18b-4384e9b3f244
                      scope: org
                      timestamp: 1741309280
                      type: add-template
                    start: 1741309200
                    total: 3
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1741312800
                    limit: 1000
                    results:
                    - change_cat: admin_action
                      metadata: '{"\wlan_id\": \"None\",\"admin_name\": \"API Automation api_automation@mistsys.com\",\"desc\": \"Delete WLAN \\"Automation Test\\"\"}'
                      org_id: 268e599f-5379-473f-b18b-4384e9b3f244
                      scope: org
                      site_id: dc47920f-52d5-499c-af72-dcd646764f84
                      timestamp: 1741309621
                      type: delete-wlan
                    - change_cat: admin_action
                      metadata: '{\"wlan_id\": \"3855dc19-63fb-4490-b113-0176dc1cc8f4\",\"admin_name\": \"API Automation api_automation@mistsys.com\",\"desc\": \"Add WLAN \\"Automation Test\\"\"}'
                      org_id: 268e599f-5379-473f-b18b-4384e9b3f244
                      scope: org
                      site_id: dc47920f-52d5-499c-af72-dcd646764f84
                      timestamp: 1741309601
                      type: add-wlan
                    - change_cat: admin_action
                      metadata: '{\"template_id\": \"7e49acf4-6841-4e56-ad7d-68d0801cbba8\",\"admin_name\": \"API Automation api_automation@mistsys.com\",\"desc\": \"Add Template \\"Automation template\\"\"}'
                      org_id: 268e599f-5379-473f-b18b-4384e9b3f244
                      scope: org
                      timestamp: 1741309280
                      type: add-template
                    start: 1741309200
                    total: 3
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_org_system_events_search'
                - description: Paginated response for organization system event search results
                  examples:
                  - end: 1741312800
                    limit: 1000
                    results:
                    - change_cat: admin_action
                      metadata: '{"\wlan_id\": \"None\",\"admin_name\": \"API Automation api_automation@mistsys.com\",\"desc\": \"Delete WLAN \\"Automation Test\\"\"}'
                      org_id: 268e599f-5379-473f-b18b-4384e9b3f244
                      scope: org
                      site_id: dc47920f-52d5-499c-af72-dcd646764f84
                      timestamp: 1741309621
                      type: delete-wlan
                    - change_cat: admin_action
                      metadata: '{\"wlan_id\": \"3855dc19-63fb-4490-b113-0176dc1cc8f4\",\"admin_name\": \"API Automation api_automation@mistsys.com\",\"desc\": \"Add WLAN \\"Automation Test\\"\"}'
                      org_id: 268e599f-5379-473f-b18b-4384e9b3f244
                      scope: org
                      site_id: dc47920f-52d5-499c-af72-dcd646764f84
                      timestamp: 1741309601
                      type: add-wlan
                    - change_cat: admin_action
                      metadata: '{\"template_id\": \"7e49acf4-6841-4e56-ad7d-68d0801cbba8\",\"admin_name\": \"API Automation api_automation@mistsys.com\",\"desc\": \"Add Template \\"Automation template\\"\"}'
                      org_id: 268e599f-5379-473f-b18b-4384e9b3f244
                      scope: org
                      timestamp: 1741309280
                      type: add-template
                    start: 1741309200
                    total: 3
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1741312800
                    limit: 1000
                    results:
                    - change_cat: admin_action
                      metadata: '{"\wlan_id\": \"None\",\"admin_name\": \"API Automation api_automation@mistsys.com\",\"desc\": \"Delete WLAN \\"Automation Test\\"\"}'
                      org_id: 268e599f-5379-473f-b18b-4384e9b3f244
                      scope: org
                      site_id: dc47920f-52d5-499c-af72-dcd646764f84
                      timestamp: 1741309621
                      type: delete-wlan
                    - change_cat: admin_action
                      metadata: '{\"wlan_id\": \"3855dc19-63fb-4490-b113-0176dc1cc8f4\",\"admin_name\": \"API Automation api_automation@mistsys.com\",\"desc\": \"Add WLAN \\"Automation Test\\"\"}'
                      org_id: 268e599f-5379-473f-b18b-4384e9b3f244
                      scope: org
                      site_id: dc47920f-52d5-499c-af72-dcd646764f84
                      timestamp: 1741309601
                      type: add-wlan
                    - change_cat: admin_action
                      metadata: '{\"template_id\": \"7e49acf4-6841-4e56-ad7d-68d0801cbba8\",\"admin_name\": \"API Automation api_automation@mistsys.com\",\"desc\": \"Add Template \\"Automation template\\"\"}'
                      org_id: 268e599f-5379-473f-b18b-4384e9b3f244
                      scope: org
                      timestamp: 1741309280
                      type: add-template
                    start: 1741309200
                    total: 3
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/events/fast_roam:
    get:
      tags:
      - Sites Events
      summary: listSiteRoamingEvents
      description: List Roaming Events data
      operationId: listSiteRoamingEvents
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: type
        in: query
        description: 'Event type used to filter results. enum: `fail`, `none`, `success`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/fast_roam_result'
          - description: 'Event type used to filter results. enum: `fail`, `none`, `success`'
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_events_fastroam'
                - description: Paginated response for fast roaming event results
                  examples:
                  - end: 1501023379
                    limit: 2
                    next: /api/v1/sites/dca0a44b-324c-11e6-a776-0243ad110007/events/fast_roam?type=success&start=1428939600&end=1428949600&limit=200&token=AAAAEgAIAAVVJh4hF8AAAARzc2lkAH%2F%2F%2F%2F0%3D
                    results:
                    - ap_mac: 5c5b350e040b
                      client_mac: dc2b2a3fb13d
                      fromap: 5c5b350e0569
                      latency: 0.1874195
                      ssid: marvis_test
                      subtype: CLIENT_AUTHENTICATED_11R
                      timestamp: 1501000002283782
                    start: 1500940800
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1501023379
                    limit: 2
                    next: /api/v1/sites/dca0a44b-324c-11e6-a776-0243ad110007/events/fast_roam?type=success&start=1428939600&end=1428949600&limit=200&token=AAAAEgAIAAVVJh4hF8AAAARzc2lkAH%2F%2F%2F%2F0%3D
                    results:
                    - ap_mac: 5c5b350e040b
                      client_mac: dc2b2a3fb13d
                      fromap: 5c5b350e0569
                      latency: 0.1874195
                      ssid: marvis_test
                      subtype: CLIENT_AUTHENTICATED_11R
                      timestamp: 1501000002283782
                    start: 1500940800
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_events_fastroam'
                - description: Paginated response for fast roaming event results
                  examples:
                  - end: 1501023379
                    limit: 2
                    next: /api/v1/sites/dca0a44b-324c-11e6-a776-0243ad110007/events/fast_roam?type=success&start=1428939600&end=1428949600&limit=200&token=AAAAEgAIAAVVJh4hF8AAAARzc2lkAH%2F%2F%2F%2F0%3D
                    results:
                    - ap_mac: 5c5b350e040b
                      client_mac: dc2b2a3fb13d
                      fromap: 5c5b350e0569
                      latency: 0.1874195
                      ssid: marvis_test
                      subtype: CLIENT_AUTHENTICATED_11R
                      timestamp: 1501000002283782
                    start: 1500940800
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1501023379
                    limit: 2
                    next: /api/v1/sites/dca0a44b-324c-11e6-a776-0243ad110007/events/fast_roam?type=success&start=1428939600&end=1428949600&limit=200&token=AAAAEgAIAAVVJh4hF8AAAARzc2lkAH%2F%2F%2F%2F0%3D
                    results:
                    - ap_mac: 5c5b350e040b
                      client_mac: dc2b2a3fb13d
                      fromap: 5c5b350e0569
                      latency: 0.1874195
                      ssid: marvis_test
                      subtype: CLIENT_AUTHENTICATED_11R
                      timestamp: 1501000002283782
                    start: 1500940800
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/events/system/count:
    get:
      tags:
      - Sites Events
      summary: countSiteSystemEvents
      description: Count system events for a site, optionally grouped by the `distinct` field and filtered by time range. Use [Count Org System Events]($e/Orgs%20Events/countOrgSystemEvents) to count system events across the organization.
      operationId: countSiteSystemEvents
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `type`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/site_system_events_count_distinct'
          - description: 'Field used to group this count response. enum: `type`'
      - name: type
        in: query
        description: See [List Device Events Definitions]($e/Constants%20Events/listDeviceEventsDefinitions)
        style: form
        explode: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/events/system/search:
    get:
      tags:
      - Sites Events
      summary: searchSiteSystemEvents
      description: Search system events for a site with time range, sorting, and pagination controls. Use [Search Org System Events]($e/Orgs%20Events/searchOrgSystemEvents) to search system events across the organization.
      operationId: searchSiteSystemEvents
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: type
        in: query
        description: See [List Device Events Definitions]($e/Constants%20Events/listDeviceEventsDefinitions)
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_device_events_search'
                - description: Paginated response for device or system event search results
                  examples:
                  - end: 0
                    limit: 0
                    next: string
                    results:
                    - ap: 5c5b351e13b5
                      apfw: 5c5b351e13b5
                      model: BT11-WW
                      org_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862a
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      text: Succeeding DNS query from 172.29.101.134 to 172.29.101.7 for "portal.mistsys.com" on vlan 1, id 60224
                      timestamp: 1547235620.89
                      type: CLIENT_DNS_OK
                    - device_type: gateway
                      job_id: c2096de9-0ca4-4a8b-b500-d37cbe0f0baf
                      mac: d007ca6c6ac0
                      org_id: 86f0c649-06b1-4337-b3d4-25eeb887f732
                      site_id: 9f8d28eb-77c7-44c7-a85b-4426bf291679
                      status: PROVISION_IN_PROGRESS
                      template_id: 660e8400-e29b-41d4-a716-446655440001
                      timestamp: 1748987445.959
                      tunnel_name: zs1
                      type: NOTICE
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 0
                    limit: 0
                    next: string
                    results:
                    - ap: 5c5b351e13b5
                      apfw: 5c5b351e13b5
                      model: BT11-WW
                      org_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862a
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      text: Succeeding DNS query from 172.29.101.134 to 172.29.101.7 for "portal.mistsys.com" on vlan 1, id 60224
                      timestamp: 1547235620.89
                      type: CLIENT_DNS_OK
                    - device_type: gateway
                      job_id: c2096de9-0ca4-4a8b-b500-d37cbe0f0baf
                      mac: d007ca6c6ac0
                      org_id: 86f0c649-06b1-4337-b3d4-25eeb887f732
                      site_id: 9f8d28eb-77c7-44c7-a85b-4426bf291679
                      status: PROVISION_IN_PROGRESS
                      template_id: 660e8400-e29b-41d4-a716-446655440001
                      timestamp: 1748987445.959
                      tunnel_name: zs1
                      type: NOTICE
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_device_events_search'
                - description: Paginated response for device or system event search results
                  examples:
                  - end: 0
                    limit: 0
                    next: string
                    results:
                    - ap: 5c5b351e13b5
                      apfw: 5c5b351e13b5
                      model: BT11-WW
                      org_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862a
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      text: Succeeding DNS query from 172.29.101.134 to 172.29.101.7 for "portal.mistsys.com" on vlan 1, id 60224
                      timestamp: 1547235620.89
                      type: CLIENT_DNS_OK
                    - device_type: gateway
                      job_id: c2096de9-0ca4-4a8b-b500-d37cbe0f0baf
                      mac: d007ca6c6ac0
                      org_id: 86f0c649-06b1-4337-b3d4-25eeb887f732
                      site_id: 9f8d28eb-77c7-44c7-a85b-4426bf291679
                      status: PROVISION_IN_PROGRESS
                      template_id: 660e8400-e29b-41d4-a716-446655440001
                      timestamp: 1748987445.959
                      tunnel_name: zs1
                      type: NOTICE
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 0
                    limit: 0
                    next: string
                    results:
                    - ap: 5c5b351e13b5
                      apfw: 5c5b351e13b5
                      model: BT11-WW
                      org_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862a
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      text: Succeeding DNS query from 172.29.101.134 to 172.29.101.7 for "portal.mistsys.com" on vlan 1, id 60224
                      timestamp: 1547235620.89
                      type: CLIENT_DNS_OK
                    - device_type: gateway
                      job_id: c2096de9-0ca4-4a8b-b500-d37cbe0f0baf
                      mac: d007ca6c6ac0
                      org_id: 86f0c649-06b1-4337-b3d4-25eeb887f732
                      site_id: 9f8d28eb-77c7-44c7-a85b-4426bf291679
                      status: PROVISION_IN_PROGRESS
                      template_id: 660e8400-e29b-41d4-a716-446655440001
                      timestamp: 1748987445.959
                      tunnel_name: zs1
                      type: NOTICE
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/evpn_topologies:
    get:
      tags:
      - Sites EVPN Topologies
      summary: listSiteEvpnTopologies
      description: Get the existing EVPN topology
      operationId: listSiteEvpnTopologies
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/evpn_topology_response'
                description: EVPN topology records returned by list APIs
                examples:
                - - created_time: 1736421230
                    evpn_options:
                      auto_loopback_subnet: 172.16.192.0/24
                      auto_loopback_subnet6: fd33:ab00:2::/64
                      auto_router_id_subnet: 172.16.254.0/23
                      core_as_border: true
                      overlay:
                        as: 65000
                      per_vlan_vga_v4_mac: false
                      routed_at: core
                      underlay:
                        as_base: 65001
                        subnet: 10.255.240.0/20
                        use_ipv6: false
                    for_site: false
                    id: 764fb173-94f9-447c-8454-def62e5a999f
                    modified_time: 1736421230
                    name: tert
                    org_id: 3a2627d7-bfbc-45af-b85d-8841581c6d63
                    pod_names:
                      '1': Pod 1
                    site_id: 00000000-0000-0000-0000-000000000000
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 1736421230
                    evpn_options:
                      auto_loopback_subnet: 172.16.192.0/24
                      auto_loopback_subnet6: fd33:ab00:2::/64
                      auto_router_id_subnet: 172.16.254.0/23
                      core_as_border: true
                      overlay:
                        as: 65000
                      per_vlan_vga_v4_mac: false
                      routed_at: core
                      underlay:
                        as_base: 65001
                        subnet: 10.255.240.0/20
                        use_ipv6: false
                    for_site: false
                    id: 764fb173-94f9-447c-8454-def62e5a999f
                    modified_time: 1736421230
                    name: tert
                    org_id: 3a2627d7-bfbc-45af-b85d-8841581c6d63
                    pod_names:
                      '1': Pod 1
                    site_id: 00000000-0000-0000-0000-000000000000
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/evpn_topology_response'
                description: EVPN topology records returned by list APIs
                examples:
                - - created_time: 1736421230
                    evpn_options:
                      auto_loopback_subnet: 172.16.192.0/24
                      auto_loopback_subnet6: fd33:ab00:2::/64
                      auto_router_id_subnet: 172.16.254.0/23
                      core_as_border: true
                      overlay:
                        as: 65000
                      per_vlan_vga_v4_mac: false
                      routed_at: core
                      underlay:
                        as_base: 65001
                        subnet: 10.255.240.0/20
                        use_ipv6: false
                    for_site: false
                    id: 764fb173-94f9-447c-8454-def62e5a999f
                    modified_time: 1736421230
                    name: tert
                    org_id: 3a2627d7-bfbc-45af-b85d-8841581c6d63
                    pod_names:
                      '1': Pod 1
                    site_id: 00000000-0000-0000-0000-000000000000
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 1736421230
                    evpn_options:
                      auto_loopback_subnet: 172.16.192.0/24
                      auto_loopback_subnet6: fd33:ab00:2::/64
                      auto_router_id_subnet: 172.16.254.0/23
                      core_as_border: true
                      overlay:
                        as: 65000
                      per_vlan_vga_v4_mac: false
                      routed_at: core
                      underlay:
                        as_base: 65001
                        subnet: 10.255.240.0/20
                        use_ipv6: false
                    for_site: false
                    id: 764fb173-94f9-447c-8454-def62e5a999f
                    modified_time: 1736421230
                    name: tert
                    org_id: 3a2627d7-bfbc-45af-b85d-8841581c6d63
                    pod_names:
                      '1': Pod 1
                    site_id: 00000000-0000-0000-0000-000000000000
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites EVPN Topologies
      summary: createSiteEvpnTopology
      description: >-
        While all the `evpn_id` / `downlink_ips` can be specified by hand, the easiest way is to call the `build_vpn_topology` API, allowing you to examine the diff, and update it yourself. You can also simply call it with `overwrite=true` which will apply the updates for you.


        **Notes:**

        1. You can use `core` / `distribution` / `access` to create a CLOS topology

        2. You can also use `core` / `distribution` to form a 2-tier EVPN topology where ESI-Lag is configured distribution to connect to access switches

        3. In a small/medium campus, `collapsed-core` can be used where core switches are the inter-connected to do EVPN
      operationId: createSiteEvpnTopology
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/evpn_topology'
              - examples:
                - name: CC
                  overwrite: true
                  pod_names:
                    '1': default
                    '2': default
                  switches:
                  - mac: 5c5b35000003
                    role: collapsed-core
                  - mac: 5c5b35000004
                    role: collapsed-core
              contentMediaType: application/json
            examples:
              Example:
                value:
                  name: CC
                  overwrite: true
                  pod_names:
                    '1': default
                    '2': default
                  switches:
                  - mac: 5c5b35000003
                    role: collapsed-core
                  - mac: 5c5b35000004
                    role: collapsed-core
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/evpn_topology'
                - description: EVPN topology create or update payload
                  examples:
                  - id: 9197ec96-4c8d-529f-c595-035895e688b2
                    name: CC
                    overwrite: true
                    pod_names:
                      '1': default
                      '2': default
                    switches:
                    - deviceprofile_id: 6a1deab1-96df-4fa2-8455-d5253f943d06
                      downlink_ips:
                      - 10.255.240.6
                      - 10.255.240.8
                      downlinks:
                      - 5c5b35000007
                      - 5c5b35000008
                      esilaglinks:
                      - 5c5b3500000f
                      evpn_id: 1
                      mac: 5c5b35000003
                      model: QFX10002-36Q
                      role: collapsed-core
                      site_id: 1916d52a-4a90-11e5-8b45-1258369c38a9
                      uplinks:
                      - 5c5b35000005
                      - 5c5b35000006
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    id: 9197ec96-4c8d-529f-c595-035895e688b2
                    name: CC
                    overwrite: true
                    pod_names:
                      '1': default
                      '2': default
                    switches:
                    - deviceprofile_id: 6a1deab1-96df-4fa2-8455-d5253f943d06
                      downlink_ips:
                      - 10.255.240.6
                      - 10.255.240.8
                      downlinks:
                      - 5c5b35000007
                      - 5c5b35000008
                      esilaglinks:
                      - 5c5b3500000f
                      evpn_id: 1
                      mac: 5c5b35000003
                      model: QFX10002-36Q
                      role: collapsed-core
                      site_id: 1916d52a-4a90-11e5-8b45-1258369c38a9
                      uplinks:
                      - 5c5b35000005
                      - 5c5b35000006
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/evpn_topology'
                - description: EVPN topology create or update payload
                  examples:
                  - id: 9197ec96-4c8d-529f-c595-035895e688b2
                    name: CC
                    overwrite: true
                    pod_names:
                      '1': default
                      '2': default
                    switches:
                    - deviceprofile_id: 6a1deab1-96df-4fa2-8455-d5253f943d06
                      downlink_ips:
                      - 10.255.240.6
                      - 10.255.240.8
                      downlinks:
                      - 5c5b35000007
                      - 5c5b35000008
                      esilaglinks:
                      - 5c5b3500000f
                      evpn_id: 1
                      mac: 5c5b35000003
                      model: QFX10002-36Q
                      role: collapsed-core
                      site_id: 1916d52a-4a90-11e5-8b45-1258369c38a9
                      uplinks:
                      - 5c5b35000005
                      - 5c5b35000006
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    id: 9197ec96-4c8d-529f-c595-035895e688b2
                    name: CC
                    overwrite: true
                    pod_names:
                      '1': default
                      '2': default
                    switches:
                    - deviceprofile_id: 6a1deab1-96df-4fa2-8455-d5253f943d06
                      downlink_ips:
                      - 10.255.240.6
                      - 10.255.240.8
                      downlinks:
                      - 5c5b35000007
                      - 5c5b35000008
                      esilaglinks:
                      - 5c5b3500000f
                      evpn_id: 1
                      mac: 5c5b35000003
                      model: QFX10002-36Q
                      role: collapsed-core
                      site_id: 1916d52a-4a90-11e5-8b45-1258369c38a9
                      uplinks:
                      - 5c5b35000005
                      - 5c5b35000006
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/evpn_topologies/{evpn_topology_id}:
    delete:
      tags:
      - Sites EVPN Topologies
      summary: deleteSiteEvpnTopology
      description: Delete the site EVPN Topology
      operationId: deleteSiteEvpnTopology
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: evpn_topology_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Sites EVPN Topologies
      summary: getSiteEvpnTopology
      description: Get One EVPN Topology Detail
      operationId: getSiteEvpnTopology
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: evpn_topology_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/evpn_topology'
                - description: EVPN topology create or update payload
                  examples:
                  - id: 9197ec96-4c8d-529f-c595-035895e688b2
                    name: CC
                    overwrite: true
                    pod_names:
                      '1': default
                      '2': default
                    switches:
                    - deviceprofile_id: 6a1deab1-96df-4fa2-8455-d5253f943d06
                      downlink_ips:
                      - 10.255.240.6
                      - 10.255.240.8
                      downlinks:
                      - 5c5b35000007
                      - 5c5b35000008
                      esilaglinks:
                      - 5c5b3500000f
                      evpn_id: 1
                      mac: 5c5b35000003
                      model: QFX10002-36Q
                      role: collapsed-core
                      site_id: 1916d52a-4a90-11e5-8b45-1258369c38a9
                      uplinks:
                      - 5c5b35000005
                      - 5c5b35000006
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    id: 9197ec96-4c8d-529f-c595-035895e688b2
                    name: CC
                    overwrite: true
                    pod_names:
                      '1': default
                      '2': default
                    switches:
                    - deviceprofile_id: 6a1deab1-96df-4fa2-8455-d5253f943d06
                      downlink_ips:
                      - 10.255.240.6
                      - 10.255.240.8
                      downlinks:
                      - 5c5b35000007
                      - 5c5b35000008
                      esilaglinks:
                      - 5c5b3500000f
                      evpn_id: 1
                      mac: 5c5b35000003
                      model: QFX10002-36Q
                      role: collapsed-core
                      site_id: 1916d52a-4a90-11e5-8b45-1258369c38a9
                      uplinks:
                      - 5c5b35000005
                      - 5c5b35000006
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/evpn_topology'
                - description: EVPN topology create or update payload
                  examples:
                  - id: 9197ec96-4c8d-529f-c595-035895e688b2
                    name: CC
                    overwrite: true
                    pod_names:
                      '1': default
                      '2': default
                    switches:
                    - deviceprofile_id: 6a1deab1-96df-4fa2-8455-d5253f943d06
                      downlink_ips:
                      - 10.255.240.6
                      - 10.255.240.8
                      downlinks:
                      - 5c5b35000007
                      - 5c5b35000008
                      esilaglinks:
                      - 5c5b3500000f
                      evpn_id: 1
                      mac: 5c5b35000003
                      model: QFX10002-36Q
                      role: collapsed-core
                      site_id: 1916d52a-4a90-11e5-8b45-1258369c38a9
                      uplinks:
                      - 5c5b35000005
                      - 5c5b35000006
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    id: 9197ec96-4c8d-529f-c595-035895e688b2
                    name: CC
                    overwrite: true
                    pod_names:
                      '1': default
                      '2': default
                    switches:
                    - deviceprofile_id: 6a1deab1-96df-4fa2-8455-d5253f943d06
                      downlink_ips:
                      - 10.255.240.6
                      - 10.255.240.8
                      downlinks:
                      - 5c5b35000007
                      - 5c5b35000008
                      esilaglinks:
                      - 5c5b3500000f
                      evpn_id: 1
                      mac: 5c5b35000003
                      model: QFX10002-36Q
                      role: collapsed-core
                      site_id: 1916d52a-4a90-11e5-8b45-1258369c38a9
                      uplinks:
                      - 5c5b35000005
                      - 5c5b35000006
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Sites EVPN Topologies
      summary: updateSiteEvpnTopology
      description: Update the EVPN Topology
      operationId: updateSiteEvpnTopology
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: evpn_topology_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/evpn_topology'
              - examples:
                - overwrite: false
                  switches:
                  - mac: 5c5b35000003
                    role: collapsed-core
                  - mac: 5c5b35000004
                    role: none
              contentMediaType: application/json
            examples:
              Example:
                value:
                  overwrite: false
                  switches:
                  - mac: 5c5b35000003
                    role: collapsed-core
                  - mac: 5c5b35000004
                    role: none
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/evpn_topology'
                - description: EVPN topology create or update payload
                  examples:
                  - id: 9197ec96-4c8d-529f-c595-035895e688b2
                    name: CC
                    overwrite: true
                    pod_names:
                      '1': default
                      '2': default
                    switches:
                    - deviceprofile_id: 6a1deab1-96df-4fa2-8455-d5253f943d06
                      downlink_ips:
                      - 10.255.240.6
                      - 10.255.240.8
                      downlinks:
                      - 5c5b35000007
                      - 5c5b35000008
                      esilaglinks:
                      - 5c5b3500000f
                      evpn_id: 1
                      mac: 5c5b35000003
                      model: QFX10002-36Q
                      role: collapsed-core
                      site_id: 1916d52a-4a90-11e5-8b45-1258369c38a9
                      uplinks:
                      - 5c5b35000005
                      - 5c5b35000006
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    id: 9197ec96-4c8d-529f-c595-035895e688b2
                    name: CC
                    overwrite: true
                    pod_names:
                      '1': default
                      '2': default
                    switches:
                    - deviceprofile_id: 6a1deab1-96df-4fa2-8455-d5253f943d06
                      downlink_ips:
                      - 10.255.240.6
                      - 10.255.240.8
                      downlinks:
                      - 5c5b35000007
                      - 5c5b35000008
                      esilaglinks:
                      - 5c5b3500000f
                      evpn_id: 1
                      mac: 5c5b35000003
                      model: QFX10002-36Q
                      role: collapsed-core
                      site_id: 1916d52a-4a90-11e5-8b45-1258369c38a9
                      uplinks:
                      - 5c5b35000005
                      - 5c5b35000006
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/evpn_topology'
                - description: EVPN topology create or update payload
                  examples:
                  - id: 9197ec96-4c8d-529f-c595-035895e688b2
                    name: CC
                    overwrite: true
                    pod_names:
                      '1': default
                      '2': default
                    switches:
                    - deviceprofile_id: 6a1deab1-96df-4fa2-8455-d5253f943d06
                      downlink_ips:
                      - 10.255.240.6
                      - 10.255.240.8
                      downlinks:
                      - 5c5b35000007
                      - 5c5b35000008
                      esilaglinks:
                      - 5c5b3500000f
                      evpn_id: 1
                      mac: 5c5b35000003
                      model: QFX10002-36Q
                      role: collapsed-core
                      site_id: 1916d52a-4a90-11e5-8b45-1258369c38a9
                      uplinks:
                      - 5c5b35000005
                      - 5c5b35000006
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    id: 9197ec96-4c8d-529f-c595-035895e688b2
                    name: CC
                    overwrite: true
                    pod_names:
                      '1': default
                      '2': default
                    switches:
                    - deviceprofile_id: 6a1deab1-96df-4fa2-8455-d5253f943d06
                      downlink_ips:
                      - 10.255.240.6
                      - 10.255.240.8
                      downlinks:
                      - 5c5b35000007
                      - 5c5b35000008
                      esilaglinks:
                      - 5c5b3500000f
                      evpn_id: 1
                      mac: 5c5b35000003
                      model: QFX10002-36Q
                      role: collapsed-core
                      site_id: 1916d52a-4a90-11e5-8b45-1258369c38a9
                      uplinks:
                      - 5c5b35000005
                      - 5c5b35000006
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/gatewaytemplates/derived:
    get:
      tags:
      - Sites Gateway Templates
      summary: listSiteGatewayTemplatesDerived
      description: Get the list of derived Gateway Templates a Site
      operationId: listSiteGatewayTemplatesDerived
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: resolve
        in: query
        description: Whether resolve the site variables
        style: form
        explode: true
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/gateway_template'
                description: List of gateway device profiles
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/gateway_template'
                description: List of gateway device profiles
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/idpprofiles/derived:
    get:
      tags:
      - Sites IDP Profiles
      summary: listSiteIdpProfilesDerived
      description: Get the list of derived IDP Profiles for a site
      operationId: listSiteIdpProfilesDerived
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/avprofile'
                description: List of antivirus scanning profiles
                examples:
                - - fallback_action: permit
                    max_filesize: 10000
                    mime_whitelist: []
                    name: av-custom
                    protocols:
                    - http
                    url_whitelist: []
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - fallback_action: permit
                    max_filesize: 10000
                    mime_whitelist: []
                    name: av-custom
                    protocols:
                    - http
                    url_whitelist: []
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/avprofile'
                description: List of antivirus scanning profiles
                examples:
                - - fallback_action: permit
                    max_filesize: 10000
                    mime_whitelist: []
                    name: av-custom
                    protocols:
                    - http
                    url_whitelist: []
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - fallback_action: permit
                    max_filesize: 10000
                    mime_whitelist: []
                    name: av-custom
                    protocols:
                    - http
                    url_whitelist: []
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/aamwprofiles/derived:
    get:
      tags:
      - Sites Advanced Anti Malware Profiles
      summary: listSiteAAMWProfilesDerived
      description: Get the list of derived Advanced Anti Malware Profile (SkyAtp) for a site
      operationId: listSiteAAMWProfilesDerived
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/avprofile'
                description: List of antivirus scanning profiles
                examples:
                - - fallback_action: permit
                    max_filesize: 10000
                    mime_whitelist: []
                    name: av-custom
                    protocols:
                    - http
                    url_whitelist: []
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - fallback_action: permit
                    max_filesize: 10000
                    mime_whitelist: []
                    name: av-custom
                    protocols:
                    - http
                    url_whitelist: []
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/avprofile'
                description: List of antivirus scanning profiles
                examples:
                - - fallback_action: permit
                    max_filesize: 10000
                    mime_whitelist: []
                    name: av-custom
                    protocols:
                    - http
                    url_whitelist: []
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - fallback_action: permit
                    max_filesize: 10000
                    mime_whitelist: []
                    name: av-custom
                    protocols:
                    - http
                    url_whitelist: []
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/avprofiles/derived:
    get:
      tags:
      - Sites Antivirus Profiles
      summary: listSiteAntivirusProfilesDerived
      description: Get the list of derived Antivirus Profiles for a site
      operationId: listSiteAntivirusProfilesDerived
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/avprofile'
                description: List of antivirus scanning profiles
                examples:
                - - fallback_action: permit
                    max_filesize: 10000
                    mime_whitelist: []
                    name: av-custom
                    protocols:
                    - http
                    url_whitelist: []
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - fallback_action: permit
                    max_filesize: 10000
                    mime_whitelist: []
                    name: av-custom
                    protocols:
                    - http
                    url_whitelist: []
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/avprofile'
                description: List of antivirus scanning profiles
                examples:
                - - fallback_action: permit
                    max_filesize: 10000
                    mime_whitelist: []
                    name: av-custom
                    protocols:
                    - http
                    url_whitelist: []
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - fallback_action: permit
                    max_filesize: 10000
                    mime_whitelist: []
                    name: av-custom
                    protocols:
                    - http
                    url_whitelist: []
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/guests:
    get:
      tags:
      - Sites Guests
      summary: listSiteAllGuestAuthorizations
      description: Get List of Site Guest Authorizations
      operationId: listSiteAllGuestAuthorizations
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wlan_id
        in: query
        description: UUID of single or multiple (Comma separated) WLAN under Site `site_id` (to filter by WLAN)
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/guest'
                description: List of guest authorization records
                examples:
                - '[{"authorized":true,"authorized_expiring_time":0,"authorized_time":0,"company":"string","email":"user@example.com","field1":"string","field2":"string","field3":"string","field4":"string","mac":"string","minutes":0,"name":"string"}]'
                - '[{"authorized":true,"authorized_expiring_time":1480704955,"authorized_time":1480704355,"company":"abc","email":"john@abc.com","field1":"xxx","mac":"5684dae9ac8b","name":"John Smith"}]'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - authorized: true
                    authorized_expiring_time: 0
                    authorized_time: 0
                    company: string
                    email: user@example.com
                    field1: string
                    field2: string
                    field3: string
                    field4: string
                    mac: string
                    minutes: 0
                    name: string
                Example2:
                  value:
                  - authorized: true
                    authorized_expiring_time: 1480704955
                    authorized_time: 1480704355
                    company: abc
                    email: john@abc.com
                    field1: xxx
                    mac: 5684dae9ac8b
                    name: John Smith
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/guest'
                description: List of guest authorization records
                examples:
                - '[{"authorized":true,"authorized_expiring_time":0,"authorized_time":0,"company":"string","email":"user@example.com","field1":"string","field2":"string","field3":"string","field4":"string","mac":"string","minutes":0,"name":"string"}]'
                - '[{"authorized":true,"authorized_expiring_time":1480704955,"authorized_time":1480704355,"company":"abc","email":"john@abc.com","field1":"xxx","mac":"5684dae9ac8b","name":"John Smith"}]'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - authorized: true
                    authorized_expiring_time: 0
                    authorized_time: 0
                    company: string
                    email: user@example.com
                    field1: string
                    field2: string
                    field3: string
                    field4: string
                    mac: string
                    minutes: 0
                    name: string
                Example2:
                  value:
                  - authorized: true
                    authorized_expiring_time: 1480704955
                    authorized_time: 1480704355
                    company: abc
                    email: john@abc.com
                    field1: xxx
                    mac: 5684dae9ac8b
                    name: John Smith
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/guests/count:
    get:
      tags:
      - Sites Guests
      summary: countSiteGuestAuthorizations
      description: Count authorized guest records for a site, optionally grouped by the `distinct` field and filtered by time range. Use [Count Org Guest Authorizations]($e/Orgs%20Guests/countOrgGuestAuthorizations) to count authorized guest records across the organization.
      operationId: countSiteGuestAuthorizations
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `auth_method`, `company`, `ssid`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/site_guests_count_distinct'
          - description: 'Field used to group this count response. enum: `auth_method`, `company`, `ssid`'
            examples:
            - auth_method
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/guests/derived:
    get:
      tags:
      - Sites Guests
      summary: listSiteAllGuestAuthorizationsDerived
      description: Get the list of derived Guest Authorizations for a site
      operationId: listSiteAllGuestAuthorizationsDerived
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wlan_id
        in: query
        description: UUID of single or multiple (Comma separated) WLAN under Site `site_id` (to filter by WLAN)
        style: form
        explode: true
        schema:
          type: string
      - name: cross_site
        in: query
        description: Whether to get org level guests, default is false i.e get site level guests
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/guest'
                description: List of guest authorization records
                examples:
                - '[{"authorized":true,"authorized_expiring_time":0,"authorized_time":0,"company":"string","email":"user@example.com","field1":"string","field2":"string","field3":"string","field4":"string","mac":"string","minutes":0,"name":"string"}]'
                - '[{"authorized":true,"authorized_expiring_time":1480704955,"authorized_time":1480704355,"company":"abc","email":"john@abc.com","field1":"xxx","mac":"5684dae9ac8b","name":"John Smith"}]'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - authorized: true
                    authorized_expiring_time: 0
                    authorized_time: 0
                    company: string
                    email: user@example.com
                    field1: string
                    field2: string
                    field3: string
                    field4: string
                    mac: string
                    minutes: 0
                    name: string
                Example2:
                  value:
                  - authorized: true
                    authorized_expiring_time: 1480704955
                    authorized_time: 1480704355
                    company: abc
                    email: john@abc.com
                    field1: xxx
                    mac: 5684dae9ac8b
                    name: John Smith
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/guest'
                description: List of guest authorization records
                examples:
                - '[{"authorized":true,"authorized_expiring_time":0,"authorized_time":0,"company":"string","email":"user@example.com","field1":"string","field2":"string","field3":"string","field4":"string","mac":"string","minutes":0,"name":"string"}]'
                - '[{"authorized":true,"authorized_expiring_time":1480704955,"authorized_time":1480704355,"company":"abc","email":"john@abc.com","field1":"xxx","mac":"5684dae9ac8b","name":"John Smith"}]'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - authorized: true
                    authorized_expiring_time: 0
                    authorized_time: 0
                    company: string
                    email: user@example.com
                    field1: string
                    field2: string
                    field3: string
                    field4: string
                    mac: string
                    minutes: 0
                    name: string
                Example2:
                  value:
                  - authorized: true
                    authorized_expiring_time: 1480704955
                    authorized_time: 1480704355
                    company: abc
                    email: john@abc.com
                    field1: xxx
                    mac: 5684dae9ac8b
                    name: John Smith
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/guests/search:
    get:
      tags:
      - Sites Guests
      summary: searchSiteGuestAuthorization
      description: Search authorized guest records for a site with filters for WLAN, SSID, authentication method, and time range. Use [Search Org Guest Authorization]($e/Orgs%20Guests/searchOrgGuestAuthorization) to search authorized guest records across the organization.
      operationId: searchSiteGuestAuthorization
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wlan_id
        in: query
        description: Filter results by WLAN identifier
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 00000000-0000-0000-0000-000000000000
      - name: auth_method
        in: query
        description: Filter guest results by authentication method
        style: form
        explode: true
        schema:
          type: string
      - name: ssid
        in: query
        description: Filter results by SSID
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_guest_search'
                - description: Paginated response for guest authorization search results
                  examples:
                  - end: 1531862583
                    limit: 2
                    next: /api/v1/sites/8aaba0aa-09cc-44bd-9709-33b98040550c/guests/search?wlan_id=88ffe630-95b8-11e8-b294-346895ed1b7d&end=1531855849.000&limit=2&start=1531776183.0
                    results:
                    - ap: 5c5b350e0001
                      auth_method: passphrase
                      authorized_expiring_time: 1531810258.186273
                      authorized_time: 1531782218
                      company: mistsystems
                      email: user@mistsys.com
                      name: john
                      ssid: openNet
                      timestamp: 1531782218
                    - ap: 5c5b350e0001
                      auth_method: facebook
                      authorized_expiring_time: 1531810821.145
                      authorized_time: 1531782632
                      company: xyz inc.
                      email: cool_user@yahoo.com
                      name: John White
                      ssid: openNet
                      timestamp: 1531782632
                    start: 1531776183
                    total: 14
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1531862583
                    limit: 2
                    next: /api/v1/sites/8aaba0aa-09cc-44bd-9709-33b98040550c/guests/search?wlan_id=88ffe630-95b8-11e8-b294-346895ed1b7d&end=1531855849.000&limit=2&start=1531776183.0
                    results:
                    - ap: 5c5b350e0001
                      auth_method: passphrase
                      authorized_expiring_time: 1531810258.186273
                      authorized_time: 1531782218
                      company: mistsystems
                      email: user@mistsys.com
                      name: john
                      ssid: openNet
                      timestamp: 1531782218
                    - ap: 5c5b350e0001
                      auth_method: facebook
                      authorized_expiring_time: 1531810821.145
                      authorized_time: 1531782632
                      company: xyz inc.
                      email: cool_user@yahoo.com
                      name: John White
                      ssid: openNet
                      timestamp: 1531782632
                    start: 1531776183
                    total: 14
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_guest_search'
                - description: Paginated response for guest authorization search results
                  examples:
                  - end: 1531862583
                    limit: 2
                    next: /api/v1/sites/8aaba0aa-09cc-44bd-9709-33b98040550c/guests/search?wlan_id=88ffe630-95b8-11e8-b294-346895ed1b7d&end=1531855849.000&limit=2&start=1531776183.0
                    results:
                    - ap: 5c5b350e0001
                      auth_method: passphrase
                      authorized_expiring_time: 1531810258.186273
                      authorized_time: 1531782218
                      company: mistsystems
                      email: user@mistsys.com
                      name: john
                      ssid: openNet
                      timestamp: 1531782218
                    - ap: 5c5b350e0001
                      auth_method: facebook
                      authorized_expiring_time: 1531810821.145
                      authorized_time: 1531782632
                      company: xyz inc.
                      email: cool_user@yahoo.com
                      name: John White
                      ssid: openNet
                      timestamp: 1531782632
                    start: 1531776183
                    total: 14
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1531862583
                    limit: 2
                    next: /api/v1/sites/8aaba0aa-09cc-44bd-9709-33b98040550c/guests/search?wlan_id=88ffe630-95b8-11e8-b294-346895ed1b7d&end=1531855849.000&limit=2&start=1531776183.0
                    results:
                    - ap: 5c5b350e0001
                      auth_method: passphrase
                      authorized_expiring_time: 1531810258.186273
                      authorized_time: 1531782218
                      company: mistsystems
                      email: user@mistsys.com
                      name: john
                      ssid: openNet
                      timestamp: 1531782218
                    - ap: 5c5b350e0001
                      auth_method: facebook
                      authorized_expiring_time: 1531810821.145
                      authorized_time: 1531782632
                      company: xyz inc.
                      email: cool_user@yahoo.com
                      name: John White
                      ssid: openNet
                      timestamp: 1531782632
                    start: 1531776183
                    total: 14
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/guests/{guest_mac}:
    delete:
      tags:
      - Sites Guests
      summary: deleteSiteGuestAuthorization
      description: Delete Guest Authorization
      operationId: deleteSiteGuestAuthorization
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: guest_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Sites Guests
      summary: getSiteGuestAuthorization
      description: Get Guest Authorization
      operationId: getSiteGuestAuthorization
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: guest_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/guest'
                - description: Guest authorization record at site scope
                  examples:
                  - '{"authorized":true,"authorized_expiring_time":0,"authorized_time":0,"company":"string","email":"user@example.com","field1":"string","field2":"string","field3":"string","field4":"string","mac":"string","minutes":0,"name":"string"}'
                  - '{"authorized":true,"authorized_expiring_time":1480704955,"authorized_time":1480704355,"company":"abc","email":"john@abc.com","field1":"xxx","mac":"5684dae9ac8b","name":"John Smith"}'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    authorized: true
                    authorized_expiring_time: 0
                    authorized_time: 0
                    company: string
                    email: user@example.com
                    field1: string
                    field2: string
                    field3: string
                    field4: string
                    mac: string
                    minutes: 0
                    name: string
                Example2:
                  value:
                    authorized: true
                    authorized_expiring_time: 1480704955
                    authorized_time: 1480704355
                    company: abc
                    email: john@abc.com
                    field1: xxx
                    mac: 5684dae9ac8b
                    name: John Smith
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/guest'
                - description: Guest authorization record at site scope
                  examples:
                  - '{"authorized":true,"authorized_expiring_time":0,"authorized_time":0,"company":"string","email":"user@example.com","field1":"string","field2":"string","field3":"string","field4":"string","mac":"string","minutes":0,"name":"string"}'
                  - '{"authorized":true,"authorized_expiring_time":1480704955,"authorized_time":1480704355,"company":"abc","email":"john@abc.com","field1":"xxx","mac":"5684dae9ac8b","name":"John Smith"}'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    authorized: true
                    authorized_expiring_time: 0
                    authorized_time: 0
                    company: string
                    email: user@example.com
                    field1: string
                    field2: string
                    field3: string
                    field4: string
                    mac: string
                    minutes: 0
                    name: string
                Example2:
                  value:
                    authorized: true
                    authorized_expiring_time: 1480704955
                    authorized_time: 1480704355
                    company: abc
                    email: john@abc.com
                    field1: xxx
                    mac: 5684dae9ac8b
                    name: John Smith
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Sites Guests
      summary: updateSiteGuestAuthorization
      description: Update Guest Authorization
      operationId: updateSiteGuestAuthorization
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: guest_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/guest'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/guest'
                - description: Guest authorization record at site scope
                  examples:
                  - '{"authorized":true,"authorized_expiring_time":0,"authorized_time":0,"company":"string","email":"user@example.com","field1":"string","field2":"string","field3":"string","field4":"string","mac":"string","minutes":0,"name":"string"}'
                  - '{"authorized":true,"authorized_expiring_time":1480704955,"authorized_time":1480704355,"company":"abc","email":"john@abc.com","field1":"xxx","mac":"5684dae9ac8b","name":"John Smith"}'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    authorized: true
                    authorized_expiring_time: 0
                    authorized_time: 0
                    company: string
                    email: user@example.com
                    field1: string
                    field2: string
                    field3: string
                    field4: string
                    mac: string
                    minutes: 0
                    name: string
                Example2:
                  value:
                    authorized: true
                    authorized_expiring_time: 1480704955
                    authorized_time: 1480704355
                    company: abc
                    email: john@abc.com
                    field1: xxx
                    mac: 5684dae9ac8b
                    name: John Smith
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/guest'
                - description: Guest authorization record at site scope
                  examples:
                  - '{"authorized":true,"authorized_expiring_time":0,"authorized_time":0,"company":"string","email":"user@example.com","field1":"string","field2":"string","field3":"string","field4":"string","mac":"string","minutes":0,"name":"string"}'
                  - '{"authorized":true,"authorized_expiring_time":1480704955,"authorized_time":1480704355,"company":"abc","email":"john@abc.com","field1":"xxx","mac":"5684dae9ac8b","name":"John Smith"}'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    authorized: true
                    authorized_expiring_time: 0
                    authorized_time: 0
                    company: string
                    email: user@example.com
                    field1: string
                    field2: string
                    field3: string
                    field4: string
                    mac: string
                    minutes: 0
                    name: string
                Example2:
                  value:
                    authorized: true
                    authorized_expiring_time: 1480704955
                    authorized_time: 1480704355
                    company: abc
                    email: john@abc.com
                    field1: xxx
                    mac: 5684dae9ac8b
                    name: John Smith
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/insights:
    get:
      tags:
      - Sites Insights
      summary: getSiteInsightMetrics
      description: Get Site Insight Metrics
      operationId: getSiteInsightMetrics
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: metrics
        in: query
        description: Comma separated Metric names, e.g. `num_clients,num_aps`. See possible values at [List Insight Metrics](/#operations/listInsightMetrics)
        required: true
        style: form
        explode: true
        schema:
          type: string
          examples:
          - num_clients,num_aps
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: interval
        in: query
        description: Aggregation works by giving a time range plus interval (e.g. 1d, 1h, 10m) where aggregation function would be applied to.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/insight_metrics'
                - description: Insight metric response for a requested time range and aggregation interval
                  examples:
                  - end: 0
                    interval: 0
                    results:
                    - {}
                    start: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 0
                    interval: 0
                    results:
                    - {}
                    start: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/insight_metrics'
                - description: Insight metric response for a requested time range and aggregation interval
                  examples:
                  - end: 0
                    interval: 0
                    results:
                    - {}
                    start: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 0
                    interval: 0
                    results:
                    - {}
                    start: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/insights/ap/{device_id}/stats:
    get:
      tags:
      - Sites Insights
      summary: getSiteInsightMetricsForAP
      description: Get AP Insight Metrics
      operationId: getSiteInsightMetricsForAP
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: metrics
        in: query
        description: Comma separated Metric names, e.g. `num_clients,num_stressed_clients`. See possible values at [List Insight Metrics](/#operations/listInsightMetrics)
        required: true
        style: form
        explode: true
        schema:
          type: string
          examples:
          - num_clients,num_stressed_clients
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: interval
        in: query
        description: Aggregation works by giving a time range plus interval (e.g. 1d, 1h, 10m) where aggregation function would be applied to.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_device_metrics'
                - description: Time-series insight metric response for a device
                  examples:
                  - end: 1604347200
                    interval: 3600
                    limit: 168
                    page: 1
                    results:
                    - 10
                    - 11
                    - 12
                    - 12
                    - 10
                    - 9
                    - 9
                    - 9
                    - 10
                    - 10
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    rt:
                    - 2020-11-01 20:00:00+00:00
                    - 2020-11-01 21:00:00+00:00
                    - 2020-11-01 22:00:00+00:00
                    - 2020-11-01 23:00:00+00:00
                    - 2020-11-02 00:00:00+00:00
                    - 2020-11-02 01:00:00+00:00
                    - 2020-11-02 02:00:00+00:00
                    - 2020-11-02 03:00:00+00:00
                    - 2020-11-02 04:00:00+00:00
                    - 2020-11-02 05:00:00+00:00
                    - 2020-11-02 06:00:00+00:00
                    - 2020-11-02 07:00:00+00:00
                    - 2020-11-02 08:00:00+00:00
                    - 2020-11-02 09:00:00+00:00
                    - 2020-11-02 10:00:00+00:00
                    - 2020-11-02 11:00:00+00:00
                    - 2020-11-02 12:00:00+00:00
                    - 2020-11-02 13:00:00+00:00
                    - 2020-11-02 14:00:00+00:00
                    - 2020-11-02 15:00:00+00:00
                    - 2020-11-02 16:00:00+00:00
                    - 2020-11-02 17:00:00+00:00
                    - 2020-11-02 18:00:00+00:00
                    - 2020-11-02 19:00:00+00:00
                    start: 1604260800
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1604347200
                    interval: 3600
                    limit: 168
                    page: 1
                    results:
                    - 10
                    - 11
                    - 12
                    - 12
                    - 10
                    - 9
                    - 9
                    - 9
                    - 10
                    - 10
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    rt:
                    - 2020-11-01 20:00:00+00:00
                    - 2020-11-01 21:00:00+00:00
                    - 2020-11-01 22:00:00+00:00
                    - 2020-11-01 23:00:00+00:00
                    - 2020-11-02 00:00:00+00:00
                    - 2020-11-02 01:00:00+00:00
                    - 2020-11-02 02:00:00+00:00
                    - 2020-11-02 03:00:00+00:00
                    - 2020-11-02 04:00:00+00:00
                    - 2020-11-02 05:00:00+00:00
                    - 2020-11-02 06:00:00+00:00
                    - 2020-11-02 07:00:00+00:00
                    - 2020-11-02 08:00:00+00:00
                    - 2020-11-02 09:00:00+00:00
                    - 2020-11-02 10:00:00+00:00
                    - 2020-11-02 11:00:00+00:00
                    - 2020-11-02 12:00:00+00:00
                    - 2020-11-02 13:00:00+00:00
                    - 2020-11-02 14:00:00+00:00
                    - 2020-11-02 15:00:00+00:00
                    - 2020-11-02 16:00:00+00:00
                    - 2020-11-02 17:00:00+00:00
                    - 2020-11-02 18:00:00+00:00
                    - 2020-11-02 19:00:00+00:00
                    start: 1604260800
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_device_metrics'
                - description: Time-series insight metric response for a device
                  examples:
                  - end: 1604347200
                    interval: 3600
                    limit: 168
                    page: 1
                    results:
                    - 10
                    - 11
                    - 12
                    - 12
                    - 10
                    - 9
                    - 9
                    - 9
                    - 10
                    - 10
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    rt:
                    - 2020-11-01 20:00:00+00:00
                    - 2020-11-01 21:00:00+00:00
                    - 2020-11-01 22:00:00+00:00
                    - 2020-11-01 23:00:00+00:00
                    - 2020-11-02 00:00:00+00:00
                    - 2020-11-02 01:00:00+00:00
                    - 2020-11-02 02:00:00+00:00
                    - 2020-11-02 03:00:00+00:00
                    - 2020-11-02 04:00:00+00:00
                    - 2020-11-02 05:00:00+00:00
                    - 2020-11-02 06:00:00+00:00
                    - 2020-11-02 07:00:00+00:00
                    - 2020-11-02 08:00:00+00:00
                    - 2020-11-02 09:00:00+00:00
                    - 2020-11-02 10:00:00+00:00
                    - 2020-11-02 11:00:00+00:00
                    - 2020-11-02 12:00:00+00:00
                    - 2020-11-02 13:00:00+00:00
                    - 2020-11-02 14:00:00+00:00
                    - 2020-11-02 15:00:00+00:00
                    - 2020-11-02 16:00:00+00:00
                    - 2020-11-02 17:00:00+00:00
                    - 2020-11-02 18:00:00+00:00
                    - 2020-11-02 19:00:00+00:00
                    start: 1604260800
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1604347200
                    interval: 3600
                    limit: 168
                    page: 1
                    results:
                    - 10
                    - 11
                    - 12
                    - 12
                    - 10
                    - 9
                    - 9
                    - 9
                    - 10
                    - 10
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    rt:
                    - 2020-11-01 20:00:00+00:00
                    - 2020-11-01 21:00:00+00:00
                    - 2020-11-01 22:00:00+00:00
                    - 2020-11-01 23:00:00+00:00
                    - 2020-11-02 00:00:00+00:00
                    - 2020-11-02 01:00:00+00:00
                    - 2020-11-02 02:00:00+00:00
                    - 2020-11-02 03:00:00+00:00
                    - 2020-11-02 04:00:00+00:00
                    - 2020-11-02 05:00:00+00:00
                    - 2020-11-02 06:00:00+00:00
                    - 2020-11-02 07:00:00+00:00
                    - 2020-11-02 08:00:00+00:00
                    - 2020-11-02 09:00:00+00:00
                    - 2020-11-02 10:00:00+00:00
                    - 2020-11-02 11:00:00+00:00
                    - 2020-11-02 12:00:00+00:00
                    - 2020-11-02 13:00:00+00:00
                    - 2020-11-02 14:00:00+00:00
                    - 2020-11-02 15:00:00+00:00
                    - 2020-11-02 16:00:00+00:00
                    - 2020-11-02 17:00:00+00:00
                    - 2020-11-02 18:00:00+00:00
                    - 2020-11-02 19:00:00+00:00
                    start: 1604260800
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/insights/client/{client_mac}:
    get:
      tags:
      - Sites Insights
      summary: getSiteInsightMetricsForClient
      description: Get Client Insight Metrics
      operationId: getSiteInsightMetricsForClient
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: client_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      - name: metrics
        in: query
        description: Comma separated Metric names, e.g. `top-app-by-num_client,top-app-by-bytes`. See possible values at [List Insight Metrics](/#operations/listInsightMetrics)
        required: true
        style: form
        explode: true
        schema:
          type: string
          examples:
          - top-app-by-num_client,top-app-by-bytes
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: interval
        in: query
        description: Aggregation works by giving a time range plus interval (e.g. 1d, 1h, 10m) where aggregation function would be applied to.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/insight_metrics'
                - description: Insight metric response for a requested time range and aggregation interval
                  examples:
                  - end: 0
                    interval: 0
                    results:
                    - {}
                    start: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 0
                    interval: 0
                    results:
                    - {}
                    start: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/insight_metrics'
                - description: Insight metric response for a requested time range and aggregation interval
                  examples:
                  - end: 0
                    interval: 0
                    results:
                    - {}
                    start: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 0
                    interval: 0
                    results:
                    - {}
                    start: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/insights/device/{device_mac}/{metric}:
    get:
      tags:
      - Sites Insights
      summary: getSiteInsightMetricsForDevice
      description: >-
        Get AP Insight Metrics

        See metrics possibilities at [List Insight Metrics]($e/Constants%20Definitions/listInsightMetrics)
      operationId: getSiteInsightMetricsForDevice
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: metric
        in: path
        description: See [List Insight Metrics]($e/Constants%20Definitions/listInsightMetrics) for available metrics
        required: true
        schema:
          type: string
      - name: device_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      - name: port_id
        in: query
        description: Port ID of the device, e.g. `ge-0/0/1`. Can be used with metrics related to interfaces, e.g. `rx_bytes`.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - ge-0/0/1
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: interval
        in: query
        description: Aggregation works by giving a time range plus interval (e.g. 1d, 1h, 10m) where aggregation function would be applied to.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_device_metrics'
                - description: Time-series insight metric response for a device
                  examples:
                  - end: 1604347200
                    interval: 3600
                    limit: 168
                    page: 1
                    results:
                    - 10
                    - 11
                    - 12
                    - 12
                    - 10
                    - 9
                    - 9
                    - 9
                    - 10
                    - 10
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    rt:
                    - 2020-11-01 20:00:00+00:00
                    - 2020-11-01 21:00:00+00:00
                    - 2020-11-01 22:00:00+00:00
                    - 2020-11-01 23:00:00+00:00
                    - 2020-11-02 00:00:00+00:00
                    - 2020-11-02 01:00:00+00:00
                    - 2020-11-02 02:00:00+00:00
                    - 2020-11-02 03:00:00+00:00
                    - 2020-11-02 04:00:00+00:00
                    - 2020-11-02 05:00:00+00:00
                    - 2020-11-02 06:00:00+00:00
                    - 2020-11-02 07:00:00+00:00
                    - 2020-11-02 08:00:00+00:00
                    - 2020-11-02 09:00:00+00:00
                    - 2020-11-02 10:00:00+00:00
                    - 2020-11-02 11:00:00+00:00
                    - 2020-11-02 12:00:00+00:00
                    - 2020-11-02 13:00:00+00:00
                    - 2020-11-02 14:00:00+00:00
                    - 2020-11-02 15:00:00+00:00
                    - 2020-11-02 16:00:00+00:00
                    - 2020-11-02 17:00:00+00:00
                    - 2020-11-02 18:00:00+00:00
                    - 2020-11-02 19:00:00+00:00
                    start: 1604260800
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1604347200
                    interval: 3600
                    limit: 168
                    page: 1
                    results:
                    - 10
                    - 11
                    - 12
                    - 12
                    - 10
                    - 9
                    - 9
                    - 9
                    - 10
                    - 10
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    rt:
                    - 2020-11-01 20:00:00+00:00
                    - 2020-11-01 21:00:00+00:00
                    - 2020-11-01 22:00:00+00:00
                    - 2020-11-01 23:00:00+00:00
                    - 2020-11-02 00:00:00+00:00
                    - 2020-11-02 01:00:00+00:00
                    - 2020-11-02 02:00:00+00:00
                    - 2020-11-02 03:00:00+00:00
                    - 2020-11-02 04:00:00+00:00
                    - 2020-11-02 05:00:00+00:00
                    - 2020-11-02 06:00:00+00:00
                    - 2020-11-02 07:00:00+00:00
                    - 2020-11-02 08:00:00+00:00
                    - 2020-11-02 09:00:00+00:00
                    - 2020-11-02 10:00:00+00:00
                    - 2020-11-02 11:00:00+00:00
                    - 2020-11-02 12:00:00+00:00
                    - 2020-11-02 13:00:00+00:00
                    - 2020-11-02 14:00:00+00:00
                    - 2020-11-02 15:00:00+00:00
                    - 2020-11-02 16:00:00+00:00
                    - 2020-11-02 17:00:00+00:00
                    - 2020-11-02 18:00:00+00:00
                    - 2020-11-02 19:00:00+00:00
                    start: 1604260800
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_device_metrics'
                - description: Time-series insight metric response for a device
                  examples:
                  - end: 1604347200
                    interval: 3600
                    limit: 168
                    page: 1
                    results:
                    - 10
                    - 11
                    - 12
                    - 12
                    - 10
                    - 9
                    - 9
                    - 9
                    - 10
                    - 10
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    rt:
                    - 2020-11-01 20:00:00+00:00
                    - 2020-11-01 21:00:00+00:00
                    - 2020-11-01 22:00:00+00:00
                    - 2020-11-01 23:00:00+00:00
                    - 2020-11-02 00:00:00+00:00
                    - 2020-11-02 01:00:00+00:00
                    - 2020-11-02 02:00:00+00:00
                    - 2020-11-02 03:00:00+00:00
                    - 2020-11-02 04:00:00+00:00
                    - 2020-11-02 05:00:00+00:00
                    - 2020-11-02 06:00:00+00:00
                    - 2020-11-02 07:00:00+00:00
                    - 2020-11-02 08:00:00+00:00
                    - 2020-11-02 09:00:00+00:00
                    - 2020-11-02 10:00:00+00:00
                    - 2020-11-02 11:00:00+00:00
                    - 2020-11-02 12:00:00+00:00
                    - 2020-11-02 13:00:00+00:00
                    - 2020-11-02 14:00:00+00:00
                    - 2020-11-02 15:00:00+00:00
                    - 2020-11-02 16:00:00+00:00
                    - 2020-11-02 17:00:00+00:00
                    - 2020-11-02 18:00:00+00:00
                    - 2020-11-02 19:00:00+00:00
                    start: 1604260800
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1604347200
                    interval: 3600
                    limit: 168
                    page: 1
                    results:
                    - 10
                    - 11
                    - 12
                    - 12
                    - 10
                    - 9
                    - 9
                    - 9
                    - 10
                    - 10
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    rt:
                    - 2020-11-01 20:00:00+00:00
                    - 2020-11-01 21:00:00+00:00
                    - 2020-11-01 22:00:00+00:00
                    - 2020-11-01 23:00:00+00:00
                    - 2020-11-02 00:00:00+00:00
                    - 2020-11-02 01:00:00+00:00
                    - 2020-11-02 02:00:00+00:00
                    - 2020-11-02 03:00:00+00:00
                    - 2020-11-02 04:00:00+00:00
                    - 2020-11-02 05:00:00+00:00
                    - 2020-11-02 06:00:00+00:00
                    - 2020-11-02 07:00:00+00:00
                    - 2020-11-02 08:00:00+00:00
                    - 2020-11-02 09:00:00+00:00
                    - 2020-11-02 10:00:00+00:00
                    - 2020-11-02 11:00:00+00:00
                    - 2020-11-02 12:00:00+00:00
                    - 2020-11-02 13:00:00+00:00
                    - 2020-11-02 14:00:00+00:00
                    - 2020-11-02 15:00:00+00:00
                    - 2020-11-02 16:00:00+00:00
                    - 2020-11-02 17:00:00+00:00
                    - 2020-11-02 18:00:00+00:00
                    - 2020-11-02 19:00:00+00:00
                    start: 1604260800
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/insights/gateway/{device_id}/stats:
    get:
      tags:
      - Sites Insights
      summary: getSiteInsightMetricsForGateway
      description: Get Gateway Insight Metrics
      operationId: getSiteInsightMetricsForGateway
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: metrics
        in: query
        description: Comma separated Metric names, e.g. `tx_bps,rx_bps`. See possible values at [List Insight Metrics](/#operations/listInsightMetrics)
        required: true
        style: form
        explode: true
        schema:
          type: string
          examples:
          - tx_bps,rx_bps
      - name: port_id
        in: query
        description: Port ID of the gateway device, e.g. `ge-0/0/1`
        style: form
        explode: true
        schema:
          type: string
          examples:
          - ge-0/0/1
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: interval
        in: query
        description: Aggregation works by giving a time range plus interval (e.g. 1d, 1h, 10m) where aggregation function would be applied to.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_device_metrics'
                - description: Time-series insight metric response for a device
                  examples:
                  - end: 1604347200
                    interval: 3600
                    limit: 168
                    page: 1
                    results:
                    - 10
                    - 11
                    - 12
                    - 12
                    - 10
                    - 9
                    - 9
                    - 9
                    - 10
                    - 10
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    rt:
                    - 2020-11-01 20:00:00+00:00
                    - 2020-11-01 21:00:00+00:00
                    - 2020-11-01 22:00:00+00:00
                    - 2020-11-01 23:00:00+00:00
                    - 2020-11-02 00:00:00+00:00
                    - 2020-11-02 01:00:00+00:00
                    - 2020-11-02 02:00:00+00:00
                    - 2020-11-02 03:00:00+00:00
                    - 2020-11-02 04:00:00+00:00
                    - 2020-11-02 05:00:00+00:00
                    - 2020-11-02 06:00:00+00:00
                    - 2020-11-02 07:00:00+00:00
                    - 2020-11-02 08:00:00+00:00
                    - 2020-11-02 09:00:00+00:00
                    - 2020-11-02 10:00:00+00:00
                    - 2020-11-02 11:00:00+00:00
                    - 2020-11-02 12:00:00+00:00
                    - 2020-11-02 13:00:00+00:00
                    - 2020-11-02 14:00:00+00:00
                    - 2020-11-02 15:00:00+00:00
                    - 2020-11-02 16:00:00+00:00
                    - 2020-11-02 17:00:00+00:00
                    - 2020-11-02 18:00:00+00:00
                    - 2020-11-02 19:00:00+00:00
                    start: 1604260800
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1604347200
                    interval: 3600
                    limit: 168
                    page: 1
                    results:
                    - 10
                    - 11
                    - 12
                    - 12
                    - 10
                    - 9
                    - 9
                    - 9
                    - 10
                    - 10
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    rt:
                    - 2020-11-01 20:00:00+00:00
                    - 2020-11-01 21:00:00+00:00
                    - 2020-11-01 22:00:00+00:00
                    - 2020-11-01 23:00:00+00:00
                    - 2020-11-02 00:00:00+00:00
                    - 2020-11-02 01:00:00+00:00
                    - 2020-11-02 02:00:00+00:00
                    - 2020-11-02 03:00:00+00:00
                    - 2020-11-02 04:00:00+00:00
                    - 2020-11-02 05:00:00+00:00
                    - 2020-11-02 06:00:00+00:00
                    - 2020-11-02 07:00:00+00:00
                    - 2020-11-02 08:00:00+00:00
                    - 2020-11-02 09:00:00+00:00
                    - 2020-11-02 10:00:00+00:00
                    - 2020-11-02 11:00:00+00:00
                    - 2020-11-02 12:00:00+00:00
                    - 2020-11-02 13:00:00+00:00
                    - 2020-11-02 14:00:00+00:00
                    - 2020-11-02 15:00:00+00:00
                    - 2020-11-02 16:00:00+00:00
                    - 2020-11-02 17:00:00+00:00
                    - 2020-11-02 18:00:00+00:00
                    - 2020-11-02 19:00:00+00:00
                    start: 1604260800
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_device_metrics'
                - description: Time-series insight metric response for a device
                  examples:
                  - end: 1604347200
                    interval: 3600
                    limit: 168
                    page: 1
                    results:
                    - 10
                    - 11
                    - 12
                    - 12
                    - 10
                    - 9
                    - 9
                    - 9
                    - 10
                    - 10
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    rt:
                    - 2020-11-01 20:00:00+00:00
                    - 2020-11-01 21:00:00+00:00
                    - 2020-11-01 22:00:00+00:00
                    - 2020-11-01 23:00:00+00:00
                    - 2020-11-02 00:00:00+00:00
                    - 2020-11-02 01:00:00+00:00
                    - 2020-11-02 02:00:00+00:00
                    - 2020-11-02 03:00:00+00:00
                    - 2020-11-02 04:00:00+00:00
                    - 2020-11-02 05:00:00+00:00
                    - 2020-11-02 06:00:00+00:00
                    - 2020-11-02 07:00:00+00:00
                    - 2020-11-02 08:00:00+00:00
                    - 2020-11-02 09:00:00+00:00
                    - 2020-11-02 10:00:00+00:00
                    - 2020-11-02 11:00:00+00:00
                    - 2020-11-02 12:00:00+00:00
                    - 2020-11-02 13:00:00+00:00
                    - 2020-11-02 14:00:00+00:00
                    - 2020-11-02 15:00:00+00:00
                    - 2020-11-02 16:00:00+00:00
                    - 2020-11-02 17:00:00+00:00
                    - 2020-11-02 18:00:00+00:00
                    - 2020-11-02 19:00:00+00:00
                    start: 1604260800
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1604347200
                    interval: 3600
                    limit: 168
                    page: 1
                    results:
                    - 10
                    - 11
                    - 12
                    - 12
                    - 10
                    - 9
                    - 9
                    - 9
                    - 10
                    - 10
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    rt:
                    - 2020-11-01 20:00:00+00:00
                    - 2020-11-01 21:00:00+00:00
                    - 2020-11-01 22:00:00+00:00
                    - 2020-11-01 23:00:00+00:00
                    - 2020-11-02 00:00:00+00:00
                    - 2020-11-02 01:00:00+00:00
                    - 2020-11-02 02:00:00+00:00
                    - 2020-11-02 03:00:00+00:00
                    - 2020-11-02 04:00:00+00:00
                    - 2020-11-02 05:00:00+00:00
                    - 2020-11-02 06:00:00+00:00
                    - 2020-11-02 07:00:00+00:00
                    - 2020-11-02 08:00:00+00:00
                    - 2020-11-02 09:00:00+00:00
                    - 2020-11-02 10:00:00+00:00
                    - 2020-11-02 11:00:00+00:00
                    - 2020-11-02 12:00:00+00:00
                    - 2020-11-02 13:00:00+00:00
                    - 2020-11-02 14:00:00+00:00
                    - 2020-11-02 15:00:00+00:00
                    - 2020-11-02 16:00:00+00:00
                    - 2020-11-02 17:00:00+00:00
                    - 2020-11-02 18:00:00+00:00
                    - 2020-11-02 19:00:00+00:00
                    start: 1604260800
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/insights/mxedge/{device_mac}/{metric}:
    get:
      tags:
      - Sites Insights
      summary: getSiteInsightMetricsForMxEdge
      description: >-
        Get MxEdge Insight Metrics

        See metrics possibilities at [List Insight Metrics](/#operations/listInsightMetrics)
      operationId: getSiteInsightMetricsForMxEdge
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: metric
        in: path
        description: See [List Insight Metrics]($e/Constants%20Definitions/listInsightMetrics) for available metrics
        required: true
        schema:
          type: string
      - name: device_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      - name: port_id
        in: query
        description: Port ID of the MxEdge device, e.g. `port0`. Can be used with metrics related to interfaces, e.g. `rx_bytes`.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - port0
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: interval
        in: query
        description: Aggregation works by giving a time range plus interval (e.g. 1d, 1h, 10m) where aggregation function would be applied to.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_device_metrics'
                - description: Time-series insight metric response for a device
                  examples:
                  - end: 1604347200
                    interval: 3600
                    limit: 168
                    page: 1
                    results:
                    - 10
                    - 11
                    - 12
                    - 12
                    - 10
                    - 9
                    - 9
                    - 9
                    - 10
                    - 10
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    rt:
                    - 2020-11-01 20:00:00+00:00
                    - 2020-11-01 21:00:00+00:00
                    - 2020-11-01 22:00:00+00:00
                    - 2020-11-01 23:00:00+00:00
                    - 2020-11-02 00:00:00+00:00
                    - 2020-11-02 01:00:00+00:00
                    - 2020-11-02 02:00:00+00:00
                    - 2020-11-02 03:00:00+00:00
                    - 2020-11-02 04:00:00+00:00
                    - 2020-11-02 05:00:00+00:00
                    - 2020-11-02 06:00:00+00:00
                    - 2020-11-02 07:00:00+00:00
                    - 2020-11-02 08:00:00+00:00
                    - 2020-11-02 09:00:00+00:00
                    - 2020-11-02 10:00:00+00:00
                    - 2020-11-02 11:00:00+00:00
                    - 2020-11-02 12:00:00+00:00
                    - 2020-11-02 13:00:00+00:00
                    - 2020-11-02 14:00:00+00:00
                    - 2020-11-02 15:00:00+00:00
                    - 2020-11-02 16:00:00+00:00
                    - 2020-11-02 17:00:00+00:00
                    - 2020-11-02 18:00:00+00:00
                    - 2020-11-02 19:00:00+00:00
                    start: 1604260800
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1604347200
                    interval: 3600
                    limit: 168
                    page: 1
                    results:
                    - 10
                    - 11
                    - 12
                    - 12
                    - 10
                    - 9
                    - 9
                    - 9
                    - 10
                    - 10
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    rt:
                    - 2020-11-01 20:00:00+00:00
                    - 2020-11-01 21:00:00+00:00
                    - 2020-11-01 22:00:00+00:00
                    - 2020-11-01 23:00:00+00:00
                    - 2020-11-02 00:00:00+00:00
                    - 2020-11-02 01:00:00+00:00
                    - 2020-11-02 02:00:00+00:00
                    - 2020-11-02 03:00:00+00:00
                    - 2020-11-02 04:00:00+00:00
                    - 2020-11-02 05:00:00+00:00
                    - 2020-11-02 06:00:00+00:00
                    - 2020-11-02 07:00:00+00:00
                    - 2020-11-02 08:00:00+00:00
                    - 2020-11-02 09:00:00+00:00
                    - 2020-11-02 10:00:00+00:00
                    - 2020-11-02 11:00:00+00:00
                    - 2020-11-02 12:00:00+00:00
                    - 2020-11-02 13:00:00+00:00
                    - 2020-11-02 14:00:00+00:00
                    - 2020-11-02 15:00:00+00:00
                    - 2020-11-02 16:00:00+00:00
                    - 2020-11-02 17:00:00+00:00
                    - 2020-11-02 18:00:00+00:00
                    - 2020-11-02 19:00:00+00:00
                    start: 1604260800
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_device_metrics'
                - description: Time-series insight metric response for a device
                  examples:
                  - end: 1604347200
                    interval: 3600
                    limit: 168
                    page: 1
                    results:
                    - 10
                    - 11
                    - 12
                    - 12
                    - 10
                    - 9
                    - 9
                    - 9
                    - 10
                    - 10
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    rt:
                    - 2020-11-01 20:00:00+00:00
                    - 2020-11-01 21:00:00+00:00
                    - 2020-11-01 22:00:00+00:00
                    - 2020-11-01 23:00:00+00:00
                    - 2020-11-02 00:00:00+00:00
                    - 2020-11-02 01:00:00+00:00
                    - 2020-11-02 02:00:00+00:00
                    - 2020-11-02 03:00:00+00:00
                    - 2020-11-02 04:00:00+00:00
                    - 2020-11-02 05:00:00+00:00
                    - 2020-11-02 06:00:00+00:00
                    - 2020-11-02 07:00:00+00:00
                    - 2020-11-02 08:00:00+00:00
                    - 2020-11-02 09:00:00+00:00
                    - 2020-11-02 10:00:00+00:00
                    - 2020-11-02 11:00:00+00:00
                    - 2020-11-02 12:00:00+00:00
                    - 2020-11-02 13:00:00+00:00
                    - 2020-11-02 14:00:00+00:00
                    - 2020-11-02 15:00:00+00:00
                    - 2020-11-02 16:00:00+00:00
                    - 2020-11-02 17:00:00+00:00
                    - 2020-11-02 18:00:00+00:00
                    - 2020-11-02 19:00:00+00:00
                    start: 1604260800
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1604347200
                    interval: 3600
                    limit: 168
                    page: 1
                    results:
                    - 10
                    - 11
                    - 12
                    - 12
                    - 10
                    - 9
                    - 9
                    - 9
                    - 10
                    - 10
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    rt:
                    - 2020-11-01 20:00:00+00:00
                    - 2020-11-01 21:00:00+00:00
                    - 2020-11-01 22:00:00+00:00
                    - 2020-11-01 23:00:00+00:00
                    - 2020-11-02 00:00:00+00:00
                    - 2020-11-02 01:00:00+00:00
                    - 2020-11-02 02:00:00+00:00
                    - 2020-11-02 03:00:00+00:00
                    - 2020-11-02 04:00:00+00:00
                    - 2020-11-02 05:00:00+00:00
                    - 2020-11-02 06:00:00+00:00
                    - 2020-11-02 07:00:00+00:00
                    - 2020-11-02 08:00:00+00:00
                    - 2020-11-02 09:00:00+00:00
                    - 2020-11-02 10:00:00+00:00
                    - 2020-11-02 11:00:00+00:00
                    - 2020-11-02 12:00:00+00:00
                    - 2020-11-02 13:00:00+00:00
                    - 2020-11-02 14:00:00+00:00
                    - 2020-11-02 15:00:00+00:00
                    - 2020-11-02 16:00:00+00:00
                    - 2020-11-02 17:00:00+00:00
                    - 2020-11-02 18:00:00+00:00
                    - 2020-11-02 19:00:00+00:00
                    start: 1604260800
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/insights/switch/{device_mac}/{metric}:
    get:
      tags:
      - Sites Insights
      summary: getSiteInsightMetricsForSwitch
      description: >-
        Get Switch Insight Metrics

        See metrics possibilities at [List Insight Metrics](/#operations/listInsightMetrics)
      operationId: getSiteInsightMetricsForSwitch
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: metric
        in: path
        description: See [List Insight Metrics]($e/Constants%20Definitions/listInsightMetrics) for available metrics
        required: true
        schema:
          type: string
      - name: device_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      - name: port_id
        in: query
        description: Port ID of the switch device, e.g. `ge-0/0/1`. Can be used with metrics related to interfaces, e.g. `rx_bytes`.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - ge-0/0/1
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: interval
        in: query
        description: Aggregation works by giving a time range plus interval (e.g. 1d, 1h, 10m) where aggregation function would be applied to.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_device_metrics'
                - description: Time-series insight metric response for a device
                  examples:
                  - end: 1604347200
                    interval: 3600
                    limit: 168
                    page: 1
                    results:
                    - 10
                    - 11
                    - 12
                    - 12
                    - 10
                    - 9
                    - 9
                    - 9
                    - 10
                    - 10
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    rt:
                    - 2020-11-01 20:00:00+00:00
                    - 2020-11-01 21:00:00+00:00
                    - 2020-11-01 22:00:00+00:00
                    - 2020-11-01 23:00:00+00:00
                    - 2020-11-02 00:00:00+00:00
                    - 2020-11-02 01:00:00+00:00
                    - 2020-11-02 02:00:00+00:00
                    - 2020-11-02 03:00:00+00:00
                    - 2020-11-02 04:00:00+00:00
                    - 2020-11-02 05:00:00+00:00
                    - 2020-11-02 06:00:00+00:00
                    - 2020-11-02 07:00:00+00:00
                    - 2020-11-02 08:00:00+00:00
                    - 2020-11-02 09:00:00+00:00
                    - 2020-11-02 10:00:00+00:00
                    - 2020-11-02 11:00:00+00:00
                    - 2020-11-02 12:00:00+00:00
                    - 2020-11-02 13:00:00+00:00
                    - 2020-11-02 14:00:00+00:00
                    - 2020-11-02 15:00:00+00:00
                    - 2020-11-02 16:00:00+00:00
                    - 2020-11-02 17:00:00+00:00
                    - 2020-11-02 18:00:00+00:00
                    - 2020-11-02 19:00:00+00:00
                    start: 1604260800
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1604347200
                    interval: 3600
                    limit: 168
                    page: 1
                    results:
                    - 10
                    - 11
                    - 12
                    - 12
                    - 10
                    - 9
                    - 9
                    - 9
                    - 10
                    - 10
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    rt:
                    - 2020-11-01 20:00:00+00:00
                    - 2020-11-01 21:00:00+00:00
                    - 2020-11-01 22:00:00+00:00
                    - 2020-11-01 23:00:00+00:00
                    - 2020-11-02 00:00:00+00:00
                    - 2020-11-02 01:00:00+00:00
                    - 2020-11-02 02:00:00+00:00
                    - 2020-11-02 03:00:00+00:00
                    - 2020-11-02 04:00:00+00:00
                    - 2020-11-02 05:00:00+00:00
                    - 2020-11-02 06:00:00+00:00
                    - 2020-11-02 07:00:00+00:00
                    - 2020-11-02 08:00:00+00:00
                    - 2020-11-02 09:00:00+00:00
                    - 2020-11-02 10:00:00+00:00
                    - 2020-11-02 11:00:00+00:00
                    - 2020-11-02 12:00:00+00:00
                    - 2020-11-02 13:00:00+00:00
                    - 2020-11-02 14:00:00+00:00
                    - 2020-11-02 15:00:00+00:00
                    - 2020-11-02 16:00:00+00:00
                    - 2020-11-02 17:00:00+00:00
                    - 2020-11-02 18:00:00+00:00
                    - 2020-11-02 19:00:00+00:00
                    start: 1604260800
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_device_metrics'
                - description: Time-series insight metric response for a device
                  examples:
                  - end: 1604347200
                    interval: 3600
                    limit: 168
                    page: 1
                    results:
                    - 10
                    - 11
                    - 12
                    - 12
                    - 10
                    - 9
                    - 9
                    - 9
                    - 10
                    - 10
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    rt:
                    - 2020-11-01 20:00:00+00:00
                    - 2020-11-01 21:00:00+00:00
                    - 2020-11-01 22:00:00+00:00
                    - 2020-11-01 23:00:00+00:00
                    - 2020-11-02 00:00:00+00:00
                    - 2020-11-02 01:00:00+00:00
                    - 2020-11-02 02:00:00+00:00
                    - 2020-11-02 03:00:00+00:00
                    - 2020-11-02 04:00:00+00:00
                    - 2020-11-02 05:00:00+00:00
                    - 2020-11-02 06:00:00+00:00
                    - 2020-11-02 07:00:00+00:00
                    - 2020-11-02 08:00:00+00:00
                    - 2020-11-02 09:00:00+00:00
                    - 2020-11-02 10:00:00+00:00
                    - 2020-11-02 11:00:00+00:00
                    - 2020-11-02 12:00:00+00:00
                    - 2020-11-02 13:00:00+00:00
                    - 2020-11-02 14:00:00+00:00
                    - 2020-11-02 15:00:00+00:00
                    - 2020-11-02 16:00:00+00:00
                    - 2020-11-02 17:00:00+00:00
                    - 2020-11-02 18:00:00+00:00
                    - 2020-11-02 19:00:00+00:00
                    start: 1604260800
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1604347200
                    interval: 3600
                    limit: 168
                    page: 1
                    results:
                    - 10
                    - 11
                    - 12
                    - 12
                    - 10
                    - 9
                    - 9
                    - 9
                    - 10
                    - 10
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    - 11
                    - 11
                    - 10
                    rt:
                    - 2020-11-01 20:00:00+00:00
                    - 2020-11-01 21:00:00+00:00
                    - 2020-11-01 22:00:00+00:00
                    - 2020-11-01 23:00:00+00:00
                    - 2020-11-02 00:00:00+00:00
                    - 2020-11-02 01:00:00+00:00
                    - 2020-11-02 02:00:00+00:00
                    - 2020-11-02 03:00:00+00:00
                    - 2020-11-02 04:00:00+00:00
                    - 2020-11-02 05:00:00+00:00
                    - 2020-11-02 06:00:00+00:00
                    - 2020-11-02 07:00:00+00:00
                    - 2020-11-02 08:00:00+00:00
                    - 2020-11-02 09:00:00+00:00
                    - 2020-11-02 10:00:00+00:00
                    - 2020-11-02 11:00:00+00:00
                    - 2020-11-02 12:00:00+00:00
                    - 2020-11-02 13:00:00+00:00
                    - 2020-11-02 14:00:00+00:00
                    - 2020-11-02 15:00:00+00:00
                    - 2020-11-02 16:00:00+00:00
                    - 2020-11-02 17:00:00+00:00
                    - 2020-11-02 18:00:00+00:00
                    - 2020-11-02 19:00:00+00:00
                    start: 1604260800
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/setting/jse/info:
    get:
      tags:
      - Sites JSE
      summary: getSiteJseInfo
      description: Retrieves the list of JSE orgs associated with the account
      operationId: getSiteJseInfo
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/account_jse_info'
                - description: Linked Juniper Security Exchange account information
                  examples:
                  - cloud_name: devcentral.juniperclouds.net
                    org_names:
                    - Mist-Sys
                    - Mist-Eng
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    cloud_name: devcentral.juniperclouds.net
                    org_names:
                    - Mist-Sys
                    - Mist-Eng
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/account_jse_info'
                - description: Linked Juniper Security Exchange account information
                  examples:
                  - cloud_name: devcentral.juniperclouds.net
                    org_names:
                    - Mist-Sys
                    - Mist-Eng
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    cloud_name: devcentral.juniperclouds.net
                    org_names:
                    - Mist-Sys
                    - Mist-Eng
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/licenses/usages:
    get:
      tags:
      - Sites Licenses
      summary: getSiteLicenseUsage
      description: This shows license usage (i.e. needed) based on the features enabled for the site.
      operationId: getSiteLicenseUsage
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Site License Usage
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/license_usage_site'
                - description: Site license usage and entitlement response
                  examples:
                  - org_entitled:
                      SUB-LOC: 30
                      SUB-MAN: 60
                    svna_enabled: true
                    trial_enabled: true
                    usages:
                      SUB-LOC: 30
                      SUB-MAN: 60
                    vna_eligible: true
                    vna_ui: true
                    wvna_eligible: true
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    org_entitled:
                      SUB-LOC: 30
                      SUB-MAN: 60
                    svna_enabled: true
                    trial_enabled: true
                    usages:
                      SUB-LOC: 30
                      SUB-MAN: 60
                    vna_eligible: true
                    vna_ui: true
                    wvna_eligible: true
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/license_usage_site'
                - description: Site license usage and entitlement response
                  examples:
                  - org_entitled:
                      SUB-LOC: 30
                      SUB-MAN: 60
                    svna_enabled: true
                    trial_enabled: true
                    usages:
                      SUB-LOC: 30
                      SUB-MAN: 60
                    vna_eligible: true
                    vna_ui: true
                    wvna_eligible: true
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    org_entitled:
                      SUB-LOC: 30
                      SUB-MAN: 60
                    svna_enabled: true
                    trial_enabled: true
                    usages:
                      SUB-LOC: 30
                      SUB-MAN: 60
                    vna_eligible: true
                    vna_ui: true
                    wvna_eligible: true
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/location/coverage:
    get:
      tags:
      - Sites Location
      summary: getSiteBeamCoverageOverview
      description: Get Beam Coverage Overview
      operationId: getSiteBeamCoverageOverview
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: map_id
        in: query
        description: Filter results by map identifier
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 00000000-0000-0000-0000-000000000000
      - name: type
        in: query
        description: 'Filter results by type. enum: `asset`, `client`, `sdkclient`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/rf_client_type'
          - description: 'Filter results by type. enum: `asset`, `client`, `sdkclient`'
      - name: client_type
        in: query
        description: Filter results by client type
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: resolution
        in: query
        description: 'Location calculation resolution used by the query. enum: `default`, `fine`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/resolution'
          - description: 'Location calculation resolution used by the query. enum: `default`, `fine`'
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_location_coverage'
                - description: Beam coverage overview for a site location map
                  examples:
                  - beams_means:
                    - - 1
                      - 3
                      - 3.2
                    - - 6
                      - 10
                      - 6.5
                    end: 1428954000
                    gridsize: 1
                    result_def:
                    - x
                    - y
                    - beams_mean
                    - beacons_mean
                    - max_rssi
                    - avg_rssi
                    results:
                    - - 1
                      - 3
                      - 3.2
                      - 18.5
                      - -68
                      - -70
                    - - 6
                      - 10
                      - 6.5
                      - 30
                      - 1
                      - -72.5
                      - -75
                    start: 1428939600
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    beams_means:
                    - - 1
                      - 3
                      - 3.2
                    - - 6
                      - 10
                      - 6.5
                    end: 1428954000
                    gridsize: 1
                    result_def:
                    - x
                    - y
                    - beams_mean
                    - beacons_mean
                    - max_rssi
                    - avg_rssi
                    results:
                    - - 1
                      - 3
                      - 3.2
                      - 18.5
                      - -68
                      - -70
                    - - 6
                      - 10
                      - 6.5
                      - 30
                      - 1
                      - -72.5
                      - -75
                    start: 1428939600
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_location_coverage'
                - description: Beam coverage overview for a site location map
                  examples:
                  - beams_means:
                    - - 1
                      - 3
                      - 3.2
                    - - 6
                      - 10
                      - 6.5
                    end: 1428954000
                    gridsize: 1
                    result_def:
                    - x
                    - y
                    - beams_mean
                    - beacons_mean
                    - max_rssi
                    - avg_rssi
                    results:
                    - - 1
                      - 3
                      - 3.2
                      - 18.5
                      - -68
                      - -70
                    - - 6
                      - 10
                      - 6.5
                      - 30
                      - 1
                      - -72.5
                      - -75
                    start: 1428939600
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    beams_means:
                    - - 1
                      - 3
                      - 3.2
                    - - 6
                      - 10
                      - 6.5
                    end: 1428954000
                    gridsize: 1
                    result_def:
                    - x
                    - y
                    - beams_mean
                    - beacons_mean
                    - max_rssi
                    - avg_rssi
                    results:
                    - - 1
                      - 3
                      - 3.2
                      - 18.5
                      - -68
                      - -70
                    - - 6
                      - 10
                      - 6.5
                      - 30
                      - 1
                      - -72.5
                      - -75
                    start: 1428939600
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/location/ml/current:
    get:
      tags:
      - Sites Location
      summary: getSiteMachineLearningCurrentStat
      description: >-
        Get Machine Learning Current Stat

        For each VBLE AP, it has ML model parameters (e.g. Path-loss-estimate, Intercept) as well as completion indicators (Level and PercentageComplete). For the completeness, ML takes N sample to finish its first level and use N*0.25 samples to complete each successive level. When a device is moved, the completeness will be reset as it has to re-learn.
      operationId: getSiteMachineLearningCurrentStat
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: map_id
        in: query
        description: Filter results by map identifier
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                uniqueItems: true
                type: array
                items:
                  type: object
                description: Machine-learning response records returned as opaque objects
                examples:
                - - current:
                      Android:
                        completed: 36
                        int: -6
                        level: 3
                        ple: -3
                        quality: '4'
                        src: device
                        timestamp: 1442854794
                      iOS:
                        completed: 16
                        int: -6
                        level: 6
                        ple: -3
                        quality: '2'
                        src: default
                        timestamp: 1442854704
                      iPod:
                        int: -10
                        overwrite: true
                        ple: -5
                        src: overwrite
                    device_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  - beacon_id: 7913f032-aab4-c3ae-e83e-5a2756ef4d40
                    current:
                      iOS:
                        completed: 16
                        int: -6
                        level: 6
                        ple: -3
                        quality: last
                        src: device
                        timestamp: 1442854704
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - current:
                      Android:
                        completed: 36
                        int: -6
                        level: 3
                        ple: -3
                        quality: '4'
                        src: device
                        timestamp: 1442854794
                      iOS:
                        completed: 16
                        int: -6
                        level: 6
                        ple: -3
                        quality: '2'
                        src: default
                        timestamp: 1442854704
                      iPod:
                        int: -10
                        overwrite: true
                        ple: -5
                        src: overwrite
                    device_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  - beacon_id: 7913f032-aab4-c3ae-e83e-5a2756ef4d40
                    current:
                      iOS:
                        completed: 16
                        int: -6
                        level: 6
                        ple: -3
                        quality: last
                        src: device
                        timestamp: 1442854704
            application/vnd.api+json:
              schema:
                uniqueItems: true
                type: array
                items:
                  type: object
                description: Machine-learning response records returned as opaque objects
                examples:
                - - current:
                      Android:
                        completed: 36
                        int: -6
                        level: 3
                        ple: -3
                        quality: '4'
                        src: device
                        timestamp: 1442854794
                      iOS:
                        completed: 16
                        int: -6
                        level: 6
                        ple: -3
                        quality: '2'
                        src: default
                        timestamp: 1442854704
                      iPod:
                        int: -10
                        overwrite: true
                        ple: -5
                        src: overwrite
                    device_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  - beacon_id: 7913f032-aab4-c3ae-e83e-5a2756ef4d40
                    current:
                      iOS:
                        completed: 16
                        int: -6
                        level: 6
                        ple: -3
                        quality: last
                        src: device
                        timestamp: 1442854704
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - current:
                      Android:
                        completed: 36
                        int: -6
                        level: 3
                        ple: -3
                        quality: '4'
                        src: device
                        timestamp: 1442854794
                      iOS:
                        completed: 16
                        int: -6
                        level: 6
                        ple: -3
                        quality: '2'
                        src: default
                        timestamp: 1442854704
                      iPod:
                        int: -10
                        overwrite: true
                        ple: -5
                        src: overwrite
                    device_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  - beacon_id: 7913f032-aab4-c3ae-e83e-5a2756ef4d40
                    current:
                      iOS:
                        completed: 16
                        int: -6
                        level: 6
                        ple: -3
                        quality: last
                        src: device
                        timestamp: 1442854704
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/location/ml/defaults:
    get:
      tags:
      - Sites Location
      summary: getSiteDefaultPlfForModels
      description: Get Default PLF for Models
      operationId: getSiteDefaultPlfForModels
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                uniqueItems: true
                type: array
                items:
                  type: object
                description: Machine-learning response records returned as opaque objects
                examples:
                - - current:
                      Android:
                        completed: 36
                        int: -6
                        level: 3
                        ple: -3
                        quality: '4'
                        src: device
                        timestamp: 1442854794
                      iOS:
                        completed: 16
                        int: -6
                        level: 6
                        ple: -3
                        quality: '2'
                        src: default
                        timestamp: 1442854704
                      iPod:
                        int: -10
                        overwrite: true
                        ple: -5
                        src: overwrite
                    device_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  - beacon_id: 7913f032-aab4-c3ae-e83e-5a2756ef4d40
                    current:
                      iOS:
                        completed: 16
                        int: -6
                        level: 6
                        ple: -3
                        quality: last
                        src: device
                        timestamp: 1442854704
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - current:
                      Android:
                        completed: 36
                        int: -6
                        level: 3
                        ple: -3
                        quality: '4'
                        src: device
                        timestamp: 1442854794
                      iOS:
                        completed: 16
                        int: -6
                        level: 6
                        ple: -3
                        quality: '2'
                        src: default
                        timestamp: 1442854704
                      iPod:
                        int: -10
                        overwrite: true
                        ple: -5
                        src: overwrite
                    device_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  - beacon_id: 7913f032-aab4-c3ae-e83e-5a2756ef4d40
                    current:
                      iOS:
                        completed: 16
                        int: -6
                        level: 6
                        ple: -3
                        quality: last
                        src: device
                        timestamp: 1442854704
            application/vnd.api+json:
              schema:
                uniqueItems: true
                type: array
                items:
                  type: object
                description: Machine-learning response records returned as opaque objects
                examples:
                - - current:
                      Android:
                        completed: 36
                        int: -6
                        level: 3
                        ple: -3
                        quality: '4'
                        src: device
                        timestamp: 1442854794
                      iOS:
                        completed: 16
                        int: -6
                        level: 6
                        ple: -3
                        quality: '2'
                        src: default
                        timestamp: 1442854704
                      iPod:
                        int: -10
                        overwrite: true
                        ple: -5
                        src: overwrite
                    device_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  - beacon_id: 7913f032-aab4-c3ae-e83e-5a2756ef4d40
                    current:
                      iOS:
                        completed: 16
                        int: -6
                        level: 6
                        ple: -3
                        quality: last
                        src: device
                        timestamp: 1442854704
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - current:
                      Android:
                        completed: 36
                        int: -6
                        level: 3
                        ple: -3
                        quality: '4'
                        src: device
                        timestamp: 1442854794
                      iOS:
                        completed: 16
                        int: -6
                        level: 6
                        ple: -3
                        quality: '2'
                        src: default
                        timestamp: 1442854704
                      iPod:
                        int: -10
                        overwrite: true
                        ple: -5
                        src: overwrite
                    device_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  - beacon_id: 7913f032-aab4-c3ae-e83e-5a2756ef4d40
                    current:
                      iOS:
                        completed: 16
                        int: -6
                        level: 6
                        ple: -3
                        quality: last
                        src: device
                        timestamp: 1442854704
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/location/ml/device/{device_id}:
    delete:
      tags:
      - Sites Location
      summary: clearSiteMlOverwriteForDevice
      description: Clear ML Overwrite for Device
      operationId: clearSiteMlOverwriteForDevice
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Sites Location
      summary: overwriteSiteMlForDevice
      description: Overwrite ML For Device
      operationId: overwriteSiteMlForDevice
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              type: object
              additionalProperties:
                $ref: '#/components/schemas/ml_overwrite_additional_properties'
              description: Request Body
              examples:
              - iOS:
                  int: 6
                  ple: -3
                iPod:
                  int: -10
                  ple: -5
              contentMediaType: application/json
            examples:
              Example:
                value:
                  iOS:
                    int: 6
                    ple: -3
                  iPod:
                    int: -10
                    ple: -5
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                uniqueItems: true
                type: array
                items:
                  type: object
                description: Machine-learning response records returned as opaque objects
                examples:
                - - current:
                      Android:
                        completed: 36
                        int: -6
                        level: 3
                        ple: -3
                        quality: '4'
                        src: device
                        timestamp: 1442854794
                      iOS:
                        completed: 16
                        int: -6
                        level: 6
                        ple: -3
                        quality: '2'
                        src: default
                        timestamp: 1442854704
                      iPod:
                        int: -10
                        overwrite: true
                        ple: -5
                        src: overwrite
                    device_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  - beacon_id: 7913f032-aab4-c3ae-e83e-5a2756ef4d40
                    current:
                      iOS:
                        completed: 16
                        int: -6
                        level: 6
                        ple: -3
                        quality: last
                        src: device
                        timestamp: 1442854704
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - current:
                      Android:
                        completed: 36
                        int: -6
                        level: 3
                        ple: -3
                        quality: '4'
                        src: device
                        timestamp: 1442854794
                      iOS:
                        completed: 16
                        int: -6
                        level: 6
                        ple: -3
                        quality: '2'
                        src: default
                        timestamp: 1442854704
                      iPod:
                        int: -10
                        overwrite: true
                        ple: -5
                        src: overwrite
                    device_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  - beacon_id: 7913f032-aab4-c3ae-e83e-5a2756ef4d40
                    current:
                      iOS:
                        completed: 16
                        int: -6
                        level: 6
                        ple: -3
                        quality: last
                        src: device
                        timestamp: 1442854704
            application/vnd.api+json:
              schema:
                uniqueItems: true
                type: array
                items:
                  type: object
                description: Machine-learning response records returned as opaque objects
                examples:
                - - current:
                      Android:
                        completed: 36
                        int: -6
                        level: 3
                        ple: -3
                        quality: '4'
                        src: device
                        timestamp: 1442854794
                      iOS:
                        completed: 16
                        int: -6
                        level: 6
                        ple: -3
                        quality: '2'
                        src: default
                        timestamp: 1442854704
                      iPod:
                        int: -10
                        overwrite: true
                        ple: -5
                        src: overwrite
                    device_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  - beacon_id: 7913f032-aab4-c3ae-e83e-5a2756ef4d40
                    current:
                      iOS:
                        completed: 16
                        int: -6
                        level: 6
                        ple: -3
                        quality: last
                        src: device
                        timestamp: 1442854704
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - current:
                      Android:
                        completed: 36
                        int: -6
                        level: 3
                        ple: -3
                        quality: '4'
                        src: device
                        timestamp: 1442854794
                      iOS:
                        completed: 16
                        int: -6
                        level: 6
                        ple: -3
                        quality: '2'
                        src: default
                        timestamp: 1442854704
                      iPod:
                        int: -10
                        overwrite: true
                        ple: -5
                        src: overwrite
                    device_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  - beacon_id: 7913f032-aab4-c3ae-e83e-5a2756ef4d40
                    current:
                      iOS:
                        completed: 16
                        int: -6
                        level: 6
                        ple: -3
                        quality: last
                        src: device
                        timestamp: 1442854704
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/location/ml/map/{map_id}:
    delete:
      tags:
      - Sites Location
      summary: clearSiteMlOverwriteForMap
      description: Clear ML Overwrite for Map
      operationId: clearSiteMlOverwriteForMap
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: map_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Sites Location
      summary: overwriteSiteMlForMap
      description: Overwrite ML For Map
      operationId: overwriteSiteMlForMap
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: map_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              type: object
              additionalProperties:
                $ref: '#/components/schemas/ml_overwrite_additional_properties'
              description: Request Body
              examples:
              - iOS:
                  int: 6
                  ple: -3
                iPod:
                  int: -10
                  ple: -5
              contentMediaType: application/json
            examples:
              Example:
                value:
                  iOS:
                    int: 6
                    ple: -3
                  iPod:
                    int: -10
                    ple: -5
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                uniqueItems: true
                type: array
                items:
                  type: object
                description: Machine-learning response records returned as opaque objects
                examples:
                - - current:
                      Android:
                        completed: 36
                        int: -6
                        level: 3
                        ple: -3
                        quality: '4'
                        src: device
                        timestamp: 1442854794
                      iOS:
                        completed: 16
                        int: -6
                        level: 6
                        ple: -3
                        quality: '2'
                        src: default
                        timestamp: 1442854704
                      iPod:
                        int: -10
                        overwrite: true
                        ple: -5
                        src: overwrite
                    device_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  - beacon_id: 7913f032-aab4-c3ae-e83e-5a2756ef4d40
                    current:
                      iOS:
                        completed: 16
                        int: -6
                        level: 6
                        ple: -3
                        quality: last
                        src: device
                        timestamp: 1442854704
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - current:
                      Android:
                        completed: 36
                        int: -6
                        level: 3
                        ple: -3
                        quality: '4'
                        src: device
                        timestamp: 1442854794
                      iOS:
                        completed: 16
                        int: -6
                        level: 6
                        ple: -3
                        quality: '2'
                        src: default
                        timestamp: 1442854704
                      iPod:
                        int: -10
                        overwrite: true
                        ple: -5
                        src: overwrite
                    device_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  - beacon_id: 7913f032-aab4-c3ae-e83e-5a2756ef4d40
                    current:
                      iOS:
                        completed: 16
                        int: -6
                        level: 6
                        ple: -3
                        quality: last
                        src: device
                        timestamp: 1442854704
            application/vnd.api+json:
              schema:
                uniqueItems: true
                type: array
                items:
                  type: object
                description: Machine-learning response records returned as opaque objects
                examples:
                - - current:
                      Android:
                        completed: 36
                        int: -6
                        level: 3
                        ple: -3
                        quality: '4'
                        src: device
                        timestamp: 1442854794
                      iOS:
                        completed: 16
                        int: -6
                        level: 6
                        ple: -3
                        quality: '2'
                        src: default
                        timestamp: 1442854704
                      iPod:
                        int: -10
                        overwrite: true
                        ple: -5
                        src: overwrite
                    device_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  - beacon_id: 7913f032-aab4-c3ae-e83e-5a2756ef4d40
                    current:
                      iOS:
                        completed: 16
                        int: -6
                        level: 6
                        ple: -3
                        quality: last
                        src: device
                        timestamp: 1442854704
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - current:
                      Android:
                        completed: 36
                        int: -6
                        level: 3
                        ple: -3
                        quality: '4'
                        src: device
                        timestamp: 1442854794
                      iOS:
                        completed: 16
                        int: -6
                        level: 6
                        ple: -3
                        quality: '2'
                        src: default
                        timestamp: 1442854704
                      iPod:
                        int: -10
                        overwrite: true
                        ple: -5
                        src: overwrite
                    device_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                  - beacon_id: 7913f032-aab4-c3ae-e83e-5a2756ef4d40
                    current:
                      iOS:
                        completed: 16
                        int: -6
                        level: 6
                        ple: -3
                        quality: last
                        src: device
                        timestamp: 1442854704
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/location/ml/reset/map/{map_id}:
    post:
      tags:
      - Sites Location
      summary: resetSiteMlStatsByMap
      description: Reset ML Stats by Map
      operationId: resetSiteMlStatsByMap
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: map_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/maps:
    get:
      tags:
      - Sites Maps
      summary: listSiteMaps
      description: Get List of Site Maps
      operationId: listSiteMaps
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mapstack_id
        in: query
        description: Filter maps by mapstack UUID; returns only maps belonging to that mapstack
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: uuid
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/map'
                description: Maps or floorplans returned by the API
                examples:
                - - created_time: 0
                    flags: {}
                    group_idx: 1
                    group_name: East Wing
                    height: 0
                    height_m: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    latlng_br:
                      lat: string
                      lng: string
                    latlng_tl:
                      lat: string
                      lng: string
                    locked: true
                    modified_time: 0
                    name: string
                    occupancy_limit: 0
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    orientation: 0
                    origin_x: 0
                    origin_y: 0
                    ppm: 0
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    sitesurvey_path:
                    - coordinate: string
                      id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      name: string
                      nodes:
                      - edges:
                          N2: string
                        name: string
                        position:
                          x: 0
                          y: 0
                    thumbnail_url: string
                    type: image
                    url: string
                    view: roadmap
                    wall_path:
                      coordinate: string
                      nodes:
                      - edges:
                          N2: string
                        name: string
                        position:
                          x: 0
                          y: 0
                    wayfinding:
                      micello:
                        account_key: string
                        default_level_id: 0
                        map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      snap_to_path: true
                    wayfinding_path:
                      coordinate: string
                      nodes:
                      - edges:
                          N2: string
                        name: string
                        position:
                          x: 0
                          y: 0
                    width: 0
                    width_m: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 0
                    flags: {}
                    group_idx: 1
                    group_name: East Wing
                    height: 0
                    height_m: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    latlng_br:
                      lat: string
                      lng: string
                    latlng_tl:
                      lat: string
                      lng: string
                    locked: true
                    modified_time: 0
                    name: string
                    occupancy_limit: 0
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    orientation: 0
                    origin_x: 0
                    origin_y: 0
                    ppm: 0
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    sitesurvey_path:
                    - coordinate: string
                      id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      name: string
                      nodes:
                      - edges:
                          N2: string
                        name: string
                        position:
                          x: 0
                          y: 0
                    thumbnail_url: string
                    type: image
                    url: string
                    view: roadmap
                    wall_path:
                      coordinate: string
                      nodes:
                      - edges:
                          N2: string
                        name: string
                        position:
                          x: 0
                          y: 0
                    wayfinding:
                      micello:
                        account_key: string
                        default_level_id: 0
                        map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      snap_to_path: true
                    wayfinding_path:
                      coordinate: string
                      nodes:
                      - edges:
                          N2: string
                        name: string
                        position:
                          x: 0
                          y: 0
                    width: 0
                    width_m: 0
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/map'
                description: Maps or floorplans returned by the API
                examples:
                - - created_time: 0
                    flags: {}
                    group_idx: 1
                    group_name: East Wing
                    height: 0
                    height_m: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    latlng_br:
                      lat: string
                      lng: string
                    latlng_tl:
                      lat: string
                      lng: string
                    locked: true
                    modified_time: 0
                    name: string
                    occupancy_limit: 0
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    orientation: 0
                    origin_x: 0
                    origin_y: 0
                    ppm: 0
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    sitesurvey_path:
                    - coordinate: string
                      id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      name: string
                      nodes:
                      - edges:
                          N2: string
                        name: string
                        position:
                          x: 0
                          y: 0
                    thumbnail_url: string
                    type: image
                    url: string
                    view: roadmap
                    wall_path:
                      coordinate: string
                      nodes:
                      - edges:
                          N2: string
                        name: string
                        position:
                          x: 0
                          y: 0
                    wayfinding:
                      micello:
                        account_key: string
                        default_level_id: 0
                        map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      snap_to_path: true
                    wayfinding_path:
                      coordinate: string
                      nodes:
                      - edges:
                          N2: string
                        name: string
                        position:
                          x: 0
                          y: 0
                    width: 0
                    width_m: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 0
                    flags: {}
                    group_idx: 1
                    group_name: East Wing
                    height: 0
                    height_m: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    latlng_br:
                      lat: string
                      lng: string
                    latlng_tl:
                      lat: string
                      lng: string
                    locked: true
                    modified_time: 0
                    name: string
                    occupancy_limit: 0
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    orientation: 0
                    origin_x: 0
                    origin_y: 0
                    ppm: 0
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    sitesurvey_path:
                    - coordinate: string
                      id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      name: string
                      nodes:
                      - edges:
                          N2: string
                        name: string
                        position:
                          x: 0
                          y: 0
                    thumbnail_url: string
                    type: image
                    url: string
                    view: roadmap
                    wall_path:
                      coordinate: string
                      nodes:
                      - edges:
                          N2: string
                        name: string
                        position:
                          x: 0
                          y: 0
                    wayfinding:
                      micello:
                        account_key: string
                        default_level_id: 0
                        map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      snap_to_path: true
                    wayfinding_path:
                      coordinate: string
                      nodes:
                      - edges:
                          N2: string
                        name: string
                        position:
                          x: 0
                          y: 0
                    width: 0
                    width_m: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites Maps
      summary: createSiteMap
      description: Create Site Map
      operationId: createSiteMap
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/map'
              - description: Request Body
                examples:
                - group_idx: 0
                  group_name: string
                  height: 0
                  height_m: 0
                  latlng_br:
                    lat: string
                    lng: string
                  latlng_tl:
                    lat: string
                    lng: string
                  locked: true
                  name: string
                  occupancy_limit: 0
                  orientation: 0
                  origin_x: 0
                  origin_y: 0
                  ppm: 0
                  sitesurvey_path:
                  - coordinate: string
                    name: string
                    nodes:
                    - edges:
                        N2: string
                      name: string
                      position:
                        x: 0
                        y: 0
                  type: image
                  view: roadmap
                  wall_path:
                    coordinate: string
                    nodes:
                    - edges:
                        N2: string
                      name: string
                      position:
                        x: 0
                        y: 0
                  wayfinding:
                    micello:
                      account_key: string
                      default_level_id: 0
                    snap_to_path: true
                  wayfinding_path:
                    coordinate: string
                    nodes:
                    - edges:
                        N2: string
                      name: string
                      position:
                        x: 0
                        y: 0
                  width: 0
                  width_m: 0
              contentMediaType: application/json
            examples:
              Example:
                value:
                  group_idx: 0
                  group_name: string
                  height: 0
                  height_m: 0
                  latlng_br:
                    lat: string
                    lng: string
                  latlng_tl:
                    lat: string
                    lng: string
                  locked: true
                  name: string
                  occupancy_limit: 0
                  orientation: 0
                  origin_x: 0
                  origin_y: 0
                  ppm: 0
                  sitesurvey_path:
                  - coordinate: string
                    name: string
                    nodes:
                    - edges:
                        N2: string
                      name: string
                      position:
                        x: 0
                        y: 0
                  type: image
                  view: roadmap
                  wall_path:
                    coordinate: string
                    nodes:
                    - edges:
                        N2: string
                      name: string
                      position:
                        x: 0
                        y: 0
                  wayfinding:
                    micello:
                      account_key: string
                      default_level_id: 0
                    snap_to_path: true
                  wayfinding_path:
                    coordinate: string
                    nodes:
                    - edges:
                        N2: string
                      name: string
                      position:
                        x: 0
                        y: 0
                  width: 0
                  width_m: 0
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/map'
                - description: Map or floorplan metadata for a site or organization
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/map'
                - description: Map or floorplan metadata for a site or organization
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/maps/auto_geofences:
    post:
      tags:
      - Sites Maps
      summary: startSiteMapsAutoGeofence
      description: The auto geofence service is a map parsing service that uses map image data to identify the exterior of buildings in the map image also known as "geofences". This API processes all maps for a given SiteId. The maps must have an image to parse for the auto geofence service. Repeated POST requests to this endpoint while the auto geofence service is processing the map will be rejected.
      operationId: startSiteMapsAutoGeofence
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/maps/import:
    post:
      tags:
      - Sites Maps
      summary: importSiteMaps
      description: >-
        Import data from files is a multipart POST which has an file, an optional json, and an optional csv, to create floorplan, assign matching inventory to specific site, place ap if name or mac matches.


        # Note

        This endpoint (at the site level), the AP must be already assigned to the site to be placed on the floorplan. If you want to place APs from the Org inventory, it is required to use the endpoint at the Org level [importOrgMaps](#operation/importOrgMaps)


        # CSV File Format

        ```csv

        Vendor AP name,Mist AP Mac

        US Office AP-2,5c:5b:35:00:00:02

        US Office AP-3,5c5b35000002

        ```
      operationId: importSiteMaps
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              type: object
              properties:
                auto_deviceprofile_assignment:
                  type: boolean
                  description: Whether to auto assign device to deviceprofile by name
                  examples:
                  - true
                csv:
                  type: string
                  description: Optional AP name-mapping CSV file
                  contentEncoding: base64
                file:
                  type: string
                  description: Ekahau or iBwave floorplan file to import
                  contentEncoding: base64
                json:
                  allOf:
                  - $ref: '#/components/schemas/map_import_json1'
                  - description: Import options for the site map file
              contentMediaType: multipart/form-data
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_map_import'
                - description: Result of importing map files and matching AP placements
                  examples:
                  - '{"aps":[{"action":"assigned-placed","floorplan_id":"6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9","height":3,"mac":"5c5b35000001","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","orientation":45}],"floorplans":[{"action":"imported","id":"cbdb7f0b-3be0-4872-88f9-58790b509c23","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","name":"map1"}],"site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","summary":{"num_ap_assigned":1,"num_inv_assigned":1,"num_map_assigned":1}}'
                  - '{"aps":[{"action":"assigned-named-placed","floorplan_id":"6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9","mac":"5c5b35000001","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","orientation":45}],"floorplans":[{"action":"imported","id":"cbdb7f0b-3be0-4872-88f9-58790b509c23","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","name":"map1"}],"site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","summary":{"num_ap_assigned":1,"num_inv_assigned":1,"num_map_assigned":1}}'
                  - '{"aps":[{"action":"placed","floorplan_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","height":3,"mac":"5c5b35000001","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","orientation":45}],"floorplans":[{"action":"imported","id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","name":"map1"}],"site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","summary":{"num_ap_assigned":1,"num_inv_assigned":1,"num_map_assigned":1}}'
                contentMediaType: application/json
              examples:
                Assigned And Placed:
                  value:
                    aps:
                    - action: assigned-placed
                      floorplan_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                      height: 3
                      mac: 5c5b35000001
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      orientation: 45
                    floorplans:
                    - action: imported
                      id: cbdb7f0b-3be0-4872-88f9-58790b509c23
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      name: map1
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    summary:
                      num_ap_assigned: 1
                      num_inv_assigned: 1
                      num_map_assigned: 1
                Assigned Named And Placed:
                  value:
                    aps:
                    - action: assigned-named-placed
                      floorplan_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                      mac: 5c5b35000001
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      orientation: 45
                    floorplans:
                    - action: imported
                      id: cbdb7f0b-3be0-4872-88f9-58790b509c23
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      name: map1
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    summary:
                      num_ap_assigned: 1
                      num_inv_assigned: 1
                      num_map_assigned: 1
                Placed:
                  value:
                    aps:
                    - action: placed
                      floorplan_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      height: 3
                      mac: 5c5b35000001
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      orientation: 45
                    floorplans:
                    - action: imported
                      id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      name: map1
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    summary:
                      num_ap_assigned: 1
                      num_inv_assigned: 1
                      num_map_assigned: 1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_map_import'
                - description: Result of importing map files and matching AP placements
                  examples:
                  - '{"aps":[{"action":"assigned-placed","floorplan_id":"6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9","height":3,"mac":"5c5b35000001","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","orientation":45}],"floorplans":[{"action":"imported","id":"cbdb7f0b-3be0-4872-88f9-58790b509c23","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","name":"map1"}],"site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","summary":{"num_ap_assigned":1,"num_inv_assigned":1,"num_map_assigned":1}}'
                  - '{"aps":[{"action":"assigned-named-placed","floorplan_id":"6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9","mac":"5c5b35000001","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","orientation":45}],"floorplans":[{"action":"imported","id":"cbdb7f0b-3be0-4872-88f9-58790b509c23","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","name":"map1"}],"site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","summary":{"num_ap_assigned":1,"num_inv_assigned":1,"num_map_assigned":1}}'
                  - '{"aps":[{"action":"placed","floorplan_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","height":3,"mac":"5c5b35000001","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","orientation":45}],"floorplans":[{"action":"imported","id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","name":"map1"}],"site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","summary":{"num_ap_assigned":1,"num_inv_assigned":1,"num_map_assigned":1}}'
                contentMediaType: application/vnd.api+json
              examples:
                Assigned And Placed:
                  value:
                    aps:
                    - action: assigned-placed
                      floorplan_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                      height: 3
                      mac: 5c5b35000001
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      orientation: 45
                    floorplans:
                    - action: imported
                      id: cbdb7f0b-3be0-4872-88f9-58790b509c23
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      name: map1
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    summary:
                      num_ap_assigned: 1
                      num_inv_assigned: 1
                      num_map_assigned: 1
                Assigned Named And Placed:
                  value:
                    aps:
                    - action: assigned-named-placed
                      floorplan_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                      mac: 5c5b35000001
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      orientation: 45
                    floorplans:
                    - action: imported
                      id: cbdb7f0b-3be0-4872-88f9-58790b509c23
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      name: map1
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    summary:
                      num_ap_assigned: 1
                      num_inv_assigned: 1
                      num_map_assigned: 1
                Placed:
                  value:
                    aps:
                    - action: placed
                      floorplan_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      height: 3
                      mac: 5c5b35000001
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      orientation: 45
                    floorplans:
                    - action: imported
                      id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                      name: map1
                    site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                    summary:
                      num_ap_assigned: 1
                      num_inv_assigned: 1
                      num_map_assigned: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/maps/{map_id}:
    delete:
      tags:
      - Sites Maps
      summary: deleteSiteMap
      description: Delete Site Map
      operationId: deleteSiteMap
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: map_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Sites Maps
      summary: getSiteMap
      description: Get Site Map Details
      operationId: getSiteMap
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: map_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/map'
                - description: Map or floorplan metadata for a site or organization
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/map'
                - description: Map or floorplan metadata for a site or organization
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Sites Maps
      summary: updateSiteMap
      description: Update Site Map
      operationId: updateSiteMap
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: map_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/map'
              - description: Request Body
                examples:
                - height: 0
                  height_m: 0
                  latlng_br:
                    lat: string
                    lng: string
                  latlng_tl:
                    lat: string
                    lng: string
                  locked: true
                  name: string
                  occupancy_limit: 0
                  orientation: 0
                  origin_x: 0
                  origin_y: 0
                  ppm: 0
                  sitesurvey_path:
                  - coordinate: string
                    name: string
                    nodes:
                    - edges:
                        N2: string
                      name: string
                      position:
                        x: 0
                        y: 0
                  type: image
                  view: roadmap
                  wall_path:
                    coordinate: string
                    nodes:
                    - edges:
                        N2: string
                      name: string
                      position:
                        x: 0
                        y: 0
                  wayfinding:
                    micello:
                      account_key: string
                      default_level_id: 0
                    snap_to_path: true
                  wayfinding_path:
                    coordinate: string
                    nodes:
                    - edges:
                        N2: string
                      name: string
                      position:
                        x: 0
                        y: 0
                  width: 0
                  width_m: 0
              contentMediaType: application/json
            examples:
              Example:
                value:
                  height: 0
                  height_m: 0
                  latlng_br:
                    lat: string
                    lng: string
                  latlng_tl:
                    lat: string
                    lng: string
                  locked: true
                  name: string
                  occupancy_limit: 0
                  orientation: 0
                  origin_x: 0
                  origin_y: 0
                  ppm: 0
                  sitesurvey_path:
                  - coordinate: string
                    name: string
                    nodes:
                    - edges:
                        N2: string
                      name: string
                      position:
                        x: 0
                        y: 0
                  type: image
                  view: roadmap
                  wall_path:
                    coordinate: string
                    nodes:
                    - edges:
                        N2: string
                      name: string
                      position:
                        x: 0
                        y: 0
                  wayfinding:
                    micello:
                      account_key: string
                      default_level_id: 0
                    snap_to_path: true
                  wayfinding_path:
                    coordinate: string
                    nodes:
                    - edges:
                        N2: string
                      name: string
                      position:
                        x: 0
                        y: 0
                  width: 0
                  width_m: 0
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/map'
                - description: Map or floorplan metadata for a site or organization
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/map'
                - description: Map or floorplan metadata for a site or organization
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/maps/{map_id}/auto_geofences:
    post:
      tags:
      - Sites Maps
      summary: startSiteMapAutoGeofence
      description: The auto geofence service is a map parsing service that uses map image data to identify the exterior of buildings in the map image also known as "geofences". This API processes a single given MapId. This map must have an image to parse for the auto geofence service. Repeated POST requests to this endpoint while the auto geofence service is processing the map will be rejected.
      operationId: startSiteMapAutoGeofence
      parameters:
      - name: map_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/maps/{map_id}/image:
    delete:
      tags:
      - Sites Maps
      summary: deleteSiteMapImage
      description: Delete Site Map Image
      operationId: deleteSiteMapImage
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: map_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites Maps
      summary: addSiteMapImage
      description: Add image map is a multipart POST which has an file (Image) and an optional json parameter
      operationId: addSiteMapImage
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: map_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              required:
              - file
              type: object
              properties:
                file:
                  type: string
                  description: Image file content uploaded as multipart form data
                  contentEncoding: base64
                json:
                  type: string
                  description: Optional JSON metadata submitted with the image upload
              contentMediaType: multipart/form-data
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/maps/{map_id}/replace:
    post:
      tags:
      - Sites Maps
      summary: replaceSiteMapImage
      description: >-
        Replace Map Image



        This works like an PUT where the image will be replaced. If transform is provided, all the locations of the objects on the map (AP, Zone, Vbeacon, Beacon) will be transformed as well (relative to the new Map)
      operationId: replaceSiteMapImage
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: map_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              required:
              - file
              type: object
              properties:
                file:
                  type: string
                  description: Map image file used to replace the existing site map
                  contentEncoding: base64
                json:
                  allOf:
                  - $ref: '#/components/schemas/map_site_replace_file_json2'
                  - description: Replacement transform options for the map image
              contentMediaType: multipart/form-data
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/maps/{map_id}/set_map:
    post:
      tags:
      - Sites Maps
      summary: bulkAssignSiteApsToMap
      description: "This API can be used to assign a list of AP Macs associated with site_id to the specified map_id. Note that map_id must be associated with corresponding site_id. This API obeys the following rules \n1. if AP is unassigned to any Map, it gets associated with map_id \n2. Any moved APs are returned in the response \n3. If the AP is considered a locked AP, no action will be taken"
      operationId: bulkAssignSiteApsToMap
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: map_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/mac_addresses'
              - examples:
                - macs:
                  - 5c5b35000001
                  - 5c5b35584a6f
              contentMediaType: application/json
            examples:
              Example:
                value:
                  macs:
                  - 5c5b35000001
                  - 5c5b35584a6f
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_set_devices_map'
                - description: Result of assigning APs to a site map
                  examples:
                  - locked:
                    - 5c5b35584a6f
                    moved:
                    - 5c5b35000001
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    locked:
                    - 5c5b35584a6f
                    moved:
                    - 5c5b35000001
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_set_devices_map'
                - description: Result of assigning APs to a site map
                  examples:
                  - locked:
                    - 5c5b35584a6f
                    moved:
                    - 5c5b35000001
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    locked:
                    - 5c5b35584a6f
                    moved:
                    - 5c5b35000001
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/maps/{map_id}/wayfinding/import:
    post:
      tags:
      - Sites Maps
      summary: importSiteWayfindings
      description: This imports the vendor map meta data into the Map JSON. This is required by the SDK and App in order to access/render the vendor Map properly.
      operationId: importSiteWayfindings
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: map_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/wayfinding_import_json'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/maps/{map_id}/apply_autoplacement:
    post:
      tags:
      - Sites Maps - Auto-placement
      summary: acceptSiteApLocalizationData
      description: >-
        Accept the cached autoplacement and auto-orientation values of a map or subset of APs on a map. Any APs that have autoplacement values are stored in cache for up to 7 days while awaiting acceptance.



        Accepting the autoplacement values overwrites the existing X, Y, and orientation of the accepted APs with their cached autoplacement values.


        Once a decision to accept is made, or the 7-day time-to-live (TTL) expires, the cached values are deleted.
      operationId: acceptSiteApLocalizationData
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: map_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/autoplacement_localization_selector'
              - description: Request Body
                examples:
                - for: placement
                  macs:
                  - 5c5b35000001
              contentMediaType: application/json
            examples:
              Example:
                value:
                  for: placement
                  macs:
                  - 5c5b35000001
        required: false
      responses:
        '200':
          description: Success
          headers: {}
          content: {}
        '400':
          description: Map does not exist or belong to specified site / Invalid localization service. Expected [placement, orientation]
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/maps/{map_id}/auto_orient:
    delete:
      tags:
      - Sites Maps - Auto-placement
      summary: deleteSiteApAutoOrientation
      description: This API is called to force stop auto placement for a given map
      operationId: deleteSiteApAutoOrientation
      parameters:
      - name: map_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Auto orient process has stopped for this map
          headers: {}
          content: {}
        '400':
          description: Autoplacement was not triggered
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Sites Maps - Auto-placement
      summary: getSiteApAutoOrientation
      description: This API is called to view the current status of auto orient for a given map.
      operationId: getSiteApAutoOrientation
      parameters:
      - name: map_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Map queued for auto orientation
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_auto_orientation_info'
                - description: Auto orientation status response
                  examples:
                  - '{"start_time":1678900062,"status":"done","stop_time":1678900362}'
                  - '{"est_time_left":300.0,"start_time":1678900062,"status":"inprogress"}'
                contentMediaType: application/json
              examples:
                Completed:
                  value:
                    start_time: 1678900062
                    status: done
                    stop_time: 1678900362
                In Progress:
                  value:
                    est_time_left: 300
                    start_time: 1678900062
                    status: inprogress
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_auto_orientation_info'
                - description: Auto orientation status response
                  examples:
                  - '{"start_time":1678900062,"status":"done","stop_time":1678900362}'
                  - '{"est_time_left":300.0,"start_time":1678900062,"status":"inprogress"}'
                contentMediaType: application/vnd.api+json
              examples:
                Completed:
                  value:
                    start_time: 1678900062
                    status: done
                    stop_time: 1678900362
                In Progress:
                  value:
                    est_time_left: 300
                    start_time: 1678900062
                    status: inprogress
        '400':
          description: Autoplacement was not triggered
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites Maps - Auto-placement
      summary: startSiteApAutoOrientation
      description: >-
        This API is called to trigger a map for auto orient. For auto orient feature to work, BLE data needs to be collected from the APs on the map. This precess is not disruptive unlike FTM collection. Repeated POST requests to this endpoint while a map is still running will be rejected.



        `force_collection` is set to `false` by default. If `force_collection`==`false`, the API attempts to start orientation with existing data. If no data exists, the API attempts to start collecting orientation data. If `force_collection`==`true`, the API attempts to start collecting orientation data.



        Providing a list of device macs is optional. If provided, auto orientation suggestions will be made only for the specified devices. If no list is provided, all APs associated with the map are considered by default.
      operationId: startSiteApAutoOrientation
      parameters:
      - name: map_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/auto_orient'
        required: false
      responses:
        '200':
          description: Map queued for auto orientation
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_auto_orientation'
                - description: Auto orientation start response
                  examples:
                  - '{"devices":{"00000000001":{"reason":"Device meets the minimum requirements for auto orient","valid":true},"00000000002":{"reason":"Device meets the minimum requirements for auto orient","valid":true},"00000000003":{"reason":"Device meets the minimum requirements for auto orient","valid":true}},"estimated_runtime":300,"reason":"Map has met the minimum requirements for auto orient","valid":true,"wifi_interrupting":true}'
                  - '{"devices":{"00000000001":{"valid":true},"00000000002":{"valid":true},"00000000003":{"valid":true}},"estimated_runtime":300,"reason":"Map Already Enqueued","started":false,"valid":true,"wifi_interrupting":true}'
                  - '{"devices":{"00000000001":{"valid":true},"00000000002":{"valid":true},"00000000003":{"valid":true},"00000000004":{"reason":"Device model AP41 is not supported for auto orient","valid":false},"00000000005":{"reason":"Device firmware 0.14.28300 does not meet the minimum requirement 0.14.28310","valid":false}},"reason":"Map has APs that do not meet the minimum requirements for auto orient","started":false,"valid":false}'
                  - '{"devices":{"00000000001":{"valid":true},"00000000002":{"valid":true},"00000000003":{"valid":true},"00000000004":{"reason":"Device model AP32 is not supported for auto orient","valid":false},"00000000005":{"reason":"Device firmware 0.14.28300 does not meet the minimum requirement 0.14.28310","valid":false}},"estimated_runtime":300,"reason":"Started collection for auto orient","started":true,"valid":false}'
                  - '{"devices":{"00000000001":{"valid":true},"00000000002":{"valid":true},"00000000003":{"valid":true}},"estimated_runtime":300,"reason":"Started collection for auto orient","started":true,"valid":true}'
                  - '{"devices":{"00000000001":{"valid":true},"00000000002":{"valid":true},"00000000003":{"valid":true}},"estimated_runtime":300,"reason":"Unable to reach auto orient service","started":false,"valid":true,"wifi_interrupting":true}'
                contentMediaType: application/json
              examples:
                Dryrun For Map Completed:
                  value:
                    devices:
                      '00000000001':
                        reason: Device meets the minimum requirements for auto orient
                        valid: true
                      '00000000002':
                        reason: Device meets the minimum requirements for auto orient
                        valid: true
                      '00000000003':
                        reason: Device meets the minimum requirements for auto orient
                        valid: true
                    estimated_runtime: 300
                    reason: Map has met the minimum requirements for auto orient
                    valid: true
                    wifi_interrupting: true
                Map Failed To Start As It Had Less Than 3 APs Associated With It:
                  value:
                    devices:
                      '00000000001':
                        valid: true
                      '00000000002':
                        valid: true
                      '00000000003':
                        valid: true
                    estimated_runtime: 300
                    reason: Map Already Enqueued
                    started: false
                    valid: true
                    wifi_interrupting: true
                Service Failed To Start Due Containing Invalid APs:
                  value:
                    devices:
                      '00000000001':
                        valid: true
                      '00000000002':
                        valid: true
                      '00000000003':
                        valid: true
                      '00000000004':
                        reason: Device model AP41 is not supported for auto orient
                        valid: false
                      '00000000005':
                        reason: Device firmware 0.14.28300 does not meet the minimum requirement 0.14.28310
                        valid: false
                    reason: Map has APs that do not meet the minimum requirements for auto orient
                    started: false
                    valid: false
                Service Started After Override For Localization / Orient Collection:
                  value:
                    devices:
                      '00000000001':
                        valid: true
                      '00000000002':
                        valid: true
                      '00000000003':
                        valid: true
                      '00000000004':
                        reason: Device model AP32 is not supported for auto orient
                        valid: false
                      '00000000005':
                        reason: Device firmware 0.14.28300 does not meet the minimum requirement 0.14.28310
                        valid: false
                    estimated_runtime: 300
                    reason: Started collection for auto orient
                    started: true
                    valid: false
                Service Started Successfully For Localization / Orient Collection:
                  value:
                    devices:
                      '00000000001':
                        valid: true
                      '00000000002':
                        valid: true
                      '00000000003':
                        valid: true
                    estimated_runtime: 300
                    reason: Started collection for auto orient
                    started: true
                    valid: true
                Unable To Reach The Orient Service:
                  value:
                    devices:
                      '00000000001':
                        valid: true
                      '00000000002':
                        valid: true
                      '00000000003':
                        valid: true
                    estimated_runtime: 300
                    reason: Unable to reach auto orient service
                    started: false
                    valid: true
                    wifi_interrupting: true
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_auto_orientation'
                - description: Auto orientation start response
                  examples:
                  - '{"devices":{"00000000001":{"reason":"Device meets the minimum requirements for auto orient","valid":true},"00000000002":{"reason":"Device meets the minimum requirements for auto orient","valid":true},"00000000003":{"reason":"Device meets the minimum requirements for auto orient","valid":true}},"estimated_runtime":300,"reason":"Map has met the minimum requirements for auto orient","valid":true,"wifi_interrupting":true}'
                  - '{"devices":{"00000000001":{"valid":true},"00000000002":{"valid":true},"00000000003":{"valid":true}},"estimated_runtime":300,"reason":"Map Already Enqueued","started":false,"valid":true,"wifi_interrupting":true}'
                  - '{"devices":{"00000000001":{"valid":true},"00000000002":{"valid":true},"00000000003":{"valid":true},"00000000004":{"reason":"Device model AP41 is not supported for auto orient","valid":false},"00000000005":{"reason":"Device firmware 0.14.28300 does not meet the minimum requirement 0.14.28310","valid":false}},"reason":"Map has APs that do not meet the minimum requirements for auto orient","started":false,"valid":false}'
                  - '{"devices":{"00000000001":{"valid":true},"00000000002":{"valid":true},"00000000003":{"valid":true},"00000000004":{"reason":"Device model AP32 is not supported for auto orient","valid":false},"00000000005":{"reason":"Device firmware 0.14.28300 does not meet the minimum requirement 0.14.28310","valid":false}},"estimated_runtime":300,"reason":"Started collection for auto orient","started":true,"valid":false}'
                  - '{"devices":{"00000000001":{"valid":true},"00000000002":{"valid":true},"00000000003":{"valid":true}},"estimated_runtime":300,"reason":"Started collection for auto orient","started":true,"valid":true}'
                  - '{"devices":{"00000000001":{"valid":true},"00000000002":{"valid":true},"00000000003":{"valid":true}},"estimated_runtime":300,"reason":"Unable to reach auto orient service","started":false,"valid":true,"wifi_interrupting":true}'
                contentMediaType: application/vnd.api+json
              examples:
                Dryrun For Map Completed:
                  value:
                    devices:
                      '00000000001':
                        reason: Device meets the minimum requirements for auto orient
                        valid: true
                      '00000000002':
                        reason: Device meets the minimum requirements for auto orient
                        valid: true
                      '00000000003':
                        reason: Device meets the minimum requirements for auto orient
                        valid: true
                    estimated_runtime: 300
                    reason: Map has met the minimum requirements for auto orient
                    valid: true
                    wifi_interrupting: true
                Map Failed To Start As It Had Less Than 3 APs Associated With It:
                  value:
                    devices:
                      '00000000001':
                        valid: true
                      '00000000002':
                        valid: true
                      '00000000003':
                        valid: true
                    estimated_runtime: 300
                    reason: Map Already Enqueued
                    started: false
                    valid: true
                    wifi_interrupting: true
                Service Failed To Start Due Containing Invalid APs:
                  value:
                    devices:
                      '00000000001':
                        valid: true
                      '00000000002':
                        valid: true
                      '00000000003':
                        valid: true
                      '00000000004':
                        reason: Device model AP41 is not supported for auto orient
                        valid: false
                      '00000000005':
                        reason: Device firmware 0.14.28300 does not meet the minimum requirement 0.14.28310
                        valid: false
                    reason: Map has APs that do not meet the minimum requirements for auto orient
                    started: false
                    valid: false
                Service Started After Override For Localization / Orient Collection:
                  value:
                    devices:
                      '00000000001':
                        valid: true
                      '00000000002':
                        valid: true
                      '00000000003':
                        valid: true
                      '00000000004':
                        reason: Device model AP32 is not supported for auto orient
                        valid: false
                      '00000000005':
                        reason: Device firmware 0.14.28300 does not meet the minimum requirement 0.14.28310
                        valid: false
                    estimated_runtime: 300
                    reason: Started collection for auto orient
                    started: true
                    valid: false
                Service Started Successfully For Localization / Orient Collection:
                  value:
                    devices:
                      '00000000001':
                        valid: true
                      '00000000002':
                        valid: true
                      '00000000003':
                        valid: true
                    estimated_runtime: 300
                    reason: Started collection for auto orient
                    started: true
                    valid: true
                Unable To Reach The Orient Service:
                  value:
                    devices:
                      '00000000001':
                        valid: true
                      '00000000002':
                        valid: true
                      '00000000003':
                        valid: true
                    estimated_runtime: 300
                    reason: Unable to reach auto orient service
                    started: false
                    valid: true
                    wifi_interrupting: true
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_detail_string'
                - description: Response containing a human-readable detail message
                  examples:
                  - '{"detail":"Map has less than 3 APs associated with it to perform auto orient"}'
                  - '{"detail":"Auto AP orient is already in progress for this Map"}'
                  - '{"detail":"Auto orient data does not exist or has gone stale"}'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Map has less than 3 APs associated with it to perform auto orient
                Example-2:
                  value:
                    detail: Auto AP orient is already in progress for this Map
                Example-3:
                  value:
                    detail: Auto orient data does not exist or has gone stale
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_detail_string'
                - description: Response containing a human-readable detail message
                  examples:
                  - '{"detail":"Map has less than 3 APs associated with it to perform auto orient"}'
                  - '{"detail":"Auto AP orient is already in progress for this Map"}'
                  - '{"detail":"Auto orient data does not exist or has gone stale"}'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Map has less than 3 APs associated with it to perform auto orient
                Example-2:
                  value:
                    detail: Auto AP orient is already in progress for this Map
                Example-3:
                  value:
                    detail: Auto orient data does not exist or has gone stale
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/maps/{map_id}/auto_placement:
    delete:
      tags:
      - Sites Maps - Auto-placement
      summary: deleteSiteApAutoplacement
      description: This API is called to force stop auto placement for a given map
      operationId: deleteSiteApAutoplacement
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: map_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Autoplacement Process has stopped for this map
          headers: {}
          content: {}
        '400':
          description: Autoplacement was not triggered
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Sites Maps - Auto-placement
      summary: getSiteApAutoPlacement
      description: >-
        This API is called to view the current status of auto placement for a given map.



        #### Status Descriptions


        | Status | Description |

        | --- | --- |

        | `pending` | Autoplacement has not been requested for this map |

        | `inprogress` | Autoplacement is currently processing |

        | `done` | The autoplacement process has completed |

        | `data_needed` | Additional position data is required for autoplacement. Users should verify the requested anchor APs have a position on the map |

        | `invalid_model` | Autoplacement is not supported on the model of the APs on the map |

        | `invalid_version` | Autoplacement is not supported with the APs current firmware version |

        | `error` | There was an error in the autoplacement process |
      operationId: getSiteApAutoPlacement
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: map_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_auto_placement_info'
                - description: Auto-placement status response with progress and validation details
                  examples:
                  - '{"end_time":1678900362,"start_time":1678900062,"status":"done"}'
                  - '{"end_time":1678900362,"start_time":1678900062,"status":"error"}'
                  - '{"est_time_left":300,"start_time":1678900062,"status":"inprogress"}'
                  - '{"status":"pending"}'
                contentMediaType: application/json
              examples:
                Done:
                  value:
                    end_time: 1678900362
                    start_time: 1678900062
                    status: done
                Error:
                  value:
                    end_time: 1678900362
                    start_time: 1678900062
                    status: error
                In Progress:
                  value:
                    est_time_left: 300
                    start_time: 1678900062
                    status: inprogress
                Pending:
                  value:
                    status: pending
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_auto_placement_info'
                - description: Auto-placement status response with progress and validation details
                  examples:
                  - '{"end_time":1678900362,"start_time":1678900062,"status":"done"}'
                  - '{"end_time":1678900362,"start_time":1678900062,"status":"error"}'
                  - '{"est_time_left":300,"start_time":1678900062,"status":"inprogress"}'
                  - '{"status":"pending"}'
                contentMediaType: application/vnd.api+json
              examples:
                Done:
                  value:
                    end_time: 1678900362
                    start_time: 1678900062
                    status: done
                Error:
                  value:
                    end_time: 1678900362
                    start_time: 1678900062
                    status: error
                In Progress:
                  value:
                    est_time_left: 300
                    start_time: 1678900062
                    status: inprogress
                Pending:
                  value:
                    status: pending
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites Maps - Auto-placement
      summary: runSiteApAutoplacement
      description: "This API is called to trigger auto placement for a map. For the auto placement feature to work, RTT-FTM data needs to be collected from the APs on the map.  \nThis scan is disruptive, and users must be notified of service disruption during the auto placement process. Repeated POST requests to this endpoint while a map is still running will be rejected.\n\n\n`force_collection` is set to `false` by default. If `force_collection` is set to `false`, the API attempts to start localization with existing data. If no data exists, the API attempts to start orchestration.  \nIf `force_collection` is set to `true`, the API attempts to start orchestration.\n\n\nProviding a list of devices is optional. If provided, autoplacement suggestions will be made only for the specified devices. If no list is provided, all APs associated with the map are considered by default."
      operationId: runSiteApAutoplacement
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: map_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/auto_placement'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_autoplacement'
                - description: Auto-placement start response returned after scheduling the run
                  examples:
                  - '{"devices":{"00000000001":{"valid":true},"00000000002":{"valid":true},"00000000003":{"valid":true}},"estimated_runtime":30,"reason":"Map Already Enqueued","started":false,"valid":true,"wifi_interrupting":true}'
                  - '{"devices":{"00000000001":{"valid":true},"00000000002":{"valid":true},"00000000003":{"valid":true}},"estimated_runtime":30,"reason":"Map has met the minimum requirements for auto placement","valid":true,"wifi_interrupting":true}'
                  - '{"devices":{},"reason":"Map has less than 3 APs associated with it to perform auto placement","started":false,"valid":false}'
                  - '{"devices":{"00000000001":{"valid":true},"00000000002":{"valid":true},"00000000003":{"valid":true},"00000000004":{"reason":"Device model AP41 is not supported for auto placement","valid":false},"00000000005":{"reason":"Device firmware 0.14.28300 does not meet the minimum requirement 0.14.28310","valid":false}},"reason":"Map has APs that do not meet the minimum requirements for auto placement","started":false,"valid":false}'
                  - '{"devices":{"00000000001":{"valid":true},"00000000002":{"valid":true},"00000000003":{"valid":true},"00000000004":{"reason":"Device model AP41 is not supported for auto placement","valid":false},"00000000005":{"reason":"Device firmware 0.14.28300 does not meet the minimum requirement 0.14.28310","valid":false}},"reason":"Started localization for auto placement","started":true,"valid":false}'
                  - '{"devices":{"00000000001":{"valid":true},"00000000002":{"valid":true},"00000000003":{"valid":true},"00000000004":{"reason":"Device model AP41 is not supported for auto placement","valid":false},"00000000005":{"reason":"Device firmware 0.14.28300 does not meet the minimum requirement 0.14.28310","valid":false}},"estimated_runtime":30,"reason":"Started collection for auto placement","started":true,"valid":false,"wifi_interrupting":true}'
                  - '{"devices":{"00000000001":{"valid":true},"00000000002":{"valid":true},"00000000003":{"valid":true}},"reason":"Started localization for auto placement","started":true,"valid":true}'
                  - '{"devices":{"00000000001":{"valid":true},"00000000002":{"valid":true},"00000000003":{"valid":true}},"estimated_runtime":30,"reason":"Started collection for auto placement","started":true,"valid":true,"wifi_interrupting":true}'
                  - '{"devices":{"00000000001":{"valid":true},"00000000002":{"valid":true},"00000000003":{"valid":true}},"estimated_runtime":30,"reason":"Unable to reach auto placement service","started":false,"valid":true,"wifi_interrupting":true}'
                contentMediaType: application/json
              examples:
                Auto placement is already in progress for this map:
                  value:
                    devices:
                      '00000000001':
                        valid: true
                      '00000000002':
                        valid: true
                      '00000000003':
                        valid: true
                    estimated_runtime: 30
                    reason: Map Already Enqueued
                    started: false
                    valid: true
                    wifi_interrupting: true
                Dryrun for map completed:
                  value:
                    devices:
                      '00000000001':
                        valid: true
                      '00000000002':
                        valid: true
                      '00000000003':
                        valid: true
                    estimated_runtime: 30
                    reason: Map has met the minimum requirements for auto placement
                    valid: true
                    wifi_interrupting: true
                Map failed to start as it had less than 3 APs associated with it:
                  value:
                    devices: {}
                    reason: Map has less than 3 APs associated with it to perform auto placement
                    started: false
                    valid: false
                Service failed to start due containing invalid APs:
                  value:
                    devices:
                      '00000000001':
                        valid: true
                      '00000000002':
                        valid: true
                      '00000000003':
                        valid: true
                      '00000000004':
                        reason: Device model AP41 is not supported for auto placement
                        valid: false
                      '00000000005':
                        reason: Device firmware 0.14.28300 does not meet the minimum requirement 0.14.28310
                        valid: false
                    reason: Map has APs that do not meet the minimum requirements for auto placement
                    started: false
                    valid: false
                Service started after override for localization:
                  value:
                    devices:
                      '00000000001':
                        valid: true
                      '00000000002':
                        valid: true
                      '00000000003':
                        valid: true
                      '00000000004':
                        reason: Device model AP41 is not supported for auto placement
                        valid: false
                      '00000000005':
                        reason: Device firmware 0.14.28300 does not meet the minimum requirement 0.14.28310
                        valid: false
                    reason: Started localization for auto placement
                    started: true
                    valid: false
                Service started after override for orchestration:
                  value:
                    devices:
                      '00000000001':
                        valid: true
                      '00000000002':
                        valid: true
                      '00000000003':
                        valid: true
                      '00000000004':
                        reason: Device model AP41 is not supported for auto placement
                        valid: false
                      '00000000005':
                        reason: Device firmware 0.14.28300 does not meet the minimum requirement 0.14.28310
                        valid: false
                    estimated_runtime: 30
                    reason: Started collection for auto placement
                    started: true
                    valid: false
                    wifi_interrupting: true
                Service started successfully for localization:
                  value:
                    devices:
                      '00000000001':
                        valid: true
                      '00000000002':
                        valid: true
                      '00000000003':
                        valid: true
                    reason: Started localization for auto placement
                    started: true
                    valid: true
                Service started successfully for orchestration:
                  value:
                    devices:
                      '00000000001':
                        valid: true
                      '00000000002':
                        valid: true
                      '00000000003':
                        valid: true
                    estimated_runtime: 30
                    reason: Started collection for auto placement
                    started: true
                    valid: true
                    wifi_interrupting: true
                Unable to reach the autoplacement service:
                  value:
                    devices:
                      '00000000001':
                        valid: true
                      '00000000002':
                        valid: true
                      '00000000003':
                        valid: true
                    estimated_runtime: 30
                    reason: Unable to reach auto placement service
                    started: false
                    valid: true
                    wifi_interrupting: true
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_autoplacement'
                - description: Auto-placement start response returned after scheduling the run
                  examples:
                  - '{"devices":{"00000000001":{"valid":true},"00000000002":{"valid":true},"00000000003":{"valid":true}},"estimated_runtime":30,"reason":"Map Already Enqueued","started":false,"valid":true,"wifi_interrupting":true}'
                  - '{"devices":{"00000000001":{"valid":true},"00000000002":{"valid":true},"00000000003":{"valid":true}},"estimated_runtime":30,"reason":"Map has met the minimum requirements for auto placement","valid":true,"wifi_interrupting":true}'
                  - '{"devices":{},"reason":"Map has less than 3 APs associated with it to perform auto placement","started":false,"valid":false}'
                  - '{"devices":{"00000000001":{"valid":true},"00000000002":{"valid":true},"00000000003":{"valid":true},"00000000004":{"reason":"Device model AP41 is not supported for auto placement","valid":false},"00000000005":{"reason":"Device firmware 0.14.28300 does not meet the minimum requirement 0.14.28310","valid":false}},"reason":"Map has APs that do not meet the minimum requirements for auto placement","started":false,"valid":false}'
                  - '{"devices":{"00000000001":{"valid":true},"00000000002":{"valid":true},"00000000003":{"valid":true},"00000000004":{"reason":"Device model AP41 is not supported for auto placement","valid":false},"00000000005":{"reason":"Device firmware 0.14.28300 does not meet the minimum requirement 0.14.28310","valid":false}},"reason":"Started localization for auto placement","started":true,"valid":false}'
                  - '{"devices":{"00000000001":{"valid":true},"00000000002":{"valid":true},"00000000003":{"valid":true},"00000000004":{"reason":"Device model AP41 is not supported for auto placement","valid":false},"00000000005":{"reason":"Device firmware 0.14.28300 does not meet the minimum requirement 0.14.28310","valid":false}},"estimated_runtime":30,"reason":"Started collection for auto placement","started":true,"valid":false,"wifi_interrupting":true}'
                  - '{"devices":{"00000000001":{"valid":true},"00000000002":{"valid":true},"00000000003":{"valid":true}},"reason":"Started localization for auto placement","started":true,"valid":true}'
                  - '{"devices":{"00000000001":{"valid":true},"00000000002":{"valid":true},"00000000003":{"valid":true}},"estimated_runtime":30,"reason":"Started collection for auto placement","started":true,"valid":true,"wifi_interrupting":true}'
                  - '{"devices":{"00000000001":{"valid":true},"00000000002":{"valid":true},"00000000003":{"valid":true}},"estimated_runtime":30,"reason":"Unable to reach auto placement service","started":false,"valid":true,"wifi_interrupting":true}'
                contentMediaType: application/vnd.api+json
              examples:
                Auto placement is already in progress for this map:
                  value:
                    devices:
                      '00000000001':
                        valid: true
                      '00000000002':
                        valid: true
                      '00000000003':
                        valid: true
                    estimated_runtime: 30
                    reason: Map Already Enqueued
                    started: false
                    valid: true
                    wifi_interrupting: true
                Dryrun for map completed:
                  value:
                    devices:
                      '00000000001':
                        valid: true
                      '00000000002':
                        valid: true
                      '00000000003':
                        valid: true
                    estimated_runtime: 30
                    reason: Map has met the minimum requirements for auto placement
                    valid: true
                    wifi_interrupting: true
                Map failed to start as it had less than 3 APs associated with it:
                  value:
                    devices: {}
                    reason: Map has less than 3 APs associated with it to perform auto placement
                    started: false
                    valid: false
                Service failed to start due containing invalid APs:
                  value:
                    devices:
                      '00000000001':
                        valid: true
                      '00000000002':
                        valid: true
                      '00000000003':
                        valid: true
                      '00000000004':
                        reason: Device model AP41 is not supported for auto placement
                        valid: false
                      '00000000005':
                        reason: Device firmware 0.14.28300 does not meet the minimum requirement 0.14.28310
                        valid: false
                    reason: Map has APs that do not meet the minimum requirements for auto placement
                    started: false
                    valid: false
                Service started after override for localization:
                  value:
                    devices:
                      '00000000001':
                        valid: true
                      '00000000002':
                        valid: true
                      '00000000003':
                        valid: true
                      '00000000004':
                        reason: Device model AP41 is not supported for auto placement
                        valid: false
                      '00000000005':
                        reason: Device firmware 0.14.28300 does not meet the minimum requirement 0.14.28310
                        valid: false
                    reason: Started localization for auto placement
                    started: true
                    valid: false
                Service started after override for orchestration:
                  value:
                    devices:
                      '00000000001':
                        valid: true
                      '00000000002':
                        valid: true
                      '00000000003':
                        valid: true
                      '00000000004':
                        reason: Device model AP41 is not supported for auto placement
                        valid: false
                      '00000000005':
                        reason: Device firmware 0.14.28300 does not meet the minimum requirement 0.14.28310
                        valid: false
                    estimated_runtime: 30
                    reason: Started collection for auto placement
                    started: true
                    valid: false
                    wifi_interrupting: true
                Service started successfully for localization:
                  value:
                    devices:
                      '00000000001':
                        valid: true
                      '00000000002':
                        valid: true
                      '00000000003':
                        valid: true
                    reason: Started localization for auto placement
                    started: true
                    valid: true
                Service started successfully for orchestration:
                  value:
                    devices:
                      '00000000001':
                        valid: true
                      '00000000002':
                        valid: true
                      '00000000003':
                        valid: true
                    estimated_runtime: 30
                    reason: Started collection for auto placement
                    started: true
                    valid: true
                    wifi_interrupting: true
                Unable to reach the autoplacement service:
                  value:
                    devices:
                      '00000000001':
                        valid: true
                      '00000000002':
                        valid: true
                      '00000000003':
                        valid: true
                    estimated_runtime: 30
                    reason: Unable to reach auto placement service
                    started: false
                    valid: true
                    wifi_interrupting: true
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/maps/{map_id}/clear_auto_orient:
    post:
      tags:
      - Sites Maps - Auto-placement
      summary: clearSiteApAutoOrient
      description: This API is used to destroy the autoorientations of a map or subset of APs on a map.
      operationId: clearSiteApAutoOrient
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: map_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/mac_addresses'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/maps/{map_id}/clear_autoplacement:
    post:
      tags:
      - Sites Maps - Auto-placement
      summary: clearSiteApAutoplacement
      description: >-
        Reject the cached autoplacement and auto-orientation values of a map or subset of APs on a map. Any APs that have autoplacement values are stored in cache for up to 7 days while awaiting rejection.



        Rejecting the autoplacement values causes the APs to retain their current X, Y, and orientation.


        Once a decision to reject is made, or the 7-day time-to-live (TTL) expires, the cached values are deleted.
      operationId: clearSiteApAutoplacement
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: map_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/autoplacement_localization_selector'
              - examples:
                - for: placement
                  macs:
                  - 5c5b35000001
              contentMediaType: application/json
            examples:
              Example:
                value:
                  for: placement
                  macs:
                  - 5c5b35000001
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/maps/{map_id}/use_auto_ap_values:
    post:
      tags:
      - Sites Maps - Auto-placement
      summary: confirmSiteApLocalizationData
      description: '**Deprecated** — use [Accept Site AP Autoplacement]($e/Sites%20Maps%20-%20Auto-placement/acceptSiteApLocalizationData) to accept cached values, or [Clear Site AP Autoplacement]($e/Sites%20Maps%20-%20Auto-placement/clearSiteApAutoplacement) to reject them.'
      operationId: confirmSiteApLocalizationData
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: map_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/use_auto_ap_values'
              - examples:
                - accept: false
                  device_macs:
                  - string
                  for: placement
              contentMediaType: application/json
            examples:
              Example:
                value:
                  accept: false
                  device_macs:
                  - string
                  for: placement
        required: false
      responses:
        '200':
          description: Success
          headers: {}
          content: {}
        '400':
          description: Map does not exist or belong to specified site / Invalid localization service. Expected [placement, orientation]
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: true
    parameters: []
  /api/v1/sites/{site_id}/maps/{map_id}/auto_zones:
    delete:
      tags:
      - Sites Maps - Auto-Zone
      summary: deleteSiteMapAutoZone
      description: This API starts the auto zones service for a specified map. This map must have an image to parse for the auto zones service. Repeated POST requests to this endpoint while the auto zones service is processing the map or awaiting review will be rejected.
      operationId: deleteSiteMapAutoZone
      parameters:
      - name: map_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Sites Maps - Auto-Zone
      summary: getSiteMapAutoZoneStatus
      description: This API provides the current status of the auto zones service for a given map
      operationId: getSiteMapAutoZoneStatus
      parameters:
      - name: map_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Status of Auto-Zone request
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_auto_zone'
                - description: Auto zones status and suggested zone response
                  examples:
                  - status: awaiting_review
                    zones:
                    - name: zone1
                      vertices:
                      - x: 0
                        y: 0
                      - x: 0
                        y: 10
                      - x: 10
                        y: 10
                      - x: 10
                        y: 0
                    - name: zone2
                      vertices:
                      - x: 0
                        y: 0
                      - x: 0
                        y: 20
                      - x: 20
                        y: 20
                      - x: 20
                        y: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    status: awaiting_review
                    zones:
                    - name: zone1
                      vertices:
                      - x: 0
                        y: 0
                      - x: 0
                        y: 10
                      - x: 10
                        y: 10
                      - x: 10
                        y: 0
                    - name: zone2
                      vertices:
                      - x: 0
                        y: 0
                      - x: 0
                        y: 20
                      - x: 20
                        y: 20
                      - x: 20
                        y: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_auto_zone'
                - description: Auto zones status and suggested zone response
                  examples:
                  - status: awaiting_review
                    zones:
                    - name: zone1
                      vertices:
                      - x: 0
                        y: 0
                      - x: 0
                        y: 10
                      - x: 10
                        y: 10
                      - x: 10
                        y: 0
                    - name: zone2
                      vertices:
                      - x: 0
                        y: 0
                      - x: 0
                        y: 20
                      - x: 20
                        y: 20
                      - x: 20
                        y: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    status: awaiting_review
                    zones:
                    - name: zone1
                      vertices:
                      - x: 0
                        y: 0
                      - x: 0
                        y: 10
                      - x: 10
                        y: 10
                      - x: 10
                        y: 0
                    - name: zone2
                      vertices:
                      - x: 0
                        y: 0
                      - x: 0
                        y: 20
                      - x: 20
                        y: 20
                      - x: 20
                        y: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites Maps - Auto-Zone
      summary: startSiteMapAutoZone
      description: This API starts the auto zones service for a specified map. This map must have an image to parse for the auto zones service. Repeated POST requests to this endpoint while the auto zones service is processing the map will be rejected.
      operationId: startSiteMapAutoZone
      parameters:
      - name: map_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/mapstacks:
    get:
      tags:
      - Sites Map Stacks
      summary: listSiteMapStacks
      description: Get List of Site Map Stacks
      operationId: listSiteMapStacks
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      - name: name
        in: query
        description: Filter by map stack name
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/mapstack_response'
                description: Map stacks returned by the API
                examples:
                - - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: Board Room
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: Board Room
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/mapstack_response'
                description: Map stacks returned by the API
                examples:
                - - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: Board Room
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: Board Room
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites Map Stacks
      summary: createSiteMapStack
      description: Create Site Map Stack
      operationId: createSiteMapStack
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/mapstack'
              - description: Request Body
                examples:
                - name: Board Room
              contentMediaType: application/json
            examples:
              Example:
                value:
                  name: Board Room
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mapstack_response'
                - description: Map Stack response object
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mapstack_response'
                - description: Map Stack response object
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/marvis_configs/count:
    get:
      tags:
      - Sites Marvis Configs
      summary: countSiteMarvisConfigActions
      description: Count Marvis Config Actions for a site by a distinct field.
      operationId: countSiteMarvisConfigActions
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field to count by. enum: `mac`, `type`, `src`, `admin_id`, `op`, `port_id`, `reason`, `vlan_ids`'
        style: form
        explode: true
        schema:
          type: string
          default: mac
      - name: mac
        in: query
        description: Filter by device MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: type
        in: query
        description: Filter by config type (e.g. wired)
        style: form
        explode: true
        schema:
          type: string
      - name: src
        in: query
        description: Filter by source of the config action (e.g. marvis)
        style: form
        explode: true
        schema:
          type: string
      - name: admin_id
        in: query
        description: Filter by admin ID
        style: form
        explode: true
        schema:
          type: string
      - name: op
        in: query
        description: Filter by operation type (e.g. disable_port, enable_port, update_mtu, add_vlans_to_port)
        style: form
        explode: true
        schema:
          type: string
      - name: port_id
        in: query
        description: Filter by port identifier (e.g. ge-0/0/13)
        style: form
        explode: true
        schema:
          type: string
      - name: vlan_ids
        in: query
        description: Filter by VLAN ID
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: reason
        in: query
        description: Filter by reason for the config action (e.g. rogue_dhcp_server_detected)
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      responses:
        '200':
          description: Count result
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/marvis_configs/search:
    get:
      tags:
      - Sites Marvis Configs
      summary: searchSiteMarvisConfigActions
      description: Search Marvis Config Actions for a site.
      operationId: searchSiteMarvisConfigActions
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mac
        in: query
        description: Filter by device MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: type
        in: query
        description: Filter by config type (e.g. wired)
        style: form
        explode: true
        schema:
          type: string
      - name: src
        in: query
        description: Filter by source of the config action (e.g. marvis)
        style: form
        explode: true
        schema:
          type: string
      - name: admin_id
        in: query
        description: Filter by admin ID
        style: form
        explode: true
        schema:
          type: string
      - name: op
        in: query
        description: Filter by operation type (e.g. disable_port, enable_port, update_mtu, add_vlans_to_port)
        style: form
        explode: true
        schema:
          type: string
      - name: port_id
        in: query
        description: Filter by port identifier (e.g. ge-0/0/13)
        style: form
        explode: true
        schema:
          type: string
      - name: vlan_ids
        in: query
        description: Filter by VLAN ID
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: reason
        in: query
        description: Filter by reason for the config action (e.g. rogue_dhcp_server_detected)
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      responses:
        '200':
          description: Paginated Marvis Config Actions search results
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/marvis_config_actions_search'
                - description: Paginated list of Marvis config actions
                  examples:
                  - end: 1775122221
                    limit: 10
                    results:
                    - admin_id: 6d617276-0000-0000-3157-000000000000
                      id: 05b46288-37d4-4860-9de4-1edc6e8d5363
                      mac: f8c1165aba00
                      op: disable_port
                      org_id: 174260d5-cb22-4ea8-badb-c77a89acb0a9
                      port_id: ge-0/0/2
                      reason: rogue_dhcp_server_detected
                      site_id: 437ac5f0-fc76-4a2b-87ab-d8d1e5c00405
                      src: marvis
                      timestamp: 1775028130.405962
                      type: wired
                      vlan_ids: []
                    - admin_id: 6d617276-0000-0000-3157-000000000000
                      id: b1a81ed4-a7a2-4945-b01d-f54afe6d5cc4
                      mac: f8c1165aba00
                      op: add_vlans_to_port
                      org_id: 174260d5-cb22-4ea8-badb-c77a89acb0a9
                      port_id: ge-0/0/12
                      reason: missing_vlans
                      site_id: 437ac5f0-fc76-4a2b-87ab-d8d1e5c00405
                      src: marvis
                      timestamp: 1774866716.15723
                      type: wired
                      vlan_ids:
                      - 100
                      - 200
                    start: 1775118621
                    total: 2
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1775122221
                    limit: 10
                    results:
                    - admin_id: 6d617276-0000-0000-3157-000000000000
                      id: 05b46288-37d4-4860-9de4-1edc6e8d5363
                      mac: f8c1165aba00
                      op: disable_port
                      org_id: 174260d5-cb22-4ea8-badb-c77a89acb0a9
                      port_id: ge-0/0/2
                      reason: rogue_dhcp_server_detected
                      site_id: 437ac5f0-fc76-4a2b-87ab-d8d1e5c00405
                      src: marvis
                      timestamp: 1775028130.405962
                      type: wired
                      vlan_ids: []
                    - admin_id: 6d617276-0000-0000-3157-000000000000
                      id: b1a81ed4-a7a2-4945-b01d-f54afe6d5cc4
                      mac: f8c1165aba00
                      op: add_vlans_to_port
                      org_id: 174260d5-cb22-4ea8-badb-c77a89acb0a9
                      port_id: ge-0/0/12
                      reason: missing_vlans
                      site_id: 437ac5f0-fc76-4a2b-87ab-d8d1e5c00405
                      src: marvis
                      timestamp: 1774866716.15723
                      type: wired
                      vlan_ids:
                      - 100
                      - 200
                    start: 1775118621
                    total: 2
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/marvis_config_actions_search'
                - description: Paginated list of Marvis config actions
                  examples:
                  - end: 1775122221
                    limit: 10
                    results:
                    - admin_id: 6d617276-0000-0000-3157-000000000000
                      id: 05b46288-37d4-4860-9de4-1edc6e8d5363
                      mac: f8c1165aba00
                      op: disable_port
                      org_id: 174260d5-cb22-4ea8-badb-c77a89acb0a9
                      port_id: ge-0/0/2
                      reason: rogue_dhcp_server_detected
                      site_id: 437ac5f0-fc76-4a2b-87ab-d8d1e5c00405
                      src: marvis
                      timestamp: 1775028130.405962
                      type: wired
                      vlan_ids: []
                    - admin_id: 6d617276-0000-0000-3157-000000000000
                      id: b1a81ed4-a7a2-4945-b01d-f54afe6d5cc4
                      mac: f8c1165aba00
                      op: add_vlans_to_port
                      org_id: 174260d5-cb22-4ea8-badb-c77a89acb0a9
                      port_id: ge-0/0/12
                      reason: missing_vlans
                      site_id: 437ac5f0-fc76-4a2b-87ab-d8d1e5c00405
                      src: marvis
                      timestamp: 1774866716.15723
                      type: wired
                      vlan_ids:
                      - 100
                      - 200
                    start: 1775118621
                    total: 2
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1775122221
                    limit: 10
                    results:
                    - admin_id: 6d617276-0000-0000-3157-000000000000
                      id: 05b46288-37d4-4860-9de4-1edc6e8d5363
                      mac: f8c1165aba00
                      op: disable_port
                      org_id: 174260d5-cb22-4ea8-badb-c77a89acb0a9
                      port_id: ge-0/0/2
                      reason: rogue_dhcp_server_detected
                      site_id: 437ac5f0-fc76-4a2b-87ab-d8d1e5c00405
                      src: marvis
                      timestamp: 1775028130.405962
                      type: wired
                      vlan_ids: []
                    - admin_id: 6d617276-0000-0000-3157-000000000000
                      id: b1a81ed4-a7a2-4945-b01d-f54afe6d5cc4
                      mac: f8c1165aba00
                      op: add_vlans_to_port
                      org_id: 174260d5-cb22-4ea8-badb-c77a89acb0a9
                      port_id: ge-0/0/12
                      reason: missing_vlans
                      site_id: 437ac5f0-fc76-4a2b-87ab-d8d1e5c00405
                      src: marvis
                      timestamp: 1774866716.15723
                      type: wired
                      vlan_ids:
                      - 100
                      - 200
                    start: 1775118621
                    total: 2
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/marvis_configs/{id}:
    delete:
      tags:
      - Sites Marvis Configs
      summary: deleteSiteMarvisConfigAction
      description: Delete a Marvis Config Action.
      operationId: deleteSiteMarvisConfigAction
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: id
        in: path
        description: UUID of the Marvis Config Action
        required: true
        schema:
          type: string
          contentEncoding: uuid
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/marvis_configs/{id}/feedback:
    post:
      tags:
      - Sites Marvis Configs
      summary: submitSiteMarvisConfigFeedback
      description: Submit feedback on a Marvis-injected config action (e.g. mark as invalid).
      operationId: submitSiteMarvisConfigFeedback
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: id
        in: path
        description: UUID of the Marvis Config Action
        required: true
        schema:
          type: string
          contentEncoding: uuid
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/marvis_config_feedback'
              - description: Request Body
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Marvis Config Feedback response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/marvis_config_feedback_response'
                - description: Response after submitting feedback on a Marvis config action
                  examples:
                  - feedback_note: this port config is intended, do not change anymore
                    feedback_type: invalid
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    feedback_note: this port config is intended, do not change anymore
                    feedback_type: invalid
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/marvis_config_feedback_response'
                - description: Response after submitting feedback on a Marvis config action
                  examples:
                  - feedback_note: this port config is intended, do not change anymore
                    feedback_type: invalid
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    feedback_note: this port config is intended, do not change anymore
                    feedback_type: invalid
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/mxedges:
    get:
      tags:
      - Sites MxEdges
      summary: listSiteMxEdges
      description: List Mist Edges for a site. Use [List Org Mist Edges]($e/Orgs%20MxEdges/listOrgMxEdges) to retrieve Mist Edges across the organization.
      operationId: listSiteMxEdges
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/mxedge'
                description: List of Mist Edge appliances
                examples:
                - - cpu_stat:
                      cpus:
                        cpu0:
                          idle: 79
                          interrupt: 0
                          system: 4
                          usage: 20
                          user: 16
                        cpu1:
                          idle: 93
                          interrupt: 0
                          system: 4
                          usage: 6
                          user: 1
                      idle: 87
                      interrupt: 0
                      system: 5
                      usage: 12
                      user: 7
                    ext_ip: 116.187.144.16
                    id: 387804a7-3474-85ce-15a2-f9a9684c9c90
                    ip_stat:
                      ip: 172.16.5.3
                      ips:
                        ens192: 172.16.5.3/24,fe81::20c:29ff:fef8:d18e/64
                    lag_stat:
                      lag0:
                        active_ports:
                        - '0'
                        - '1'
                    last_seen: 1547437078
                    magic: ExNpT5gi-ADR8WTFd4EiQPY3cP5WdSoD
                    memory_stats:
                      active: 1061085184
                      available: 4124860416
                      buffers: 789495808
                      cached: 718016512
                      free: 2818838528
                      inactive: 458158080
                      swap_cached: 0
                      swap_free: 8161062912
                      swap_total: 8161062912
                      total: 7947616256
                      usage: 65
                    model: ME-S2019
                    mxagent_registered: false
                    mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4
                    name: Guest
                    num_tunnels: 31
                    port_stat:
                      eth0:
                        full_duplex: true
                        lldp_stats:
                          mgmt_addr: 122.16.3.11
                          port_desc: GigabitEthernet4/0/16
                          port_id: "\x05Gi4/0/16"
                          system_desc: Cisco IOS Software
                          system_name: ME-DC2-DIS-SW
                        rx_bytes: 2056
                        rx_errors: 0
                        rx_pkts: 670
                        speed: 1000
                        tx_bytes: 2056
                        tx_pkts: 670
                        up: true
                      eth1:
                        up: false
                      module:
                        up: false
                    status: connected
                    tunterm_registered: false
                    tunterm_stat:
                      monitoring_failed: false
                    uptime: 884221
                    version: 0.1.2
                    virtualization_type: VirtualizationVMware
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - cpu_stat:
                      cpus:
                        cpu0:
                          idle: 79
                          interrupt: 0
                          system: 4
                          usage: 20
                          user: 16
                        cpu1:
                          idle: 93
                          interrupt: 0
                          system: 4
                          usage: 6
                          user: 1
                      idle: 87
                      interrupt: 0
                      system: 5
                      usage: 12
                      user: 7
                    ext_ip: 116.187.144.16
                    id: 387804a7-3474-85ce-15a2-f9a9684c9c90
                    ip_stat:
                      ip: 172.16.5.3
                      ips:
                        ens192: 172.16.5.3/24,fe81::20c:29ff:fef8:d18e/64
                    lag_stat:
                      lag0:
                        active_ports:
                        - '0'
                        - '1'
                    last_seen: 1547437078
                    magic: ExNpT5gi-ADR8WTFd4EiQPY3cP5WdSoD
                    memory_stats:
                      active: 1061085184
                      available: 4124860416
                      buffers: 789495808
                      cached: 718016512
                      free: 2818838528
                      inactive: 458158080
                      swap_cached: 0
                      swap_free: 8161062912
                      swap_total: 8161062912
                      total: 7947616256
                      usage: 65
                    model: ME-S2019
                    mxagent_registered: false
                    mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4
                    name: Guest
                    num_tunnels: 31
                    port_stat:
                      eth0:
                        full_duplex: true
                        lldp_stats:
                          mgmt_addr: 122.16.3.11
                          port_desc: GigabitEthernet4/0/16
                          port_id: "\x05Gi4/0/16"
                          system_desc: Cisco IOS Software
                          system_name: ME-DC2-DIS-SW
                        rx_bytes: 2056
                        rx_errors: 0
                        rx_pkts: 670
                        speed: 1000
                        tx_bytes: 2056
                        tx_pkts: 670
                        up: true
                      eth1:
                        up: false
                      module:
                        up: false
                    status: connected
                    tunterm_registered: false
                    tunterm_stat:
                      monitoring_failed: false
                    uptime: 884221
                    version: 0.1.2
                    virtualization_type: VirtualizationVMware
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/mxedge'
                description: List of Mist Edge appliances
                examples:
                - - cpu_stat:
                      cpus:
                        cpu0:
                          idle: 79
                          interrupt: 0
                          system: 4
                          usage: 20
                          user: 16
                        cpu1:
                          idle: 93
                          interrupt: 0
                          system: 4
                          usage: 6
                          user: 1
                      idle: 87
                      interrupt: 0
                      system: 5
                      usage: 12
                      user: 7
                    ext_ip: 116.187.144.16
                    id: 387804a7-3474-85ce-15a2-f9a9684c9c90
                    ip_stat:
                      ip: 172.16.5.3
                      ips:
                        ens192: 172.16.5.3/24,fe81::20c:29ff:fef8:d18e/64
                    lag_stat:
                      lag0:
                        active_ports:
                        - '0'
                        - '1'
                    last_seen: 1547437078
                    magic: ExNpT5gi-ADR8WTFd4EiQPY3cP5WdSoD
                    memory_stats:
                      active: 1061085184
                      available: 4124860416
                      buffers: 789495808
                      cached: 718016512
                      free: 2818838528
                      inactive: 458158080
                      swap_cached: 0
                      swap_free: 8161062912
                      swap_total: 8161062912
                      total: 7947616256
                      usage: 65
                    model: ME-S2019
                    mxagent_registered: false
                    mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4
                    name: Guest
                    num_tunnels: 31
                    port_stat:
                      eth0:
                        full_duplex: true
                        lldp_stats:
                          mgmt_addr: 122.16.3.11
                          port_desc: GigabitEthernet4/0/16
                          port_id: "\x05Gi4/0/16"
                          system_desc: Cisco IOS Software
                          system_name: ME-DC2-DIS-SW
                        rx_bytes: 2056
                        rx_errors: 0
                        rx_pkts: 670
                        speed: 1000
                        tx_bytes: 2056
                        tx_pkts: 670
                        up: true
                      eth1:
                        up: false
                      module:
                        up: false
                    status: connected
                    tunterm_registered: false
                    tunterm_stat:
                      monitoring_failed: false
                    uptime: 884221
                    version: 0.1.2
                    virtualization_type: VirtualizationVMware
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - cpu_stat:
                      cpus:
                        cpu0:
                          idle: 79
                          interrupt: 0
                          system: 4
                          usage: 20
                          user: 16
                        cpu1:
                          idle: 93
                          interrupt: 0
                          system: 4
                          usage: 6
                          user: 1
                      idle: 87
                      interrupt: 0
                      system: 5
                      usage: 12
                      user: 7
                    ext_ip: 116.187.144.16
                    id: 387804a7-3474-85ce-15a2-f9a9684c9c90
                    ip_stat:
                      ip: 172.16.5.3
                      ips:
                        ens192: 172.16.5.3/24,fe81::20c:29ff:fef8:d18e/64
                    lag_stat:
                      lag0:
                        active_ports:
                        - '0'
                        - '1'
                    last_seen: 1547437078
                    magic: ExNpT5gi-ADR8WTFd4EiQPY3cP5WdSoD
                    memory_stats:
                      active: 1061085184
                      available: 4124860416
                      buffers: 789495808
                      cached: 718016512
                      free: 2818838528
                      inactive: 458158080
                      swap_cached: 0
                      swap_free: 8161062912
                      swap_total: 8161062912
                      total: 7947616256
                      usage: 65
                    model: ME-S2019
                    mxagent_registered: false
                    mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4
                    name: Guest
                    num_tunnels: 31
                    port_stat:
                      eth0:
                        full_duplex: true
                        lldp_stats:
                          mgmt_addr: 122.16.3.11
                          port_desc: GigabitEthernet4/0/16
                          port_id: "\x05Gi4/0/16"
                          system_desc: Cisco IOS Software
                          system_name: ME-DC2-DIS-SW
                        rx_bytes: 2056
                        rx_errors: 0
                        rx_pkts: 670
                        speed: 1000
                        tx_bytes: 2056
                        tx_pkts: 670
                        up: true
                      eth1:
                        up: false
                      module:
                        up: false
                    status: connected
                    tunterm_registered: false
                    tunterm_stat:
                      monitoring_failed: false
                    uptime: 884221
                    version: 0.1.2
                    virtualization_type: VirtualizationVMware
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/mxedges/events/count:
    get:
      tags:
      - Sites MxEdges
      summary: countSiteMxEdgeEvents
      description: Count by Distinct Attributes of Mist Edge Events
      operationId: countSiteMxEdgeEvents
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `mxcluster_id`, `mxedge_id`, `package`, `type`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/site_mxedge_events_count_distinct'
          - description: 'Field used to group this count response. enum: `mxcluster_id`, `mxedge_id`, `package`, `type`'
      - name: mxedge_id
        in: query
        description: Filter results by Mist Edge identifier
        style: form
        explode: true
        schema:
          type: string
      - name: mxcluster_id
        in: query
        description: Mist edge cluster id
        style: form
        explode: true
        schema:
          type: string
      - name: type
        in: query
        description: See [List Device Events Definitions]($e/Constants%20Events/listDeviceEventsDefinitions)
        style: form
        explode: true
        schema:
          type: string
      - name: service
        in: query
        description: Filter results by service name
        style: form
        explode: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/mxedges/events/search:
    get:
      tags:
      - Sites MxEdges
      summary: searchSiteMistEdgeEvents
      description: Search Mist Edge events for a site with filters for Mist Edge, Mist Edge cluster, event type, service, component, and time range. Use [Search Org Mist Edge Events]($e/Orgs%20MxEdges/searchOrgMistEdgeEvents) to search Mist Edge events across the organization.
      operationId: searchSiteMistEdgeEvents
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mxedge_id
        in: query
        description: Filter results by Mist Edge identifier
        style: form
        explode: true
        schema:
          type: string
      - name: mxcluster_id
        in: query
        description: Mist edge cluster id
        style: form
        explode: true
        schema:
          type: string
      - name: type
        in: query
        description: See [List Device Events Definitions]($e/Constants%20Events/listDeviceEventsDefinitions)
        style: form
        explode: true
        schema:
          type: string
      - name: service
        in: query
        description: Filter results by service name
        style: form
        explode: true
        schema:
          type: string
      - name: component
        in: query
        description: Filter results by component name
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 10
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_mxedge_events_search'
                - description: Search response for Mist Edge event records
                  examples:
                  - end: 1694708579
                    limit: 10
                    page: 3
                    results:
                    - mxcluster_id: 2815c917-58e7-472f-a190-bfd44fb58d05
                      mxedge_id: 00000000-0000-0000-1000-020000dc585c
                      org_id: f2695c32-0e83-4936-b1b2-96fc88051213
                      service: tunterm
                      timestamp: 1694678225.927
                      type: ME_SERVICE_STOPPED
                    start: 1694622179
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1694708579
                    limit: 10
                    page: 3
                    results:
                    - mxcluster_id: 2815c917-58e7-472f-a190-bfd44fb58d05
                      mxedge_id: 00000000-0000-0000-1000-020000dc585c
                      org_id: f2695c32-0e83-4936-b1b2-96fc88051213
                      service: tunterm
                      timestamp: 1694678225.927
                      type: ME_SERVICE_STOPPED
                    start: 1694622179
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_mxedge_events_search'
                - description: Search response for Mist Edge event records
                  examples:
                  - end: 1694708579
                    limit: 10
                    page: 3
                    results:
                    - mxcluster_id: 2815c917-58e7-472f-a190-bfd44fb58d05
                      mxedge_id: 00000000-0000-0000-1000-020000dc585c
                      org_id: f2695c32-0e83-4936-b1b2-96fc88051213
                      service: tunterm
                      timestamp: 1694678225.927
                      type: ME_SERVICE_STOPPED
                    start: 1694622179
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1694708579
                    limit: 10
                    page: 3
                    results:
                    - mxcluster_id: 2815c917-58e7-472f-a190-bfd44fb58d05
                      mxedge_id: 00000000-0000-0000-1000-020000dc585c
                      org_id: f2695c32-0e83-4936-b1b2-96fc88051213
                      service: tunterm
                      timestamp: 1694678225.927
                      type: ME_SERVICE_STOPPED
                    start: 1694622179
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/mxedges/{mxedge_id}:
    delete:
      tags:
      - Sites MxEdges
      summary: deleteSiteMxEdge
      description: Delete Site Mist Edge
      operationId: deleteSiteMxEdge
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mxedge_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Sites MxEdges
      summary: getSiteMxEdge
      description: Get Site Mist Edge
      operationId: getSiteMxEdge
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mxedge_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Sites MxEdges
      summary: updateSiteMxEdge
      description: Update Site Mist Edge settings
      operationId: updateSiteMxEdge
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mxedge_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/mxedge'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mxedge'
                - description: Mist Edge appliance configuration and registration state
                  examples:
                  - id: 95ddd29a-6a3c-929e-a431-51a5b09f36a6
                    magic: L-NpT5gi-ADR8WTFd4EiQPY3cP5WdSoD
                    model: ME-100
                    mxagent_registered: true
                    mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4
                    mxedge_mgmt:
                      mist_password: MIST_PASSWORD
                      root_password: ROOT_PASSWORD
                    name: Guest
                    ntp_servers: []
                    oob_ip_config:
                      dns:
                      - 8.8.8.8
                      - 4.4.4.4
                      gateway: 10.2.1.254
                      ip: 10.2.1.10
                      netmask: 255.255.255.0
                      type: static
                    tunterm_dhcpd_config:
                      '2':
                        enabled: true
                        servers:
                        - 11.2.3.44
                      enabled: false
                      servers:
                      - 11.2.3.4
                    tunterm_extra_routes:
                      11.0.0.0/8:
                        via: 10.3.3.1
                    tunterm_ip_config:
                      gateway: 10.2.1.254
                      ip: 10.2.1.1
                      netmask: 255.255.255.0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    id: 95ddd29a-6a3c-929e-a431-51a5b09f36a6
                    magic: L-NpT5gi-ADR8WTFd4EiQPY3cP5WdSoD
                    model: ME-100
                    mxagent_registered: true
                    mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4
                    mxedge_mgmt:
                      mist_password: MIST_PASSWORD
                      root_password: ROOT_PASSWORD
                    name: Guest
                    ntp_servers: []
                    oob_ip_config:
                      dns:
                      - 8.8.8.8
                      - 4.4.4.4
                      gateway: 10.2.1.254
                      ip: 10.2.1.10
                      netmask: 255.255.255.0
                      type: static
                    tunterm_dhcpd_config:
                      '2':
                        enabled: true
                        servers:
                        - 11.2.3.44
                      enabled: false
                      servers:
                      - 11.2.3.4
                    tunterm_extra_routes:
                      11.0.0.0/8:
                        via: 10.3.3.1
                    tunterm_ip_config:
                      gateway: 10.2.1.254
                      ip: 10.2.1.1
                      netmask: 255.255.255.0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mxedge'
                - description: Mist Edge appliance configuration and registration state
                  examples:
                  - id: 95ddd29a-6a3c-929e-a431-51a5b09f36a6
                    magic: L-NpT5gi-ADR8WTFd4EiQPY3cP5WdSoD
                    model: ME-100
                    mxagent_registered: true
                    mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4
                    mxedge_mgmt:
                      mist_password: MIST_PASSWORD
                      root_password: ROOT_PASSWORD
                    name: Guest
                    ntp_servers: []
                    oob_ip_config:
                      dns:
                      - 8.8.8.8
                      - 4.4.4.4
                      gateway: 10.2.1.254
                      ip: 10.2.1.10
                      netmask: 255.255.255.0
                      type: static
                    tunterm_dhcpd_config:
                      '2':
                        enabled: true
                        servers:
                        - 11.2.3.44
                      enabled: false
                      servers:
                      - 11.2.3.4
                    tunterm_extra_routes:
                      11.0.0.0/8:
                        via: 10.3.3.1
                    tunterm_ip_config:
                      gateway: 10.2.1.254
                      ip: 10.2.1.1
                      netmask: 255.255.255.0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    id: 95ddd29a-6a3c-929e-a431-51a5b09f36a6
                    magic: L-NpT5gi-ADR8WTFd4EiQPY3cP5WdSoD
                    model: ME-100
                    mxagent_registered: true
                    mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4
                    mxedge_mgmt:
                      mist_password: MIST_PASSWORD
                      root_password: ROOT_PASSWORD
                    name: Guest
                    ntp_servers: []
                    oob_ip_config:
                      dns:
                      - 8.8.8.8
                      - 4.4.4.4
                      gateway: 10.2.1.254
                      ip: 10.2.1.10
                      netmask: 255.255.255.0
                      type: static
                    tunterm_dhcpd_config:
                      '2':
                        enabled: true
                        servers:
                        - 11.2.3.44
                      enabled: false
                      servers:
                      - 11.2.3.4
                    tunterm_extra_routes:
                      11.0.0.0/8:
                        via: 10.3.3.1
                    tunterm_ip_config:
                      gateway: 10.2.1.254
                      ip: 10.2.1.1
                      netmask: 255.255.255.0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/mxedges/{mxedge_id}/support:
    post:
      tags:
      - Sites MxEdges
      summary: uploadSiteMxEdgeSupportFiles
      description: Support / Upload Mist Edge support files
      operationId: uploadSiteMxEdgeSupportFiles
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mxedge_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/networktemplates/derived:
    get:
      tags:
      - Sites Network Templates
      summary: listSiteNetworkTemplatesDerived
      description: Get the list of derived Network Templates a Site
      operationId: listSiteNetworkTemplatesDerived
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: resolve
        in: query
        description: Whether resolve the site variables
        style: form
        explode: true
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/network_template'
                - description: Network template configuration applied to sites or site groups
                  examples:
                  - additional_config_cmds:
                    - set snmp community public
                    created_time: 0
                    dhcp_snooping:
                      all_networks: true
                      enable_arp_spoof_check: true
                      enable_ip_source_guard: true
                      enabled: true
                      networks:
                      - string
                    dns_servers:
                    - string
                    dns_suffix:
                    - string
                    extra_routes:
                      property1:
                        via: string
                      property2:
                        via: string
                    group_tags: {}
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6708
                    import_org_networks:
                    - ap
                    mist_nac:
                      enabled: true
                      network: string
                    modified_time: 0
                    name: string
                    networks:
                      property1:
                        subnet: 192.168.1.0/24
                        vlan_id: 10
                      property2:
                        subnet: 192.168.1.0/24
                        vlan_id: 10
                    ntp_servers:
                    - string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    port_usages:
                      dynamic:
                        mode: dynamic
                        reset_default_when: link_down
                        rules:
                        - equals: string
                          equals_any:
                          - string
                          expression: string
                          src: lldp_chassis_id
                          usage: string
                      property1:
                        all_networks: false
                        allow_dhcpd: true
                        bypass_auth_when_server_down: true
                        description: string
                        disable_autoneg: false
                        disabled: false
                        duplex: auto
                        enable_mac_auth: true
                        enable_qos: true
                        guest_network: string
                        mac_auth_only: true
                        mac_auth_protocol: pap
                        mac_limit: 0
                        networks:
                        - string
                        persist_mac: false
                        poe_disabled: false
                        port_auth: dot1x
                        port_network: string
                        server_reject_network: null
                        speed: auto
                        storm_control:
                          no_broadcast: false
                          no_multicast: false
                          no_registered_multicast: false
                          no_unknown_unicast: false
                          percentage: 80
                        stp_edge: true
                        voip_network: string
                      property2:
                        all_networks: false
                        allow_dhcpd: true
                        bypass_auth_when_server_down: true
                        description: string
                        disable_autoneg: false
                        disabled: false
                        duplex: auto
                        enable_mac_auth: true
                        enable_qos: true
                        guest_network: string
                        mac_auth_only: true
                        mac_auth_protocol: pap
                        mac_limit: 0
                        mode: access
                        networks:
                        - string
                        persist_mac: false
                        poe_disabled: false
                        port_network: string
                        server_reject_network: null
                        speed: auto
                        storm_control:
                          no_broadcast: false
                          no_multicast: false
                          no_registered_multicast: false
                          no_unknown_unicast: false
                          percentage: 80
                        stp_edge: true
                        voip_network: string
                    switch_mgmt:
                      config_revert_timer: 10
                      protect_re:
                        enabled: false
                      root_password: string
                      tacacs:
                        acct_servers:
                        - host: 198.51.100.1
                          port: '49'
                          secret: string
                          timeout: 10
                        enabled: true
                        network: string
                        tacplus_servers:
                        - host: 198.51.100.1
                          port: '49'
                          secret: string
                          timeout: 10
                    vrf_config:
                      enabled: false
                    vrf_instances:
                      property1:
                        extra_routes:
                          property1:
                            via: 198.51.100.1
                          property2:
                            via: 198.51.100.10
                        networks:
                        - string
                      property2:
                        extra_routes:
                          property1:
                            via: 198.51.100.1
                          property2:
                            via: 198.51.100.10
                        networks:
                        - string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    additional_config_cmds:
                    - set snmp community public
                    created_time: 0
                    dhcp_snooping:
                      all_networks: true
                      enable_arp_spoof_check: true
                      enable_ip_source_guard: true
                      enabled: true
                      networks:
                      - string
                    dns_servers:
                    - string
                    dns_suffix:
                    - string
                    extra_routes:
                      property1:
                        via: string
                      property2:
                        via: string
                    group_tags: {}
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6708
                    import_org_networks:
                    - ap
                    mist_nac:
                      enabled: true
                      network: string
                    modified_time: 0
                    name: string
                    networks:
                      property1:
                        subnet: 192.168.1.0/24
                        vlan_id: 10
                      property2:
                        subnet: 192.168.1.0/24
                        vlan_id: 10
                    ntp_servers:
                    - string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    port_usages:
                      dynamic:
                        mode: dynamic
                        reset_default_when: link_down
                        rules:
                        - equals: string
                          equals_any:
                          - string
                          expression: string
                          src: lldp_chassis_id
                          usage: string
                      property1:
                        all_networks: false
                        allow_dhcpd: true
                        bypass_auth_when_server_down: true
                        description: string
                        disable_autoneg: false
                        disabled: false
                        duplex: auto
                        enable_mac_auth: true
                        enable_qos: true
                        guest_network: string
                        mac_auth_only: true
                        mac_auth_protocol: pap
                        mac_limit: 0
                        networks:
                        - string
                        persist_mac: false
                        poe_disabled: false
                        port_auth: dot1x
                        port_network: string
                        server_reject_network: null
                        speed: auto
                        storm_control:
                          no_broadcast: false
                          no_multicast: false
                          no_registered_multicast: false
                          no_unknown_unicast: false
                          percentage: 80
                        stp_edge: true
                        voip_network: string
                      property2:
                        all_networks: false
                        allow_dhcpd: true
                        bypass_auth_when_server_down: true
                        description: string
                        disable_autoneg: false
                        disabled: false
                        duplex: auto
                        enable_mac_auth: true
                        enable_qos: true
                        guest_network: string
                        mac_auth_only: true
                        mac_auth_protocol: pap
                        mac_limit: 0
                        mode: access
                        networks:
                        - string
                        persist_mac: false
                        poe_disabled: false
                        port_network: string
                        server_reject_network: null
                        speed: auto
                        storm_control:
                          no_broadcast: false
                          no_multicast: false
                          no_registered_multicast: false
                          no_unknown_unicast: false
                          percentage: 80
                        stp_edge: true
                        voip_network: string
                    switch_mgmt:
                      config_revert_timer: 10
                      protect_re:
                        enabled: false
                      root_password: string
                      tacacs:
                        acct_servers:
                        - host: 198.51.100.1
                          port: '49'
                          secret: string
                          timeout: 10
                        enabled: true
                        network: string
                        tacplus_servers:
                        - host: 198.51.100.1
                          port: '49'
                          secret: string
                          timeout: 10
                    vrf_config:
                      enabled: false
                    vrf_instances:
                      property1:
                        extra_routes:
                          property1:
                            via: 198.51.100.1
                          property2:
                            via: 198.51.100.10
                        networks:
                        - string
                      property2:
                        extra_routes:
                          property1:
                            via: 198.51.100.1
                          property2:
                            via: 198.51.100.10
                        networks:
                        - string
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/network_template'
                - description: Network template configuration applied to sites or site groups
                  examples:
                  - additional_config_cmds:
                    - set snmp community public
                    created_time: 0
                    dhcp_snooping:
                      all_networks: true
                      enable_arp_spoof_check: true
                      enable_ip_source_guard: true
                      enabled: true
                      networks:
                      - string
                    dns_servers:
                    - string
                    dns_suffix:
                    - string
                    extra_routes:
                      property1:
                        via: string
                      property2:
                        via: string
                    group_tags: {}
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6708
                    import_org_networks:
                    - ap
                    mist_nac:
                      enabled: true
                      network: string
                    modified_time: 0
                    name: string
                    networks:
                      property1:
                        subnet: 192.168.1.0/24
                        vlan_id: 10
                      property2:
                        subnet: 192.168.1.0/24
                        vlan_id: 10
                    ntp_servers:
                    - string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    port_usages:
                      dynamic:
                        mode: dynamic
                        reset_default_when: link_down
                        rules:
                        - equals: string
                          equals_any:
                          - string
                          expression: string
                          src: lldp_chassis_id
                          usage: string
                      property1:
                        all_networks: false
                        allow_dhcpd: true
                        bypass_auth_when_server_down: true
                        description: string
                        disable_autoneg: false
                        disabled: false
                        duplex: auto
                        enable_mac_auth: true
                        enable_qos: true
                        guest_network: string
                        mac_auth_only: true
                        mac_auth_protocol: pap
                        mac_limit: 0
                        networks:
                        - string
                        persist_mac: false
                        poe_disabled: false
                        port_auth: dot1x
                        port_network: string
                        server_reject_network: null
                        speed: auto
                        storm_control:
                          no_broadcast: false
                          no_multicast: false
                          no_registered_multicast: false
                          no_unknown_unicast: false
                          percentage: 80
                        stp_edge: true
                        voip_network: string
                      property2:
                        all_networks: false
                        allow_dhcpd: true
                        bypass_auth_when_server_down: true
                        description: string
                        disable_autoneg: false
                        disabled: false
                        duplex: auto
                        enable_mac_auth: true
                        enable_qos: true
                        guest_network: string
                        mac_auth_only: true
                        mac_auth_protocol: pap
                        mac_limit: 0
                        mode: access
                        networks:
                        - string
                        persist_mac: false
                        poe_disabled: false
                        port_network: string
                        server_reject_network: null
                        speed: auto
                        storm_control:
                          no_broadcast: false
                          no_multicast: false
                          no_registered_multicast: false
                          no_unknown_unicast: false
                          percentage: 80
                        stp_edge: true
                        voip_network: string
                    switch_mgmt:
                      config_revert_timer: 10
                      protect_re:
                        enabled: false
                      root_password: string
                      tacacs:
                        acct_servers:
                        - host: 198.51.100.1
                          port: '49'
                          secret: string
                          timeout: 10
                        enabled: true
                        network: string
                        tacplus_servers:
                        - host: 198.51.100.1
                          port: '49'
                          secret: string
                          timeout: 10
                    vrf_config:
                      enabled: false
                    vrf_instances:
                      property1:
                        extra_routes:
                          property1:
                            via: 198.51.100.1
                          property2:
                            via: 198.51.100.10
                        networks:
                        - string
                      property2:
                        extra_routes:
                          property1:
                            via: 198.51.100.1
                          property2:
                            via: 198.51.100.10
                        networks:
                        - string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    additional_config_cmds:
                    - set snmp community public
                    created_time: 0
                    dhcp_snooping:
                      all_networks: true
                      enable_arp_spoof_check: true
                      enable_ip_source_guard: true
                      enabled: true
                      networks:
                      - string
                    dns_servers:
                    - string
                    dns_suffix:
                    - string
                    extra_routes:
                      property1:
                        via: string
                      property2:
                        via: string
                    group_tags: {}
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6708
                    import_org_networks:
                    - ap
                    mist_nac:
                      enabled: true
                      network: string
                    modified_time: 0
                    name: string
                    networks:
                      property1:
                        subnet: 192.168.1.0/24
                        vlan_id: 10
                      property2:
                        subnet: 192.168.1.0/24
                        vlan_id: 10
                    ntp_servers:
                    - string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    port_usages:
                      dynamic:
                        mode: dynamic
                        reset_default_when: link_down
                        rules:
                        - equals: string
                          equals_any:
                          - string
                          expression: string
                          src: lldp_chassis_id
                          usage: string
                      property1:
                        all_networks: false
                        allow_dhcpd: true
                        bypass_auth_when_server_down: true
                        description: string
                        disable_autoneg: false
                        disabled: false
                        duplex: auto
                        enable_mac_auth: true
                        enable_qos: true
                        guest_network: string
                        mac_auth_only: true
                        mac_auth_protocol: pap
                        mac_limit: 0
                        networks:
                        - string
                        persist_mac: false
                        poe_disabled: false
                        port_auth: dot1x
                        port_network: string
                        server_reject_network: null
                        speed: auto
                        storm_control:
                          no_broadcast: false
                          no_multicast: false
                          no_registered_multicast: false
                          no_unknown_unicast: false
                          percentage: 80
                        stp_edge: true
                        voip_network: string
                      property2:
                        all_networks: false
                        allow_dhcpd: true
                        bypass_auth_when_server_down: true
                        description: string
                        disable_autoneg: false
                        disabled: false
                        duplex: auto
                        enable_mac_auth: true
                        enable_qos: true
                        guest_network: string
                        mac_auth_only: true
                        mac_auth_protocol: pap
                        mac_limit: 0
                        mode: access
                        networks:
                        - string
                        persist_mac: false
                        poe_disabled: false
                        port_network: string
                        server_reject_network: null
                        speed: auto
                        storm_control:
                          no_broadcast: false
                          no_multicast: false
                          no_registered_multicast: false
                          no_unknown_unicast: false
                          percentage: 80
                        stp_edge: true
                        voip_network: string
                    switch_mgmt:
                      config_revert_timer: 10
                      protect_re:
                        enabled: false
                      root_password: string
                      tacacs:
                        acct_servers:
                        - host: 198.51.100.1
                          port: '49'
                          secret: string
                          timeout: 10
                        enabled: true
                        network: string
                        tacplus_servers:
                        - host: 198.51.100.1
                          port: '49'
                          secret: string
                          timeout: 10
                    vrf_config:
                      enabled: false
                    vrf_instances:
                      property1:
                        extra_routes:
                          property1:
                            via: 198.51.100.1
                          property2:
                            via: 198.51.100.10
                        networks:
                        - string
                      property2:
                        extra_routes:
                          property1:
                            via: 198.51.100.1
                          property2:
                            via: 198.51.100.10
                        networks:
                        - string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/networks/derived:
    get:
      tags:
      - Sites Networks
      summary: listSiteNetworksDerived
      description: Get the list of derived Networks for a Site
      operationId: listSiteNetworksDerived
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: resolve
        in: query
        description: Whether resolve the site variables
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/network'
                description: List of organization network definitions
                examples:
                - - created_time: 0
                    disallow_mist_services: false
                    gateway: 192.168.70.1
                    hosts:
                      property1:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                      property2:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6f13
                    internal_access:
                      enabled: true
                    internet_access:
                      create_simple_service_policy: false
                      destination_nat:
                        property1:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                        property2:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                      enabled: true
                      restricted: false
                      static_nat:
                        property1:
                          internal_ip: 192.168.70.3
                          name: printer-1
                        property2:
                          internal_ip: 192.168.70.3
                          name: printer-1
                    isolation: true
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    subnet: 192.168.70.0/24
                    tenants:
                      property1:
                        addresses:
                        - 10.10.10.10
                      property2:
                        addresses:
                        - 10.10.10.45
                    vlan_id: 10
                    vpn_access:
                      property1:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
                      property2:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 0
                    disallow_mist_services: false
                    gateway: 192.168.70.1
                    hosts:
                      property1:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                      property2:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6f13
                    internal_access:
                      enabled: true
                    internet_access:
                      create_simple_service_policy: false
                      destination_nat:
                        property1:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                        property2:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                      enabled: true
                      restricted: false
                      static_nat:
                        property1:
                          internal_ip: 192.168.70.3
                          name: printer-1
                        property2:
                          internal_ip: 192.168.70.3
                          name: printer-1
                    isolation: true
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    subnet: 192.168.70.0/24
                    tenants:
                      property1:
                        addresses:
                        - 10.10.10.10
                      property2:
                        addresses:
                        - 10.10.10.45
                    vlan_id: 10
                    vpn_access:
                      property1:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
                      property2:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/network'
                description: List of organization network definitions
                examples:
                - - created_time: 0
                    disallow_mist_services: false
                    gateway: 192.168.70.1
                    hosts:
                      property1:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                      property2:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6f13
                    internal_access:
                      enabled: true
                    internet_access:
                      create_simple_service_policy: false
                      destination_nat:
                        property1:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                        property2:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                      enabled: true
                      restricted: false
                      static_nat:
                        property1:
                          internal_ip: 192.168.70.3
                          name: printer-1
                        property2:
                          internal_ip: 192.168.70.3
                          name: printer-1
                    isolation: true
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    subnet: 192.168.70.0/24
                    tenants:
                      property1:
                        addresses:
                        - 10.10.10.10
                      property2:
                        addresses:
                        - 10.10.10.45
                    vlan_id: 10
                    vpn_access:
                      property1:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
                      property2:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 0
                    disallow_mist_services: false
                    gateway: 192.168.70.1
                    hosts:
                      property1:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                      property2:
                        external_ips: 172.16.10.32-172.16.10.35
                        ips: 192.168.70.32-192.168.70.35
                    id: 497f6eca-6276-4993-bfeb-53cbbbba6f13
                    internal_access:
                      enabled: true
                    internet_access:
                      create_simple_service_policy: false
                      destination_nat:
                        property1:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                        property2:
                          internal_ip: 192.168.70.30
                          name: web server
                          port: '443'
                      enabled: true
                      restricted: false
                      static_nat:
                        property1:
                          internal_ip: 192.168.70.3
                          name: printer-1
                        property2:
                          internal_ip: 192.168.70.3
                          name: printer-1
                    isolation: true
                    modified_time: 0
                    name: string
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    subnet: 192.168.70.0/24
                    tenants:
                      property1:
                        addresses:
                        - 10.10.10.10
                      property2:
                        addresses:
                        - 10.10.10.45
                    vlan_id: 10
                    vpn_access:
                      property1:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
                      property2:
                        allow_ping: true
                        destination_nat:
                          property1:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                          property2:
                            internal_ip: 192.168.70.5/30
                            name: web server
                            port: '443'
                        nat_pool: 172.16.0.0/26
                        routed: true
                        source_nat:
                          external_ip: 172.16.0.8/30
                        static_nat:
                          property1:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                          property2:
                            internal_ip: 192.168.70.3
                            name: pos_station-1
                        summarized_subnet: 172.16.0.0/16
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/psks:
    get:
      tags:
      - Sites Psks
      summary: listSitePsks
      description: Get List of Site PSKs
      operationId: listSitePsks
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: ssid
        in: query
        description: Filter results by SSID
        style: form
        explode: true
        schema:
          type: string
      - name: role
        in: query
        description: Filter PSK results by role
        style: form
        explode: true
        schema:
          type: string
      - name: name
        in: query
        description: Filter results by name
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/psk'
                description: List of personal PSK configurations
                examples:
                - - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    passphrase: secretpsk
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ssid: string
                    usage: multi
                    vlan_id: 1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    passphrase: secretpsk
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ssid: string
                    usage: multi
                    vlan_id: 1
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/psk'
                description: List of personal PSK configurations
                examples:
                - - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    passphrase: secretpsk
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ssid: string
                    usage: multi
                    vlan_id: 1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    passphrase: secretpsk
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ssid: string
                    usage: multi
                    vlan_id: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites Psks
      summary: createSitePsk
      description: >-
        Create Site PSK



        When `usage`==`macs`, corresponding "macs" field will hold a list consisting of client MAC addresses (["xx:xx:xx:xx:xx",...]) or mac patterns(["xx:xx:*","xx*",...]) or both (["xx:xx:xx:xx:xx:xx", "xx:*", ...]). This list is capped at 5000
      operationId: createSitePsk
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/psk'
              - description: Request Body
                examples:
                - mac: string
                  name: string
                  passphrase: secretpsk
                  ssid: string
                  usage: multi
                  vlan_id: 1
              contentMediaType: application/json
            examples:
              Example:
                value:
                  mac: string
                  name: string
                  passphrase: secretpsk
                  ssid: string
                  usage: multi
                  vlan_id: 1
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/psk'
                - description: Personal pre-shared key configuration for WLAN access
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/psk'
                - description: Personal pre-shared key configuration for WLAN access
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Sites Psks
      summary: updateSiteMultiplePsks
      description: Update multiple PSKs
      operationId: updateSiteMultiplePsks
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              uniqueItems: true
              type: array
              items:
                $ref: '#/components/schemas/psk'
              description: ''
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/psk'
                description: List of personal PSK configurations
                examples:
                - - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    passphrase: secretpsk
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ssid: string
                    usage: multi
                    vlan_id: 1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    passphrase: secretpsk
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ssid: string
                    usage: multi
                    vlan_id: 1
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/psk'
                description: List of personal PSK configurations
                examples:
                - - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    passphrase: secretpsk
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ssid: string
                    usage: multi
                    vlan_id: 1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    passphrase: secretpsk
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ssid: string
                    usage: multi
                    vlan_id: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/psks/import:
    post:
      tags:
      - Sites Psks
      summary: importSitePsks
      description: >-
        Import PSK from CSV file or JSON


        ## CSV File Format

        ```csv

        PSK Import CSV File Format:

        name,ssid,passphrase,usage,vlan_id,mac

        Common,warehouse,foryoureyesonly,single,35,a31425f31278

        Justin,reception,visible,multi,1002

        ```
      operationId: importSitePsks
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              type: object
              properties:
                file:
                  type: string
                  description: Uploaded CSV or binary file containing PSKs to import
                  contentEncoding: base64
              contentMediaType: multipart/form-data
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/psk'
                description: List of personal PSK configurations
                examples:
                - - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    passphrase: secretpsk
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ssid: string
                    usage: multi
                    vlan_id: 1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    passphrase: secretpsk
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ssid: string
                    usage: multi
                    vlan_id: 1
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/psk'
                description: List of personal PSK configurations
                examples:
                - - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    passphrase: secretpsk
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ssid: string
                    usage: multi
                    vlan_id: 1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    passphrase: secretpsk
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ssid: string
                    usage: multi
                    vlan_id: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/psks/{psk_id}:
    delete:
      tags:
      - Sites Psks
      summary: deleteSitePsk
      description: Delete Site PSK
      operationId: deleteSitePsk
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: psk_id
        in: path
        description: PSK ID
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Sites Psks
      summary: getSitePsk
      description: Get Site PSK Details
      operationId: getSitePsk
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: psk_id
        in: path
        description: PSK ID
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/psk'
                - description: Personal pre-shared key configuration for WLAN access
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/psk'
                - description: Personal pre-shared key configuration for WLAN access
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Sites Psks
      summary: updateSitePsk
      description: Update Site PSK
      operationId: updateSitePsk
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: psk_id
        in: path
        description: PSK ID
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/psk'
              - description: Request Body
                examples:
                - mac: string
                  name: string
                  passphrase: secretpsk
                  ssid: string
                  usage: multi
                  vlan_id: 1
              contentMediaType: application/json
            examples:
              Example:
                value:
                  mac: string
                  name: string
                  passphrase: secretpsk
                  ssid: string
                  usage: multi
                  vlan_id: 1
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/psk'
                - description: Personal pre-shared key configuration for WLAN access
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/psk'
                - description: Personal pre-shared key configuration for WLAN access
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/rftemplates/derived:
    get:
      tags:
      - Sites RF Templates
      summary: listSiteRfTemplatesDerived
      description: Get the list of derived RF Templates a Site
      operationId: listSiteRfTemplatesDerived
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: resolve
        in: query
        description: Whether resolve the site variables
        style: form
        explode: true
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/rf_template'
                description: List of RF templates
                examples:
                - - ant_gain_24: 0
                    ant_gain_5: 0
                    band_24:
                      allow_rrm_disable: true
                      ant_gain: 0
                      bandwidth: 20
                      channels:
                      - 1
                      - 6
                      - 11
                      disabled: false
                      power_max: 11
                      power_min: 3
                      preamble: short
                    band_24_usage: auto
                    band_5:
                      allow_rrm_disable: false
                      ant_gain: 0
                      bandwidth: 80
                      channels:
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 149
                      - 153
                      - 157
                      - 161
                      disabled: false
                      power_max: 16
                      power_min: 9
                      preamble: short
                    country_code: FR
                    created_time: 1594743723
                    enable_unii_4: false
                    id: b3f20330-f76a-49f1-bc65-0d8727140b1d
                    model_specific: {}
                    modified_time: 1613582192
                    name: Lab
                    org_id: 203d3d02-dbc0-4c1b-9f41-76896a3330f4
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - ant_gain_24: 0
                    ant_gain_5: 0
                    band_24:
                      allow_rrm_disable: true
                      ant_gain: 0
                      bandwidth: 20
                      channels:
                      - 1
                      - 6
                      - 11
                      disabled: false
                      power_max: 11
                      power_min: 3
                      preamble: short
                    band_24_usage: auto
                    band_5:
                      allow_rrm_disable: false
                      ant_gain: 0
                      bandwidth: 80
                      channels:
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 149
                      - 153
                      - 157
                      - 161
                      disabled: false
                      power_max: 16
                      power_min: 9
                      preamble: short
                    country_code: FR
                    created_time: 1594743723
                    enable_unii_4: false
                    id: b3f20330-f76a-49f1-bc65-0d8727140b1d
                    model_specific: {}
                    modified_time: 1613582192
                    name: Lab
                    org_id: 203d3d02-dbc0-4c1b-9f41-76896a3330f4
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/rf_template'
                description: List of RF templates
                examples:
                - - ant_gain_24: 0
                    ant_gain_5: 0
                    band_24:
                      allow_rrm_disable: true
                      ant_gain: 0
                      bandwidth: 20
                      channels:
                      - 1
                      - 6
                      - 11
                      disabled: false
                      power_max: 11
                      power_min: 3
                      preamble: short
                    band_24_usage: auto
                    band_5:
                      allow_rrm_disable: false
                      ant_gain: 0
                      bandwidth: 80
                      channels:
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 149
                      - 153
                      - 157
                      - 161
                      disabled: false
                      power_max: 16
                      power_min: 9
                      preamble: short
                    country_code: FR
                    created_time: 1594743723
                    enable_unii_4: false
                    id: b3f20330-f76a-49f1-bc65-0d8727140b1d
                    model_specific: {}
                    modified_time: 1613582192
                    name: Lab
                    org_id: 203d3d02-dbc0-4c1b-9f41-76896a3330f4
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - ant_gain_24: 0
                    ant_gain_5: 0
                    band_24:
                      allow_rrm_disable: true
                      ant_gain: 0
                      bandwidth: 20
                      channels:
                      - 1
                      - 6
                      - 11
                      disabled: false
                      power_max: 11
                      power_min: 3
                      preamble: short
                    band_24_usage: auto
                    band_5:
                      allow_rrm_disable: false
                      ant_gain: 0
                      bandwidth: 80
                      channels:
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 149
                      - 153
                      - 157
                      - 161
                      disabled: false
                      power_max: 16
                      power_min: 9
                      preamble: short
                    country_code: FR
                    created_time: 1594743723
                    enable_unii_4: false
                    id: b3f20330-f76a-49f1-bc65-0d8727140b1d
                    model_specific: {}
                    modified_time: 1613582192
                    name: Lab
                    org_id: 203d3d02-dbc0-4c1b-9f41-76896a3330f4
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/rfdiags:
    get:
      tags:
      - Sites Rfdiags
      summary: getSiteSiteRfdiagRecording
      description: List RF Glass Recording
      operationId: getSiteSiteRfdiagRecording
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  type: array
                  items:
                    $ref: '#/components/schemas/rf_diag_info_item'
                description: List response containing RF diagnostic recording entry arrays
                examples:
                - - - asset_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      asset_name: string
                      client_name: string
                      duration: 0
                      end_time: 0
                      frame_count: 0
                      id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      mac: string
                      map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      name: string
                      next: string
                      raw_events: string
                      ready: true
                      sdkclient_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sdkclient_name: string
                      sdkclient_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      start_time: 0
                      type: sdkclient
                      url: string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - - asset_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      asset_name: string
                      client_name: string
                      duration: 0
                      end_time: 0
                      frame_count: 0
                      id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      mac: string
                      map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      name: string
                      next: string
                      raw_events: string
                      ready: true
                      sdkclient_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sdkclient_name: string
                      sdkclient_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      start_time: 0
                      type: sdkclient
                      url: string
            application/vnd.api+json:
              schema:
                type: array
                items:
                  type: array
                  items:
                    $ref: '#/components/schemas/rf_diag_info_item'
                description: List response containing RF diagnostic recording entry arrays
                examples:
                - - - asset_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      asset_name: string
                      client_name: string
                      duration: 0
                      end_time: 0
                      frame_count: 0
                      id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      mac: string
                      map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      name: string
                      next: string
                      raw_events: string
                      ready: true
                      sdkclient_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sdkclient_name: string
                      sdkclient_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      start_time: 0
                      type: sdkclient
                      url: string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - - asset_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      asset_name: string
                      client_name: string
                      duration: 0
                      end_time: 0
                      frame_count: 0
                      id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      mac: string
                      map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      name: string
                      next: string
                      raw_events: string
                      ready: true
                      sdkclient_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sdkclient_name: string
                      sdkclient_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      start_time: 0
                      type: sdkclient
                      url: string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites Rfdiags
      summary: startSiteRecording
      description: Start RF Glass Recording
      operationId: startSiteRecording
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/rf_diag'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                uniqueItems: true
                type: array
                items:
                  $ref: '#/components/schemas/rf_diag_info_item'
                description: RF diagnostic recording response entries
                examples:
                - - asset_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    asset_name: string
                    client_name: string
                    duration: 0
                    end_time: 0
                    frame_count: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    next: string
                    raw_events: string
                    ready: true
                    sdkclient_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    sdkclient_name: string
                    sdkclient_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    start_time: 0
                    type: sdkclient
                    url: string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - asset_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    asset_name: string
                    client_name: string
                    duration: 0
                    end_time: 0
                    frame_count: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    next: string
                    raw_events: string
                    ready: true
                    sdkclient_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    sdkclient_name: string
                    sdkclient_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    start_time: 0
                    type: sdkclient
                    url: string
            application/vnd.api+json:
              schema:
                uniqueItems: true
                type: array
                items:
                  $ref: '#/components/schemas/rf_diag_info_item'
                description: RF diagnostic recording response entries
                examples:
                - - asset_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    asset_name: string
                    client_name: string
                    duration: 0
                    end_time: 0
                    frame_count: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    next: string
                    raw_events: string
                    ready: true
                    sdkclient_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    sdkclient_name: string
                    sdkclient_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    start_time: 0
                    type: sdkclient
                    url: string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - asset_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    asset_name: string
                    client_name: string
                    duration: 0
                    end_time: 0
                    frame_count: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    next: string
                    raw_events: string
                    ready: true
                    sdkclient_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    sdkclient_name: string
                    sdkclient_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    start_time: 0
                    type: sdkclient
                    url: string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/rfdiags/{rfdiag_id}:
    delete:
      tags:
      - Sites Rfdiags
      summary: deleteSiteRfdiagRecording
      description: Delete Recording
      operationId: deleteSiteRfdiagRecording
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: rfdiag_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Sites Rfdiags
      summary: getSiteRfdiagRecording
      description: Get RF Diag Recording Details
      operationId: getSiteRfdiagRecording
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: rfdiag_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                uniqueItems: true
                type: array
                items:
                  $ref: '#/components/schemas/rf_diag_info_item'
                description: RF diagnostic recording response entries
                examples:
                - - asset_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    asset_name: string
                    client_name: string
                    duration: 0
                    end_time: 0
                    frame_count: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    next: string
                    raw_events: string
                    ready: true
                    sdkclient_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    sdkclient_name: string
                    sdkclient_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    start_time: 0
                    type: sdkclient
                    url: string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - asset_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    asset_name: string
                    client_name: string
                    duration: 0
                    end_time: 0
                    frame_count: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    next: string
                    raw_events: string
                    ready: true
                    sdkclient_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    sdkclient_name: string
                    sdkclient_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    start_time: 0
                    type: sdkclient
                    url: string
            application/vnd.api+json:
              schema:
                uniqueItems: true
                type: array
                items:
                  $ref: '#/components/schemas/rf_diag_info_item'
                description: RF diagnostic recording response entries
                examples:
                - - asset_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    asset_name: string
                    client_name: string
                    duration: 0
                    end_time: 0
                    frame_count: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    next: string
                    raw_events: string
                    ready: true
                    sdkclient_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    sdkclient_name: string
                    sdkclient_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    start_time: 0
                    type: sdkclient
                    url: string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - asset_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    asset_name: string
                    client_name: string
                    duration: 0
                    end_time: 0
                    frame_count: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    next: string
                    raw_events: string
                    ready: true
                    sdkclient_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    sdkclient_name: string
                    sdkclient_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    start_time: 0
                    type: sdkclient
                    url: string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Sites Rfdiags
      summary: updateSiteRfdiagRecording
      description: Update Recording
      operationId: updateSiteRfdiagRecording
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: rfdiag_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/rf_diag'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                uniqueItems: true
                type: array
                items:
                  $ref: '#/components/schemas/rf_diag_info_item'
                description: RF diagnostic recording response entries
                examples:
                - - asset_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    asset_name: string
                    client_name: string
                    duration: 0
                    end_time: 0
                    frame_count: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    next: string
                    raw_events: string
                    ready: true
                    sdkclient_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    sdkclient_name: string
                    sdkclient_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    start_time: 0
                    type: sdkclient
                    url: string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - asset_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    asset_name: string
                    client_name: string
                    duration: 0
                    end_time: 0
                    frame_count: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    next: string
                    raw_events: string
                    ready: true
                    sdkclient_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    sdkclient_name: string
                    sdkclient_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    start_time: 0
                    type: sdkclient
                    url: string
            application/vnd.api+json:
              schema:
                uniqueItems: true
                type: array
                items:
                  $ref: '#/components/schemas/rf_diag_info_item'
                description: RF diagnostic recording response entries
                examples:
                - - asset_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    asset_name: string
                    client_name: string
                    duration: 0
                    end_time: 0
                    frame_count: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    next: string
                    raw_events: string
                    ready: true
                    sdkclient_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    sdkclient_name: string
                    sdkclient_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    start_time: 0
                    type: sdkclient
                    url: string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - asset_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    asset_name: string
                    client_name: string
                    duration: 0
                    end_time: 0
                    frame_count: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    mac: string
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    name: string
                    next: string
                    raw_events: string
                    ready: true
                    sdkclient_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    sdkclient_name: string
                    sdkclient_uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    start_time: 0
                    type: sdkclient
                    url: string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/rfdiags/{rfdiag_id}/download:
    get:
      tags:
      - Sites Rfdiags
      summary: downloadSiteRfdiagRecording
      description: >-
        Download Recording

        Download raw_events blob
      operationId: downloadSiteRfdiagRecording
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: rfdiag_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: string
                description: File
                contentEncoding: base64
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                type: string
                description: File
                contentEncoding: base64
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/rfdiags/{rfdiag_id}/stop:
    post:
      tags:
      - Sites Rfdiags
      summary: stopSiteRfdiagRecording
      description: If the recording session is active for the given rfdiag_id, it will finish the recording. duration and end_time will be updated to reflect the correct values.
      operationId: stopSiteRfdiagRecording
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: rfdiag_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/insights/rogues:
    get:
      tags:
      - Sites Rogues
      summary: listSiteRogueAPs
      description: Get List of Site Rogue/Neighbor APs
      operationId: listSiteRogueAPs
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: type
        in: query
        description: 'Rogue classification used to filter the results. enum: `honeypot`, `lan`, `others`, `spoof`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/rogue_type'
          - description: 'Rogue classification used to filter the results. enum: `honeypot`, `lan`, `others`, `spoof`'
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: interval
        in: query
        description: Aggregation works by giving a time range plus interval (e.g. 1d, 1h, 10m) where aggregation function would be applied to.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 10m
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_insight_rogue'
                - description: Paginated response for rogue or neighbor AP insight results
                  examples:
                  - end: 1428954000
                    limit: 100
                    next: /api/v1/sites/a3eda150-ab3f-11e4-aa18-13e21dd250cc/rogues?start=1498482000&end=1498485600&limit=10&interval=1h&type=others
                    results:
                    - ap_mac: 5c5b350e021c
                      avg_rssi: -72
                      bssid: d8-97-ba-76-b5-aa
                      channel: '11'
                      num_aps: 4
                      ssid: xfinitywifi
                      times_heard: 8
                    start: 1428939600
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1428954000
                    limit: 100
                    next: /api/v1/sites/a3eda150-ab3f-11e4-aa18-13e21dd250cc/rogues?start=1498482000&end=1498485600&limit=10&interval=1h&type=others
                    results:
                    - ap_mac: 5c5b350e021c
                      avg_rssi: -72
                      bssid: d8-97-ba-76-b5-aa
                      channel: '11'
                      num_aps: 4
                      ssid: xfinitywifi
                      times_heard: 8
                    start: 1428939600
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_insight_rogue'
                - description: Paginated response for rogue or neighbor AP insight results
                  examples:
                  - end: 1428954000
                    limit: 100
                    next: /api/v1/sites/a3eda150-ab3f-11e4-aa18-13e21dd250cc/rogues?start=1498482000&end=1498485600&limit=10&interval=1h&type=others
                    results:
                    - ap_mac: 5c5b350e021c
                      avg_rssi: -72
                      bssid: d8-97-ba-76-b5-aa
                      channel: '11'
                      num_aps: 4
                      ssid: xfinitywifi
                      times_heard: 8
                    start: 1428939600
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1428954000
                    limit: 100
                    next: /api/v1/sites/a3eda150-ab3f-11e4-aa18-13e21dd250cc/rogues?start=1498482000&end=1498485600&limit=10&interval=1h&type=others
                    results:
                    - ap_mac: 5c5b350e021c
                      avg_rssi: -72
                      bssid: d8-97-ba-76-b5-aa
                      channel: '11'
                      num_aps: 4
                      ssid: xfinitywifi
                      times_heard: 8
                    start: 1428939600
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/insights/rogues/clients:
    get:
      tags:
      - Sites Rogues
      summary: listSiteRogueClients
      description: Get List of Site Rogue Clients
      operationId: listSiteRogueClients
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: interval
        in: query
        description: Aggregation works by giving a time range plus interval (e.g. 1d, 1h, 10m) where aggregation function would be applied to.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 10m
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_insight_rogue_client'
                - description: Paginated response for rogue client insight results
                  examples:
                  - end: 1428954000
                    limit: 100
                    next: /api/v1/sites/a3eda150-ab3f-11e4-aa18-13e21dd250cc/rogues/clients?start=1498482000&end=1498485600&limit=10&interval=1h
                    results:
                    - annotation: whitelist
                      ap_mac: 5c-5b-35-0e-02-1c
                      avg_rssi: -63.9
                      band: '5'
                      bssid: d8-97-ba-76-b5-aa
                      client_mac: 34-f8-32-13-57-c2
                      num_aps: 2
                    start: 1428939600
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1428954000
                    limit: 100
                    next: /api/v1/sites/a3eda150-ab3f-11e4-aa18-13e21dd250cc/rogues/clients?start=1498482000&end=1498485600&limit=10&interval=1h
                    results:
                    - annotation: whitelist
                      ap_mac: 5c-5b-35-0e-02-1c
                      avg_rssi: -63.9
                      band: '5'
                      bssid: d8-97-ba-76-b5-aa
                      client_mac: 34-f8-32-13-57-c2
                      num_aps: 2
                    start: 1428939600
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_insight_rogue_client'
                - description: Paginated response for rogue client insight results
                  examples:
                  - end: 1428954000
                    limit: 100
                    next: /api/v1/sites/a3eda150-ab3f-11e4-aa18-13e21dd250cc/rogues/clients?start=1498482000&end=1498485600&limit=10&interval=1h
                    results:
                    - annotation: whitelist
                      ap_mac: 5c-5b-35-0e-02-1c
                      avg_rssi: -63.9
                      band: '5'
                      bssid: d8-97-ba-76-b5-aa
                      client_mac: 34-f8-32-13-57-c2
                      num_aps: 2
                    start: 1428939600
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1428954000
                    limit: 100
                    next: /api/v1/sites/a3eda150-ab3f-11e4-aa18-13e21dd250cc/rogues/clients?start=1498482000&end=1498485600&limit=10&interval=1h
                    results:
                    - annotation: whitelist
                      ap_mac: 5c-5b-35-0e-02-1c
                      avg_rssi: -63.9
                      band: '5'
                      bssid: d8-97-ba-76-b5-aa
                      client_mac: 34-f8-32-13-57-c2
                      num_aps: 2
                    start: 1428939600
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/rogues/events/count:
    get:
      tags:
      - Sites Rogues
      summary: countSiteRogueEvents
      description: Count by Distinct Attributes of Rogue Events
      operationId: countSiteRogueEvents
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `ap`, `bssid`, `ssid`, `type`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/site_rogue_events_count_distinct'
          - description: 'Field used to group this count response. enum: `ap`, `bssid`, `ssid`, `type`'
      - name: type
        in: query
        description: 'Rogue classification used to filter the results. enum: `honeypot`, `lan`, `others`, `spoof`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/rogue_type'
          - description: 'Rogue classification used to filter the results. enum: `honeypot`, `lan`, `others`, `spoof`'
      - name: ssid
        in: query
        description: Filter results by SSID
        style: form
        explode: true
        schema:
          type: string
      - name: bssid
        in: query
        description: Filter results by BSSID
        style: form
        explode: true
        schema:
          type: string
      - name: ap_mac
        in: query
        description: MAC of the device that had strongest signal strength for ssid/bssid pair
        style: form
        explode: true
        schema:
          type: string
      - name: channel
        in: query
        description: Filter results by channel
        style: form
        explode: true
        schema:
          type: string
      - name: seen_on_lan
        in: query
        description: Whether the reporting AP see a wireless client (on LAN) connecting to it
        style: form
        explode: true
        schema:
          type: boolean
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/rogues/events/search:
    get:
      tags:
      - Sites Rogues
      summary: searchSiteRogueEvents
      description: Search Rogue Events
      operationId: searchSiteRogueEvents
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: type
        in: query
        description: 'Rogue classification used to filter the results. enum: `honeypot`, `lan`, `others`, `spoof`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/rogue_type'
          - description: 'Rogue classification used to filter the results. enum: `honeypot`, `lan`, `others`, `spoof`'
      - name: ssid
        in: query
        description: Filter results by SSID
        style: form
        explode: true
        schema:
          type: string
      - name: bssid
        in: query
        description: Filter results by BSSID
        style: form
        explode: true
        schema:
          type: string
      - name: ap_mac
        in: query
        description: MAC of the device that had strongest signal strength for ssid/bssid pair
        style: form
        explode: true
        schema:
          type: string
      - name: channel
        in: query
        description: Filter results by channel
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: seen_on_lan
        in: query
        description: Whether the reporting AP see a wireless client (on LAN) connecting to it
        style: form
        explode: true
        schema:
          type: boolean
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_events_rogue_search'
                - description: Paginated response for rogue AP event search results
                  examples:
                  - end: 1538074800
                    limit: 10
                    results:
                    - ap: 5c5b350e10030
                      bssid: 38ff363c8c4c
                      channel: 136
                      rssi: -54
                      ssid: MyHomeNetwork
                      timestamp: 1538074612
                    - ap: 5c5b350e10030
                      bssid: 60d02c2394cc
                      channel: 11
                      rssi: -59
                      ssid: Home-Office
                      timestamp: 1538074612
                    start: 1538071200
                    total: 2
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1538074800
                    limit: 10
                    results:
                    - ap: 5c5b350e10030
                      bssid: 38ff363c8c4c
                      channel: 136
                      rssi: -54
                      ssid: MyHomeNetwork
                      timestamp: 1538074612
                    - ap: 5c5b350e10030
                      bssid: 60d02c2394cc
                      channel: 11
                      rssi: -59
                      ssid: Home-Office
                      timestamp: 1538074612
                    start: 1538071200
                    total: 2
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_events_rogue_search'
                - description: Paginated response for rogue AP event search results
                  examples:
                  - end: 1538074800
                    limit: 10
                    results:
                    - ap: 5c5b350e10030
                      bssid: 38ff363c8c4c
                      channel: 136
                      rssi: -54
                      ssid: MyHomeNetwork
                      timestamp: 1538074612
                    - ap: 5c5b350e10030
                      bssid: 60d02c2394cc
                      channel: 11
                      rssi: -59
                      ssid: Home-Office
                      timestamp: 1538074612
                    start: 1538071200
                    total: 2
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1538074800
                    limit: 10
                    results:
                    - ap: 5c5b350e10030
                      bssid: 38ff363c8c4c
                      channel: 136
                      rssi: -54
                      ssid: MyHomeNetwork
                      timestamp: 1538074612
                    - ap: 5c5b350e10030
                      bssid: 60d02c2394cc
                      channel: 11
                      rssi: -59
                      ssid: Home-Office
                      timestamp: 1538074612
                    start: 1538071200
                    total: 2
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/rogues/{rogue_bssid}:
    get:
      tags:
      - Sites Rogues
      summary: getSiteRogueAP
      description: Get Rogue AP Details
      operationId: getSiteRogueAP
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: rogue_bssid
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rogue_details'
                - description: Rogue AP detail response
                  examples:
                  - manufacture: Intel Corporate
                    seen_as_client: true
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    manufacture: Intel Corporate
                    seen_as_client: true
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rogue_details'
                - description: Rogue AP detail response
                  examples:
                  - manufacture: Intel Corporate
                    seen_as_client: true
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    manufacture: Intel Corporate
                    seen_as_client: true
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/rrm/channel_scores/band/{band}:
    get:
      tags:
      - Sites RRM
      summary: getSiteChannelScores
      description: Get Site Channel Scores
      operationId: getSiteChannelScores
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: band
        in: path
        description: 802.11 Band
        required: true
        schema:
          allOf:
          - $ref: '#/components/schemas/dot11_band'
          - description: 802.11 Band
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_rrm_channel_scores'
                - description: Response containing RRM channel score records
                  examples:
                  - results:
                    - channel: 36
                      util_score: 0.009
                      util_score_noise_floor: 0.001
                      util_score_non_wifi: 0.003
                      util_score_other: 0.002
                      util_score_radar: 0
                      util_score_undecodable_wifi: 0.004
                      util_score_unknown_wifi: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    results:
                    - channel: 36
                      util_score: 0.009
                      util_score_noise_floor: 0.001
                      util_score_non_wifi: 0.003
                      util_score_other: 0.002
                      util_score_radar: 0
                      util_score_undecodable_wifi: 0.004
                      util_score_unknown_wifi: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_rrm_channel_scores'
                - description: Response containing RRM channel score records
                  examples:
                  - results:
                    - channel: 36
                      util_score: 0.009
                      util_score_noise_floor: 0.001
                      util_score_non_wifi: 0.003
                      util_score_other: 0.002
                      util_score_radar: 0
                      util_score_undecodable_wifi: 0.004
                      util_score_unknown_wifi: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    results:
                    - channel: 36
                      util_score: 0.009
                      util_score_noise_floor: 0.001
                      util_score_non_wifi: 0.003
                      util_score_other: 0.002
                      util_score_radar: 0
                      util_score_undecodable_wifi: 0.004
                      util_score_unknown_wifi: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/rrm/current:
    get:
      tags:
      - Sites RRM
      summary: getSiteCurrentChannelPlanning
      description: Get Current Channel Planning
      operationId: getSiteCurrentChannelPlanning
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rrm'
                - description: Current RRM channel-planning state for a site
                  examples:
                  - band_24: {}
                    band_24_metric:
                      avg_aps_per_channel: 0
                      channel_distribution_uniformity: 0
                      cochannel_neighbors: 0
                      density: 0
                      naps_by_channel: {}
                      naps_by_power: {}
                      neighbors: 0
                      noise: 0
                    band_5: {}
                    band_5_metric:
                      avg_aps_per_channel: 0
                      channel_distribution_uniformity: 0
                      cochannel_neighbors: 0
                      density: 0
                      naps_by_channel: {}
                      naps_by_power: {}
                      neighbors: 0
                      noise: 0
                    rftemplate:
                      band_24:
                        allow_rrm_disable: true
                        antenna_mode: default
                        bandwidth: 20
                        channels:
                        - 1
                        - 6
                        - 11
                        disabled: true
                        power: 5
                        power_max: 3
                        power_min: 18
                        preamble: auto
                      band_5:
                        allow_rrm_disable: true
                        antenna_mode: default
                        bandwidth: 20
                        channels:
                        - 36
                        - 40
                        - 44
                        - 48
                        - 52
                        - 56
                        - 60
                        - 64
                        - 100
                        - 104
                        - 108
                        - 112
                        disabled: true
                        power: 9
                        power_max: 6
                        power_min: 17
                        preamble: auto
                      country_code: string
                      created_time: 0
                      id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      model_specific:
                        property1:
                          band_24:
                            allow_rrm_disable: true
                            antenna_mode: default
                            bandwidth: 20
                            channels:
                            - 1
                            - 6
                            - 11
                            disabled: true
                            power: 9
                            power_max: 6
                            power_min: 17
                            preamble: auto
                          band_5:
                            allow_rrm_disable: true
                            antenna_mode: default
                            bandwidth: 20
                            channels:
                            - 36
                            - 40
                            - 44
                            - 48
                            - 52
                            - 56
                            - 60
                            - 64
                            - 100
                            - 104
                            - 108
                            - 112
                            disabled: true
                            power: 10
                            power_max: 6
                            power_min: 15
                            preamble: auto
                      modified_time: 0
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    rftemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    rftemplate_name: string
                    status: updating
                    timestamp: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    band_24: {}
                    band_24_metric:
                      avg_aps_per_channel: 0
                      channel_distribution_uniformity: 0
                      cochannel_neighbors: 0
                      density: 0
                      naps_by_channel: {}
                      naps_by_power: {}
                      neighbors: 0
                      noise: 0
                    band_5: {}
                    band_5_metric:
                      avg_aps_per_channel: 0
                      channel_distribution_uniformity: 0
                      cochannel_neighbors: 0
                      density: 0
                      naps_by_channel: {}
                      naps_by_power: {}
                      neighbors: 0
                      noise: 0
                    rftemplate:
                      band_24:
                        allow_rrm_disable: true
                        antenna_mode: default
                        bandwidth: 20
                        channels:
                        - 1
                        - 6
                        - 11
                        disabled: true
                        power: 5
                        power_max: 3
                        power_min: 18
                        preamble: auto
                      band_5:
                        allow_rrm_disable: true
                        antenna_mode: default
                        bandwidth: 20
                        channels:
                        - 36
                        - 40
                        - 44
                        - 48
                        - 52
                        - 56
                        - 60
                        - 64
                        - 100
                        - 104
                        - 108
                        - 112
                        disabled: true
                        power: 9
                        power_max: 6
                        power_min: 17
                        preamble: auto
                      country_code: string
                      created_time: 0
                      id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      model_specific:
                        property1:
                          band_24:
                            allow_rrm_disable: true
                            antenna_mode: default
                            bandwidth: 20
                            channels:
                            - 1
                            - 6
                            - 11
                            disabled: true
                            power: 9
                            power_max: 6
                            power_min: 17
                            preamble: auto
                          band_5:
                            allow_rrm_disable: true
                            antenna_mode: default
                            bandwidth: 20
                            channels:
                            - 36
                            - 40
                            - 44
                            - 48
                            - 52
                            - 56
                            - 60
                            - 64
                            - 100
                            - 104
                            - 108
                            - 112
                            disabled: true
                            power: 10
                            power_max: 6
                            power_min: 15
                            preamble: auto
                      modified_time: 0
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    rftemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    rftemplate_name: string
                    status: updating
                    timestamp: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rrm'
                - description: Current RRM channel-planning state for a site
                  examples:
                  - band_24: {}
                    band_24_metric:
                      avg_aps_per_channel: 0
                      channel_distribution_uniformity: 0
                      cochannel_neighbors: 0
                      density: 0
                      naps_by_channel: {}
                      naps_by_power: {}
                      neighbors: 0
                      noise: 0
                    band_5: {}
                    band_5_metric:
                      avg_aps_per_channel: 0
                      channel_distribution_uniformity: 0
                      cochannel_neighbors: 0
                      density: 0
                      naps_by_channel: {}
                      naps_by_power: {}
                      neighbors: 0
                      noise: 0
                    rftemplate:
                      band_24:
                        allow_rrm_disable: true
                        antenna_mode: default
                        bandwidth: 20
                        channels:
                        - 1
                        - 6
                        - 11
                        disabled: true
                        power: 5
                        power_max: 3
                        power_min: 18
                        preamble: auto
                      band_5:
                        allow_rrm_disable: true
                        antenna_mode: default
                        bandwidth: 20
                        channels:
                        - 36
                        - 40
                        - 44
                        - 48
                        - 52
                        - 56
                        - 60
                        - 64
                        - 100
                        - 104
                        - 108
                        - 112
                        disabled: true
                        power: 9
                        power_max: 6
                        power_min: 17
                        preamble: auto
                      country_code: string
                      created_time: 0
                      id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      model_specific:
                        property1:
                          band_24:
                            allow_rrm_disable: true
                            antenna_mode: default
                            bandwidth: 20
                            channels:
                            - 1
                            - 6
                            - 11
                            disabled: true
                            power: 9
                            power_max: 6
                            power_min: 17
                            preamble: auto
                          band_5:
                            allow_rrm_disable: true
                            antenna_mode: default
                            bandwidth: 20
                            channels:
                            - 36
                            - 40
                            - 44
                            - 48
                            - 52
                            - 56
                            - 60
                            - 64
                            - 100
                            - 104
                            - 108
                            - 112
                            disabled: true
                            power: 10
                            power_max: 6
                            power_min: 15
                            preamble: auto
                      modified_time: 0
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    rftemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    rftemplate_name: string
                    status: updating
                    timestamp: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    band_24: {}
                    band_24_metric:
                      avg_aps_per_channel: 0
                      channel_distribution_uniformity: 0
                      cochannel_neighbors: 0
                      density: 0
                      naps_by_channel: {}
                      naps_by_power: {}
                      neighbors: 0
                      noise: 0
                    band_5: {}
                    band_5_metric:
                      avg_aps_per_channel: 0
                      channel_distribution_uniformity: 0
                      cochannel_neighbors: 0
                      density: 0
                      naps_by_channel: {}
                      naps_by_power: {}
                      neighbors: 0
                      noise: 0
                    rftemplate:
                      band_24:
                        allow_rrm_disable: true
                        antenna_mode: default
                        bandwidth: 20
                        channels:
                        - 1
                        - 6
                        - 11
                        disabled: true
                        power: 5
                        power_max: 3
                        power_min: 18
                        preamble: auto
                      band_5:
                        allow_rrm_disable: true
                        antenna_mode: default
                        bandwidth: 20
                        channels:
                        - 36
                        - 40
                        - 44
                        - 48
                        - 52
                        - 56
                        - 60
                        - 64
                        - 100
                        - 104
                        - 108
                        - 112
                        disabled: true
                        power: 9
                        power_max: 6
                        power_min: 17
                        preamble: auto
                      country_code: string
                      created_time: 0
                      id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      model_specific:
                        property1:
                          band_24:
                            allow_rrm_disable: true
                            antenna_mode: default
                            bandwidth: 20
                            channels:
                            - 1
                            - 6
                            - 11
                            disabled: true
                            power: 9
                            power_max: 6
                            power_min: 17
                            preamble: auto
                          band_5:
                            allow_rrm_disable: true
                            antenna_mode: default
                            bandwidth: 20
                            channels:
                            - 36
                            - 40
                            - 44
                            - 48
                            - 52
                            - 56
                            - 60
                            - 64
                            - 100
                            - 104
                            - 108
                            - 112
                            disabled: true
                            power: 10
                            power_max: 6
                            power_min: 15
                            preamble: auto
                      modified_time: 0
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    rftemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    rftemplate_name: string
                    status: updating
                    timestamp: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/rrm/current/devices/{device_id}/band/{band}:
    get:
      tags:
      - Sites RRM
      summary: getSiteCurrentRrmConsiderations
      description: Get Current RRM Considerations for an AP on a Specific Band
      operationId: getSiteCurrentRrmConsiderations
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: band
        in: path
        description: 802.11 Band
        required: true
        schema:
          allOf:
          - $ref: '#/components/schemas/dot11_band'
          - description: 802.11 Band
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_rrm_consideration'
                - description: Response containing current RRM considerations for an AP radio band
                  examples:
                  - results:
                    - channel: 36
                      noise: -78
                      other_rssi: -66
                      other_ssid: Rivendell5G
                      rssi: -48
                      util_score: 0.1
                      util_score_non_wifi: 0.01
                      util_score_other: 0.05
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    results:
                    - channel: 36
                      noise: -78
                      other_rssi: -66
                      other_ssid: Rivendell5G
                      rssi: -48
                      util_score: 0.1
                      util_score_non_wifi: 0.01
                      util_score_other: 0.05
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_rrm_consideration'
                - description: Response containing current RRM considerations for an AP radio band
                  examples:
                  - results:
                    - channel: 36
                      noise: -78
                      other_rssi: -66
                      other_ssid: Rivendell5G
                      rssi: -48
                      util_score: 0.1
                      util_score_non_wifi: 0.01
                      util_score_other: 0.05
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    results:
                    - channel: 36
                      noise: -78
                      other_rssi: -66
                      other_ssid: Rivendell5G
                      rssi: -48
                      util_score: 0.1
                      util_score_non_wifi: 0.01
                      util_score_other: 0.05
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/rrm/events:
    get:
      tags:
      - Sites RRM
      summary: listSiteRrmEvents
      description: List Site RRM Events
      operationId: listSiteRrmEvents
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: band
        in: query
        description: '802.11 band used to filter radio results. enum: `24`, `5`, `5-dedicated`, `5-selectable`, `6`, `6-dedicated`, `6-selectable`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/dot11_band'
          - description: '802.11 band used to filter radio results. enum: `24`, `5`, `5-dedicated`, `5-selectable`, `6`, `6-dedicated`, `6-selectable`'
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_events_rrm'
                - description: Paginated response for RRM event results
                  examples:
                  - end: 1428954000
                    limit: 100
                    next: /api/v1/sites/dca0a44b-324c-11e6-a776-0243ad110007/events/rrm?start=1428939600&end=1428949600&limit=200&token=001a0010000000120010000005005880ec18000004776c616e007fffffeb067ab8e29c1d659b6a7c8cf698bf81490003
                    results:
                    - ap: 5c5b359e4fe0
                      band: '24'
                      bandwidth: 20
                      channel: 6
                      event: scheduled-site_rrm
                      power: 5
                      pre_bandwidth: 20
                      pre_channel: 1
                      pre_power: 11
                      pre_usage: '24'
                      timestamp: 1428939600
                      usage: '24'
                    start: 1428939600
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1428954000
                    limit: 100
                    next: /api/v1/sites/dca0a44b-324c-11e6-a776-0243ad110007/events/rrm?start=1428939600&end=1428949600&limit=200&token=001a0010000000120010000005005880ec18000004776c616e007fffffeb067ab8e29c1d659b6a7c8cf698bf81490003
                    results:
                    - ap: 5c5b359e4fe0
                      band: '24'
                      bandwidth: 20
                      channel: 6
                      event: scheduled-site_rrm
                      power: 5
                      pre_bandwidth: 20
                      pre_channel: 1
                      pre_power: 11
                      pre_usage: '24'
                      timestamp: 1428939600
                      usage: '24'
                    start: 1428939600
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_events_rrm'
                - description: Paginated response for RRM event results
                  examples:
                  - end: 1428954000
                    limit: 100
                    next: /api/v1/sites/dca0a44b-324c-11e6-a776-0243ad110007/events/rrm?start=1428939600&end=1428949600&limit=200&token=001a0010000000120010000005005880ec18000004776c616e007fffffeb067ab8e29c1d659b6a7c8cf698bf81490003
                    results:
                    - ap: 5c5b359e4fe0
                      band: '24'
                      bandwidth: 20
                      channel: 6
                      event: scheduled-site_rrm
                      power: 5
                      pre_bandwidth: 20
                      pre_channel: 1
                      pre_power: 11
                      pre_usage: '24'
                      timestamp: 1428939600
                      usage: '24'
                    start: 1428939600
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1428954000
                    limit: 100
                    next: /api/v1/sites/dca0a44b-324c-11e6-a776-0243ad110007/events/rrm?start=1428939600&end=1428949600&limit=200&token=001a0010000000120010000005005880ec18000004776c616e007fffffeb067ab8e29c1d659b6a7c8cf698bf81490003
                    results:
                    - ap: 5c5b359e4fe0
                      band: '24'
                      bandwidth: 20
                      channel: 6
                      event: scheduled-site_rrm
                      power: 5
                      pre_bandwidth: 20
                      pre_channel: 1
                      pre_power: 11
                      pre_usage: '24'
                      timestamp: 1428939600
                      usage: '24'
                    start: 1428939600
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/rrm/neighbors/band/{band}:
    get:
      tags:
      - Sites RRM
      summary: listSiteCurrentRrmNeighbors
      description: List Current RRM observed neighbors
      operationId: listSiteCurrentRrmNeighbors
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: band
        in: path
        description: 802.11 Band
        required: true
        schema:
          allOf:
          - $ref: '#/components/schemas/dot11_band'
          - description: 802.11 Band
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_rrm_neighbors'
                - description: Paginated response for current RRM neighbor observations
                  examples:
                  - end: 1428954000
                    limit: 100
                    next: /api/v1/sites/dca0a44b-324c-11e6-a776-0243ad110007/events/rrm?start=1428939600&end=1428949600&limit=200&token=001a0010000000120010000005005880ec18000004776c616e007fffffeb067ab8e29c1d659b6a7c8cf698bf81490003
                    results:
                    - mac: a7c7096d7b8f
                      neighbors:
                      - mac: 5c5b35000311
                        rssi: -75
                    start: 1428939600
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1428954000
                    limit: 100
                    next: /api/v1/sites/dca0a44b-324c-11e6-a776-0243ad110007/events/rrm?start=1428939600&end=1428949600&limit=200&token=001a0010000000120010000005005880ec18000004776c616e007fffffeb067ab8e29c1d659b6a7c8cf698bf81490003
                    results:
                    - mac: a7c7096d7b8f
                      neighbors:
                      - mac: 5c5b35000311
                        rssi: -75
                    start: 1428939600
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_rrm_neighbors'
                - description: Paginated response for current RRM neighbor observations
                  examples:
                  - end: 1428954000
                    limit: 100
                    next: /api/v1/sites/dca0a44b-324c-11e6-a776-0243ad110007/events/rrm?start=1428939600&end=1428949600&limit=200&token=001a0010000000120010000005005880ec18000004776c616e007fffffeb067ab8e29c1d659b6a7c8cf698bf81490003
                    results:
                    - mac: a7c7096d7b8f
                      neighbors:
                      - mac: 5c5b35000311
                        rssi: -75
                    start: 1428939600
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1428954000
                    limit: 100
                    next: /api/v1/sites/dca0a44b-324c-11e6-a776-0243ad110007/events/rrm?start=1428939600&end=1428949600&limit=200&token=001a0010000000120010000005005880ec18000004776c616e007fffffeb067ab8e29c1d659b6a7c8cf698bf81490003
                    results:
                    - mac: a7c7096d7b8f
                      neighbors:
                      - mac: 5c5b35000311
                        rssi: -75
                    start: 1428939600
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/rssizones:
    get:
      tags:
      - Sites RSSI Zones
      summary: listSiteRssiZones
      description: Get List of Site RSSI Zone (RSSI-based)
      operationId: listSiteRssiZones
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/rssi_zone'
                description: RSSI zone configurations returned by list operations
                contentMediaType: application/json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites RSSI Zones
      summary: createSiteRssiZone
      description: Create RSSI Zone
      operationId: createSiteRssiZone
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/rssi_zone'
              - description: Request Body
                examples:
                - '{"devices":[{"device_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","rssi":0}],"name":"string"}'
              contentMediaType: application/json
            examples:
              Example:
                value:
                  devices:
                  - device_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    rssi: 0
                  name: string
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rssi_zone'
                - description: RSSI-based zone configuration for a site
                  examples:
                  - devices:
                    - device_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      rssi: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    devices:
                    - device_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      rssi: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/rssizones/{rssizone_id}:
    delete:
      tags:
      - Sites RSSI Zones
      summary: deleteSiteRssiZone
      description: Delete Site RSSI Zone
      operationId: deleteSiteRssiZone
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: rssizone_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Sites RSSI Zones
      summary: getSiteRssiZone
      description: Get Site RSSI Zone details
      operationId: getSiteRssiZone
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: rssizone_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/rssi_zone'
                description: RSSI zone configurations returned by list operations
                examples:
                - - created_time: 0
                    devices:
                    - device_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      rssi: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 0
                    devices:
                    - device_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      rssi: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/rssi_zone'
                description: RSSI zone configurations returned by list operations
                examples:
                - - created_time: 0
                    devices:
                    - device_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      rssi: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 0
                    devices:
                    - device_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      rssi: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Sites RSSI Zones
      summary: updateSiteRssiZone
      description: Update Site RSSI Zone
      operationId: updateSiteRssiZone
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: rssizone_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/rssi_zone'
              - description: Request Body
                examples:
                - '{"devices":[{"device_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","rssi":0}],"name":"string"}'
              contentMediaType: application/json
            examples:
              Example:
                value:
                  devices:
                  - device_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    rssi: 0
                  name: string
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rssi_zone'
                - description: RSSI-based zone configuration for a site
                  examples:
                  - created_time: 0
                    devices:
                    - device_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      rssi: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    devices:
                    - device_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      rssi: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rssi_zone'
                - description: RSSI-based zone configuration for a site
                  examples:
                  - created_time: 0
                    devices:
                    - device_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      rssi: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    devices:
                    - device_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      rssi: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/services/derived:
    get:
      tags:
      - Sites Services
      summary: listSiteServicesDerived
      description: Get the list of derived Services for a Site
      operationId: listSiteServicesDerived
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: resolve
        in: query
        description: Whether resolve the site variables
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/service'
                description: Service definitions returned by list operations
                examples:
                - - addresses:
                    - string
                    apps:
                    - string
                    dscp: 8
                    hostnames:
                    - string
                    max_jitter: 0
                    max_latency: 0
                    max_loss: 0
                    name: string
                    specs:
                    - port_range: '0'
                      protocol: any
                    traffic_class: best_effort
                    traffic_type: default
                    type: custom
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - addresses:
                    - string
                    apps:
                    - string
                    dscp: 8
                    hostnames:
                    - string
                    max_jitter: 0
                    max_latency: 0
                    max_loss: 0
                    name: string
                    specs:
                    - port_range: '0'
                      protocol: any
                    traffic_class: best_effort
                    traffic_type: default
                    type: custom
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/service'
                description: Service definitions returned by list operations
                examples:
                - - addresses:
                    - string
                    apps:
                    - string
                    dscp: 8
                    hostnames:
                    - string
                    max_jitter: 0
                    max_latency: 0
                    max_loss: 0
                    name: string
                    specs:
                    - port_range: '0'
                      protocol: any
                    traffic_class: best_effort
                    traffic_type: default
                    type: custom
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - addresses:
                    - string
                    apps:
                    - string
                    dscp: 8
                    hostnames:
                    - string
                    max_jitter: 0
                    max_latency: 0
                    max_loss: 0
                    name: string
                    specs:
                    - port_range: '0'
                      protocol: any
                    traffic_class: best_effort
                    traffic_type: default
                    type: custom
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/services/events/count:
    get:
      tags:
      - Sites Services
      summary: countSiteServicePathEvents
      description: Count by Distinct Attributes of Service Path Events
      operationId: countSiteServicePathEvents
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `mac`, `model`, `policy`, `port_id`, `site_id`, `type`, `vpn_name`, `vpn_path`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/site_service_events_count_distinct'
          - description: 'Field used to group this count response. enum: `mac`, `model`, `policy`, `port_id`, `site_id`, `type`, `vpn_name`, `vpn_path`'
      - name: type
        in: query
        description: Event type, e.g. GW_SERVICE_PATH_DOWN
        style: form
        explode: true
        schema:
          type: string
      - name: text
        in: query
        description: Description of the event including the reason it is triggered
        style: form
        explode: true
        schema:
          type: string
      - name: vpn_name
        in: query
        description: Filter results by vpn name
        style: form
        explode: true
        schema:
          type: string
      - name: vpn_path
        in: query
        description: Filter results by vpn path
        style: form
        explode: true
        schema:
          type: string
      - name: policy
        in: query
        description: Service policy associated with that specific path
        style: form
        explode: true
        schema:
          type: string
      - name: port_id
        in: query
        description: Filter results by port identifier
        style: form
        explode: true
        schema:
          type: string
      - name: model
        in: query
        description: Filter results by device model
        style: form
        explode: true
        schema:
          type: string
      - name: version
        in: query
        description: Filter results by software version
        style: form
        explode: true
        schema:
          type: string
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/services/events/search:
    get:
      tags:
      - Sites Services
      summary: searchSiteServicePathEvents
      description: Search Service Path Events
      operationId: searchSiteServicePathEvents
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: type
        in: query
        description: Event type, e.g. GW_SERVICE_PATH_DOWN
        style: form
        explode: true
        schema:
          type: string
      - name: text
        in: query
        description: Description of the event including the reason it is triggered
        style: form
        explode: true
        schema:
          type: string
      - name: peer_port_id
        in: query
        description: Port ID of the peer gateway
        style: form
        explode: true
        schema:
          type: string
      - name: peer_mac
        in: query
        description: MAC address of the peer gateway
        style: form
        explode: true
        schema:
          type: string
      - name: vpn_name
        in: query
        description: Filter results by vpn name
        style: form
        explode: true
        schema:
          type: string
      - name: vpn_path
        in: query
        description: Filter results by vpn path
        style: form
        explode: true
        schema:
          type: string
      - name: policy
        in: query
        description: Service policy associated with that specific path
        style: form
        explode: true
        schema:
          type: string
      - name: port_id
        in: query
        description: Filter results by port identifier
        style: form
        explode: true
        schema:
          type: string
      - name: model
        in: query
        description: Filter results by device model
        style: form
        explode: true
        schema:
          type: string
      - name: version
        in: query
        description: Filter results by software version
        style: form
        explode: true
        schema:
          type: string
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_events_path_search'
                - description: Paginated response for service path event search results
                  examples:
                  - end: 1697096379
                    limit: 10
                    results:
                    - mac: 90ec7734b374
                      model: SSR120
                      org_id: a3c6718f-2823-4e48-bf5e-b841768a4c9b
                      policy: INTERNET
                      port_id: ge-1/0/6
                      site_id: 4279edbd-1d24-41ea-9505-2eb26c8590fa
                      text: Peer Path Down
                      timestamp: 1697037328.651775
                      type: GW_SERVICE_PATH_REMOVE
                      version: 6.1.5-14.lts
                      vpn_name: Syracuse_HUB
                      vpn_path: Syracuse_HUB-Wan0
                    start: 1697009979
                    total: 2
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1697096379
                    limit: 10
                    results:
                    - mac: 90ec7734b374
                      model: SSR120
                      org_id: a3c6718f-2823-4e48-bf5e-b841768a4c9b
                      policy: INTERNET
                      port_id: ge-1/0/6
                      site_id: 4279edbd-1d24-41ea-9505-2eb26c8590fa
                      text: Peer Path Down
                      timestamp: 1697037328.651775
                      type: GW_SERVICE_PATH_REMOVE
                      version: 6.1.5-14.lts
                      vpn_name: Syracuse_HUB
                      vpn_path: Syracuse_HUB-Wan0
                    start: 1697009979
                    total: 2
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_events_path_search'
                - description: Paginated response for service path event search results
                  examples:
                  - end: 1697096379
                    limit: 10
                    results:
                    - mac: 90ec7734b374
                      model: SSR120
                      org_id: a3c6718f-2823-4e48-bf5e-b841768a4c9b
                      policy: INTERNET
                      port_id: ge-1/0/6
                      site_id: 4279edbd-1d24-41ea-9505-2eb26c8590fa
                      text: Peer Path Down
                      timestamp: 1697037328.651775
                      type: GW_SERVICE_PATH_REMOVE
                      version: 6.1.5-14.lts
                      vpn_name: Syracuse_HUB
                      vpn_path: Syracuse_HUB-Wan0
                    start: 1697009979
                    total: 2
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1697096379
                    limit: 10
                    results:
                    - mac: 90ec7734b374
                      model: SSR120
                      org_id: a3c6718f-2823-4e48-bf5e-b841768a4c9b
                      policy: INTERNET
                      port_id: ge-1/0/6
                      site_id: 4279edbd-1d24-41ea-9505-2eb26c8590fa
                      text: Peer Path Down
                      timestamp: 1697037328.651775
                      type: GW_SERVICE_PATH_REMOVE
                      version: 6.1.5-14.lts
                      vpn_name: Syracuse_HUB
                      vpn_path: Syracuse_HUB-Wan0
                    start: 1697009979
                    total: 2
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/servicepolicies/derived:
    get:
      tags:
      - Sites Service Policies
      summary: listSiteServicePoliciesDerived
      description: Get the list of derived Service Policies for a Site
      operationId: listSiteServicePoliciesDerived
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: resolve
        in: query
        description: Whether resolve the site variables
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/org_service_policy'
                description: List of organization-level service policies
                examples:
                - - action: allow
                    created_time: 0
                    id: string
                    modified_time: 0
                    name: string
                    org_id: string
                    services:
                    - string
                    tenants:
                    - string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - action: allow
                    created_time: 0
                    id: string
                    modified_time: 0
                    name: string
                    org_id: string
                    services:
                    - string
                    tenants:
                    - string
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/org_service_policy'
                description: List of organization-level service policies
                examples:
                - - action: allow
                    created_time: 0
                    id: string
                    modified_time: 0
                    name: string
                    org_id: string
                    services:
                    - string
                    tenants:
                    - string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - action: allow
                    created_time: 0
                    id: string
                    modified_time: 0
                    name: string
                    org_id: string
                    services:
                    - string
                    tenants:
                    - string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/setting:
    get:
      tags:
      - Sites Setting
      summary: getSiteSetting
      description: Get the Site Settings
      operationId: getSiteSetting
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/site_setting'
                - description: Configuration settings applied at the site level
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/site_setting'
                - description: Configuration settings applied at the site level
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Sites Setting
      summary: updateSiteSettings
      description: Update Site Settings
      operationId: updateSiteSettings
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/site_setting'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/site_setting'
                - description: Configuration settings applied at the site level
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/site_setting'
                - description: Configuration settings applied at the site level
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/setting/blacklist:
    delete:
      tags:
      - Sites Setting
      summary: deleteSiteWirelessClientsBlocklist
      description: Delete Site Blacklist Station Clients
      operationId: deleteSiteWirelessClientsBlocklist
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites Setting
      summary: createSiteWirelessClientsBlocklist
      description: >-
        This endpoint is to provide list of client macs for annotation blacklist.


        Retrieve the current clients list `blacklist_url` under Site:Setting
      operationId: createSiteWirelessClientsBlocklist
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/mac_addresses'
              - description: Request Body
                examples:
                - macs:
                  - 18-65-90-de-f4-c6
                  - 84-89-ad-5d-69-0d
              contentMediaType: application/json
            examples:
              Example:
                value:
                  macs:
                  - 18-65-90-de-f4-c6
                  - 84-89-ad-5d-69-0d
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mac_addresses'
                - description: Request containing one or more MAC addresses
                  examples:
                  - macs:
                    - 18-65-90-de-f4-c6
                    - 84-89-ad-5d-69-0d
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    macs:
                    - 18-65-90-de-f4-c6
                    - 84-89-ad-5d-69-0d
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mac_addresses'
                - description: Request containing one or more MAC addresses
                  examples:
                  - macs:
                    - 18-65-90-de-f4-c6
                    - 84-89-ad-5d-69-0d
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    macs:
                    - 18-65-90-de-f4-c6
                    - 84-89-ad-5d-69-0d
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/setting/derived:
    get:
      tags:
      - Sites Setting
      summary: getSiteSettingDerived
      description: Get the Derived Site Settings, generated by merging the Org level templates (network templates, gateway templates) and the Site level configuration. If the same parameter is defined in both scopes, the Site level one is used. In addition, the Zoom and Teams accounts are also merged into the derived settings.
      operationId: getSiteSettingDerived
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/site_setting_derived'
                - description: Site settings with derived OAuth account integration data
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/site_setting_derived'
                - description: Site settings with derived OAuth account integration data
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/setting/watched_station:
    delete:
      tags:
      - Sites Setting
      summary: deleteSiteWatchedStations
      description: Delete Site Watched Station Clients
      operationId: deleteSiteWatchedStations
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites Setting
      summary: createSiteWatchedStations
      description: >-
        This endpoint is to provide list of client macs for annotation as watched station.


        Retrieve the current clients list from `watched_station_url` under Site:Setting
      operationId: createSiteWatchedStations
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/mac_addresses'
              - description: Request Body
                examples:
                - macs:
                  - 18-65-90-de-f4-c6
                  - 84-89-ad-5d-69-0d
              contentMediaType: application/json
            examples:
              Example:
                value:
                  macs:
                  - 18-65-90-de-f4-c6
                  - 84-89-ad-5d-69-0d
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mac_addresses'
                - description: Request containing one or more MAC addresses
                  examples:
                  - macs:
                    - 18-65-90-de-f4-c6
                    - 84-89-ad-5d-69-0d
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    macs:
                    - 18-65-90-de-f4-c6
                    - 84-89-ad-5d-69-0d
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mac_addresses'
                - description: Request containing one or more MAC addresses
                  examples:
                  - macs:
                    - 18-65-90-de-f4-c6
                    - 84-89-ad-5d-69-0d
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    macs:
                    - 18-65-90-de-f4-c6
                    - 84-89-ad-5d-69-0d
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/setting/whitelist:
    delete:
      tags:
      - Sites Setting
      summary: deleteSiteWirelessClientsAllowlist
      description: Delete Site Whitelist Station Clients
      operationId: deleteSiteWirelessClientsAllowlist
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites Setting
      summary: createSiteWirelessClientsAllowlist
      description: >-
        This endpoint is to provide list of client macs for annotation as whitelist.


        Retrieve the current clients list from `whitelist_url` under Site:Setting
      operationId: createSiteWirelessClientsAllowlist
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/mac_addresses'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mac_addresses'
                - description: Request containing one or more MAC addresses
                  examples:
                  - macs:
                    - 18-65-90-de-f4-c6
                    - 84-89-ad-5d-69-0d
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    macs:
                    - 18-65-90-de-f4-c6
                    - 84-89-ad-5d-69-0d
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mac_addresses'
                - description: Request containing one or more MAC addresses
                  examples:
                  - macs:
                    - 18-65-90-de-f4-c6
                    - 84-89-ad-5d-69-0d
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    macs:
                    - 18-65-90-de-f4-c6
                    - 84-89-ad-5d-69-0d
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/sitetemplates/derived:
    get:
      tags:
      - Sites Site Templates
      summary: listSiteSiteTemplatesDerived
      description: Get the list of derived Site Templates for Site
      operationId: listSiteSiteTemplatesDerived
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: resolve
        in: query
        description: Whether resolve the site variables
        style: form
        explode: true
        schema:
          type: boolean
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/site_template'
                description: List of site templates
                examples:
                - - auto_upgrade:
                      day_of_week: mon
                      enabled: true
                      time_of_day: string
                      version: string
                    name: string
                    vars:
                      SSID_STR: string
                      VLAN_ID: string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - auto_upgrade:
                      day_of_week: mon
                      enabled: true
                      time_of_day: string
                      version: string
                    name: string
                    vars:
                      SSID_STR: string
                      VLAN_ID: string
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/site_template'
                description: List of site templates
                examples:
                - - auto_upgrade:
                      day_of_week: mon
                      enabled: true
                      time_of_day: string
                      version: string
                    name: string
                    vars:
                      SSID_STR: string
                      VLAN_ID: string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - auto_upgrade:
                      day_of_week: mon
                      enabled: true
                      time_of_day: string
                      version: string
                    name: string
                    vars:
                      SSID_STR: string
                      VLAN_ID: string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/skyatp/events/count:
    get:
      tags:
      - Sites Skyatp
      summary: countSiteSkyatpEvents
      description: Count by Distinct Attributes of Skyatp Events (WIP)
      operationId: countSiteSkyatpEvents
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `device_mac`, `mac`, `threat_level`, `type`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/site_sky_atp_events_count_distinct'
          - description: 'Field used to group this count response. enum: `device_mac`, `mac`, `threat_level`, `type`'
      - name: type
        in: query
        description: Event type, e.g. cc, fs, mw
        style: form
        explode: true
        schema:
          type: string
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: device_mac
        in: query
        description: Filter results by device MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: threat_level
        in: query
        description: Filter results by threat level
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: ip
        in: query
        description: Filter results by IPv4 address
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: ipv4
          examples:
          - 192.168.1.1
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/skyatp/events/search:
    get:
      tags:
      - Sites Skyatp
      summary: searchSiteSkyatpEvents
      description: Search Skyatp Events (WIP)
      operationId: searchSiteSkyatpEvents
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: type
        in: query
        description: Event type, e.g. cc, fs, mw
        style: form
        explode: true
        schema:
          type: string
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: device_mac
        in: query
        description: Filter results by device MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: threat_level
        in: query
        description: Filter results by threat level
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: ip
        in: query
        description: Filter results by IPv4 address
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: ipv4
          examples:
          - 192.168.1.1
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_events_sky_atp_search'
                - description: Paginated response for Sky ATP event search results
                  examples:
                  - end: 1513176951
                    limit: 10
                    results:
                    - device_mac: 658279bb1fa4
                      ip: 172.16.0.11
                      mac: b019c66c8348
                      org_id: 3139f2c2-fac6-11e5-8156-0242ac110006
                      site_id: 70e0f468-fc13-11e5-85ad-0242ac110008
                      threat_level: 7
                      timestamp: 1592524478
                      type: cc
                    start: 1512572151
                    total: 1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1513176951
                    limit: 10
                    results:
                    - device_mac: 658279bb1fa4
                      ip: 172.16.0.11
                      mac: b019c66c8348
                      org_id: 3139f2c2-fac6-11e5-8156-0242ac110006
                      site_id: 70e0f468-fc13-11e5-85ad-0242ac110008
                      threat_level: 7
                      timestamp: 1592524478
                      type: cc
                    start: 1512572151
                    total: 1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_events_sky_atp_search'
                - description: Paginated response for Sky ATP event search results
                  examples:
                  - end: 1513176951
                    limit: 10
                    results:
                    - device_mac: 658279bb1fa4
                      ip: 172.16.0.11
                      mac: b019c66c8348
                      org_id: 3139f2c2-fac6-11e5-8156-0242ac110006
                      site_id: 70e0f468-fc13-11e5-85ad-0242ac110008
                      threat_level: 7
                      timestamp: 1592524478
                      type: cc
                    start: 1512572151
                    total: 1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1513176951
                    limit: 10
                    results:
                    - device_mac: 658279bb1fa4
                      ip: 172.16.0.11
                      mac: b019c66c8348
                      org_id: 3139f2c2-fac6-11e5-8156-0242ac110006
                      site_id: 70e0f468-fc13-11e5-85ad-0242ac110008
                      threat_level: 7
                      timestamp: 1592524478
                      type: cc
                    start: 1512572151
                    total: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/classifier/{classifier}/summary:
    get:
      tags:
      - Sites SLEs
      summary: getSiteSleClassifierDetails
      description: >-
        Get SLE classifier details



        This API Endpoint is deprecated and replaced by [Get Site SLE Classifier Summary Trend]($e/Sites%20SLEs/getSiteSleClassifierSummaryTrend)
      operationId: getSiteSleClassifierDetails
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: scope
        in: path
        description: ''
        required: true
        schema:
          $ref: '#/components/schemas/sle_summary_scope'
      - name: scope_id
        in: path
        description: >-
          * site_id if `scope`==`site`

          * device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`

          * mac if `scope`==`client`
        required: true
        schema:
          type: string
      - name: metric
        in: path
        description: Values from `listSiteSlesMetrics`
        required: true
        schema:
          type: string
      - name: classifier
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sle_classifier_summary'
                - description: Deprecated SLE classifier summary response
                  examples:
                  - classifier:
                      impact:
                        num_aps: 2
                        num_users: 17
                        total_aps: 3
                        total_users: 20
                      interval: 3600
                      name: wifi-interference
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 102.5
                        - 108.03333
                        - 0
                        - 0
                        - 201.9
                        - 566.48334
                        - 135.63333
                        - 0
                        duration:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 102.5
                        - 108.03333
                        - 0
                        - 0
                        - 201.9
                        - 566.48334
                        - 135.63333
                        - 0
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 444.13333
                      x_label: seconds
                      y_label: user-minutes
                    end: 1627312871
                    failures: []
                    impact:
                      num_aps: 2
                      num_users: 21
                      total_aps: 3
                      total_users: 26
                    metric: capacity
                    start: 1627226471
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    classifier:
                      impact:
                        num_aps: 2
                        num_users: 17
                        total_aps: 3
                        total_users: 20
                      interval: 3600
                      name: wifi-interference
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 102.5
                        - 108.03333
                        - 0
                        - 0
                        - 201.9
                        - 566.48334
                        - 135.63333
                        - 0
                        duration:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 102.5
                        - 108.03333
                        - 0
                        - 0
                        - 201.9
                        - 566.48334
                        - 135.63333
                        - 0
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 444.13333
                      x_label: seconds
                      y_label: user-minutes
                    end: 1627312871
                    failures: []
                    impact:
                      num_aps: 2
                      num_users: 21
                      total_aps: 3
                      total_users: 26
                    metric: capacity
                    start: 1627226471
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sle_classifier_summary'
                - description: Deprecated SLE classifier summary response
                  examples:
                  - classifier:
                      impact:
                        num_aps: 2
                        num_users: 17
                        total_aps: 3
                        total_users: 20
                      interval: 3600
                      name: wifi-interference
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 102.5
                        - 108.03333
                        - 0
                        - 0
                        - 201.9
                        - 566.48334
                        - 135.63333
                        - 0
                        duration:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 102.5
                        - 108.03333
                        - 0
                        - 0
                        - 201.9
                        - 566.48334
                        - 135.63333
                        - 0
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 444.13333
                      x_label: seconds
                      y_label: user-minutes
                    end: 1627312871
                    failures: []
                    impact:
                      num_aps: 2
                      num_users: 21
                      total_aps: 3
                      total_users: 26
                    metric: capacity
                    start: 1627226471
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    classifier:
                      impact:
                        num_aps: 2
                        num_users: 17
                        total_aps: 3
                        total_users: 20
                      interval: 3600
                      name: wifi-interference
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 102.5
                        - 108.03333
                        - 0
                        - 0
                        - 201.9
                        - 566.48334
                        - 135.63333
                        - 0
                        duration:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 102.5
                        - 108.03333
                        - 0
                        - 0
                        - 201.9
                        - 566.48334
                        - 135.63333
                        - 0
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 444.13333
                      x_label: seconds
                      y_label: user-minutes
                    end: 1627312871
                    failures: []
                    impact:
                      num_aps: 2
                      num_users: 21
                      total_aps: 3
                      total_users: 26
                    metric: capacity
                    start: 1627226471
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: true
    parameters: []
  /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/classifier/{classifier}/summary-trend:
    get:
      tags:
      - Sites SLEs
      summary: getSiteSleClassifierSummaryTrend
      description: Get SLE classifier Summary Trend
      operationId: getSiteSleClassifierSummaryTrend
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: scope
        in: path
        description: ''
        required: true
        schema:
          $ref: '#/components/schemas/sle_summary_scope'
      - name: scope_id
        in: path
        description: >-
          * site_id if `scope`==`site`

          * device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`

          * mac if `scope`==`client`
        required: true
        schema:
          type: string
      - name: metric
        in: path
        description: Values from `listSiteSlesMetrics`
        required: true
        schema:
          type: string
      - name: classifier
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sle_classifier_summary_trend'
                - description: Time-series trend response for an SLE classifier
                  examples:
                  - classifier:
                      interval: 3600
                      name: wifi-interference
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 102.5
                        - 108.03333
                        - 0
                        - 0
                        - 201.9
                        - 566.48334
                        - 135.63333
                        - 0
                        duration:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 102.5
                        - 108.03333
                        - 0
                        - 0
                        - 201.9
                        - 566.48334
                        - 135.63333
                        - 0
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 444.13333
                      x_label: seconds
                      y_label: user-minutes
                    end: 1627312871
                    metric: capacity
                    start: 1627226471
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    classifier:
                      interval: 3600
                      name: wifi-interference
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 102.5
                        - 108.03333
                        - 0
                        - 0
                        - 201.9
                        - 566.48334
                        - 135.63333
                        - 0
                        duration:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 102.5
                        - 108.03333
                        - 0
                        - 0
                        - 201.9
                        - 566.48334
                        - 135.63333
                        - 0
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 444.13333
                      x_label: seconds
                      y_label: user-minutes
                    end: 1627312871
                    metric: capacity
                    start: 1627226471
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sle_classifier_summary_trend'
                - description: Time-series trend response for an SLE classifier
                  examples:
                  - classifier:
                      interval: 3600
                      name: wifi-interference
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 102.5
                        - 108.03333
                        - 0
                        - 0
                        - 201.9
                        - 566.48334
                        - 135.63333
                        - 0
                        duration:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 102.5
                        - 108.03333
                        - 0
                        - 0
                        - 201.9
                        - 566.48334
                        - 135.63333
                        - 0
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 444.13333
                      x_label: seconds
                      y_label: user-minutes
                    end: 1627312871
                    metric: capacity
                    start: 1627226471
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    classifier:
                      interval: 3600
                      name: wifi-interference
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 102.5
                        - 108.03333
                        - 0
                        - 0
                        - 201.9
                        - 566.48334
                        - 135.63333
                        - 0
                        duration:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 102.5
                        - 108.03333
                        - 0
                        - 0
                        - 201.9
                        - 566.48334
                        - 135.63333
                        - 0
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 444.13333
                      x_label: seconds
                      y_label: user-minutes
                    end: 1627312871
                    metric: capacity
                    start: 1627226471
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/classifiers:
    get:
      tags:
      - Sites SLEs
      summary: listSiteSleMetricClassifiers
      description: List classifiers for a specific metric
      operationId: listSiteSleMetricClassifiers
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: scope
        in: path
        description: ''
        required: true
        schema:
          $ref: '#/components/schemas/site_sle_metric_classifiers_scope_parameters'
      - name: scope_id
        in: path
        description: >-
          * site_id if `scope`==`site`

          * device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`

          * mac if `scope`==`client`
        required: true
        schema:
          type: string
      - name: metric
        in: path
        description: Values from `listSiteSlesMetrics`
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                uniqueItems: true
                type: array
                items:
                  type: string
                description: Unique string values returned or accepted by this schema
                examples:
                - - asymmetry-uplink
                  - weak-signal
                  - asymmetry-downlink
                contentMediaType: application/json
              examples:
                example:
                  value:
                  - asymmetry-uplink
                  - weak-signal
                  - asymmetry-downlink
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/histogram:
    get:
      tags:
      - Sites SLEs
      summary: getSiteSleHistogram
      description: Get the histogram for the SLE metric
      operationId: getSiteSleHistogram
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: scope
        in: path
        description: ''
        required: true
        schema:
          $ref: '#/components/schemas/site_sle_histogram_scope_parameters'
      - name: scope_id
        in: path
        description: >-
          * site_id if `scope`==`site`

          * device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`

          * mac if `scope`==`client`
        required: true
        schema:
          type: string
      - name: metric
        in: path
        description: Values from `listSiteSlesMetrics`
        required: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sle_histogram'
                - description: Histogram response for an SLE metric
                  examples:
                  - data:
                    - range:
                      - null
                      - 0
                      value: 0
                    - range:
                      - 0
                      - 10
                      value: 0
                    - range:
                      - 10
                      - 20
                      value: 5105
                    - range:
                      - 20
                      - 30
                      value: 10616
                    - range:
                      - 30
                      - 40
                      value: 40051
                    - range:
                      - 40
                      - 50
                      value: 141201
                    - range:
                      - 50
                      - 60
                      value: 949823
                    - range:
                      - 60
                      - 70
                      value: 686308
                    - range:
                      - 70
                      - 80
                      value: 177670
                    - range:
                      - 80
                      - 90
                      value: 689
                    - range:
                      - 90
                      - 100
                      value: 0
                    - range:
                      - 100
                      - null
                      value: 0
                    end: 1627055181
                    metric: capacity
                    start: 1626968781
                    x_label: available_bandwidth(%)
                    y_label: seconds
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    data:
                    - range:
                      - null
                      - 0
                      value: 0
                    - range:
                      - 0
                      - 10
                      value: 0
                    - range:
                      - 10
                      - 20
                      value: 5105
                    - range:
                      - 20
                      - 30
                      value: 10616
                    - range:
                      - 30
                      - 40
                      value: 40051
                    - range:
                      - 40
                      - 50
                      value: 141201
                    - range:
                      - 50
                      - 60
                      value: 949823
                    - range:
                      - 60
                      - 70
                      value: 686308
                    - range:
                      - 70
                      - 80
                      value: 177670
                    - range:
                      - 80
                      - 90
                      value: 689
                    - range:
                      - 90
                      - 100
                      value: 0
                    - range:
                      - 100
                      - null
                      value: 0
                    end: 1627055181
                    metric: capacity
                    start: 1626968781
                    x_label: available_bandwidth(%)
                    y_label: seconds
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sle_histogram'
                - description: Histogram response for an SLE metric
                  examples:
                  - data:
                    - range:
                      - null
                      - 0
                      value: 0
                    - range:
                      - 0
                      - 10
                      value: 0
                    - range:
                      - 10
                      - 20
                      value: 5105
                    - range:
                      - 20
                      - 30
                      value: 10616
                    - range:
                      - 30
                      - 40
                      value: 40051
                    - range:
                      - 40
                      - 50
                      value: 141201
                    - range:
                      - 50
                      - 60
                      value: 949823
                    - range:
                      - 60
                      - 70
                      value: 686308
                    - range:
                      - 70
                      - 80
                      value: 177670
                    - range:
                      - 80
                      - 90
                      value: 689
                    - range:
                      - 90
                      - 100
                      value: 0
                    - range:
                      - 100
                      - null
                      value: 0
                    end: 1627055181
                    metric: capacity
                    start: 1626968781
                    x_label: available_bandwidth(%)
                    y_label: seconds
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    data:
                    - range:
                      - null
                      - 0
                      value: 0
                    - range:
                      - 0
                      - 10
                      value: 0
                    - range:
                      - 10
                      - 20
                      value: 5105
                    - range:
                      - 20
                      - 30
                      value: 10616
                    - range:
                      - 30
                      - 40
                      value: 40051
                    - range:
                      - 40
                      - 50
                      value: 141201
                    - range:
                      - 50
                      - 60
                      value: 949823
                    - range:
                      - 60
                      - 70
                      value: 686308
                    - range:
                      - 70
                      - 80
                      value: 177670
                    - range:
                      - 80
                      - 90
                      value: 689
                    - range:
                      - 90
                      - 100
                      value: 0
                    - range:
                      - 100
                      - null
                      value: 0
                    end: 1627055181
                    metric: capacity
                    start: 1626968781
                    x_label: available_bandwidth(%)
                    y_label: seconds
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/impact-summary:
    get:
      tags:
      - Sites SLEs
      summary: getSiteSleImpactSummary
      description: "Get impact summary counts optionally filtered by classifier and failure type\n \n* Wireless SLE Fields: `wlan`, `device_type`, `device_os` ,`band`, `ap`, `server`, `mxedge`\n* Wired SLE Fields: `switch`, `client`, `vlan`, `interface`, `chassis`\n* WAN SLE Fields: `gateway`, `client`, `interface`, `chassis`, `peer_path`, `gateway_zones`"
      operationId: getSiteSleImpactSummary
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: scope
        in: path
        description: ''
        required: true
        schema:
          $ref: '#/components/schemas/site_sle_impact_summary_scope_parameters'
      - name: scope_id
        in: path
        description: >-
          * site_id if `scope`==`site`

          * device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`

          * mac if `scope`==`client`
        required: true
        schema:
          type: string
      - name: metric
        in: path
        description: Values from `listSiteSlesMetrics`
        required: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: fields
        in: query
        description: 'Additional response fields to include, as a comma-separated list or `*` for all fields. enum: `ap`, `band`, `chassis`, `client`, `device_os`, `device_type`, `gateway`, `gateway_zones`, `interface`, `mxedge`, `peer_path`, `server`, `switch`, `vlan`, `wlan`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/site_sle_impact_summary_fields_parameter'
          - description: 'Additional response fields to include, as a comma-separated list or `*` for all fields. enum: `ap`, `band`, `chassis`, `client`, `device_os`, `device_type`, `gateway`, `gateway_zones`, `interface`, `mxedge`, `peer_path`, `server`, `switch`, `vlan`, `wlan`'
      - name: classifier
        in: query
        description: Filter SLE impact results by classifier
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sle_impact_summary'
                - description: SLE impact summary grouped by client, device, AP, WLAN, and band dimensions
                  examples:
                  - ap:
                    - ap_mac: 5c5b3550bd2e
                      degraded: 1486
                      duration: 0
                      name: ap43-off.lab
                      total: 27406
                    - ap_mac: d420b083e17a
                      degraded: 3
                      duration: 0
                      name: ap33-ent.lab
                      total: 1193
                    band:
                    - band: '24'
                      degraded: 1410
                      duration: 0
                      name: '24'
                      total: 28536
                    - band: '5'
                      degraded: 78
                      duration: 0
                      name: '5'
                      total: 4679
                    classifier: ''
                    device_os:
                    - degraded: 1329
                      device_os: ''
                      duration: 0
                      name: unknown
                      total: 27165
                    - degraded: 81
                      device_os: Linux
                      duration: 0
                      name: Linux
                      total: 1437
                    - degraded: 36
                      device_os: Android 11
                      duration: 0
                      name: Android 11
                      total: 761
                    - degraded: 39
                      device_os: '14.6'
                      duration: 0
                      name: '14.6'
                      total: 2413
                    - degraded: 2
                      device_os: Catalina
                      duration: 0
                      name: Catalina
                      total: 1438
                    device_type:
                    - degraded: 1410
                      device_type: ''
                      duration: 0
                      name: unknown
                      total: 28603
                    - degraded: 2
                      device_type: iPhone
                      duration: 0
                      name: iPhone
                      total: 1263
                    - degraded: 36
                      device_type: OnePlus
                      duration: 0
                      name: OnePlus
                      total: 761
                    - degraded: 37
                      device_type: iPad
                      duration: 0
                      name: iPad
                      total: 1150
                    - degraded: 2
                      device_type: Mac
                      duration: 0
                      name: Mac
                      total: 1438
                    end: 1627312734
                    failure: ''
                    metric: capacity
                    start: 1627226334
                    wlan:
                    - degraded: 37
                      duration: 0
                      name: MlN.ADM
                      total: 1150
                      wlan_id: ba3f85fc-ba48-4d8f-ad89-152e5c42db18
                    - degraded: 1410
                      duration: 0
                      name: MlN
                      total: 28603
                      wlan_id: 649a2336-b1e0-47bd-961c-f637dbe50e7b
                    - degraded: 41
                      duration: 0
                      name: MlN.1X
                      total: 3462
                      wlan_id: a937da77-fe3c-4784-86c4-f2134d7b1483
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    ap:
                    - ap_mac: 5c5b3550bd2e
                      degraded: 1486
                      duration: 0
                      name: ap43-off.lab
                      total: 27406
                    - ap_mac: d420b083e17a
                      degraded: 3
                      duration: 0
                      name: ap33-ent.lab
                      total: 1193
                    band:
                    - band: '24'
                      degraded: 1410
                      duration: 0
                      name: '24'
                      total: 28536
                    - band: '5'
                      degraded: 78
                      duration: 0
                      name: '5'
                      total: 4679
                    classifier: ''
                    device_os:
                    - degraded: 1329
                      device_os: ''
                      duration: 0
                      name: unknown
                      total: 27165
                    - degraded: 81
                      device_os: Linux
                      duration: 0
                      name: Linux
                      total: 1437
                    - degraded: 36
                      device_os: Android 11
                      duration: 0
                      name: Android 11
                      total: 761
                    - degraded: 39
                      device_os: '14.6'
                      duration: 0
                      name: '14.6'
                      total: 2413
                    - degraded: 2
                      device_os: Catalina
                      duration: 0
                      name: Catalina
                      total: 1438
                    device_type:
                    - degraded: 1410
                      device_type: ''
                      duration: 0
                      name: unknown
                      total: 28603
                    - degraded: 2
                      device_type: iPhone
                      duration: 0
                      name: iPhone
                      total: 1263
                    - degraded: 36
                      device_type: OnePlus
                      duration: 0
                      name: OnePlus
                      total: 761
                    - degraded: 37
                      device_type: iPad
                      duration: 0
                      name: iPad
                      total: 1150
                    - degraded: 2
                      device_type: Mac
                      duration: 0
                      name: Mac
                      total: 1438
                    end: 1627312734
                    failure: ''
                    metric: capacity
                    start: 1627226334
                    wlan:
                    - degraded: 37
                      duration: 0
                      name: MlN.ADM
                      total: 1150
                      wlan_id: ba3f85fc-ba48-4d8f-ad89-152e5c42db18
                    - degraded: 1410
                      duration: 0
                      name: MlN
                      total: 28603
                      wlan_id: 649a2336-b1e0-47bd-961c-f637dbe50e7b
                    - degraded: 41
                      duration: 0
                      name: MlN.1X
                      total: 3462
                      wlan_id: a937da77-fe3c-4784-86c4-f2134d7b1483
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sle_impact_summary'
                - description: SLE impact summary grouped by client, device, AP, WLAN, and band dimensions
                  examples:
                  - ap:
                    - ap_mac: 5c5b3550bd2e
                      degraded: 1486
                      duration: 0
                      name: ap43-off.lab
                      total: 27406
                    - ap_mac: d420b083e17a
                      degraded: 3
                      duration: 0
                      name: ap33-ent.lab
                      total: 1193
                    band:
                    - band: '24'
                      degraded: 1410
                      duration: 0
                      name: '24'
                      total: 28536
                    - band: '5'
                      degraded: 78
                      duration: 0
                      name: '5'
                      total: 4679
                    classifier: ''
                    device_os:
                    - degraded: 1329
                      device_os: ''
                      duration: 0
                      name: unknown
                      total: 27165
                    - degraded: 81
                      device_os: Linux
                      duration: 0
                      name: Linux
                      total: 1437
                    - degraded: 36
                      device_os: Android 11
                      duration: 0
                      name: Android 11
                      total: 761
                    - degraded: 39
                      device_os: '14.6'
                      duration: 0
                      name: '14.6'
                      total: 2413
                    - degraded: 2
                      device_os: Catalina
                      duration: 0
                      name: Catalina
                      total: 1438
                    device_type:
                    - degraded: 1410
                      device_type: ''
                      duration: 0
                      name: unknown
                      total: 28603
                    - degraded: 2
                      device_type: iPhone
                      duration: 0
                      name: iPhone
                      total: 1263
                    - degraded: 36
                      device_type: OnePlus
                      duration: 0
                      name: OnePlus
                      total: 761
                    - degraded: 37
                      device_type: iPad
                      duration: 0
                      name: iPad
                      total: 1150
                    - degraded: 2
                      device_type: Mac
                      duration: 0
                      name: Mac
                      total: 1438
                    end: 1627312734
                    failure: ''
                    metric: capacity
                    start: 1627226334
                    wlan:
                    - degraded: 37
                      duration: 0
                      name: MlN.ADM
                      total: 1150
                      wlan_id: ba3f85fc-ba48-4d8f-ad89-152e5c42db18
                    - degraded: 1410
                      duration: 0
                      name: MlN
                      total: 28603
                      wlan_id: 649a2336-b1e0-47bd-961c-f637dbe50e7b
                    - degraded: 41
                      duration: 0
                      name: MlN.1X
                      total: 3462
                      wlan_id: a937da77-fe3c-4784-86c4-f2134d7b1483
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    ap:
                    - ap_mac: 5c5b3550bd2e
                      degraded: 1486
                      duration: 0
                      name: ap43-off.lab
                      total: 27406
                    - ap_mac: d420b083e17a
                      degraded: 3
                      duration: 0
                      name: ap33-ent.lab
                      total: 1193
                    band:
                    - band: '24'
                      degraded: 1410
                      duration: 0
                      name: '24'
                      total: 28536
                    - band: '5'
                      degraded: 78
                      duration: 0
                      name: '5'
                      total: 4679
                    classifier: ''
                    device_os:
                    - degraded: 1329
                      device_os: ''
                      duration: 0
                      name: unknown
                      total: 27165
                    - degraded: 81
                      device_os: Linux
                      duration: 0
                      name: Linux
                      total: 1437
                    - degraded: 36
                      device_os: Android 11
                      duration: 0
                      name: Android 11
                      total: 761
                    - degraded: 39
                      device_os: '14.6'
                      duration: 0
                      name: '14.6'
                      total: 2413
                    - degraded: 2
                      device_os: Catalina
                      duration: 0
                      name: Catalina
                      total: 1438
                    device_type:
                    - degraded: 1410
                      device_type: ''
                      duration: 0
                      name: unknown
                      total: 28603
                    - degraded: 2
                      device_type: iPhone
                      duration: 0
                      name: iPhone
                      total: 1263
                    - degraded: 36
                      device_type: OnePlus
                      duration: 0
                      name: OnePlus
                      total: 761
                    - degraded: 37
                      device_type: iPad
                      duration: 0
                      name: iPad
                      total: 1150
                    - degraded: 2
                      device_type: Mac
                      duration: 0
                      name: Mac
                      total: 1438
                    end: 1627312734
                    failure: ''
                    metric: capacity
                    start: 1627226334
                    wlan:
                    - degraded: 37
                      duration: 0
                      name: MlN.ADM
                      total: 1150
                      wlan_id: ba3f85fc-ba48-4d8f-ad89-152e5c42db18
                    - degraded: 1410
                      duration: 0
                      name: MlN
                      total: 28603
                      wlan_id: 649a2336-b1e0-47bd-961c-f637dbe50e7b
                    - degraded: 41
                      duration: 0
                      name: MlN.1X
                      total: 3462
                      wlan_id: a937da77-fe3c-4784-86c4-f2134d7b1483
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/impacted-applications:
    get:
      tags:
      - Sites SLEs
      summary: listSiteSleImpactedApplications
      description: For WAN SLEs. List the impacted interfaces optionally filtered by classifier and failure type
      operationId: listSiteSleImpactedApplications
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: scope
        in: path
        description: ''
        required: true
        schema:
          $ref: '#/components/schemas/site_sle_scope'
      - name: scope_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
      - name: metric
        in: path
        description: Values from `listSiteSlesMetrics`
        required: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: classifier
        in: query
        description: Filter SLE impact results by classifier
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sle_impacted_applications'
                - description: Paginated list of applications impacted by an SLE metric
                  examples:
                  - apps:
                    - app: ZOOM
                      degraded: 371103
                      duration: 0
                      name: ZOOM
                      threshold: 173
                      total: 1771274
                    classifier: ''
                    end: 1668760746
                    failure: ''
                    limit: 1000
                    metric: application_health
                    page: 1
                    start: 1668121200
                    total_count: 1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    apps:
                    - app: ZOOM
                      degraded: 371103
                      duration: 0
                      name: ZOOM
                      threshold: 173
                      total: 1771274
                    classifier: ''
                    end: 1668760746
                    failure: ''
                    limit: 1000
                    metric: application_health
                    page: 1
                    start: 1668121200
                    total_count: 1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sle_impacted_applications'
                - description: Paginated list of applications impacted by an SLE metric
                  examples:
                  - apps:
                    - app: ZOOM
                      degraded: 371103
                      duration: 0
                      name: ZOOM
                      threshold: 173
                      total: 1771274
                    classifier: ''
                    end: 1668760746
                    failure: ''
                    limit: 1000
                    metric: application_health
                    page: 1
                    start: 1668121200
                    total_count: 1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    apps:
                    - app: ZOOM
                      degraded: 371103
                      duration: 0
                      name: ZOOM
                      threshold: 173
                      total: 1771274
                    classifier: ''
                    end: 1668760746
                    failure: ''
                    limit: 1000
                    metric: application_health
                    page: 1
                    start: 1668121200
                    total_count: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/impacted-aps:
    get:
      tags:
      - Sites SLEs
      summary: listSiteSleImpactedAps
      description: For Wireless SLEs. List the impacted APs optionally filtered by classifier and failure type
      operationId: listSiteSleImpactedAps
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: scope
        in: path
        description: ''
        required: true
        schema:
          $ref: '#/components/schemas/site_sle_impacted_aps_scope_parameters'
      - name: scope_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
      - name: metric
        in: path
        description: Values from `listSiteSlesMetrics`
        required: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: classifier
        in: query
        description: Filter SLE impact results by classifier
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sle_impacted_aps'
                - description: Paginated list of APs impacted by an SLE metric
                  examples:
                  - aps:
                    - ap_mac: 5c5b35500000
                      degraded: 1486
                      duration: 0
                      name: ap43.lab
                      total: 27377
                    - ap_mac: d420b0830000
                      degraded: 3
                      duration: 0
                      name: ap33.lab
                      total: 1189
                    classifier: ''
                    end: 1627313016
                    failure: ''
                    limit: 1000
                    metric: capacity
                    page: 1
                    start: 1627226616
                    total_count: 2
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    aps:
                    - ap_mac: 5c5b35500000
                      degraded: 1486
                      duration: 0
                      name: ap43.lab
                      total: 27377
                    - ap_mac: d420b0830000
                      degraded: 3
                      duration: 0
                      name: ap33.lab
                      total: 1189
                    classifier: ''
                    end: 1627313016
                    failure: ''
                    limit: 1000
                    metric: capacity
                    page: 1
                    start: 1627226616
                    total_count: 2
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sle_impacted_aps'
                - description: Paginated list of APs impacted by an SLE metric
                  examples:
                  - aps:
                    - ap_mac: 5c5b35500000
                      degraded: 1486
                      duration: 0
                      name: ap43.lab
                      total: 27377
                    - ap_mac: d420b0830000
                      degraded: 3
                      duration: 0
                      name: ap33.lab
                      total: 1189
                    classifier: ''
                    end: 1627313016
                    failure: ''
                    limit: 1000
                    metric: capacity
                    page: 1
                    start: 1627226616
                    total_count: 2
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    aps:
                    - ap_mac: 5c5b35500000
                      degraded: 1486
                      duration: 0
                      name: ap43.lab
                      total: 27377
                    - ap_mac: d420b0830000
                      degraded: 3
                      duration: 0
                      name: ap33.lab
                      total: 1189
                    classifier: ''
                    end: 1627313016
                    failure: ''
                    limit: 1000
                    metric: capacity
                    page: 1
                    start: 1627226616
                    total_count: 2
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/impacted-chassis:
    get:
      tags:
      - Sites SLEs
      summary: listSiteSleImpactedChassis
      description: For Wired and WAN SLEs. List the impacted interfaces optionally filtered by classifier and failure type
      operationId: listSiteSleImpactedChassis
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: scope
        in: path
        description: ''
        required: true
        schema:
          $ref: '#/components/schemas/site_sle_impacted_chassis_scope_parameters'
      - name: scope_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
      - name: metric
        in: path
        description: Values from `listSiteSlesMetrics`
        required: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: classifier
        in: query
        description: Filter SLE impact results by classifier
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sle_impacted_chassis'
                - description: Paginated list of chassis impacted by an SLE metric
                  examples:
                  - chassis:
                    - chassis: '1'
                      degraded: 12.283334
                      duration: 13655.167
                      role: master
                      switch_mac: d0dd49012345
                      switch_name: test-chassis
                      total: 13655.167
                    classifier: ''
                    end: 1668760643
                    failure: ''
                    limit: 1000
                    metric: switch_health
                    page: 1
                    start: 1668121200
                    total_count: 1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    chassis:
                    - chassis: '1'
                      degraded: 12.283334
                      duration: 13655.167
                      role: master
                      switch_mac: d0dd49012345
                      switch_name: test-chassis
                      total: 13655.167
                    classifier: ''
                    end: 1668760643
                    failure: ''
                    limit: 1000
                    metric: switch_health
                    page: 1
                    start: 1668121200
                    total_count: 1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sle_impacted_chassis'
                - description: Paginated list of chassis impacted by an SLE metric
                  examples:
                  - chassis:
                    - chassis: '1'
                      degraded: 12.283334
                      duration: 13655.167
                      role: master
                      switch_mac: d0dd49012345
                      switch_name: test-chassis
                      total: 13655.167
                    classifier: ''
                    end: 1668760643
                    failure: ''
                    limit: 1000
                    metric: switch_health
                    page: 1
                    start: 1668121200
                    total_count: 1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    chassis:
                    - chassis: '1'
                      degraded: 12.283334
                      duration: 13655.167
                      role: master
                      switch_mac: d0dd49012345
                      switch_name: test-chassis
                      total: 13655.167
                    classifier: ''
                    end: 1668760643
                    failure: ''
                    limit: 1000
                    metric: switch_health
                    page: 1
                    start: 1668121200
                    total_count: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/impacted-clients:
    get:
      tags:
      - Sites SLEs
      summary: listSiteSleImpactedWiredClients
      description: For Wired SLEs. List the impacted interfaces optionally filtered by classifier and failure type
      operationId: listSiteSleImpactedWiredClients
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: scope
        in: path
        description: ''
        required: true
        schema:
          $ref: '#/components/schemas/site_sle_impacted_clients_scope_parameters'
      - name: scope_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
      - name: metric
        in: path
        description: Values from `listSiteSlesMetrics`
        required: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: classifier
        in: query
        description: Filter SLE impact results by classifier
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sle_impacted_clients'
                - description: Paginated list of clients impacted by an SLE metric
                  examples:
                  - classifier: ''
                    clients:
                    - degraded: 40
                      duration: 11014
                      mac: '001122334455'
                      name: test-device
                      switches:
                      - interfaces:
                        - ge-0/0/6
                        switch_mac: 2c2131001122
                        switch_name: test-ex
                      total: 11014
                    end: 1668760198
                    failure: ''
                    limit: 1000
                    metric: switch_throughput
                    page: 1
                    start: 1668726000
                    total_count: 1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    classifier: ''
                    clients:
                    - degraded: 40
                      duration: 11014
                      mac: '001122334455'
                      name: test-device
                      switches:
                      - interfaces:
                        - ge-0/0/6
                        switch_mac: 2c2131001122
                        switch_name: test-ex
                      total: 11014
                    end: 1668760198
                    failure: ''
                    limit: 1000
                    metric: switch_throughput
                    page: 1
                    start: 1668726000
                    total_count: 1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sle_impacted_clients'
                - description: Paginated list of clients impacted by an SLE metric
                  examples:
                  - classifier: ''
                    clients:
                    - degraded: 40
                      duration: 11014
                      mac: '001122334455'
                      name: test-device
                      switches:
                      - interfaces:
                        - ge-0/0/6
                        switch_mac: 2c2131001122
                        switch_name: test-ex
                      total: 11014
                    end: 1668760198
                    failure: ''
                    limit: 1000
                    metric: switch_throughput
                    page: 1
                    start: 1668726000
                    total_count: 1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    classifier: ''
                    clients:
                    - degraded: 40
                      duration: 11014
                      mac: '001122334455'
                      name: test-device
                      switches:
                      - interfaces:
                        - ge-0/0/6
                        switch_mac: 2c2131001122
                        switch_name: test-ex
                      total: 11014
                    end: 1668760198
                    failure: ''
                    limit: 1000
                    metric: switch_throughput
                    page: 1
                    start: 1668726000
                    total_count: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/impacted-gateways:
    get:
      tags:
      - Sites SLEs
      summary: listSiteSleImpactedGateways
      description: For WAN SLEs. List the impacted interfaces optionally filtered by classifier and failure type
      operationId: listSiteSleImpactedGateways
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: scope
        in: path
        description: ''
        required: true
        schema:
          $ref: '#/components/schemas/site_sle_impacted_gateways_scope_parameters'
      - name: scope_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
      - name: metric
        in: path
        description: Values from `listSiteSlesMetrics`
        required: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: classifier
        in: query
        description: Filter SLE impact results by classifier
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sle_impacted_gateways'
                - description: Paginated list of gateways impacted by an SLE metric
                  examples:
                  - classifier: ''
                    end: 1668760746
                    failure: ''
                    gateways:
                    - degraded: 758573.1
                      duration: 2770997
                      gateway_mac: fc3342001122
                      gateway_model: SRX320
                      gateway_version: 20.4R1.12
                      name: test-SRX
                      total: 2770997
                    limit: 1000
                    metric: application_health
                    page: 1
                    start: 1668121200
                    total_count: 1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    classifier: ''
                    end: 1668760746
                    failure: ''
                    gateways:
                    - degraded: 758573.1
                      duration: 2770997
                      gateway_mac: fc3342001122
                      gateway_model: SRX320
                      gateway_version: 20.4R1.12
                      name: test-SRX
                      total: 2770997
                    limit: 1000
                    metric: application_health
                    page: 1
                    start: 1668121200
                    total_count: 1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sle_impacted_gateways'
                - description: Paginated list of gateways impacted by an SLE metric
                  examples:
                  - classifier: ''
                    end: 1668760746
                    failure: ''
                    gateways:
                    - degraded: 758573.1
                      duration: 2770997
                      gateway_mac: fc3342001122
                      gateway_model: SRX320
                      gateway_version: 20.4R1.12
                      name: test-SRX
                      total: 2770997
                    limit: 1000
                    metric: application_health
                    page: 1
                    start: 1668121200
                    total_count: 1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    classifier: ''
                    end: 1668760746
                    failure: ''
                    gateways:
                    - degraded: 758573.1
                      duration: 2770997
                      gateway_mac: fc3342001122
                      gateway_model: SRX320
                      gateway_version: 20.4R1.12
                      name: test-SRX
                      total: 2770997
                    limit: 1000
                    metric: application_health
                    page: 1
                    start: 1668121200
                    total_count: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/impacted-interfaces:
    get:
      tags:
      - Sites SLEs
      summary: listSiteSleImpactedInterfaces
      description: For Wired and WAN SLEs. List the impacted interfaces optionally filtered by classifier and failure type
      operationId: listSiteSleImpactedInterfaces
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: scope
        in: path
        description: ''
        required: true
        schema:
          $ref: '#/components/schemas/site_sle_impacted_interfaces_scope_parameters'
      - name: scope_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
      - name: metric
        in: path
        description: Values from `listSiteSlesMetrics`
        required: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: classifier
        in: query
        description: Filter SLE impact results by classifier
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sle_impacted_interfaces'
                - description: Paginated list of interfaces impacted by an SLE metric
                  examples:
                  - classifier: ''
                    end: 1668760198
                    failure: ''
                    interfaces:
                    - degraded: 11.583333
                      duration: 765.4667
                      interface_name: ge-0/0/10
                      switch_mac: 2c2131001122
                      switch_name: test-ex
                      total: 765.4667
                    - degraded: 191.08333
                      duration: 13775.35
                      interface_name: xe-0/1/0
                      switch_mac: 2c2131001122
                      switch_name: test-ex
                      total: 13775.35
                    limit: 1000
                    metric: switch_throughput
                    page: 1
                    start: 1668726000
                    total_count: 5
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    classifier: ''
                    end: 1668760198
                    failure: ''
                    interfaces:
                    - degraded: 11.583333
                      duration: 765.4667
                      interface_name: ge-0/0/10
                      switch_mac: 2c2131001122
                      switch_name: test-ex
                      total: 765.4667
                    - degraded: 191.08333
                      duration: 13775.35
                      interface_name: xe-0/1/0
                      switch_mac: 2c2131001122
                      switch_name: test-ex
                      total: 13775.35
                    limit: 1000
                    metric: switch_throughput
                    page: 1
                    start: 1668726000
                    total_count: 5
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sle_impacted_interfaces'
                - description: Paginated list of interfaces impacted by an SLE metric
                  examples:
                  - classifier: ''
                    end: 1668760198
                    failure: ''
                    interfaces:
                    - degraded: 11.583333
                      duration: 765.4667
                      interface_name: ge-0/0/10
                      switch_mac: 2c2131001122
                      switch_name: test-ex
                      total: 765.4667
                    - degraded: 191.08333
                      duration: 13775.35
                      interface_name: xe-0/1/0
                      switch_mac: 2c2131001122
                      switch_name: test-ex
                      total: 13775.35
                    limit: 1000
                    metric: switch_throughput
                    page: 1
                    start: 1668726000
                    total_count: 5
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    classifier: ''
                    end: 1668760198
                    failure: ''
                    interfaces:
                    - degraded: 11.583333
                      duration: 765.4667
                      interface_name: ge-0/0/10
                      switch_mac: 2c2131001122
                      switch_name: test-ex
                      total: 765.4667
                    - degraded: 191.08333
                      duration: 13775.35
                      interface_name: xe-0/1/0
                      switch_mac: 2c2131001122
                      switch_name: test-ex
                      total: 13775.35
                    limit: 1000
                    metric: switch_throughput
                    page: 1
                    start: 1668726000
                    total_count: 5
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/impacted-switches:
    get:
      tags:
      - Sites SLEs
      summary: listSiteSleImpactedSwitches
      description: For Wired SLEs. List the impacted switches optionally filtered by classifier and failure type
      operationId: listSiteSleImpactedSwitches
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: scope
        in: path
        description: ''
        required: true
        schema:
          $ref: '#/components/schemas/site_sle_impacted_switches_scope_parameters'
      - name: scope_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
      - name: metric
        in: path
        description: Values from `listSiteSlesMetrics`
        required: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: classifier
        in: query
        description: Filter SLE impact results by classifier
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sle_impacted_switches'
                - description: Paginated list of switches impacted by an SLE metric
                  examples:
                  - classifier: ''
                    end: 1668760198
                    failure: ''
                    limit: 1000
                    metric: switch_throughput
                    page: 1
                    start: 1668726000
                    switches:
                    - degraded: 109.88333
                      duration: 5753.75
                      interface:
                      - ge-0/0/11
                      - xe-0/1/0
                      name: test-ex
                      switch_mac: 2c2131001122
                      switch_model: EX2300-C-12P
                      switch_version: 20.4R3-S3.4
                      total: 5753.75
                    total_count: 1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    classifier: ''
                    end: 1668760198
                    failure: ''
                    limit: 1000
                    metric: switch_throughput
                    page: 1
                    start: 1668726000
                    switches:
                    - degraded: 109.88333
                      duration: 5753.75
                      interface:
                      - ge-0/0/11
                      - xe-0/1/0
                      name: test-ex
                      switch_mac: 2c2131001122
                      switch_model: EX2300-C-12P
                      switch_version: 20.4R3-S3.4
                      total: 5753.75
                    total_count: 1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sle_impacted_switches'
                - description: Paginated list of switches impacted by an SLE metric
                  examples:
                  - classifier: ''
                    end: 1668760198
                    failure: ''
                    limit: 1000
                    metric: switch_throughput
                    page: 1
                    start: 1668726000
                    switches:
                    - degraded: 109.88333
                      duration: 5753.75
                      interface:
                      - ge-0/0/11
                      - xe-0/1/0
                      name: test-ex
                      switch_mac: 2c2131001122
                      switch_model: EX2300-C-12P
                      switch_version: 20.4R3-S3.4
                      total: 5753.75
                    total_count: 1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    classifier: ''
                    end: 1668760198
                    failure: ''
                    limit: 1000
                    metric: switch_throughput
                    page: 1
                    start: 1668726000
                    switches:
                    - degraded: 109.88333
                      duration: 5753.75
                      interface:
                      - ge-0/0/11
                      - xe-0/1/0
                      name: test-ex
                      switch_mac: 2c2131001122
                      switch_model: EX2300-C-12P
                      switch_version: 20.4R3-S3.4
                      total: 5753.75
                    total_count: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/impacted-users:
    get:
      tags:
      - Sites SLEs
      summary: listSiteSleImpactedWirelessClients
      description: For Wireless SLEs. List the impacted wireless users optionally filtered by classifier and failure type
      operationId: listSiteSleImpactedWirelessClients
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: scope
        in: path
        description: ''
        required: true
        schema:
          $ref: '#/components/schemas/site_sle_impacted_users_scope_parameter'
      - name: scope_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
      - name: metric
        in: path
        description: Values from `listSiteSlesMetrics`
        required: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: classifier
        in: query
        description: Filter SLE impact results by classifier
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sle_impacted_users'
                - description: Paginated list of users impacted by an SLE metric
                  examples:
                  - classifier: ''
                    end: 1627313103
                    failure: ''
                    limit: 1000
                    metric: capacity
                    page: 1
                    start: 1627226703
                    total_count: 21
                    users:
                    - ap_mac: d420b0830000
                      ap_name: ap33.lab
                      degraded: 2
                      device_os: '14.6'
                      device_type: iPhone
                      duration: 1270
                      mac: dc080f360000
                      name: aPhone-20973
                      ssid: lab.1X
                      total: 1270
                      wlan_id: a937da77-0000-0000-0000-f2134d7b1483
                    - ap_mac: 5c5b35500000
                      ap_name: ap43.lab
                      degraded: 36
                      device_os: Android 11
                      device_type: OnePlus
                      duration: 767
                      mac: 4c4feedc0000
                      name: OnePlus-8
                      ssid: lab.1X
                      total: 767
                      wlan_id: a937da77-0000-0000-0000-f2134d7b1483
                    - ap_mac: 5c5b35500000
                      ap_name: ap43.lab
                      degraded: 2
                      device_os: Catalina
                      device_type: Mac
                      duration: 1405
                      mac: a483e7390000
                      name: tmunzer-mbp
                      ssid: lab.1X
                      total: 1405
                      wlan_id: a937da77-0000-0000-0000-f2134d7b1483
                    - ap_mac: 5c5b35500000
                      ap_name: ap43.lab
                      degraded: 81
                      device_os: Linux
                      device_type: unknown
                      duration: 1403
                      mac: 5caafd0d0000
                      name: SonosZP
                      ssid: lab
                      total: 1403
                      wlan_id: 649a2336-0000-0000-0000-f637dbe50e7b
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    classifier: ''
                    end: 1627313103
                    failure: ''
                    limit: 1000
                    metric: capacity
                    page: 1
                    start: 1627226703
                    total_count: 21
                    users:
                    - ap_mac: d420b0830000
                      ap_name: ap33.lab
                      degraded: 2
                      device_os: '14.6'
                      device_type: iPhone
                      duration: 1270
                      mac: dc080f360000
                      name: aPhone-20973
                      ssid: lab.1X
                      total: 1270
                      wlan_id: a937da77-0000-0000-0000-f2134d7b1483
                    - ap_mac: 5c5b35500000
                      ap_name: ap43.lab
                      degraded: 36
                      device_os: Android 11
                      device_type: OnePlus
                      duration: 767
                      mac: 4c4feedc0000
                      name: OnePlus-8
                      ssid: lab.1X
                      total: 767
                      wlan_id: a937da77-0000-0000-0000-f2134d7b1483
                    - ap_mac: 5c5b35500000
                      ap_name: ap43.lab
                      degraded: 2
                      device_os: Catalina
                      device_type: Mac
                      duration: 1405
                      mac: a483e7390000
                      name: tmunzer-mbp
                      ssid: lab.1X
                      total: 1405
                      wlan_id: a937da77-0000-0000-0000-f2134d7b1483
                    - ap_mac: 5c5b35500000
                      ap_name: ap43.lab
                      degraded: 81
                      device_os: Linux
                      device_type: unknown
                      duration: 1403
                      mac: 5caafd0d0000
                      name: SonosZP
                      ssid: lab
                      total: 1403
                      wlan_id: 649a2336-0000-0000-0000-f637dbe50e7b
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sle_impacted_users'
                - description: Paginated list of users impacted by an SLE metric
                  examples:
                  - classifier: ''
                    end: 1627313103
                    failure: ''
                    limit: 1000
                    metric: capacity
                    page: 1
                    start: 1627226703
                    total_count: 21
                    users:
                    - ap_mac: d420b0830000
                      ap_name: ap33.lab
                      degraded: 2
                      device_os: '14.6'
                      device_type: iPhone
                      duration: 1270
                      mac: dc080f360000
                      name: aPhone-20973
                      ssid: lab.1X
                      total: 1270
                      wlan_id: a937da77-0000-0000-0000-f2134d7b1483
                    - ap_mac: 5c5b35500000
                      ap_name: ap43.lab
                      degraded: 36
                      device_os: Android 11
                      device_type: OnePlus
                      duration: 767
                      mac: 4c4feedc0000
                      name: OnePlus-8
                      ssid: lab.1X
                      total: 767
                      wlan_id: a937da77-0000-0000-0000-f2134d7b1483
                    - ap_mac: 5c5b35500000
                      ap_name: ap43.lab
                      degraded: 2
                      device_os: Catalina
                      device_type: Mac
                      duration: 1405
                      mac: a483e7390000
                      name: tmunzer-mbp
                      ssid: lab.1X
                      total: 1405
                      wlan_id: a937da77-0000-0000-0000-f2134d7b1483
                    - ap_mac: 5c5b35500000
                      ap_name: ap43.lab
                      degraded: 81
                      device_os: Linux
                      device_type: unknown
                      duration: 1403
                      mac: 5caafd0d0000
                      name: SonosZP
                      ssid: lab
                      total: 1403
                      wlan_id: 649a2336-0000-0000-0000-f637dbe50e7b
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    classifier: ''
                    end: 1627313103
                    failure: ''
                    limit: 1000
                    metric: capacity
                    page: 1
                    start: 1627226703
                    total_count: 21
                    users:
                    - ap_mac: d420b0830000
                      ap_name: ap33.lab
                      degraded: 2
                      device_os: '14.6'
                      device_type: iPhone
                      duration: 1270
                      mac: dc080f360000
                      name: aPhone-20973
                      ssid: lab.1X
                      total: 1270
                      wlan_id: a937da77-0000-0000-0000-f2134d7b1483
                    - ap_mac: 5c5b35500000
                      ap_name: ap43.lab
                      degraded: 36
                      device_os: Android 11
                      device_type: OnePlus
                      duration: 767
                      mac: 4c4feedc0000
                      name: OnePlus-8
                      ssid: lab.1X
                      total: 767
                      wlan_id: a937da77-0000-0000-0000-f2134d7b1483
                    - ap_mac: 5c5b35500000
                      ap_name: ap43.lab
                      degraded: 2
                      device_os: Catalina
                      device_type: Mac
                      duration: 1405
                      mac: a483e7390000
                      name: tmunzer-mbp
                      ssid: lab.1X
                      total: 1405
                      wlan_id: a937da77-0000-0000-0000-f2134d7b1483
                    - ap_mac: 5c5b35500000
                      ap_name: ap43.lab
                      degraded: 81
                      device_os: Linux
                      device_type: unknown
                      duration: 1403
                      mac: 5caafd0d0000
                      name: SonosZP
                      ssid: lab
                      total: 1403
                      wlan_id: 649a2336-0000-0000-0000-f637dbe50e7b
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/summary:
    get:
      tags:
      - Sites SLEs
      summary: getSiteSleSummary
      description: >-
        Get the summary for the SLE metric



        This API Endpoint is deprecated and replaced by [Get Site SLE Summary Trend]($e/Sites%20SLEs/getSiteSleSummaryTrend)
      operationId: getSiteSleSummary
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: scope
        in: path
        description: ''
        required: true
        schema:
          $ref: '#/components/schemas/site_sle_metric_summary_scope_parameters'
      - name: scope_id
        in: path
        description: >-
          * site_id if `scope`==`site`

          * device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`

          * mac if `scope`==`client`
        required: true
        schema:
          type: string
      - name: metric
        in: path
        description: Values from `listSiteSlesMetrics`
        required: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sle_summary'
                - description: Deprecated SLE summary response for a metric window
                  examples:
                  - classifiers:
                    - impact:
                        num_aps: 1
                        num_users: 4
                        total_aps: 3
                        total_users: 26
                      interval: 3600
                      name: client-count
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 5.8
                        - 0
                        - 0
                        - 0
                        - 4.65
                        - 0
                        - 7.55
                        - 47.55
                        - 13.266666
                        duration:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 5.8
                        - 0
                        - 0
                        - 0
                        - 4.65
                        - 0
                        - 7.55
                        - 47.55
                        - 13.266666
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                      x_label: seconds
                      y_label: user-minutes
                    - impact:
                        num_aps: 2
                        num_users: 17
                        total_aps: 3
                        total_users: 26
                      interval: 3600
                      name: wifi-interference
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 102.5
                        - 108.03333
                        - 0
                        - 0
                        - 201.9
                        - 566.48334
                        - 135.63333
                        - 0
                        duration:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 102.5
                        - 108.03333
                        - 0
                        - 0
                        - 201.9
                        - 566.48334
                        - 135.63333
                        - 0
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                      x_label: seconds
                      y_label: user-minutes
                    - impact:
                        num_aps: 0
                        num_users: 0
                        total_aps: 3
                        total_users: 26
                      interval: 3600
                      name: client_usage
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        duration:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                      x_label: seconds
                      y_label: user-minutes
                    - impact:
                        num_aps: 1
                        num_users: 17
                        total_aps: 3
                        total_users: 26
                      interval: 3600
                      name: non-wifi-interference
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 16.65
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 31.15
                        - 17.616667
                        - 17.85
                        - 0
                        - 0
                        - 0
                        - 0
                        duration:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 16.65
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 31.15
                        - 17.616667
                        - 17.85
                        - 0
                        - 0
                        - 0
                        - 0
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                      x_label: seconds
                      y_label: user-minutes
                    end: 1627312606
                    events: []
                    impact:
                      num_aps: 2
                      num_users: 21
                      total_aps: 3
                      total_users: 26
                    sle:
                      interval: 3600
                      name: capacity
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 16.65
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 5.8
                        - 102.5
                        - 139.18333
                        - 17.616667
                        - 22.5
                        - 201.9
                        - 574.0333
                        - 183.18333
                        - 13.266666
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                        value:
                        - 0.6764934
                        - 0.6783766
                        - 0.641645
                        - 0.6934629
                        - 0.68676674
                        - 0.6834809
                        - 0.6961604
                        - 0.6979584
                        - 0.7033722
                        - 0.70410794
                        - 0.7025278
                        - 0.70305353
                        - 0.70292175
                        - 0.7009334
                        - 0.69344264
                        - 0.68596864
                        - 0.5952168
                        - 0.62183666
                        - 0.68161446
                        - 0.65352744
                        - 0.6183489
                        - 0.54178274
                        - 0.6044712
                        - 0.66845906
                      x_label: seconds
                      y_label: '%'
                    start: 1627226206
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    classifiers:
                    - impact:
                        num_aps: 1
                        num_users: 4
                        total_aps: 3
                        total_users: 26
                      interval: 3600
                      name: client-count
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 5.8
                        - 0
                        - 0
                        - 0
                        - 4.65
                        - 0
                        - 7.55
                        - 47.55
                        - 13.266666
                        duration:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 5.8
                        - 0
                        - 0
                        - 0
                        - 4.65
                        - 0
                        - 7.55
                        - 47.55
                        - 13.266666
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                      x_label: seconds
                      y_label: user-minutes
                    - impact:
                        num_aps: 2
                        num_users: 17
                        total_aps: 3
                        total_users: 26
                      interval: 3600
                      name: wifi-interference
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 102.5
                        - 108.03333
                        - 0
                        - 0
                        - 201.9
                        - 566.48334
                        - 135.63333
                        - 0
                        duration:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 102.5
                        - 108.03333
                        - 0
                        - 0
                        - 201.9
                        - 566.48334
                        - 135.63333
                        - 0
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                      x_label: seconds
                      y_label: user-minutes
                    - impact:
                        num_aps: 0
                        num_users: 0
                        total_aps: 3
                        total_users: 26
                      interval: 3600
                      name: client_usage
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        duration:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                      x_label: seconds
                      y_label: user-minutes
                    - impact:
                        num_aps: 1
                        num_users: 17
                        total_aps: 3
                        total_users: 26
                      interval: 3600
                      name: non-wifi-interference
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 16.65
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 31.15
                        - 17.616667
                        - 17.85
                        - 0
                        - 0
                        - 0
                        - 0
                        duration:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 16.65
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 31.15
                        - 17.616667
                        - 17.85
                        - 0
                        - 0
                        - 0
                        - 0
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                      x_label: seconds
                      y_label: user-minutes
                    end: 1627312606
                    events: []
                    impact:
                      num_aps: 2
                      num_users: 21
                      total_aps: 3
                      total_users: 26
                    sle:
                      interval: 3600
                      name: capacity
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 16.65
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 5.8
                        - 102.5
                        - 139.18333
                        - 17.616667
                        - 22.5
                        - 201.9
                        - 574.0333
                        - 183.18333
                        - 13.266666
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                        value:
                        - 0.6764934
                        - 0.6783766
                        - 0.641645
                        - 0.6934629
                        - 0.68676674
                        - 0.6834809
                        - 0.6961604
                        - 0.6979584
                        - 0.7033722
                        - 0.70410794
                        - 0.7025278
                        - 0.70305353
                        - 0.70292175
                        - 0.7009334
                        - 0.69344264
                        - 0.68596864
                        - 0.5952168
                        - 0.62183666
                        - 0.68161446
                        - 0.65352744
                        - 0.6183489
                        - 0.54178274
                        - 0.6044712
                        - 0.66845906
                      x_label: seconds
                      y_label: '%'
                    start: 1627226206
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sle_summary'
                - description: Deprecated SLE summary response for a metric window
                  examples:
                  - classifiers:
                    - impact:
                        num_aps: 1
                        num_users: 4
                        total_aps: 3
                        total_users: 26
                      interval: 3600
                      name: client-count
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 5.8
                        - 0
                        - 0
                        - 0
                        - 4.65
                        - 0
                        - 7.55
                        - 47.55
                        - 13.266666
                        duration:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 5.8
                        - 0
                        - 0
                        - 0
                        - 4.65
                        - 0
                        - 7.55
                        - 47.55
                        - 13.266666
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                      x_label: seconds
                      y_label: user-minutes
                    - impact:
                        num_aps: 2
                        num_users: 17
                        total_aps: 3
                        total_users: 26
                      interval: 3600
                      name: wifi-interference
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 102.5
                        - 108.03333
                        - 0
                        - 0
                        - 201.9
                        - 566.48334
                        - 135.63333
                        - 0
                        duration:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 102.5
                        - 108.03333
                        - 0
                        - 0
                        - 201.9
                        - 566.48334
                        - 135.63333
                        - 0
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                      x_label: seconds
                      y_label: user-minutes
                    - impact:
                        num_aps: 0
                        num_users: 0
                        total_aps: 3
                        total_users: 26
                      interval: 3600
                      name: client_usage
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        duration:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                      x_label: seconds
                      y_label: user-minutes
                    - impact:
                        num_aps: 1
                        num_users: 17
                        total_aps: 3
                        total_users: 26
                      interval: 3600
                      name: non-wifi-interference
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 16.65
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 31.15
                        - 17.616667
                        - 17.85
                        - 0
                        - 0
                        - 0
                        - 0
                        duration:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 16.65
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 31.15
                        - 17.616667
                        - 17.85
                        - 0
                        - 0
                        - 0
                        - 0
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                      x_label: seconds
                      y_label: user-minutes
                    end: 1627312606
                    events: []
                    impact:
                      num_aps: 2
                      num_users: 21
                      total_aps: 3
                      total_users: 26
                    sle:
                      interval: 3600
                      name: capacity
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 16.65
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 5.8
                        - 102.5
                        - 139.18333
                        - 17.616667
                        - 22.5
                        - 201.9
                        - 574.0333
                        - 183.18333
                        - 13.266666
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                        value:
                        - 0.6764934
                        - 0.6783766
                        - 0.641645
                        - 0.6934629
                        - 0.68676674
                        - 0.6834809
                        - 0.6961604
                        - 0.6979584
                        - 0.7033722
                        - 0.70410794
                        - 0.7025278
                        - 0.70305353
                        - 0.70292175
                        - 0.7009334
                        - 0.69344264
                        - 0.68596864
                        - 0.5952168
                        - 0.62183666
                        - 0.68161446
                        - 0.65352744
                        - 0.6183489
                        - 0.54178274
                        - 0.6044712
                        - 0.66845906
                      x_label: seconds
                      y_label: '%'
                    start: 1627226206
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    classifiers:
                    - impact:
                        num_aps: 1
                        num_users: 4
                        total_aps: 3
                        total_users: 26
                      interval: 3600
                      name: client-count
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 5.8
                        - 0
                        - 0
                        - 0
                        - 4.65
                        - 0
                        - 7.55
                        - 47.55
                        - 13.266666
                        duration:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 5.8
                        - 0
                        - 0
                        - 0
                        - 4.65
                        - 0
                        - 7.55
                        - 47.55
                        - 13.266666
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                      x_label: seconds
                      y_label: user-minutes
                    - impact:
                        num_aps: 2
                        num_users: 17
                        total_aps: 3
                        total_users: 26
                      interval: 3600
                      name: wifi-interference
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 102.5
                        - 108.03333
                        - 0
                        - 0
                        - 201.9
                        - 566.48334
                        - 135.63333
                        - 0
                        duration:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 102.5
                        - 108.03333
                        - 0
                        - 0
                        - 201.9
                        - 566.48334
                        - 135.63333
                        - 0
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                      x_label: seconds
                      y_label: user-minutes
                    - impact:
                        num_aps: 0
                        num_users: 0
                        total_aps: 3
                        total_users: 26
                      interval: 3600
                      name: client_usage
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        duration:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                      x_label: seconds
                      y_label: user-minutes
                    - impact:
                        num_aps: 1
                        num_users: 17
                        total_aps: 3
                        total_users: 26
                      interval: 3600
                      name: non-wifi-interference
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 16.65
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 31.15
                        - 17.616667
                        - 17.85
                        - 0
                        - 0
                        - 0
                        - 0
                        duration:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 16.65
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 31.15
                        - 17.616667
                        - 17.85
                        - 0
                        - 0
                        - 0
                        - 0
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                      x_label: seconds
                      y_label: user-minutes
                    end: 1627312606
                    events: []
                    impact:
                      num_aps: 2
                      num_users: 21
                      total_aps: 3
                      total_users: 26
                    sle:
                      interval: 3600
                      name: capacity
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 16.65
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 5.8
                        - 102.5
                        - 139.18333
                        - 17.616667
                        - 22.5
                        - 201.9
                        - 574.0333
                        - 183.18333
                        - 13.266666
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                        value:
                        - 0.6764934
                        - 0.6783766
                        - 0.641645
                        - 0.6934629
                        - 0.68676674
                        - 0.6834809
                        - 0.6961604
                        - 0.6979584
                        - 0.7033722
                        - 0.70410794
                        - 0.7025278
                        - 0.70305353
                        - 0.70292175
                        - 0.7009334
                        - 0.69344264
                        - 0.68596864
                        - 0.5952168
                        - 0.62183666
                        - 0.68161446
                        - 0.65352744
                        - 0.6183489
                        - 0.54178274
                        - 0.6044712
                        - 0.66845906
                      x_label: seconds
                      y_label: '%'
                    start: 1627226206
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: true
    parameters: []
  /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/summary-trend:
    get:
      tags:
      - Sites SLEs
      summary: getSiteSleSummaryTrend
      description: Get the summary for the SLE metric trend
      operationId: getSiteSleSummaryTrend
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: scope
        in: path
        description: ''
        required: true
        schema:
          $ref: '#/components/schemas/site_sle_metric_summary_scope_parameters'
      - name: scope_id
        in: path
        description: >-
          * site_id if `scope`==`site`

          * device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`

          * mac if `scope`==`client`
        required: true
        schema:
          type: string
      - name: metric
        in: path
        description: Values from `listSiteSlesMetrics`
        required: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sle_summary_trend'
                - description: Time-series SLE summary trend response
                  examples:
                  - classifiers:
                    - interval: 3600
                      name: client-count
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 5.8
                        - 0
                        - 0
                        - 0
                        - 4.65
                        - 0
                        - 7.55
                        - 47.55
                        - 13.266666
                        duration:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 5.8
                        - 0
                        - 0
                        - 0
                        - 4.65
                        - 0
                        - 7.55
                        - 47.55
                        - 13.266666
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                      x_label: seconds
                      y_label: user-minutes
                    - interval: 3600
                      name: wifi-interference
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 102.5
                        - 108.03333
                        - 0
                        - 0
                        - 201.9
                        - 566.48334
                        - 135.63333
                        - 0
                        duration:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 102.5
                        - 108.03333
                        - 0
                        - 0
                        - 201.9
                        - 566.48334
                        - 135.63333
                        - 0
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                      x_label: seconds
                      y_label: user-minutes
                    - interval: 3600
                      name: client_usage
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        duration:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                      x_label: seconds
                      y_label: user-minutes
                    - interval: 3600
                      name: non-wifi-interference
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 16.65
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 31.15
                        - 17.616667
                        - 17.85
                        - 0
                        - 0
                        - 0
                        - 0
                        duration:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 16.65
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 31.15
                        - 17.616667
                        - 17.85
                        - 0
                        - 0
                        - 0
                        - 0
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                      x_label: seconds
                      y_label: user-minutes
                    end: 1627312606
                    sle:
                      interval: 3600
                      name: capacity
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 16.65
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 5.8
                        - 102.5
                        - 139.18333
                        - 17.616667
                        - 22.5
                        - 201.9
                        - 574.0333
                        - 183.18333
                        - 13.266666
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                        value:
                        - 0.6764934
                        - 0.6783766
                        - 0.641645
                        - 0.6934629
                        - 0.68676674
                        - 0.6834809
                        - 0.6961604
                        - 0.6979584
                        - 0.7033722
                        - 0.70410794
                        - 0.7025278
                        - 0.70305353
                        - 0.70292175
                        - 0.7009334
                        - 0.69344264
                        - 0.68596864
                        - 0.5952168
                        - 0.62183666
                        - 0.68161446
                        - 0.65352744
                        - 0.6183489
                        - 0.54178274
                        - 0.6044712
                        - 0.66845906
                      x_label: seconds
                      y_label: '%'
                    start: 1627226206
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    classifiers:
                    - interval: 3600
                      name: client-count
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 5.8
                        - 0
                        - 0
                        - 0
                        - 4.65
                        - 0
                        - 7.55
                        - 47.55
                        - 13.266666
                        duration:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 5.8
                        - 0
                        - 0
                        - 0
                        - 4.65
                        - 0
                        - 7.55
                        - 47.55
                        - 13.266666
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                      x_label: seconds
                      y_label: user-minutes
                    - interval: 3600
                      name: wifi-interference
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 102.5
                        - 108.03333
                        - 0
                        - 0
                        - 201.9
                        - 566.48334
                        - 135.63333
                        - 0
                        duration:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 102.5
                        - 108.03333
                        - 0
                        - 0
                        - 201.9
                        - 566.48334
                        - 135.63333
                        - 0
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                      x_label: seconds
                      y_label: user-minutes
                    - interval: 3600
                      name: client_usage
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        duration:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                      x_label: seconds
                      y_label: user-minutes
                    - interval: 3600
                      name: non-wifi-interference
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 16.65
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 31.15
                        - 17.616667
                        - 17.85
                        - 0
                        - 0
                        - 0
                        - 0
                        duration:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 16.65
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 31.15
                        - 17.616667
                        - 17.85
                        - 0
                        - 0
                        - 0
                        - 0
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                      x_label: seconds
                      y_label: user-minutes
                    end: 1627312606
                    sle:
                      interval: 3600
                      name: capacity
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 16.65
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 5.8
                        - 102.5
                        - 139.18333
                        - 17.616667
                        - 22.5
                        - 201.9
                        - 574.0333
                        - 183.18333
                        - 13.266666
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                        value:
                        - 0.6764934
                        - 0.6783766
                        - 0.641645
                        - 0.6934629
                        - 0.68676674
                        - 0.6834809
                        - 0.6961604
                        - 0.6979584
                        - 0.7033722
                        - 0.70410794
                        - 0.7025278
                        - 0.70305353
                        - 0.70292175
                        - 0.7009334
                        - 0.69344264
                        - 0.68596864
                        - 0.5952168
                        - 0.62183666
                        - 0.68161446
                        - 0.65352744
                        - 0.6183489
                        - 0.54178274
                        - 0.6044712
                        - 0.66845906
                      x_label: seconds
                      y_label: '%'
                    start: 1627226206
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sle_summary_trend'
                - description: Time-series SLE summary trend response
                  examples:
                  - classifiers:
                    - interval: 3600
                      name: client-count
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 5.8
                        - 0
                        - 0
                        - 0
                        - 4.65
                        - 0
                        - 7.55
                        - 47.55
                        - 13.266666
                        duration:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 5.8
                        - 0
                        - 0
                        - 0
                        - 4.65
                        - 0
                        - 7.55
                        - 47.55
                        - 13.266666
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                      x_label: seconds
                      y_label: user-minutes
                    - interval: 3600
                      name: wifi-interference
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 102.5
                        - 108.03333
                        - 0
                        - 0
                        - 201.9
                        - 566.48334
                        - 135.63333
                        - 0
                        duration:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 102.5
                        - 108.03333
                        - 0
                        - 0
                        - 201.9
                        - 566.48334
                        - 135.63333
                        - 0
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                      x_label: seconds
                      y_label: user-minutes
                    - interval: 3600
                      name: client_usage
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        duration:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                      x_label: seconds
                      y_label: user-minutes
                    - interval: 3600
                      name: non-wifi-interference
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 16.65
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 31.15
                        - 17.616667
                        - 17.85
                        - 0
                        - 0
                        - 0
                        - 0
                        duration:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 16.65
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 31.15
                        - 17.616667
                        - 17.85
                        - 0
                        - 0
                        - 0
                        - 0
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                      x_label: seconds
                      y_label: user-minutes
                    end: 1627312606
                    sle:
                      interval: 3600
                      name: capacity
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 16.65
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 5.8
                        - 102.5
                        - 139.18333
                        - 17.616667
                        - 22.5
                        - 201.9
                        - 574.0333
                        - 183.18333
                        - 13.266666
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                        value:
                        - 0.6764934
                        - 0.6783766
                        - 0.641645
                        - 0.6934629
                        - 0.68676674
                        - 0.6834809
                        - 0.6961604
                        - 0.6979584
                        - 0.7033722
                        - 0.70410794
                        - 0.7025278
                        - 0.70305353
                        - 0.70292175
                        - 0.7009334
                        - 0.69344264
                        - 0.68596864
                        - 0.5952168
                        - 0.62183666
                        - 0.68161446
                        - 0.65352744
                        - 0.6183489
                        - 0.54178274
                        - 0.6044712
                        - 0.66845906
                      x_label: seconds
                      y_label: '%'
                    start: 1627226206
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    classifiers:
                    - interval: 3600
                      name: client-count
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 5.8
                        - 0
                        - 0
                        - 0
                        - 4.65
                        - 0
                        - 7.55
                        - 47.55
                        - 13.266666
                        duration:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 5.8
                        - 0
                        - 0
                        - 0
                        - 4.65
                        - 0
                        - 7.55
                        - 47.55
                        - 13.266666
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                      x_label: seconds
                      y_label: user-minutes
                    - interval: 3600
                      name: wifi-interference
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 102.5
                        - 108.03333
                        - 0
                        - 0
                        - 201.9
                        - 566.48334
                        - 135.63333
                        - 0
                        duration:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 102.5
                        - 108.03333
                        - 0
                        - 0
                        - 201.9
                        - 566.48334
                        - 135.63333
                        - 0
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                      x_label: seconds
                      y_label: user-minutes
                    - interval: 3600
                      name: client_usage
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        duration:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                      x_label: seconds
                      y_label: user-minutes
                    - interval: 3600
                      name: non-wifi-interference
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 16.65
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 31.15
                        - 17.616667
                        - 17.85
                        - 0
                        - 0
                        - 0
                        - 0
                        duration:
                        - 0
                        - 0
                        - 0
                        - 0
                        - 16.65
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 31.15
                        - 17.616667
                        - 17.85
                        - 0
                        - 0
                        - 0
                        - 0
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                      x_label: seconds
                      y_label: user-minutes
                    end: 1627312606
                    sle:
                      interval: 3600
                      name: capacity
                      samples:
                        degraded:
                        - 0
                        - 0
                        - 210.03334
                        - 3.1333334
                        - 16.65
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 0
                        - 5.8
                        - 102.5
                        - 139.18333
                        - 17.616667
                        - 22.5
                        - 201.9
                        - 574.0333
                        - 183.18333
                        - 13.266666
                        total:
                        - 1302.3
                        - 1289.0167
                        - 1396.3167
                        - 1423.6666
                        - 1439.2167
                        - 1414.7
                        - 1361.0834
                        - 1371.5834
                        - 1372.0667
                        - 1339.1
                        - 1374.3667
                        - 1369.9
                        - 1352.4833
                        - 1382.8
                        - 1426.7167
                        - 1425.6333
                        - 1403.9333
                        - 1420.75
                        - 1416.8334
                        - 1437.3334
                        - 1425.1
                        - 1485.3667
                        - 1426.4333
                        - 289.83334
                        value:
                        - 0.6764934
                        - 0.6783766
                        - 0.641645
                        - 0.6934629
                        - 0.68676674
                        - 0.6834809
                        - 0.6961604
                        - 0.6979584
                        - 0.7033722
                        - 0.70410794
                        - 0.7025278
                        - 0.70305353
                        - 0.70292175
                        - 0.7009334
                        - 0.69344264
                        - 0.68596864
                        - 0.5952168
                        - 0.62183666
                        - 0.68161446
                        - 0.65352744
                        - 0.6183489
                        - 0.54178274
                        - 0.6044712
                        - 0.66845906
                      x_label: seconds
                      y_label: '%'
                    start: 1627226206
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/threshold:
    get:
      tags:
      - Sites SLEs
      summary: getSiteSleThreshold
      description: Get the SLE threshold
      operationId: getSiteSleThreshold
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: scope
        in: path
        description: ''
        required: true
        schema:
          $ref: '#/components/schemas/site_sle_threshold_scope_parameter'
      - name: scope_id
        in: path
        description: >-
          * site_id if `scope`==`site`

          * device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`

          * mac if `scope`==`client`
        required: true
        schema:
          type: string
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: metric
        in: path
        description: Values from `listSiteSlesMetrics`
        required: true
        schema:
          type: string
          examples:
          - asymmetry-uplink
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sle_threshold'
                - description: Threshold metadata and configured value for an SLE metric
                  examples:
                  - default: -72
                    direction: left
                    maximum: -60
                    metric: coverage
                    minimum: -90
                    threshold: '-66'
                    units: dBm
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    default: -72
                    direction: left
                    maximum: -60
                    metric: coverage
                    minimum: -90
                    threshold: '-66'
                    units: dBm
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sle_threshold'
                - description: Threshold metadata and configured value for an SLE metric
                  examples:
                  - default: -72
                    direction: left
                    maximum: -60
                    metric: coverage
                    minimum: -90
                    threshold: '-66'
                    units: dBm
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    default: -72
                    direction: left
                    maximum: -60
                    metric: coverage
                    minimum: -90
                    threshold: '-66'
                    units: dBm
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites SLEs
      summary: replaceSiteSleThreshold
      description: Replace the SLE threshold
      operationId: replaceSiteSleThreshold
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: scope
        in: path
        description: ''
        required: true
        schema:
          $ref: '#/components/schemas/site_sle_threshold_scope_parameter'
      - name: scope_id
        in: path
        description: >-
          * site_id if `scope`==`site`

          * device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`

          * mac if `scope`==`client`
        required: true
        schema:
          type: string
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: metric
        in: path
        description: Values from `listSiteSlesMetrics`
        required: true
        schema:
          type: string
          examples:
          - asymmetry-uplink
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/sle_threshold'
              - examples:
                - maximum: -60
                  minimum: -90
              contentMediaType: application/json
            examples:
              Example:
                value:
                  maximum: -60
                  minimum: -90
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sle_threshold'
                - description: Threshold metadata and configured value for an SLE metric
                  examples:
                  - default: -72
                    direction: left
                    maximum: -60
                    metric: coverage
                    minimum: -90
                    threshold: '-66'
                    units: dBm
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    default: -72
                    direction: left
                    maximum: -60
                    metric: coverage
                    minimum: -90
                    threshold: '-66'
                    units: dBm
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sle_threshold'
                - description: Threshold metadata and configured value for an SLE metric
                  examples:
                  - default: -72
                    direction: left
                    maximum: -60
                    metric: coverage
                    minimum: -90
                    threshold: '-66'
                    units: dBm
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    default: -72
                    direction: left
                    maximum: -60
                    metric: coverage
                    minimum: -90
                    threshold: '-66'
                    units: dBm
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Sites SLEs
      summary: updateSiteSleThreshold
      description: Update the SLE threshold
      operationId: updateSiteSleThreshold
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: scope
        in: path
        description: ''
        required: true
        schema:
          $ref: '#/components/schemas/site_sle_threshold_scope_parameter'
      - name: scope_id
        in: path
        description: >-
          * site_id if `scope`==`site`

          * device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`

          * mac if `scope`==`client`
        required: true
        schema:
          type: string
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: metric
        in: path
        description: Values from `listSiteSlesMetrics`
        required: true
        schema:
          type: string
          examples:
          - asymmetry-uplink
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/sle_threshold'
              - examples:
                - maximum: -60
                  minimum: -90
              contentMediaType: application/json
            examples:
              Example:
                value:
                  maximum: -60
                  minimum: -90
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sle_threshold'
                - description: Threshold metadata and configured value for an SLE metric
                  examples:
                  - default: -72
                    direction: left
                    maximum: -60
                    metric: coverage
                    minimum: -90
                    threshold: '-66'
                    units: dBm
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    default: -72
                    direction: left
                    maximum: -60
                    metric: coverage
                    minimum: -90
                    threshold: '-66'
                    units: dBm
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sle_threshold'
                - description: Threshold metadata and configured value for an SLE metric
                  examples:
                  - default: -72
                    direction: left
                    maximum: -60
                    metric: coverage
                    minimum: -90
                    threshold: '-66'
                    units: dBm
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    default: -72
                    direction: left
                    maximum: -60
                    metric: coverage
                    minimum: -90
                    threshold: '-66'
                    units: dBm
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metrics:
    get:
      tags:
      - Sites SLEs
      summary: listSiteSlesMetrics
      description: List the metrics for the given scope
      operationId: listSiteSlesMetrics
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: scope
        in: path
        description: ''
        required: true
        schema:
          $ref: '#/components/schemas/site_sle_metrics_scope_parameters'
      - name: scope_id
        in: path
        description: >-
          * site_id if `scope`==`site`

          * device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`

          * mac if `scope`==`client`
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/site_sle_metrics'
                - description: SLE metrics available for a site
                  examples:
                  - enabled:
                    - coverage
                    - capacity
                    - time-to-connect
                    - failed-to-connect
                    - roaming
                    - roaming-v2
                    - throughput
                    - switch_health
                    - switch_throughput
                    - switch_stc
                    - gateway-health
                    - application_health
                    - wan-link-health
                    - ap-availability
                    supported:
                    - coverage
                    - capacity
                    - time-to-connect
                    - failed-to-connect
                    - roaming
                    - roaming-v2
                    - location_jitter
                    - location_latency
                    - throughput
                    - location_dropped-requests
                    - switch_health
                    - switch_throughput
                    - switch_stc
                    - gateway-health
                    - application_health
                    - wan-link-health
                    - ap-availability
                    - location_sdk-connect-time
                    - location_ble-hung
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    enabled:
                    - coverage
                    - capacity
                    - time-to-connect
                    - failed-to-connect
                    - roaming
                    - roaming-v2
                    - throughput
                    - switch_health
                    - switch_throughput
                    - switch_stc
                    - gateway-health
                    - application_health
                    - wan-link-health
                    - ap-availability
                    supported:
                    - coverage
                    - capacity
                    - time-to-connect
                    - failed-to-connect
                    - roaming
                    - roaming-v2
                    - location_jitter
                    - location_latency
                    - throughput
                    - location_dropped-requests
                    - switch_health
                    - switch_throughput
                    - switch_stc
                    - gateway-health
                    - application_health
                    - wan-link-health
                    - ap-availability
                    - location_sdk-connect-time
                    - location_ble-hung
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/site_sle_metrics'
                - description: SLE metrics available for a site
                  examples:
                  - enabled:
                    - coverage
                    - capacity
                    - time-to-connect
                    - failed-to-connect
                    - roaming
                    - roaming-v2
                    - throughput
                    - switch_health
                    - switch_throughput
                    - switch_stc
                    - gateway-health
                    - application_health
                    - wan-link-health
                    - ap-availability
                    supported:
                    - coverage
                    - capacity
                    - time-to-connect
                    - failed-to-connect
                    - roaming
                    - roaming-v2
                    - location_jitter
                    - location_latency
                    - throughput
                    - location_dropped-requests
                    - switch_health
                    - switch_throughput
                    - switch_stc
                    - gateway-health
                    - application_health
                    - wan-link-health
                    - ap-availability
                    - location_sdk-connect-time
                    - location_ble-hung
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    enabled:
                    - coverage
                    - capacity
                    - time-to-connect
                    - failed-to-connect
                    - roaming
                    - roaming-v2
                    - throughput
                    - switch_health
                    - switch_throughput
                    - switch_stc
                    - gateway-health
                    - application_health
                    - wan-link-health
                    - ap-availability
                    supported:
                    - coverage
                    - capacity
                    - time-to-connect
                    - failed-to-connect
                    - roaming
                    - roaming-v2
                    - location_jitter
                    - location_latency
                    - throughput
                    - location_dropped-requests
                    - switch_health
                    - switch_throughput
                    - switch_stc
                    - gateway-health
                    - application_health
                    - wan-link-health
                    - ap-availability
                    - location_sdk-connect-time
                    - location_ble-hung
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/check_radius_server:
    post:
      tags:
      - Sites Synthetic Tests
      summary: startSiteSwitchRadiusSyntheticTest
      description: "Ping test from the AP to confirm 'reachability' of the RADIUS server. \n\nUtilize Juniper EX switch(to which an AP is connected to) radius test capabilities to get details on the RADIUS Server 'availability'.\n\n\n\n#### Subscribe to Device Command outputs\n\n`WS /api-ws/v1/stream`\n\n\n```json\n{\n    \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n\n#### Example output from ws stream\n\n```json\n{\n  \"event\": \"data\",\n  \"channel\": \"/sites/d6fb4f96-3ba4-4cf5-8af2-a8d7b85087ac/devices/00000000-0000-0000-1000-2093390b3580/cmd\",\n  \"data\": \"{\\\"event\\\": \\\"data\\\", \\\"channel\\\": \\\"/sites/d6fb4f96-3ba4-4cf5-8af2-a8d7b85087ac/devices/2093390b3580/cmd\\\", \\\"data\\\": {\\\"session\\\": \\\"6043daff-884e-48bc-aa9a-810d268aceb1\\\", \\\"raw\\\": \\\"    Reason : fail\\\"}}\"\n}\n{\n  \"event\": \"data\",\n  \"channel\": \"/sites/d6fb4f96-3ba4-4cf5-8af2-a8d7b85087ac/devices/00000000-0000-0000-1000-2093390b3580/cmd\",\n  \"data\": \"{\\\"event\\\": \\\"data\\\", \\\"channel\\\": \\\"/sites/d6fb4f96-3ba4-4cf5-8af2-a8d7b85087ac/devices/2093390b3580/cmd\\\", \\\"data\\\": {\\\"session\\\": \\\"6043daff-884e-48bc-aa9a-810d268aceb1\\\", \\\"raw\\\": \\\"    Test complete. Exiting\\\"}}\"\n}\n```"
      operationId: startSiteSwitchRadiusSyntheticTest
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/synthetictest_radius_server'
              - examples:
                - password: string
                  profile: dot1x
                  user: string
              contentMediaType: application/json
            examples:
              Example:
                value:
                  password: string
                  profile: dot1x
                  user: string
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/synthetic_test:
    get:
      tags:
      - Sites Synthetic Tests
      summary: getSiteDeviceSyntheticTest
      description: Get Device Synthetic Test
      operationId: getSiteDeviceSyntheticTest
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Synthetic Test Status
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/synthetictest_info'
                - description: Synthetic test status or result record
                  examples:
                  - device_type: gateway
                    mac: 5c5b35584a6f
                    port_id: ge-0/0/1.100
                    start_time: 1675718807
                    status: inprogress
                    type: speedtest
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    device_type: gateway
                    mac: 5c5b35584a6f
                    port_id: ge-0/0/1.100
                    start_time: 1675718807
                    status: inprogress
                    type: speedtest
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/synthetictest_info'
                - description: Synthetic test status or result record
                  examples:
                  - device_type: gateway
                    mac: 5c5b35584a6f
                    port_id: ge-0/0/1.100
                    start_time: 1675718807
                    status: inprogress
                    type: speedtest
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    device_type: gateway
                    mac: 5c5b35584a6f
                    port_id: ge-0/0/1.100
                    start_time: 1675718807
                    status: inprogress
                    type: speedtest
        '400':
          description: Device not online / Device not supported / Already in progress
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites Synthetic Tests
      summary: triggerSiteDeviceSyntheticTest
      description: Trigger Device Synthetic Test
      operationId: triggerSiteDeviceSyntheticTest
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/synthetictest_device'
        required: false
      responses:
        '200':
          description: Scheduled
          headers: {}
          content: {}
        '400':
          description: Device not online / Device not supported / Already in progress
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/synthetic_test:
    post:
      tags:
      - Sites Synthetic Tests
      summary: triggerSiteSyntheticTest
      description: Trigger Synthetic Testing
      operationId: triggerSiteSyntheticTest
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/synthetictest'
              - examples:
                - email: test@mist.com
              contentMediaType: application/json
            examples:
              Example:
                value:
                  email: test@mist.com
        required: false
      responses:
        '200':
          description: Synthetic Test Started
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_synthetictest'
                - description: Result returned after a site synthetic test is queued
                  examples:
                  - id: a42775f6-edc8-69b5-f979-542fa1b43ff9
                    message: Successfully queued synthetic test for the site.
                    status: string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    id: a42775f6-edc8-69b5-f979-542fa1b43ff9
                    message: Successfully queued synthetic test for the site.
                    status: string
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_synthetictest'
                - description: Result returned after a site synthetic test is queued
                  examples:
                  - id: a42775f6-edc8-69b5-f979-542fa1b43ff9
                    message: Successfully queued synthetic test for the site.
                    status: string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    id: a42775f6-edc8-69b5-f979-542fa1b43ff9
                    message: Successfully queued synthetic test for the site.
                    status: string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/synthetic_test/search:
    get:
      tags:
      - Sites Synthetic Tests
      summary: searchSiteSyntheticTest
      description: Search Site Synthetic Testing
      operationId: searchSiteSyntheticTest
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b350e0410
      - name: port_id
        in: query
        description: Filter results by port identifier
        style: form
        explode: true
        schema:
          type: string
          examples:
          - ge-1/0/1
      - name: vlan_id
        in: query
        description: Filter results by VLAN ID
        style: form
        explode: true
        schema:
          type: string
          examples:
          - '100'
      - name: by
        in: query
        description: Entity who triggers the test
        style: form
        explode: true
        schema:
          type: string
          examples:
          - user
      - name: reason
        in: query
        description: Filter results by reason
        style: form
        explode: true
        schema:
          type: string
          examples:
          - test failed
      - name: type
        in: query
        description: 'Synthetic test type used to filter results. enum: `arp`, `curl`, `dhcp`, `dhcp6`, `dns`, `lan_connectivity`, `radius`, `speedtest`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/synthetictest_type'
          - description: 'Synthetic test type used to filter results. enum: `arp`, `curl`, `dhcp`, `dhcp6`, `dns`, `lan_connectivity`, `radius`, `speedtest`'
      - name: protocol
        in: query
        description: 'Connectivity protocol used to filter synthetic test results. enum: `ping`, `traceroute`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/synthetictest_protocol'
          - description: 'Connectivity protocol used to filter synthetic test results. enum: `ping`, `traceroute`'
      - name: tenant
        in: query
        description: Filter results by tenant network
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Synthetic Test Search Result
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_synthetictest_search'
                - description: Paginated response for site synthetic test search results
                  examples:
                  - end: 0
                    limit: 0
                    next: string
                    results:
                    - by: user
                      device_type: gateway
                      failed: false
                      latency: 40
                      mac: aff827549235
                      port_id: ge-0/0/2
                      rx_mbps: 322
                      timestamp: 1706824045.059036
                      tx_mbps: 199
                      type: speedtest
                      vlan_id: 20
                    - by: marvis
                      device_type: gateway
                      failed: true
                      latency: 0
                      mac: 8396cd006c8c
                      port_id: ge-0/0/2
                      reason: interface not ready to perform test
                      rx_mbps: 0
                      timestamp: 1706824045.059036
                      tx_mbps: 0
                      type: speedtest
                      vlan_id: 100
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 0
                    limit: 0
                    next: string
                    results:
                    - by: user
                      device_type: gateway
                      failed: false
                      latency: 40
                      mac: aff827549235
                      port_id: ge-0/0/2
                      rx_mbps: 322
                      timestamp: 1706824045.059036
                      tx_mbps: 199
                      type: speedtest
                      vlan_id: 20
                    - by: marvis
                      device_type: gateway
                      failed: true
                      latency: 0
                      mac: 8396cd006c8c
                      port_id: ge-0/0/2
                      reason: interface not ready to perform test
                      rx_mbps: 0
                      timestamp: 1706824045.059036
                      tx_mbps: 0
                      type: speedtest
                      vlan_id: 100
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_synthetictest_search'
                - description: Paginated response for site synthetic test search results
                  examples:
                  - end: 0
                    limit: 0
                    next: string
                    results:
                    - by: user
                      device_type: gateway
                      failed: false
                      latency: 40
                      mac: aff827549235
                      port_id: ge-0/0/2
                      rx_mbps: 322
                      timestamp: 1706824045.059036
                      tx_mbps: 199
                      type: speedtest
                      vlan_id: 20
                    - by: marvis
                      device_type: gateway
                      failed: true
                      latency: 0
                      mac: 8396cd006c8c
                      port_id: ge-0/0/2
                      reason: interface not ready to perform test
                      rx_mbps: 0
                      timestamp: 1706824045.059036
                      tx_mbps: 0
                      type: speedtest
                      vlan_id: 100
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 0
                    limit: 0
                    next: string
                    results:
                    - by: user
                      device_type: gateway
                      failed: false
                      latency: 40
                      mac: aff827549235
                      port_id: ge-0/0/2
                      rx_mbps: 322
                      timestamp: 1706824045.059036
                      tx_mbps: 199
                      type: speedtest
                      vlan_id: 20
                    - by: marvis
                      device_type: gateway
                      failed: true
                      latency: 0
                      mac: 8396cd006c8c
                      port_id: ge-0/0/2
                      reason: interface not ready to perform test
                      rx_mbps: 0
                      timestamp: 1706824045.059036
                      tx_mbps: 0
                      type: speedtest
                      vlan_id: 100
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/uisettings:
    get:
      tags:
      - Sites UI Settings
      summary: listSiteUiSettings
      description: List the Site UI settings/databoard
      operationId: listSiteUiSettings
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: List of Site UI Setting
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ui_settings'
                description: Site UI settings records returned by a list response
                examples:
                - - created_time: 1508823803
                    defaultScopeId: 67970e46-4e12-11e6-9188-0242ad112847
                    defaultScopeType: site
                    defaultTimeRange:
                      end: 1508828400
                      endDate: 10/23/2017
                      interval: 1d
                      name: This Week
                      shortName: thisWeek
                      start: 1508655600
                      usePreset: true
                    description: Description of the databoard
                    for_site: true
                    id: 3bdcc7e8-c04d-4512-b4fc-093da9057eb0
                    isCustomDataboard: true
                    isScopeLinked: true
                    isTimeRangeLinked: true
                    modified_time: 0
                    name: New Databoard
                    org_id: cc079380-5029-4d4a-9125-858de85731ff
                    purpose: databoard
                    site_id: 67970e46-4e12-11e6-9188-0242ad112847
                    tiles:
                    - chartBand: 2.4 ghz
                      chartColor: '#00B4AD'
                      chartDirection: tx + rx
                      chartRankBy: string
                      chartType: timeSeries
                      colspan: 5
                      column: 1
                      hideEmptyRows: true
                      id: 7a9ab38c-cfc3-483d-b51a-0aec571fadc0
                      metric:
                        apiName: client_dhcp_latency
                      name: New Analysis
                      row: 1
                      rowspan: 2
                      scopeId: e0c767834b4c
                      scopeType: client
                      timeRange:
                        end: 1508823743
                        endDate: 10/23/2017
                        interval: 1d
                        name: Past 7 Days
                        shortName: 7d
                        start: 1508223600
                        usePreset: true
                      trendType: line
                      vizType: averageTimeSeriesChart
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 1508823803
                    defaultScopeId: 67970e46-4e12-11e6-9188-0242ad112847
                    defaultScopeType: site
                    defaultTimeRange:
                      end: 1508828400
                      endDate: 10/23/2017
                      interval: 1d
                      name: This Week
                      shortName: thisWeek
                      start: 1508655600
                      usePreset: true
                    description: Description of the databoard
                    for_site: true
                    id: 3bdcc7e8-c04d-4512-b4fc-093da9057eb0
                    isCustomDataboard: true
                    isScopeLinked: true
                    isTimeRangeLinked: true
                    modified_time: 0
                    name: New Databoard
                    org_id: cc079380-5029-4d4a-9125-858de85731ff
                    purpose: databoard
                    site_id: 67970e46-4e12-11e6-9188-0242ad112847
                    tiles:
                    - chartBand: 2.4 ghz
                      chartColor: '#00B4AD'
                      chartDirection: tx + rx
                      chartRankBy: string
                      chartType: timeSeries
                      colspan: 5
                      column: 1
                      hideEmptyRows: true
                      id: 7a9ab38c-cfc3-483d-b51a-0aec571fadc0
                      metric:
                        apiName: client_dhcp_latency
                      name: New Analysis
                      row: 1
                      rowspan: 2
                      scopeId: e0c767834b4c
                      scopeType: client
                      timeRange:
                        end: 1508823743
                        endDate: 10/23/2017
                        interval: 1d
                        name: Past 7 Days
                        shortName: 7d
                        start: 1508223600
                        usePreset: true
                      trendType: line
                      vizType: averageTimeSeriesChart
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ui_settings'
                description: Site UI settings records returned by a list response
                examples:
                - - created_time: 1508823803
                    defaultScopeId: 67970e46-4e12-11e6-9188-0242ad112847
                    defaultScopeType: site
                    defaultTimeRange:
                      end: 1508828400
                      endDate: 10/23/2017
                      interval: 1d
                      name: This Week
                      shortName: thisWeek
                      start: 1508655600
                      usePreset: true
                    description: Description of the databoard
                    for_site: true
                    id: 3bdcc7e8-c04d-4512-b4fc-093da9057eb0
                    isCustomDataboard: true
                    isScopeLinked: true
                    isTimeRangeLinked: true
                    modified_time: 0
                    name: New Databoard
                    org_id: cc079380-5029-4d4a-9125-858de85731ff
                    purpose: databoard
                    site_id: 67970e46-4e12-11e6-9188-0242ad112847
                    tiles:
                    - chartBand: 2.4 ghz
                      chartColor: '#00B4AD'
                      chartDirection: tx + rx
                      chartRankBy: string
                      chartType: timeSeries
                      colspan: 5
                      column: 1
                      hideEmptyRows: true
                      id: 7a9ab38c-cfc3-483d-b51a-0aec571fadc0
                      metric:
                        apiName: client_dhcp_latency
                      name: New Analysis
                      row: 1
                      rowspan: 2
                      scopeId: e0c767834b4c
                      scopeType: client
                      timeRange:
                        end: 1508823743
                        endDate: 10/23/2017
                        interval: 1d
                        name: Past 7 Days
                        shortName: 7d
                        start: 1508223600
                        usePreset: true
                      trendType: line
                      vizType: averageTimeSeriesChart
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 1508823803
                    defaultScopeId: 67970e46-4e12-11e6-9188-0242ad112847
                    defaultScopeType: site
                    defaultTimeRange:
                      end: 1508828400
                      endDate: 10/23/2017
                      interval: 1d
                      name: This Week
                      shortName: thisWeek
                      start: 1508655600
                      usePreset: true
                    description: Description of the databoard
                    for_site: true
                    id: 3bdcc7e8-c04d-4512-b4fc-093da9057eb0
                    isCustomDataboard: true
                    isScopeLinked: true
                    isTimeRangeLinked: true
                    modified_time: 0
                    name: New Databoard
                    org_id: cc079380-5029-4d4a-9125-858de85731ff
                    purpose: databoard
                    site_id: 67970e46-4e12-11e6-9188-0242ad112847
                    tiles:
                    - chartBand: 2.4 ghz
                      chartColor: '#00B4AD'
                      chartDirection: tx + rx
                      chartRankBy: string
                      chartType: timeSeries
                      colspan: 5
                      column: 1
                      hideEmptyRows: true
                      id: 7a9ab38c-cfc3-483d-b51a-0aec571fadc0
                      metric:
                        apiName: client_dhcp_latency
                      name: New Analysis
                      row: 1
                      rowspan: 2
                      scopeId: e0c767834b4c
                      scopeType: client
                      timeRange:
                        end: 1508823743
                        endDate: 10/23/2017
                        interval: 1d
                        name: Past 7 Days
                        shortName: 7d
                        start: 1508223600
                        usePreset: true
                      trendType: line
                      vizType: averageTimeSeriesChart
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites UI Settings
      summary: createSiteUiSettings
      description: Create a Site UI settings/databoard
      operationId: createSiteUiSettings
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ui_settings'
              - description: Request Body
                examples:
                - defaultScopeId: 67970e46-4e12-11e6-9188-0242ad112847
                  defaultScopeType: site
                  defaultTimeRange:
                    end: 1508828400
                    endDate: 10/23/2017
                    interval: 1d
                    name: This Week
                    shortName: thisWeek
                    start: 1508655600
                    usePreset: true
                  description: Description of the databoard
                  isCustomDataboard: true
                  isScopeLinked: true
                  isTimeRangeLinked: true
                  name: New Databoard
                  purpose: databoard
                  tiles:
                  - chartBand: 2.4 ghz
                    chartColor: '#00B4AD'
                    chartDirection: tx + rx
                    chartRankBy: string
                    chartType: timeSeries
                    colspan: 5
                    column: 1
                    hideEmptyRows: true
                    metric:
                      apiName: client_dhcp_latency
                    name: New Analysis
                    row: 1
                    rowspan: 2
                    scopeId: e0c767834b4c
                    scopeType: client
                    timeRange:
                      end: 1508823743
                      endDate: 10/23/2017
                      interval: 1d
                      name: Past 7 Days
                      shortName: 7d
                      start: 1508223600
                      usePreset: true
                    trendType: line
                    vizType: averageTimeSeriesChart
              contentMediaType: application/json
            examples:
              Example:
                value:
                  defaultScopeId: 67970e46-4e12-11e6-9188-0242ad112847
                  defaultScopeType: site
                  defaultTimeRange:
                    end: 1508828400
                    endDate: 10/23/2017
                    interval: 1d
                    name: This Week
                    shortName: thisWeek
                    start: 1508655600
                    usePreset: true
                  description: Description of the databoard
                  isCustomDataboard: true
                  isScopeLinked: true
                  isTimeRangeLinked: true
                  name: New Databoard
                  purpose: databoard
                  tiles:
                  - chartBand: 2.4 ghz
                    chartColor: '#00B4AD'
                    chartDirection: tx + rx
                    chartRankBy: string
                    chartType: timeSeries
                    colspan: 5
                    column: 1
                    hideEmptyRows: true
                    metric:
                      apiName: client_dhcp_latency
                    name: New Analysis
                    row: 1
                    rowspan: 2
                    scopeId: e0c767834b4c
                    scopeType: client
                    timeRange:
                      end: 1508823743
                      endDate: 10/23/2017
                      interval: 1d
                      name: Past 7 Days
                      shortName: 7d
                      start: 1508223600
                      usePreset: true
                    trendType: line
                    vizType: averageTimeSeriesChart
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ui_settings'
                - description: Site UI settings databoard
                  examples:
                  - created_time: 1508823803
                    defaultScopeId: 67970e46-4e12-11e6-9188-0242ad112847
                    defaultScopeType: site
                    defaultTimeRange:
                      end: 1508828400
                      endDate: 10/23/2017
                      interval: 1d
                      name: This Week
                      shortName: thisWeek
                      start: 1508655600
                      usePreset: true
                    description: Description of the databoard
                    for_site: true
                    id: 3bdcc7e8-c04d-4512-b4fc-093da9057eb0
                    isCustomDataboard: true
                    isScopeLinked: true
                    isTimeRangeLinked: true
                    modified_time: 0
                    name: New Databoard
                    org_id: cc079380-5029-4d4a-9125-858de85731ff
                    purpose: databoard
                    site_id: 67970e46-4e12-11e6-9188-0242ad112847
                    tiles:
                    - chartBand: 2.4 ghz
                      chartColor: '#00B4AD'
                      chartDirection: tx + rx
                      chartRankBy: string
                      chartType: timeSeries
                      colspan: 5
                      column: 1
                      hideEmptyRows: true
                      id: 7a9ab38c-cfc3-483d-b51a-0aec571fadc0
                      metric:
                        apiName: client_dhcp_latency
                      name: New Analysis
                      row: 1
                      rowspan: 2
                      scopeId: e0c767834b4c
                      scopeType: client
                      timeRange:
                        end: 1508823743
                        endDate: 10/23/2017
                        interval: 1d
                        name: Past 7 Days
                        shortName: 7d
                        start: 1508223600
                        usePreset: true
                      trendType: line
                      vizType: averageTimeSeriesChart
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 1508823803
                    defaultScopeId: 67970e46-4e12-11e6-9188-0242ad112847
                    defaultScopeType: site
                    defaultTimeRange:
                      end: 1508828400
                      endDate: 10/23/2017
                      interval: 1d
                      name: This Week
                      shortName: thisWeek
                      start: 1508655600
                      usePreset: true
                    description: Description of the databoard
                    for_site: true
                    id: 3bdcc7e8-c04d-4512-b4fc-093da9057eb0
                    isCustomDataboard: true
                    isScopeLinked: true
                    isTimeRangeLinked: true
                    modified_time: 0
                    name: New Databoard
                    org_id: cc079380-5029-4d4a-9125-858de85731ff
                    purpose: databoard
                    site_id: 67970e46-4e12-11e6-9188-0242ad112847
                    tiles:
                    - chartBand: 2.4 ghz
                      chartColor: '#00B4AD'
                      chartDirection: tx + rx
                      chartRankBy: string
                      chartType: timeSeries
                      colspan: 5
                      column: 1
                      hideEmptyRows: true
                      id: 7a9ab38c-cfc3-483d-b51a-0aec571fadc0
                      metric:
                        apiName: client_dhcp_latency
                      name: New Analysis
                      row: 1
                      rowspan: 2
                      scopeId: e0c767834b4c
                      scopeType: client
                      timeRange:
                        end: 1508823743
                        endDate: 10/23/2017
                        interval: 1d
                        name: Past 7 Days
                        shortName: 7d
                        start: 1508223600
                        usePreset: true
                      trendType: line
                      vizType: averageTimeSeriesChart
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ui_settings'
                - description: Site UI settings databoard
                  examples:
                  - created_time: 1508823803
                    defaultScopeId: 67970e46-4e12-11e6-9188-0242ad112847
                    defaultScopeType: site
                    defaultTimeRange:
                      end: 1508828400
                      endDate: 10/23/2017
                      interval: 1d
                      name: This Week
                      shortName: thisWeek
                      start: 1508655600
                      usePreset: true
                    description: Description of the databoard
                    for_site: true
                    id: 3bdcc7e8-c04d-4512-b4fc-093da9057eb0
                    isCustomDataboard: true
                    isScopeLinked: true
                    isTimeRangeLinked: true
                    modified_time: 0
                    name: New Databoard
                    org_id: cc079380-5029-4d4a-9125-858de85731ff
                    purpose: databoard
                    site_id: 67970e46-4e12-11e6-9188-0242ad112847
                    tiles:
                    - chartBand: 2.4 ghz
                      chartColor: '#00B4AD'
                      chartDirection: tx + rx
                      chartRankBy: string
                      chartType: timeSeries
                      colspan: 5
                      column: 1
                      hideEmptyRows: true
                      id: 7a9ab38c-cfc3-483d-b51a-0aec571fadc0
                      metric:
                        apiName: client_dhcp_latency
                      name: New Analysis
                      row: 1
                      rowspan: 2
                      scopeId: e0c767834b4c
                      scopeType: client
                      timeRange:
                        end: 1508823743
                        endDate: 10/23/2017
                        interval: 1d
                        name: Past 7 Days
                        shortName: 7d
                        start: 1508223600
                        usePreset: true
                      trendType: line
                      vizType: averageTimeSeriesChart
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 1508823803
                    defaultScopeId: 67970e46-4e12-11e6-9188-0242ad112847
                    defaultScopeType: site
                    defaultTimeRange:
                      end: 1508828400
                      endDate: 10/23/2017
                      interval: 1d
                      name: This Week
                      shortName: thisWeek
                      start: 1508655600
                      usePreset: true
                    description: Description of the databoard
                    for_site: true
                    id: 3bdcc7e8-c04d-4512-b4fc-093da9057eb0
                    isCustomDataboard: true
                    isScopeLinked: true
                    isTimeRangeLinked: true
                    modified_time: 0
                    name: New Databoard
                    org_id: cc079380-5029-4d4a-9125-858de85731ff
                    purpose: databoard
                    site_id: 67970e46-4e12-11e6-9188-0242ad112847
                    tiles:
                    - chartBand: 2.4 ghz
                      chartColor: '#00B4AD'
                      chartDirection: tx + rx
                      chartRankBy: string
                      chartType: timeSeries
                      colspan: 5
                      column: 1
                      hideEmptyRows: true
                      id: 7a9ab38c-cfc3-483d-b51a-0aec571fadc0
                      metric:
                        apiName: client_dhcp_latency
                      name: New Analysis
                      row: 1
                      rowspan: 2
                      scopeId: e0c767834b4c
                      scopeType: client
                      timeRange:
                        end: 1508823743
                        endDate: 10/23/2017
                        interval: 1d
                        name: Past 7 Days
                        shortName: 7d
                        start: 1508223600
                        usePreset: true
                      trendType: line
                      vizType: averageTimeSeriesChart
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/uisettings/derived:
    get:
      tags:
      - Sites UI Settings
      summary: listSiteUiSettingDerived
      description: Get both site UI settings(for_site=true) and org UI settings (for_site=false)
      operationId: listSiteUiSettingDerived
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ui_settings'
                - description: Site UI settings databoard
                  examples:
                  - created_time: 1508823803
                    defaultScopeId: 67970e46-4e12-11e6-9188-0242ad112847
                    defaultScopeType: site
                    defaultTimeRange:
                      end: 1508828400
                      endDate: 10/23/2017
                      interval: 1d
                      name: This Week
                      shortName: thisWeek
                      start: 1508655600
                      usePreset: true
                    description: Description of the databoard
                    for_site: true
                    id: 3bdcc7e8-c04d-4512-b4fc-093da9057eb0
                    isCustomDataboard: true
                    isScopeLinked: true
                    isTimeRangeLinked: true
                    modified_time: 0
                    name: New Databoard
                    org_id: cc079380-5029-4d4a-9125-858de85731ff
                    purpose: databoard
                    site_id: 67970e46-4e12-11e6-9188-0242ad112847
                    tiles:
                    - chartBand: 2.4 ghz
                      chartColor: '#00B4AD'
                      chartDirection: tx + rx
                      chartRankBy: string
                      chartType: timeSeries
                      colspan: 5
                      column: 1
                      hideEmptyRows: true
                      id: 7a9ab38c-cfc3-483d-b51a-0aec571fadc0
                      metric:
                        apiName: client_dhcp_latency
                      name: New Analysis
                      row: 1
                      rowspan: 2
                      scopeId: e0c767834b4c
                      scopeType: client
                      timeRange:
                        end: 1508823743
                        endDate: 10/23/2017
                        interval: 1d
                        name: Past 7 Days
                        shortName: 7d
                        start: 1508223600
                        usePreset: true
                      trendType: line
                      vizType: averageTimeSeriesChart
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 1508823803
                    defaultScopeId: 67970e46-4e12-11e6-9188-0242ad112847
                    defaultScopeType: site
                    defaultTimeRange:
                      end: 1508828400
                      endDate: 10/23/2017
                      interval: 1d
                      name: This Week
                      shortName: thisWeek
                      start: 1508655600
                      usePreset: true
                    description: Description of the databoard
                    for_site: true
                    id: 3bdcc7e8-c04d-4512-b4fc-093da9057eb0
                    isCustomDataboard: true
                    isScopeLinked: true
                    isTimeRangeLinked: true
                    modified_time: 0
                    name: New Databoard
                    org_id: cc079380-5029-4d4a-9125-858de85731ff
                    purpose: databoard
                    site_id: 67970e46-4e12-11e6-9188-0242ad112847
                    tiles:
                    - chartBand: 2.4 ghz
                      chartColor: '#00B4AD'
                      chartDirection: tx + rx
                      chartRankBy: string
                      chartType: timeSeries
                      colspan: 5
                      column: 1
                      hideEmptyRows: true
                      id: 7a9ab38c-cfc3-483d-b51a-0aec571fadc0
                      metric:
                        apiName: client_dhcp_latency
                      name: New Analysis
                      row: 1
                      rowspan: 2
                      scopeId: e0c767834b4c
                      scopeType: client
                      timeRange:
                        end: 1508823743
                        endDate: 10/23/2017
                        interval: 1d
                        name: Past 7 Days
                        shortName: 7d
                        start: 1508223600
                        usePreset: true
                      trendType: line
                      vizType: averageTimeSeriesChart
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ui_settings'
                - description: Site UI settings databoard
                  examples:
                  - created_time: 1508823803
                    defaultScopeId: 67970e46-4e12-11e6-9188-0242ad112847
                    defaultScopeType: site
                    defaultTimeRange:
                      end: 1508828400
                      endDate: 10/23/2017
                      interval: 1d
                      name: This Week
                      shortName: thisWeek
                      start: 1508655600
                      usePreset: true
                    description: Description of the databoard
                    for_site: true
                    id: 3bdcc7e8-c04d-4512-b4fc-093da9057eb0
                    isCustomDataboard: true
                    isScopeLinked: true
                    isTimeRangeLinked: true
                    modified_time: 0
                    name: New Databoard
                    org_id: cc079380-5029-4d4a-9125-858de85731ff
                    purpose: databoard
                    site_id: 67970e46-4e12-11e6-9188-0242ad112847
                    tiles:
                    - chartBand: 2.4 ghz
                      chartColor: '#00B4AD'
                      chartDirection: tx + rx
                      chartRankBy: string
                      chartType: timeSeries
                      colspan: 5
                      column: 1
                      hideEmptyRows: true
                      id: 7a9ab38c-cfc3-483d-b51a-0aec571fadc0
                      metric:
                        apiName: client_dhcp_latency
                      name: New Analysis
                      row: 1
                      rowspan: 2
                      scopeId: e0c767834b4c
                      scopeType: client
                      timeRange:
                        end: 1508823743
                        endDate: 10/23/2017
                        interval: 1d
                        name: Past 7 Days
                        shortName: 7d
                        start: 1508223600
                        usePreset: true
                      trendType: line
                      vizType: averageTimeSeriesChart
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 1508823803
                    defaultScopeId: 67970e46-4e12-11e6-9188-0242ad112847
                    defaultScopeType: site
                    defaultTimeRange:
                      end: 1508828400
                      endDate: 10/23/2017
                      interval: 1d
                      name: This Week
                      shortName: thisWeek
                      start: 1508655600
                      usePreset: true
                    description: Description of the databoard
                    for_site: true
                    id: 3bdcc7e8-c04d-4512-b4fc-093da9057eb0
                    isCustomDataboard: true
                    isScopeLinked: true
                    isTimeRangeLinked: true
                    modified_time: 0
                    name: New Databoard
                    org_id: cc079380-5029-4d4a-9125-858de85731ff
                    purpose: databoard
                    site_id: 67970e46-4e12-11e6-9188-0242ad112847
                    tiles:
                    - chartBand: 2.4 ghz
                      chartColor: '#00B4AD'
                      chartDirection: tx + rx
                      chartRankBy: string
                      chartType: timeSeries
                      colspan: 5
                      column: 1
                      hideEmptyRows: true
                      id: 7a9ab38c-cfc3-483d-b51a-0aec571fadc0
                      metric:
                        apiName: client_dhcp_latency
                      name: New Analysis
                      row: 1
                      rowspan: 2
                      scopeId: e0c767834b4c
                      scopeType: client
                      timeRange:
                        end: 1508823743
                        endDate: 10/23/2017
                        interval: 1d
                        name: Past 7 Days
                        shortName: 7d
                        start: 1508223600
                        usePreset: true
                      trendType: line
                      vizType: averageTimeSeriesChart
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/uisettings/{uisetting_id}:
    delete:
      tags:
      - Sites UI Settings
      summary: deleteSiteUiSetting
      description: Site UI settings
      operationId: deleteSiteUiSetting
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: uisetting_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Sites UI Settings
      summary: getSiteUiSetting
      description: Site UI settings
      operationId: getSiteUiSetting
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: uisetting_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ui_settings'
                - description: Site UI settings databoard
                  examples:
                  - created_time: 1508823803
                    defaultScopeId: 67970e46-4e12-11e6-9188-0242ad112847
                    defaultScopeType: site
                    defaultTimeRange:
                      end: 1508828400
                      endDate: 10/23/2017
                      interval: 1d
                      name: This Week
                      shortName: thisWeek
                      start: 1508655600
                      usePreset: true
                    description: Description of the databoard
                    for_site: true
                    id: 3bdcc7e8-c04d-4512-b4fc-093da9057eb0
                    isCustomDataboard: true
                    isScopeLinked: true
                    isTimeRangeLinked: true
                    modified_time: 0
                    name: New Databoard
                    org_id: cc079380-5029-4d4a-9125-858de85731ff
                    purpose: databoard
                    site_id: 67970e46-4e12-11e6-9188-0242ad112847
                    tiles:
                    - chartBand: 2.4 ghz
                      chartColor: '#00B4AD'
                      chartDirection: tx + rx
                      chartRankBy: string
                      chartType: timeSeries
                      colspan: 5
                      column: 1
                      hideEmptyRows: true
                      id: 7a9ab38c-cfc3-483d-b51a-0aec571fadc0
                      metric:
                        apiName: client_dhcp_latency
                      name: New Analysis
                      row: 1
                      rowspan: 2
                      scopeId: e0c767834b4c
                      scopeType: client
                      timeRange:
                        end: 1508823743
                        endDate: 10/23/2017
                        interval: 1d
                        name: Past 7 Days
                        shortName: 7d
                        start: 1508223600
                        usePreset: true
                      trendType: line
                      vizType: averageTimeSeriesChart
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 1508823803
                    defaultScopeId: 67970e46-4e12-11e6-9188-0242ad112847
                    defaultScopeType: site
                    defaultTimeRange:
                      end: 1508828400
                      endDate: 10/23/2017
                      interval: 1d
                      name: This Week
                      shortName: thisWeek
                      start: 1508655600
                      usePreset: true
                    description: Description of the databoard
                    for_site: true
                    id: 3bdcc7e8-c04d-4512-b4fc-093da9057eb0
                    isCustomDataboard: true
                    isScopeLinked: true
                    isTimeRangeLinked: true
                    modified_time: 0
                    name: New Databoard
                    org_id: cc079380-5029-4d4a-9125-858de85731ff
                    purpose: databoard
                    site_id: 67970e46-4e12-11e6-9188-0242ad112847
                    tiles:
                    - chartBand: 2.4 ghz
                      chartColor: '#00B4AD'
                      chartDirection: tx + rx
                      chartRankBy: string
                      chartType: timeSeries
                      colspan: 5
                      column: 1
                      hideEmptyRows: true
                      id: 7a9ab38c-cfc3-483d-b51a-0aec571fadc0
                      metric:
                        apiName: client_dhcp_latency
                      name: New Analysis
                      row: 1
                      rowspan: 2
                      scopeId: e0c767834b4c
                      scopeType: client
                      timeRange:
                        end: 1508823743
                        endDate: 10/23/2017
                        interval: 1d
                        name: Past 7 Days
                        shortName: 7d
                        start: 1508223600
                        usePreset: true
                      trendType: line
                      vizType: averageTimeSeriesChart
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ui_settings'
                - description: Site UI settings databoard
                  examples:
                  - created_time: 1508823803
                    defaultScopeId: 67970e46-4e12-11e6-9188-0242ad112847
                    defaultScopeType: site
                    defaultTimeRange:
                      end: 1508828400
                      endDate: 10/23/2017
                      interval: 1d
                      name: This Week
                      shortName: thisWeek
                      start: 1508655600
                      usePreset: true
                    description: Description of the databoard
                    for_site: true
                    id: 3bdcc7e8-c04d-4512-b4fc-093da9057eb0
                    isCustomDataboard: true
                    isScopeLinked: true
                    isTimeRangeLinked: true
                    modified_time: 0
                    name: New Databoard
                    org_id: cc079380-5029-4d4a-9125-858de85731ff
                    purpose: databoard
                    site_id: 67970e46-4e12-11e6-9188-0242ad112847
                    tiles:
                    - chartBand: 2.4 ghz
                      chartColor: '#00B4AD'
                      chartDirection: tx + rx
                      chartRankBy: string
                      chartType: timeSeries
                      colspan: 5
                      column: 1
                      hideEmptyRows: true
                      id: 7a9ab38c-cfc3-483d-b51a-0aec571fadc0
                      metric:
                        apiName: client_dhcp_latency
                      name: New Analysis
                      row: 1
                      rowspan: 2
                      scopeId: e0c767834b4c
                      scopeType: client
                      timeRange:
                        end: 1508823743
                        endDate: 10/23/2017
                        interval: 1d
                        name: Past 7 Days
                        shortName: 7d
                        start: 1508223600
                        usePreset: true
                      trendType: line
                      vizType: averageTimeSeriesChart
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 1508823803
                    defaultScopeId: 67970e46-4e12-11e6-9188-0242ad112847
                    defaultScopeType: site
                    defaultTimeRange:
                      end: 1508828400
                      endDate: 10/23/2017
                      interval: 1d
                      name: This Week
                      shortName: thisWeek
                      start: 1508655600
                      usePreset: true
                    description: Description of the databoard
                    for_site: true
                    id: 3bdcc7e8-c04d-4512-b4fc-093da9057eb0
                    isCustomDataboard: true
                    isScopeLinked: true
                    isTimeRangeLinked: true
                    modified_time: 0
                    name: New Databoard
                    org_id: cc079380-5029-4d4a-9125-858de85731ff
                    purpose: databoard
                    site_id: 67970e46-4e12-11e6-9188-0242ad112847
                    tiles:
                    - chartBand: 2.4 ghz
                      chartColor: '#00B4AD'
                      chartDirection: tx + rx
                      chartRankBy: string
                      chartType: timeSeries
                      colspan: 5
                      column: 1
                      hideEmptyRows: true
                      id: 7a9ab38c-cfc3-483d-b51a-0aec571fadc0
                      metric:
                        apiName: client_dhcp_latency
                      name: New Analysis
                      row: 1
                      rowspan: 2
                      scopeId: e0c767834b4c
                      scopeType: client
                      timeRange:
                        end: 1508823743
                        endDate: 10/23/2017
                        interval: 1d
                        name: Past 7 Days
                        shortName: 7d
                        start: 1508223600
                        usePreset: true
                      trendType: line
                      vizType: averageTimeSeriesChart
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites UI Settings
      summary: updateSiteUiSetting
      description: Site UI settings
      operationId: updateSiteUiSetting
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: uisetting_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ui_settings'
              - description: Request Body
                examples:
                - defaultScopeId: 67970e46-4e12-11e6-9188-0242ad112847
                  defaultScopeType: site
                  defaultTimeRange:
                    end: 1508828400
                    endDate: 10/23/2017
                    interval: 1d
                    name: This Week
                    shortName: thisWeek
                    start: 1508655600
                    usePreset: true
                  description: Description of the databoard
                  isCustomDataboard: true
                  isScopeLinked: true
                  isTimeRangeLinked: true
                  name: New Databoard
                  purpose: databoard
                  tiles:
                  - chartBand: 2.4 ghz
                    chartColor: '#00B4AD'
                    chartDirection: tx + rx
                    chartRankBy: string
                    chartType: timeSeries
                    colspan: 5
                    column: 1
                    hideEmptyRows: true
                    metric:
                      apiName: client_dhcp_latency
                    name: New Analysis
                    row: 1
                    rowspan: 2
                    scopeId: e0c767834b4c
                    scopeType: client
                    timeRange:
                      end: 1508823743
                      endDate: 10/23/2017
                      interval: 1d
                      name: Past 7 Days
                      shortName: 7d
                      start: 1508223600
                      usePreset: true
                    trendType: line
                    vizType: averageTimeSeriesChart
              contentMediaType: application/json
            examples:
              Example:
                value:
                  defaultScopeId: 67970e46-4e12-11e6-9188-0242ad112847
                  defaultScopeType: site
                  defaultTimeRange:
                    end: 1508828400
                    endDate: 10/23/2017
                    interval: 1d
                    name: This Week
                    shortName: thisWeek
                    start: 1508655600
                    usePreset: true
                  description: Description of the databoard
                  isCustomDataboard: true
                  isScopeLinked: true
                  isTimeRangeLinked: true
                  name: New Databoard
                  purpose: databoard
                  tiles:
                  - chartBand: 2.4 ghz
                    chartColor: '#00B4AD'
                    chartDirection: tx + rx
                    chartRankBy: string
                    chartType: timeSeries
                    colspan: 5
                    column: 1
                    hideEmptyRows: true
                    metric:
                      apiName: client_dhcp_latency
                    name: New Analysis
                    row: 1
                    rowspan: 2
                    scopeId: e0c767834b4c
                    scopeType: client
                    timeRange:
                      end: 1508823743
                      endDate: 10/23/2017
                      interval: 1d
                      name: Past 7 Days
                      shortName: 7d
                      start: 1508223600
                      usePreset: true
                    trendType: line
                    vizType: averageTimeSeriesChart
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ui_settings'
                - description: Site UI settings databoard
                  examples:
                  - created_time: 1508823803
                    defaultScopeId: 67970e46-4e12-11e6-9188-0242ad112847
                    defaultScopeType: site
                    defaultTimeRange:
                      end: 1508828400
                      endDate: 10/23/2017
                      interval: 1d
                      name: This Week
                      shortName: thisWeek
                      start: 1508655600
                      usePreset: true
                    description: Description of the databoard
                    for_site: true
                    id: 3bdcc7e8-c04d-4512-b4fc-093da9057eb0
                    isCustomDataboard: true
                    isScopeLinked: true
                    isTimeRangeLinked: true
                    modified_time: 0
                    name: New Databoard
                    org_id: cc079380-5029-4d4a-9125-858de85731ff
                    purpose: databoard
                    site_id: 67970e46-4e12-11e6-9188-0242ad112847
                    tiles:
                    - chartBand: 2.4 ghz
                      chartColor: '#00B4AD'
                      chartDirection: tx + rx
                      chartRankBy: string
                      chartType: timeSeries
                      colspan: 5
                      column: 1
                      hideEmptyRows: true
                      id: 7a9ab38c-cfc3-483d-b51a-0aec571fadc0
                      metric:
                        apiName: client_dhcp_latency
                      name: New Analysis
                      row: 1
                      rowspan: 2
                      scopeId: e0c767834b4c
                      scopeType: client
                      timeRange:
                        end: 1508823743
                        endDate: 10/23/2017
                        interval: 1d
                        name: Past 7 Days
                        shortName: 7d
                        start: 1508223600
                        usePreset: true
                      trendType: line
                      vizType: averageTimeSeriesChart
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 1508823803
                    defaultScopeId: 67970e46-4e12-11e6-9188-0242ad112847
                    defaultScopeType: site
                    defaultTimeRange:
                      end: 1508828400
                      endDate: 10/23/2017
                      interval: 1d
                      name: This Week
                      shortName: thisWeek
                      start: 1508655600
                      usePreset: true
                    description: Description of the databoard
                    for_site: true
                    id: 3bdcc7e8-c04d-4512-b4fc-093da9057eb0
                    isCustomDataboard: true
                    isScopeLinked: true
                    isTimeRangeLinked: true
                    modified_time: 0
                    name: New Databoard
                    org_id: cc079380-5029-4d4a-9125-858de85731ff
                    purpose: databoard
                    site_id: 67970e46-4e12-11e6-9188-0242ad112847
                    tiles:
                    - chartBand: 2.4 ghz
                      chartColor: '#00B4AD'
                      chartDirection: tx + rx
                      chartRankBy: string
                      chartType: timeSeries
                      colspan: 5
                      column: 1
                      hideEmptyRows: true
                      id: 7a9ab38c-cfc3-483d-b51a-0aec571fadc0
                      metric:
                        apiName: client_dhcp_latency
                      name: New Analysis
                      row: 1
                      rowspan: 2
                      scopeId: e0c767834b4c
                      scopeType: client
                      timeRange:
                        end: 1508823743
                        endDate: 10/23/2017
                        interval: 1d
                        name: Past 7 Days
                        shortName: 7d
                        start: 1508223600
                        usePreset: true
                      trendType: line
                      vizType: averageTimeSeriesChart
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ui_settings'
                - description: Site UI settings databoard
                  examples:
                  - created_time: 1508823803
                    defaultScopeId: 67970e46-4e12-11e6-9188-0242ad112847
                    defaultScopeType: site
                    defaultTimeRange:
                      end: 1508828400
                      endDate: 10/23/2017
                      interval: 1d
                      name: This Week
                      shortName: thisWeek
                      start: 1508655600
                      usePreset: true
                    description: Description of the databoard
                    for_site: true
                    id: 3bdcc7e8-c04d-4512-b4fc-093da9057eb0
                    isCustomDataboard: true
                    isScopeLinked: true
                    isTimeRangeLinked: true
                    modified_time: 0
                    name: New Databoard
                    org_id: cc079380-5029-4d4a-9125-858de85731ff
                    purpose: databoard
                    site_id: 67970e46-4e12-11e6-9188-0242ad112847
                    tiles:
                    - chartBand: 2.4 ghz
                      chartColor: '#00B4AD'
                      chartDirection: tx + rx
                      chartRankBy: string
                      chartType: timeSeries
                      colspan: 5
                      column: 1
                      hideEmptyRows: true
                      id: 7a9ab38c-cfc3-483d-b51a-0aec571fadc0
                      metric:
                        apiName: client_dhcp_latency
                      name: New Analysis
                      row: 1
                      rowspan: 2
                      scopeId: e0c767834b4c
                      scopeType: client
                      timeRange:
                        end: 1508823743
                        endDate: 10/23/2017
                        interval: 1d
                        name: Past 7 Days
                        shortName: 7d
                        start: 1508223600
                        usePreset: true
                      trendType: line
                      vizType: averageTimeSeriesChart
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 1508823803
                    defaultScopeId: 67970e46-4e12-11e6-9188-0242ad112847
                    defaultScopeType: site
                    defaultTimeRange:
                      end: 1508828400
                      endDate: 10/23/2017
                      interval: 1d
                      name: This Week
                      shortName: thisWeek
                      start: 1508655600
                      usePreset: true
                    description: Description of the databoard
                    for_site: true
                    id: 3bdcc7e8-c04d-4512-b4fc-093da9057eb0
                    isCustomDataboard: true
                    isScopeLinked: true
                    isTimeRangeLinked: true
                    modified_time: 0
                    name: New Databoard
                    org_id: cc079380-5029-4d4a-9125-858de85731ff
                    purpose: databoard
                    site_id: 67970e46-4e12-11e6-9188-0242ad112847
                    tiles:
                    - chartBand: 2.4 ghz
                      chartColor: '#00B4AD'
                      chartDirection: tx + rx
                      chartRankBy: string
                      chartType: timeSeries
                      colspan: 5
                      column: 1
                      hideEmptyRows: true
                      id: 7a9ab38c-cfc3-483d-b51a-0aec571fadc0
                      metric:
                        apiName: client_dhcp_latency
                      name: New Analysis
                      row: 1
                      rowspan: 2
                      scopeId: e0c767834b4c
                      scopeType: client
                      timeRange:
                        end: 1508823743
                        endDate: 10/23/2017
                        interval: 1d
                        name: Past 7 Days
                        shortName: 7d
                        start: 1508223600
                        usePreset: true
                      trendType: line
                      vizType: averageTimeSeriesChart
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/uisettings:
    get:
      tags:
      - Orgs UI Settings
      summary: listOrgUiSettings
      description: List the Orgs UI settings/databoard
      operationId: listOrgUiSettings
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: List of Org UI Setting
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/org_ui_settings'
                description: List of organization UI databoards
                examples:
                - - created_time: 1749083436
                    description: AP related stats
                    for_site: false
                    id: 9a702097-0dd3-48af-909b-2be4ff94d139
                    isCustomDataboard: true
                    modified_time: 1749083436
                    name: AP Stats
                    org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                    purpose: marvisdashboard
                    site_id: 00000000-0000-0000-0000-000000000000
                    tiles:
                    - description: User typed tile descr
                      id: 3eef7c83-3d33-417a-a729-4772d4a1013a
                      isAutoTitle: true
                      name: List top 10 APs by bandwidth
                      nl_query: List top 10 APs by bandwidth
                      position:
                        col: 1
                        colSpan: 2
                        row: 1
                        rowSpan: 1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 1749083436
                    description: AP related stats
                    for_site: false
                    id: 9a702097-0dd3-48af-909b-2be4ff94d139
                    isCustomDataboard: true
                    modified_time: 1749083436
                    name: AP Stats
                    org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                    purpose: marvisdashboard
                    site_id: 00000000-0000-0000-0000-000000000000
                    tiles:
                    - description: User typed tile descr
                      id: 3eef7c83-3d33-417a-a729-4772d4a1013a
                      isAutoTitle: true
                      name: List top 10 APs by bandwidth
                      nl_query: List top 10 APs by bandwidth
                      position:
                        col: 1
                        colSpan: 2
                        row: 1
                        rowSpan: 1
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/org_ui_settings'
                description: List of organization UI databoards
                examples:
                - - created_time: 1749083436
                    description: AP related stats
                    for_site: false
                    id: 9a702097-0dd3-48af-909b-2be4ff94d139
                    isCustomDataboard: true
                    modified_time: 1749083436
                    name: AP Stats
                    org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                    purpose: marvisdashboard
                    site_id: 00000000-0000-0000-0000-000000000000
                    tiles:
                    - description: User typed tile descr
                      id: 3eef7c83-3d33-417a-a729-4772d4a1013a
                      isAutoTitle: true
                      name: List top 10 APs by bandwidth
                      nl_query: List top 10 APs by bandwidth
                      position:
                        col: 1
                        colSpan: 2
                        row: 1
                        rowSpan: 1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 1749083436
                    description: AP related stats
                    for_site: false
                    id: 9a702097-0dd3-48af-909b-2be4ff94d139
                    isCustomDataboard: true
                    modified_time: 1749083436
                    name: AP Stats
                    org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                    purpose: marvisdashboard
                    site_id: 00000000-0000-0000-0000-000000000000
                    tiles:
                    - description: User typed tile descr
                      id: 3eef7c83-3d33-417a-a729-4772d4a1013a
                      isAutoTitle: true
                      name: List top 10 APs by bandwidth
                      nl_query: List top 10 APs by bandwidth
                      position:
                        col: 1
                        colSpan: 2
                        row: 1
                        rowSpan: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs UI Settings
      summary: createOrgUiSettings
      description: Create an Org UI settings/databoard
      operationId: createOrgUiSettings
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/org_ui_settings'
              - description: Request Body
                examples:
                - description: AP related stats
                  isCustomDataboard: true
                  name: AP Stats
                  purpose: marvisdashboard
                  tiles:
                  - description: User typed tile descr
                    isAutoTitle: true
                    name: List top 10 APs by bandwidth
                    nl_query: List top 10 APs by bandwidth
                    position:
                      col: 1
                      colSpan: 2
                      row: 1
                      rowSpan: 1
              contentMediaType: application/json
            examples:
              Example:
                value:
                  description: AP related stats
                  isCustomDataboard: true
                  name: AP Stats
                  purpose: marvisdashboard
                  tiles:
                  - description: User typed tile descr
                    isAutoTitle: true
                    name: List top 10 APs by bandwidth
                    nl_query: List top 10 APs by bandwidth
                    position:
                      col: 1
                      colSpan: 2
                      row: 1
                      rowSpan: 1
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org_ui_settings'
                - description: Organization UI settings databoard
                  examples:
                  - created_time: 1749083436
                    description: AP related stats
                    for_site: false
                    id: 9a702097-0dd3-48af-909b-2be4ff94d139
                    isCustomDataboard: true
                    modified_time: 1749083436
                    name: AP Stats
                    org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                    purpose: marvisdashboard
                    site_id: 00000000-0000-0000-0000-000000000000
                    tiles:
                    - description: User typed tile descr
                      id: 3eef7c83-3d33-417a-a729-4772d4a1013a
                      isAutoTitle: true
                      name: List top 10 APs by bandwidth
                      nl_query: List top 10 APs by bandwidth
                      position:
                        col: 1
                        colSpan: 2
                        row: 1
                        rowSpan: 1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 1749083436
                    description: AP related stats
                    for_site: false
                    id: 9a702097-0dd3-48af-909b-2be4ff94d139
                    isCustomDataboard: true
                    modified_time: 1749083436
                    name: AP Stats
                    org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                    purpose: marvisdashboard
                    site_id: 00000000-0000-0000-0000-000000000000
                    tiles:
                    - description: User typed tile descr
                      id: 3eef7c83-3d33-417a-a729-4772d4a1013a
                      isAutoTitle: true
                      name: List top 10 APs by bandwidth
                      nl_query: List top 10 APs by bandwidth
                      position:
                        col: 1
                        colSpan: 2
                        row: 1
                        rowSpan: 1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org_ui_settings'
                - description: Organization UI settings databoard
                  examples:
                  - created_time: 1749083436
                    description: AP related stats
                    for_site: false
                    id: 9a702097-0dd3-48af-909b-2be4ff94d139
                    isCustomDataboard: true
                    modified_time: 1749083436
                    name: AP Stats
                    org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                    purpose: marvisdashboard
                    site_id: 00000000-0000-0000-0000-000000000000
                    tiles:
                    - description: User typed tile descr
                      id: 3eef7c83-3d33-417a-a729-4772d4a1013a
                      isAutoTitle: true
                      name: List top 10 APs by bandwidth
                      nl_query: List top 10 APs by bandwidth
                      position:
                        col: 1
                        colSpan: 2
                        row: 1
                        rowSpan: 1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 1749083436
                    description: AP related stats
                    for_site: false
                    id: 9a702097-0dd3-48af-909b-2be4ff94d139
                    isCustomDataboard: true
                    modified_time: 1749083436
                    name: AP Stats
                    org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                    purpose: marvisdashboard
                    site_id: 00000000-0000-0000-0000-000000000000
                    tiles:
                    - description: User typed tile descr
                      id: 3eef7c83-3d33-417a-a729-4772d4a1013a
                      isAutoTitle: true
                      name: List top 10 APs by bandwidth
                      nl_query: List top 10 APs by bandwidth
                      position:
                        col: 1
                        colSpan: 2
                        row: 1
                        rowSpan: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/uisettings/{uisetting_id}:
    delete:
      tags:
      - Orgs UI Settings
      summary: deleteOrgUiSetting
      description: Delete an Org UI settings
      operationId: deleteOrgUiSetting
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: uisetting_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Orgs UI Settings
      summary: getOrgUiSetting
      description: Get an Org UI settings/databoard
      operationId: getOrgUiSetting
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: uisetting_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org_ui_settings'
                - description: Organization UI settings databoard
                  examples:
                  - created_time: 1749083436
                    description: AP related stats
                    for_site: false
                    id: 9a702097-0dd3-48af-909b-2be4ff94d139
                    isCustomDataboard: true
                    modified_time: 1749083436
                    name: AP Stats
                    org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                    purpose: marvisdashboard
                    site_id: 00000000-0000-0000-0000-000000000000
                    tiles:
                    - description: User typed tile descr
                      id: 3eef7c83-3d33-417a-a729-4772d4a1013a
                      isAutoTitle: true
                      name: List top 10 APs by bandwidth
                      nl_query: List top 10 APs by bandwidth
                      position:
                        col: 1
                        colSpan: 2
                        row: 1
                        rowSpan: 1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 1749083436
                    description: AP related stats
                    for_site: false
                    id: 9a702097-0dd3-48af-909b-2be4ff94d139
                    isCustomDataboard: true
                    modified_time: 1749083436
                    name: AP Stats
                    org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                    purpose: marvisdashboard
                    site_id: 00000000-0000-0000-0000-000000000000
                    tiles:
                    - description: User typed tile descr
                      id: 3eef7c83-3d33-417a-a729-4772d4a1013a
                      isAutoTitle: true
                      name: List top 10 APs by bandwidth
                      nl_query: List top 10 APs by bandwidth
                      position:
                        col: 1
                        colSpan: 2
                        row: 1
                        rowSpan: 1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org_ui_settings'
                - description: Organization UI settings databoard
                  examples:
                  - created_time: 1749083436
                    description: AP related stats
                    for_site: false
                    id: 9a702097-0dd3-48af-909b-2be4ff94d139
                    isCustomDataboard: true
                    modified_time: 1749083436
                    name: AP Stats
                    org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                    purpose: marvisdashboard
                    site_id: 00000000-0000-0000-0000-000000000000
                    tiles:
                    - description: User typed tile descr
                      id: 3eef7c83-3d33-417a-a729-4772d4a1013a
                      isAutoTitle: true
                      name: List top 10 APs by bandwidth
                      nl_query: List top 10 APs by bandwidth
                      position:
                        col: 1
                        colSpan: 2
                        row: 1
                        rowSpan: 1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 1749083436
                    description: AP related stats
                    for_site: false
                    id: 9a702097-0dd3-48af-909b-2be4ff94d139
                    isCustomDataboard: true
                    modified_time: 1749083436
                    name: AP Stats
                    org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                    purpose: marvisdashboard
                    site_id: 00000000-0000-0000-0000-000000000000
                    tiles:
                    - description: User typed tile descr
                      id: 3eef7c83-3d33-417a-a729-4772d4a1013a
                      isAutoTitle: true
                      name: List top 10 APs by bandwidth
                      nl_query: List top 10 APs by bandwidth
                      position:
                        col: 1
                        colSpan: 2
                        row: 1
                        rowSpan: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Orgs UI Settings
      summary: updateOrgUiSetting
      description: Org UI settings/databoard
      operationId: updateOrgUiSetting
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: uisetting_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/org_ui_settings'
              - description: Request Body
                examples:
                - description: AP related stats
                  isCustomDataboard: true
                  name: AP Stats
                  purpose: marvisdashboard
                  tiles:
                  - description: User typed tile descr
                    isAutoTitle: true
                    name: List top 10 APs by bandwidth
                    nl_query: List top 10 APs by bandwidth
                    position:
                      col: 1
                      colSpan: 2
                      row: 1
                      rowSpan: 1
              contentMediaType: application/json
            examples:
              Example:
                value:
                  description: AP related stats
                  isCustomDataboard: true
                  name: AP Stats
                  purpose: marvisdashboard
                  tiles:
                  - description: User typed tile descr
                    isAutoTitle: true
                    name: List top 10 APs by bandwidth
                    nl_query: List top 10 APs by bandwidth
                    position:
                      col: 1
                      colSpan: 2
                      row: 1
                      rowSpan: 1
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org_ui_settings'
                - description: Organization UI settings databoard
                  examples:
                  - created_time: 1749083436
                    description: AP related stats
                    for_site: false
                    id: 9a702097-0dd3-48af-909b-2be4ff94d139
                    isCustomDataboard: true
                    modified_time: 1749083436
                    name: AP Stats
                    org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                    purpose: marvisdashboard
                    site_id: 00000000-0000-0000-0000-000000000000
                    tiles:
                    - description: User typed tile descr
                      id: 3eef7c83-3d33-417a-a729-4772d4a1013a
                      isAutoTitle: true
                      name: List top 10 APs by bandwidth
                      nl_query: List top 10 APs by bandwidth
                      position:
                        col: 1
                        colSpan: 2
                        row: 1
                        rowSpan: 1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 1749083436
                    description: AP related stats
                    for_site: false
                    id: 9a702097-0dd3-48af-909b-2be4ff94d139
                    isCustomDataboard: true
                    modified_time: 1749083436
                    name: AP Stats
                    org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                    purpose: marvisdashboard
                    site_id: 00000000-0000-0000-0000-000000000000
                    tiles:
                    - description: User typed tile descr
                      id: 3eef7c83-3d33-417a-a729-4772d4a1013a
                      isAutoTitle: true
                      name: List top 10 APs by bandwidth
                      nl_query: List top 10 APs by bandwidth
                      position:
                        col: 1
                        colSpan: 2
                        row: 1
                        rowSpan: 1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/org_ui_settings'
                - description: Organization UI settings databoard
                  examples:
                  - created_time: 1749083436
                    description: AP related stats
                    for_site: false
                    id: 9a702097-0dd3-48af-909b-2be4ff94d139
                    isCustomDataboard: true
                    modified_time: 1749083436
                    name: AP Stats
                    org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                    purpose: marvisdashboard
                    site_id: 00000000-0000-0000-0000-000000000000
                    tiles:
                    - description: User typed tile descr
                      id: 3eef7c83-3d33-417a-a729-4772d4a1013a
                      isAutoTitle: true
                      name: List top 10 APs by bandwidth
                      nl_query: List top 10 APs by bandwidth
                      position:
                        col: 1
                        colSpan: 2
                        row: 1
                        rowSpan: 1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 1749083436
                    description: AP related stats
                    for_site: false
                    id: 9a702097-0dd3-48af-909b-2be4ff94d139
                    isCustomDataboard: true
                    modified_time: 1749083436
                    name: AP Stats
                    org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                    purpose: marvisdashboard
                    site_id: 00000000-0000-0000-0000-000000000000
                    tiles:
                    - description: User typed tile descr
                      id: 3eef7c83-3d33-417a-a729-4772d4a1013a
                      isAutoTitle: true
                      name: List top 10 APs by bandwidth
                      nl_query: List top 10 APs by bandwidth
                      position:
                        col: 1
                        colSpan: 2
                        row: 1
                        rowSpan: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/vbeacons:
    get:
      tags:
      - Sites vBeacons
      summary: listSiteVBeacons
      description: Get List of Site Virtual Beacons
      operationId: listSiteVBeacons
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/vbeacon'
                description: Virtual beacon records returned by a list response
                examples:
                - - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    major: 0
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    message: string
                    minor: 0
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    power: 4
                    power_mode: default
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    url: string
                    uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    wayfinding_nodename: string
                    x: 0
                    y: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    major: 0
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    message: string
                    minor: 0
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    power: 4
                    power_mode: default
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    url: string
                    uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    wayfinding_nodename: string
                    x: 0
                    y: 0
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/vbeacon'
                description: Virtual beacon records returned by a list response
                examples:
                - - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    major: 0
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    message: string
                    minor: 0
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    power: 4
                    power_mode: default
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    url: string
                    uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    wayfinding_nodename: string
                    x: 0
                    y: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    major: 0
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    message: string
                    minor: 0
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    power: 4
                    power_mode: default
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    url: string
                    uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    wayfinding_nodename: string
                    x: 0
                    y: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites vBeacons
      summary: createSiteVBeacon
      description: Create Virtual Beacon
      operationId: createSiteVBeacon
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/vbeacon'
              - description: Request Body
                examples:
                - major: 0
                  message: string
                  minor: 0
                  name: string
                  power: 4
                  power_mode: default
                  url: string
                  uuid: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                  wayfinding_nodename: string
                  x: 0
                  y: 0
              contentMediaType: application/json
            examples:
              Example:
                value:
                  major: 0
                  message: string
                  minor: 0
                  name: string
                  power: 4
                  power_mode: default
                  url: string
                  uuid: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                  wayfinding_nodename: string
                  x: 0
                  y: 0
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vbeacon'
                - description: Virtual beacon configuration for SDK proximity notifications
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    major: 0
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    message: string
                    minor: 0
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    power: 4
                    power_mode: default
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    url: string
                    uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    wayfinding_nodename: string
                    x: 0
                    y: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    major: 0
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    message: string
                    minor: 0
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    power: 4
                    power_mode: default
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    url: string
                    uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    wayfinding_nodename: string
                    x: 0
                    y: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vbeacon'
                - description: Virtual beacon configuration for SDK proximity notifications
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    major: 0
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    message: string
                    minor: 0
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    power: 4
                    power_mode: default
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    url: string
                    uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    wayfinding_nodename: string
                    x: 0
                    y: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    major: 0
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    message: string
                    minor: 0
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    power: 4
                    power_mode: default
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    url: string
                    uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    wayfinding_nodename: string
                    x: 0
                    y: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/vbeacons/{vbeacon_id}:
    delete:
      tags:
      - Sites vBeacons
      summary: deleteSiteVBeacon
      description: Delete Site Virtual Beacon
      operationId: deleteSiteVBeacon
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: vbeacon_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Sites vBeacons
      summary: getSiteVBeacon
      description: Get Site Virtual Beacon Details
      operationId: getSiteVBeacon
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: vbeacon_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vbeacon'
                - description: Virtual beacon configuration for SDK proximity notifications
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    major: 0
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    message: string
                    minor: 0
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    power: 4
                    power_mode: default
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    url: string
                    uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    wayfinding_nodename: string
                    x: 0
                    y: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    major: 0
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    message: string
                    minor: 0
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    power: 4
                    power_mode: default
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    url: string
                    uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    wayfinding_nodename: string
                    x: 0
                    y: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vbeacon'
                - description: Virtual beacon configuration for SDK proximity notifications
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    major: 0
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    message: string
                    minor: 0
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    power: 4
                    power_mode: default
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    url: string
                    uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    wayfinding_nodename: string
                    x: 0
                    y: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    major: 0
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    message: string
                    minor: 0
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    power: 4
                    power_mode: default
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    url: string
                    uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    wayfinding_nodename: string
                    x: 0
                    y: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Sites vBeacons
      summary: updateSiteVBeacon
      description: Update Site Virtual Beacon
      operationId: updateSiteVBeacon
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: vbeacon_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/vbeacon'
              - description: Request Body
                examples:
                - major: 0
                  message: string
                  minor: 0
                  name: string
                  power: 4
                  power_mode: default
                  url: string
                  uuid: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                  wayfinding_nodename: string
                  x: 0
                  y: 0
              contentMediaType: application/json
            examples:
              Example:
                value:
                  major: 0
                  message: string
                  minor: 0
                  name: string
                  power: 4
                  power_mode: default
                  url: string
                  uuid: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                  wayfinding_nodename: string
                  x: 0
                  y: 0
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vbeacon'
                - description: Virtual beacon configuration for SDK proximity notifications
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    major: 0
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    message: string
                    minor: 0
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    power: 4
                    power_mode: default
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    url: string
                    uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    wayfinding_nodename: string
                    x: 0
                    y: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    major: 0
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    message: string
                    minor: 0
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    power: 4
                    power_mode: default
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    url: string
                    uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    wayfinding_nodename: string
                    x: 0
                    y: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vbeacon'
                - description: Virtual beacon configuration for SDK proximity notifications
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    major: 0
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    message: string
                    minor: 0
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    power: 4
                    power_mode: default
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    url: string
                    uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    wayfinding_nodename: string
                    x: 0
                    y: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    major: 0
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    message: string
                    minor: 0
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    power: 4
                    power_mode: default
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    url: string
                    uuid: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    wayfinding_nodename: string
                    x: 0
                    y: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/vpns/derived:
    get:
      tags:
      - Sites VPNs
      summary: listSiteVpnsDerived
      description: Get the list of derived VPNs for a site
      operationId: listSiteVpnsDerived
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: resolve
        in: query
        description: Whether resolve the site variables
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          examples:
          - true
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/vpn'
                description: VPN records returned by a list response
                examples:
                - - name: string
                    paths:
                      property1:
                        bfd_profile: broadband
                        ip: string
                      property2:
                        bfd_profile: lte
                        ip: string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - name: string
                    paths:
                      property1:
                        bfd_profile: broadband
                        ip: string
                      property2:
                        bfd_profile: lte
                        ip: string
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/vpn'
                description: VPN records returned by a list response
                examples:
                - - name: string
                    paths:
                      property1:
                        bfd_profile: broadband
                        ip: string
                      property2:
                        bfd_profile: lte
                        ip: string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - name: string
                    paths:
                      property1:
                        bfd_profile: broadband
                        ip: string
                      property2:
                        bfd_profile: lte
                        ip: string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/wan_usages/count:
    get:
      tags:
      - Sites WAN Usages
      summary: countSiteWanUsage
      description: Count Site WAN Usages
      operationId: countSiteWanUsage
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - '001122334455'
      - name: peer_mac
        in: query
        description: Filter results by peer MAC address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - '001122334455'
      - name: port_id
        in: query
        description: Port ID for the device
        style: form
        explode: true
        schema:
          type: string
          examples:
          - ge-0/0/0
      - name: peer_port_id
        in: query
        description: Peer Port ID for the device
        style: form
        explode: true
        schema:
          type: string
          examples:
          - ge-0/0/0
      - name: policy
        in: query
        description: Filter results by WAN path policy
        style: form
        explode: true
        schema:
          type: string
      - name: tenant
        in: query
        description: Filter results by tenant network
        style: form
        explode: true
        schema:
          type: string
      - name: path_type
        in: query
        description: Filter results by port path type
        style: form
        explode: true
        schema:
          type: string
          examples:
          - primary
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `mac`, `path_type`, `peer_mac`, `peer_port_id`, `policy`, `port_id`, `tenant`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/wan_usages_count_distinct'
          - description: 'Field used to group this count response. enum: `mac`, `path_type`, `peer_mac`, `peer_port_id`, `policy`, `port_id`, `tenant`'
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/wan_usages/search:
    get:
      tags:
      - Sites WAN Usages
      summary: searchSiteWanUsage
      description: Search Site WAN Usages
      operationId: searchSiteWanUsage
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - '001122334455'
      - name: peer_mac
        in: query
        description: Filter results by peer MAC address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - '001122334455'
      - name: port_id
        in: query
        description: Port ID for the device
        style: form
        explode: true
        schema:
          type: string
          examples:
          - ge-0/0/0
      - name: peer_port_id
        in: query
        description: Peer Port ID for the device
        style: form
        explode: true
        schema:
          type: string
          examples:
          - ge-0/0/0
      - name: policy
        in: query
        description: Filter results by WAN path policy
        style: form
        explode: true
        schema:
          type: string
          examples:
          - primary
      - name: tenant
        in: query
        description: Filter results by tenant network
        style: form
        explode: true
        schema:
          type: string
      - name: path_type
        in: query
        description: Filter results by port path type
        style: form
        explode: true
        schema:
          type: string
          examples:
          - primary
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/search_wan_usage'
                - description: Paginated response for WAN usage searches
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/search_wan_usage'
                - description: Paginated response for WAN usage searches
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/webhooks:
    get:
      tags:
      - Sites Webhooks
      summary: listSiteWebhooks
      description: Get List of Site Webhooks
      operationId: listSiteWebhooks
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/webhook'
                description: Webhook configuration records returned by a list response
                examples:
                - - created_time: 0
                    enabled: true
                    headers: {}
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    splunk_token: string
                    topics:
                    - location
                    type: http-post
                    url: string
                    verify_cert: true
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 0
                    enabled: true
                    headers: {}
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    splunk_token: string
                    topics:
                    - location
                    type: http-post
                    url: string
                    verify_cert: true
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/webhook'
                description: Webhook configuration records returned by a list response
                examples:
                - - created_time: 0
                    enabled: true
                    headers: {}
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    splunk_token: string
                    topics:
                    - location
                    type: http-post
                    url: string
                    verify_cert: true
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 0
                    enabled: true
                    headers: {}
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    splunk_token: string
                    topics:
                    - location
                    type: http-post
                    url: string
                    verify_cert: true
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites Webhooks
      summary: createSiteWebhook
      description: "Webhook defines a webhook, modeled after [github\\u2019s model](https://developer.github.com/webhooks/).\n\n\nThere is two types of webhooks:\n* webhooks ([examples](https://www.postman.com/juniper-mist/workspace/mist-systems-s-public-workspace/folder/224925-be01e694-7253-4195-8563-78e2a745e114))        \n* raw data webhooks ([examples](https://www.postman.com/juniper-mist/workspace/mist-systems-s-public-workspace/folder/224925-e2d5d5f8-4bdb-4efc-93e4-90f4b33d0b2b))\n\n\n##### Webhooks\nWebhooks can be configured at the org level (subset of topics only) and at the site level. It is possible to have multiple topics in the same webhook configuration and/or to have multiple webhooks configured at the same time.\n\n##### Client Raw Data Webhooks\nRaw data webhooks are a special subset of webhooks that provide insight into raw data packets emitted by a client, identified by their advertising MAC address (assets, discovered BLE, connected Wi-Fi, unconnected Wi-Fi). The data that client raw data webhooks encompasses are reporting AP information, RSSI Data, and any special packets/telemetry packets that the client may emit. Note that client raw webhooks are the raw data coming from the client and do not contain the X,Y location data of the client. In order to get the location data for a client please see our location webhooks. Clients can be identified uniquely across these client raw data topics and location webhook topic using MAC address as the Unique identifier (client identifier).\n\n###### Client Raw Data Webhooks Topics\nTopics that correspond to client raw data for different client types. \n* `asset-raw-rssi` - Raw data from packets emitted by named and filtered assets \n* `discovered-raw-rssi` - Raw data from packets emitted by passive BLE devices \n* `wifi-conn-raw` - Raw data from packets emitted by connected devices \n* `wifi-unconn-raw` - Raw data from packets emitted by unconnected devices (passive)\n\n### Asset Filtering for Client Raw Data Webhooks\n\nThe `asset-raw-rssi` webhook topic supports filtering of raw data by incorporating asset filters in the webhook payload.  \nThe filter topic allows multiple Webhooks to receive a subset of the a`asset-raw-rssi` data by assigning asset filters to a given webhook. The `asset-raw-rssi` filter topic is filtered-asset-rssi.\n\n\nA webhook assigned to a filter topic can take a list of AssetFilter IDs, which act as inclusive filters to determine which named asset and filtered asset data is sent to the assigned filter topic. Filters can be applied to multiple webhooks, and the same data can be sent to multiple filter topics.\n\n### Rules for Configuring Client Raw Data Webhooks\n\n1. Only four instances of a webhook object can contain a specific filter topic. - A site-level entry will override an org-level entry for the same client raw data webhook topic.\n2. An assigned asset filter must exist and belong to the same site as the webhook it is assigned to.\n"
      operationId: createSiteWebhook
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/webhook'
              - description: Request Body
                examples:
                - enabled: true
                  headers: {}
                  name: string
                  secret: string
                  splunk_token: string
                  topics:
                  - location
                  type: http-post
                  url: string
                  verify_cert: true
              contentMediaType: application/json
            examples:
              Example:
                value:
                  enabled: true
                  headers: {}
                  name: string
                  secret: string
                  splunk_token: string
                  topics:
                  - location
                  type: http-post
                  url: string
                  verify_cert: true
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/webhook'
                - description: Webhook configuration for delivering selected Mist events to an external destination
                  examples:
                  - created_time: 0
                    enabled: true
                    headers: {}
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    splunk_token: string
                    topics:
                    - location
                    type: http-post
                    url: string
                    verify_cert: true
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    enabled: true
                    headers: {}
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    splunk_token: string
                    topics:
                    - location
                    type: http-post
                    url: string
                    verify_cert: true
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/webhook'
                - description: Webhook configuration for delivering selected Mist events to an external destination
                  examples:
                  - created_time: 0
                    enabled: true
                    headers: {}
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    splunk_token: string
                    topics:
                    - location
                    type: http-post
                    url: string
                    verify_cert: true
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    enabled: true
                    headers: {}
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    splunk_token: string
                    topics:
                    - location
                    type: http-post
                    url: string
                    verify_cert: true
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400_webhook'
                - description: Webhook-specific HTTP 400 bad request error response
                  examples:
                  - '{"detail":"invalid field: assetfilter_ids","reason":"contains duplicate uuids"}'
                  - '{"detail":"invalid field: assetfilter_ids"}'
                  - '{"detail":"invalid field: assetfilter_ids"}'
                  - '{"detail":"Webhook already configured for special location topic"}'
                  - '{"detail":"Only one location topic can be configured per URL"}'
                  - '{"detail":"invalid field: topics","reason":"filtered asset webhooks must be associated with a site"}'
                contentMediaType: application/json
              examples:
                Duplicate_assetfilter_id:
                  value:
                    detail: 'invalid field: assetfilter_ids'
                    reason: contains duplicate uuids
                Invalid_assetfilter_id:
                  value:
                    detail: 'invalid field: assetfilter_ids'
                Malformed_assetfilter_id:
                  value:
                    detail: 'invalid field: assetfilter_ids'
                RawDataWebhook_already_created:
                  value:
                    detail: Webhook already configured for special location topic
                RawDataWebhook_multiple_topics:
                  value:
                    detail: Only one location topic can be configured per URL
                org_level_filter_webhook:
                  value:
                    detail: 'invalid field: topics'
                    reason: filtered asset webhooks must be associated with a site
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400_webhook'
                - description: Webhook-specific HTTP 400 bad request error response
                  examples:
                  - '{"detail":"invalid field: assetfilter_ids","reason":"contains duplicate uuids"}'
                  - '{"detail":"invalid field: assetfilter_ids"}'
                  - '{"detail":"invalid field: assetfilter_ids"}'
                  - '{"detail":"Webhook already configured for special location topic"}'
                  - '{"detail":"Only one location topic can be configured per URL"}'
                  - '{"detail":"invalid field: topics","reason":"filtered asset webhooks must be associated with a site"}'
                contentMediaType: application/vnd.api+json
              examples:
                Duplicate_assetfilter_id:
                  value:
                    detail: 'invalid field: assetfilter_ids'
                    reason: contains duplicate uuids
                Invalid_assetfilter_id:
                  value:
                    detail: 'invalid field: assetfilter_ids'
                Malformed_assetfilter_id:
                  value:
                    detail: 'invalid field: assetfilter_ids'
                RawDataWebhook_already_created:
                  value:
                    detail: Webhook already configured for special location topic
                RawDataWebhook_multiple_topics:
                  value:
                    detail: Only one location topic can be configured per URL
                org_level_filter_webhook:
                  value:
                    detail: 'invalid field: topics'
                    reason: filtered asset webhooks must be associated with a site
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/webhooks/{webhook_id}:
    delete:
      tags:
      - Sites Webhooks
      summary: deleteSiteWebhook
      description: Delete Site Webhook
      operationId: deleteSiteWebhook
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: webhook_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Sites Webhooks
      summary: getSiteWebhook
      description: Get Site Webhook Details
      operationId: getSiteWebhook
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: webhook_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/webhook'
                - description: Webhook configuration for delivering selected Mist events to an external destination
                  examples:
                  - created_time: 0
                    enabled: true
                    headers: {}
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    splunk_token: string
                    topics:
                    - location
                    type: http-post
                    url: string
                    verify_cert: true
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    enabled: true
                    headers: {}
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    splunk_token: string
                    topics:
                    - location
                    type: http-post
                    url: string
                    verify_cert: true
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/webhook'
                - description: Webhook configuration for delivering selected Mist events to an external destination
                  examples:
                  - created_time: 0
                    enabled: true
                    headers: {}
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    splunk_token: string
                    topics:
                    - location
                    type: http-post
                    url: string
                    verify_cert: true
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    enabled: true
                    headers: {}
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    splunk_token: string
                    topics:
                    - location
                    type: http-post
                    url: string
                    verify_cert: true
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Sites Webhooks
      summary: updateSiteWebhook
      description: Update Site Webhook
      operationId: updateSiteWebhook
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: webhook_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/webhook'
              - description: Request Body
                examples:
                - enabled: true
                  headers: {}
                  name: string
                  secret: string
                  splunk_token: string
                  topics:
                  - location
                  type: http-post
                  url: string
                  verify_cert: true
              contentMediaType: application/json
            examples:
              Example:
                value:
                  enabled: true
                  headers: {}
                  name: string
                  secret: string
                  splunk_token: string
                  topics:
                  - location
                  type: http-post
                  url: string
                  verify_cert: true
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/webhook'
                - description: Webhook configuration for delivering selected Mist events to an external destination
                  examples:
                  - created_time: 0
                    enabled: true
                    headers: {}
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    splunk_token: string
                    topics:
                    - location
                    type: http-post
                    url: string
                    verify_cert: true
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    enabled: true
                    headers: {}
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    splunk_token: string
                    topics:
                    - location
                    type: http-post
                    url: string
                    verify_cert: true
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/webhook'
                - description: Webhook configuration for delivering selected Mist events to an external destination
                  examples:
                  - created_time: 0
                    enabled: true
                    headers: {}
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    splunk_token: string
                    topics:
                    - location
                    type: http-post
                    url: string
                    verify_cert: true
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    enabled: true
                    headers: {}
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    secret: string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    splunk_token: string
                    topics:
                    - location
                    type: http-post
                    url: string
                    verify_cert: true
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/webhooks/{webhook_id}/events/count:
    get:
      tags:
      - Sites Webhooks
      summary: countSiteWebhooksDeliveries
      description: >-
        Count Site Webhooks deliveries



        Topics Supported:

        - alarms

        - audits

        - device-updowns

        - occupancy-alerts

        - ping
      operationId: countSiteWebhooksDeliveries
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: webhook_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: error
        in: query
        description: Filter webhook delivery results by error message
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Webhook delivery failed
      - name: status_code
        in: query
        description: Filter webhook delivery results by HTTP status code
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
          examples:
          - 200
      - name: status
        in: query
        description: 'Webhook delivery status used to filter results. enum: `failure`, `success`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/webhook_delivery_status'
          - description: 'Webhook delivery status used to filter results. enum: `failure`, `success`'
            examples:
            - failure
      - name: topic
        in: query
        description: 'Webhook topic used to filter results. enum: `alarms`, `audits`, `device-updowns`, `occupancy-alerts`, `ping`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/webhook_delivery_topic'
          - description: 'Webhook topic used to filter results. enum: `alarms`, `audits`, `device-updowns`, `occupancy-alerts`, `ping`'
            examples:
            - audits
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `status`, `status_code`, `topic`, `webhook_id`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/webhook_delivery_distinct'
          - description: 'Field used to group this count response. enum: `status`, `status_code`, `topic`, `webhook_id`'
            examples:
            - webhook_id
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/webhooks/{webhook_id}/events/search:
    get:
      tags:
      - Sites Webhooks
      summary: searchSiteWebhooksDeliveries
      description: >-
        Search Site Webhooks deliveries



        Topics Supported:

        - alarms

        - audits

        - device-updowns

        - occupancy-alerts

        - ping
      operationId: searchSiteWebhooksDeliveries
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: webhook_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: error
        in: query
        description: Filter webhook delivery results by error message
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Webhook delivery failed
      - name: status_code
        in: query
        description: Filter webhook delivery results by HTTP status code
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
          examples:
          - 200
      - name: status
        in: query
        description: 'Webhook delivery status used to filter results. enum: `failure`, `success`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/webhook_delivery_status'
          - description: 'Webhook delivery status used to filter results. enum: `failure`, `success`'
            examples:
            - failure
      - name: topic
        in: query
        description: 'Webhook topic used to filter results. enum: `alarms`, `audits`, `device-updowns`, `occupancy-alerts`, `ping`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/webhook_delivery_topic'
          - description: 'Webhook topic used to filter results. enum: `alarms`, `audits`, `device-updowns`, `occupancy-alerts`, `ping`'
            examples:
            - audits
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/search_webhook_delivery'
                - description: Paginated response for webhook delivery searches
                  examples:
                  - end: 1688035193
                    limit: 10
                    results:
                    - error: string
                      id: 55b0f02f-ebf6-4ad2-8b10-200508a97581
                      org_id: fc7e2967-e7ef-41e6-b007-1217713de05a
                      req_headers: '{\"Content-Type\":[\"application/json\"],\"User-Agent\":[\"Mist-webhook\"]}'
                      req_payload: '{\"topic\":\"audits\",\"events\":[{\"admin_name\":\"John Doe john.doe@juniper.net\",\"after\":\"{\\"radio_config\\": {\\"band_24\\": {\\"disabled\\": false, \\"allow_rrm_disable\\": false, \\"power_min\\": null, \\"power_max\\": null, \\"power\\": 10, \\"preamble\\": \\"short\\", \\"channels\\": [1, 10], \\"bandwidth\\": 20}}}\",\"before\":\"{\\"radio_config\\": {\\"band_24\\": {\\"disabled\\": false, \\"allow_rrm_disable\\": false, \\"power_min\\": 8, \\"power_max\\": 18, \\"power\\": null, \\"preamble\\": \\"long\\", \\"channels\\": [1, 10], \\"bandwidth\\": 20}}}\",\"id\":\"737909a2-04ff-4aeb-b9da-cc924e74a4dd\",\"message\":\"Update Site Settings\",\"org_id\":\"fc7e2967-e7ef-41e6-b007-1217713de05a\",\"site_id\":\"256c3a35-9cb7-436e-bc6d-314972645d95\",\"site_name\":\"Test Site\",\"src_ip\":\"1.2.3.4\",\"timestamp\":1685956576.923601,\"user_agent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/112.0.0.0 Safari/537.36\"}]}'
                      req_url: https://example.com
                      resp_body: Ok
                      resp_headers: string
                      site_id: 256c3a35-9cb7-436e-bc6d-314972645d95
                      status: success
                      status_code: 200
                      timestamp: 1687962508.583656
                      topic: audits
                      webhook_id: 7a11b901-f719-4c91-8aef-deb8699a6364
                    start: 1687948793
                    total: 0
                contentMediaType: application/json
              examples:
                Webhook Deliveries:
                  value:
                    end: 1688035193
                    limit: 10
                    results:
                    - error: string
                      id: 55b0f02f-ebf6-4ad2-8b10-200508a97581
                      org_id: fc7e2967-e7ef-41e6-b007-1217713de05a
                      req_headers: '{\"Content-Type\":[\"application/json\"],\"User-Agent\":[\"Mist-webhook\"]}'
                      req_payload: '{\"topic\":\"audits\",\"events\":[{\"admin_name\":\"John Doe john.doe@juniper.net\",\"after\":\"{\\"radio_config\\": {\\"band_24\\": {\\"disabled\\": false, \\"allow_rrm_disable\\": false, \\"power_min\\": null, \\"power_max\\": null, \\"power\\": 10, \\"preamble\\": \\"short\\", \\"channels\\": [1, 10], \\"bandwidth\\": 20}}}\",\"before\":\"{\\"radio_config\\": {\\"band_24\\": {\\"disabled\\": false, \\"allow_rrm_disable\\": false, \\"power_min\\": 8, \\"power_max\\": 18, \\"power\\": null, \\"preamble\\": \\"long\\", \\"channels\\": [1, 10], \\"bandwidth\\": 20}}}\",\"id\":\"737909a2-04ff-4aeb-b9da-cc924e74a4dd\",\"message\":\"Update Site Settings\",\"org_id\":\"fc7e2967-e7ef-41e6-b007-1217713de05a\",\"site_id\":\"256c3a35-9cb7-436e-bc6d-314972645d95\",\"site_name\":\"Test Site\",\"src_ip\":\"1.2.3.4\",\"timestamp\":1685956576.923601,\"user_agent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/112.0.0.0 Safari/537.36\"}]}'
                      req_url: https://example.com
                      resp_body: Ok
                      resp_headers: string
                      site_id: 256c3a35-9cb7-436e-bc6d-314972645d95
                      status: success
                      status_code: 200
                      timestamp: 1687962508.583656
                      topic: audits
                      webhook_id: 7a11b901-f719-4c91-8aef-deb8699a6364
                    start: 1687948793
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/search_webhook_delivery'
                - description: Paginated response for webhook delivery searches
                  examples:
                  - end: 1688035193
                    limit: 10
                    results:
                    - error: string
                      id: 55b0f02f-ebf6-4ad2-8b10-200508a97581
                      org_id: fc7e2967-e7ef-41e6-b007-1217713de05a
                      req_headers: '{\"Content-Type\":[\"application/json\"],\"User-Agent\":[\"Mist-webhook\"]}'
                      req_payload: '{\"topic\":\"audits\",\"events\":[{\"admin_name\":\"John Doe john.doe@juniper.net\",\"after\":\"{\\"radio_config\\": {\\"band_24\\": {\\"disabled\\": false, \\"allow_rrm_disable\\": false, \\"power_min\\": null, \\"power_max\\": null, \\"power\\": 10, \\"preamble\\": \\"short\\", \\"channels\\": [1, 10], \\"bandwidth\\": 20}}}\",\"before\":\"{\\"radio_config\\": {\\"band_24\\": {\\"disabled\\": false, \\"allow_rrm_disable\\": false, \\"power_min\\": 8, \\"power_max\\": 18, \\"power\\": null, \\"preamble\\": \\"long\\", \\"channels\\": [1, 10], \\"bandwidth\\": 20}}}\",\"id\":\"737909a2-04ff-4aeb-b9da-cc924e74a4dd\",\"message\":\"Update Site Settings\",\"org_id\":\"fc7e2967-e7ef-41e6-b007-1217713de05a\",\"site_id\":\"256c3a35-9cb7-436e-bc6d-314972645d95\",\"site_name\":\"Test Site\",\"src_ip\":\"1.2.3.4\",\"timestamp\":1685956576.923601,\"user_agent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/112.0.0.0 Safari/537.36\"}]}'
                      req_url: https://example.com
                      resp_body: Ok
                      resp_headers: string
                      site_id: 256c3a35-9cb7-436e-bc6d-314972645d95
                      status: success
                      status_code: 200
                      timestamp: 1687962508.583656
                      topic: audits
                      webhook_id: 7a11b901-f719-4c91-8aef-deb8699a6364
                    start: 1687948793
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Webhook Deliveries:
                  value:
                    end: 1688035193
                    limit: 10
                    results:
                    - error: string
                      id: 55b0f02f-ebf6-4ad2-8b10-200508a97581
                      org_id: fc7e2967-e7ef-41e6-b007-1217713de05a
                      req_headers: '{\"Content-Type\":[\"application/json\"],\"User-Agent\":[\"Mist-webhook\"]}'
                      req_payload: '{\"topic\":\"audits\",\"events\":[{\"admin_name\":\"John Doe john.doe@juniper.net\",\"after\":\"{\\"radio_config\\": {\\"band_24\\": {\\"disabled\\": false, \\"allow_rrm_disable\\": false, \\"power_min\\": null, \\"power_max\\": null, \\"power\\": 10, \\"preamble\\": \\"short\\", \\"channels\\": [1, 10], \\"bandwidth\\": 20}}}\",\"before\":\"{\\"radio_config\\": {\\"band_24\\": {\\"disabled\\": false, \\"allow_rrm_disable\\": false, \\"power_min\\": 8, \\"power_max\\": 18, \\"power\\": null, \\"preamble\\": \\"long\\", \\"channels\\": [1, 10], \\"bandwidth\\": 20}}}\",\"id\":\"737909a2-04ff-4aeb-b9da-cc924e74a4dd\",\"message\":\"Update Site Settings\",\"org_id\":\"fc7e2967-e7ef-41e6-b007-1217713de05a\",\"site_id\":\"256c3a35-9cb7-436e-bc6d-314972645d95\",\"site_name\":\"Test Site\",\"src_ip\":\"1.2.3.4\",\"timestamp\":1685956576.923601,\"user_agent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/112.0.0.0 Safari/537.36\"}]}'
                      req_url: https://example.com
                      resp_body: Ok
                      resp_headers: string
                      site_id: 256c3a35-9cb7-436e-bc6d-314972645d95
                      status: success
                      status_code: 200
                      timestamp: 1687962508.583656
                      topic: audits
                      webhook_id: 7a11b901-f719-4c91-8aef-deb8699a6364
                    start: 1687948793
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/webhooks/{webhook_id}/ping:
    post:
      tags:
      - Sites Webhooks
      summary: pingSiteWebhook
      description: Send a Ping event to the webhook
      operationId: pingSiteWebhook
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: webhook_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/wlans:
    get:
      tags:
      - Sites Wlans
      summary: listSiteWlans
      description: Get List of Site WLANs
      operationId: listSiteWlans
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/wlan'
                description: WLAN records returned by a list response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/wlan'
                description: WLAN records returned by a list response
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites Wlans
      summary: createSiteWlan
      description: Create Site WLAN
      operationId: createSiteWlan
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/wlan'
              - description: Request Body
                examples:
                - acct_immediate_update: false
                  acct_interim_interval: 0
                  acct_servers:
                  - host: 1.2.3.4
                    keywrap_enabled: true
                    keywrap_format: hex
                    keywrap_kek: '1122334455'
                    keywrap_mack: '1122334455'
                    port: 1813
                    secret: testing123
                  airwatch:
                    api_key: aHhlbGxvYXNkZmFzZGZhc2Rmc2RmCg=="
                    console_url: https://hs1.airwatchportals.com
                    enabled: true
                    password: user1
                    username: test123
                  allow_ipv6_ndp: true
                  allow_mdns: false
                  allow_ssdp: false
                  ap_ids:
                  - 497f6eca-6276-4993-bfeb-53cbbbbb6f08
                  app_limit:
                    apps:
                      dropbox: 300
                      netflix: 60
                    enabled: false
                    wxtag_ids:
                      f99862d9-2726-931f-7559-3dfdf5d070d3: 30
                  app_qos:
                    apps:
                      skype-business-video:
                        dscp: 32
                        dst_subnet: 10.2.0.0/16
                        src_subnet: 10.2.0.0/16
                    enabled: true
                    others:
                    - dscp: 32
                      dst_subnet: 10.2.0.0/16
                      port_ranges: 80,1024-6553
                      protocol: udp
                      src_subnet: 10.2.0.0/16
                  apply_to: site
                  arp_filter: false
                  auth:
                    anticlog_threshold: 16
                    eap_reauth: false
                    enable_mac_auth: false
                    key_idx: 1
                    keys:
                    - string
                    multi_psk_only: false
                    pairwise:
                    - wpa2-ccmp
                    private_wlan: true
                    psk: foryoureyesonly
                    type: psk
                    wep_as_secondary_auth: true
                  auth_server_selection: ordered
                  auth_servers:
                  - host: 1.2.3.4
                    keywrap_enabled: true
                    keywrap_format: hex
                    keywrap_kek: '1122334455'
                    keywrap_mack: '1122334455'
                    port: 1812
                    secret: testing123
                  auth_servers_nas_id: 5c5b350e0101-nas
                  auth_servers_nas_ip: 15.3.1.5
                  auth_servers_retries: 5
                  auth_servers_timeout: 5
                  band: string
                  band_steer: false
                  band_steer_force_band5: false
                  bands:
                  - '24'
                  - '5'
                  block_blacklist_clients: false
                  bonjour:
                    additional_vlan_ids: 10,20
                    enabled: false
                    services:
                      airplay:
                        radius_groups:
                        - teachers
                        scope: same_ap
                  cisco_cwa:
                    allowed_hostnames:
                    - snapchat.com
                    allowed_subnets:
                    - 63.5.3.0/24
                    blocked_subnets:
                    - 192.168.0.0/16
                    enabled: false
                  client_limit_down: 1000
                  client_limit_down_enabled: false
                  client_limit_up: 512
                  client_limit_up_enabled: false
                  coa_servers:
                  - disable_event_timestamp_check: false
                    enabled: false
                    ip: 1.2.3.4
                    port: 3799
                    secret: testing456
                  disable_11ax: false
                  disable_ht_vht_rates: false
                  disable_uapsd: false
                  disable_v1_roam_notify: false
                  disable_v2_roam_notify: false
                  disable_wmm: false
                  dns_server_rewrite:
                    enabled: false
                    radius_groups:
                      contractor: 172.1.1.1
                      guest: 8.8.8.8
                  dtim: 2
                  dynamic_psk:
                    default_psk: foryoureyesonly
                    default_vlan_id: 999
                    enabled: false
                    source: cloud_psks
                  dynamic_vlan:
                    default_vlan_id: 999
                    enabled: false
                    local_vlan_ids:
                    - 1
                    type: airespace-interface-name
                    vlans:
                      '131': default
                      '322': fast,video
                  enable_local_keycaching: false
                  enable_wireless_bridging: false
                  enabled: true
                  fast_dot1x_timers: false
                  hide_ssid: false
                  hostname_ie: false
                  hotspot20:
                    domain_name:
                    - mist.com
                    enabled: true
                    nai_realms:
                    - string
                    operators:
                    - google
                    - att
                    rcoi:
                    - 5A03BA0000
                    venue_name: some_name
                  interface: all
                  isolation: false
                  l2_isolation: false
                  legacy_overds: false
                  limit_bcast: false
                  limit_probe_response: true
                  max_idletime: 1800
                  mist_nac:
                    enabled: false
                  no_static_dns: false
                  no_static_ip: false
                  ssid: demo
              contentMediaType: application/json
            examples:
              Example:
                value:
                  acct_immediate_update: false
                  acct_interim_interval: 0
                  acct_servers:
                  - host: 1.2.3.4
                    keywrap_enabled: true
                    keywrap_format: hex
                    keywrap_kek: '1122334455'
                    keywrap_mack: '1122334455'
                    port: 1813
                    secret: testing123
                  airwatch:
                    api_key: aHhlbGxvYXNkZmFzZGZhc2Rmc2RmCg=="
                    console_url: https://hs1.airwatchportals.com
                    enabled: true
                    password: user1
                    username: test123
                  allow_ipv6_ndp: true
                  allow_mdns: false
                  allow_ssdp: false
                  ap_ids:
                  - 497f6eca-6276-4993-bfeb-53cbbbbb6f08
                  app_limit:
                    apps:
                      dropbox: 300
                      netflix: 60
                    enabled: false
                    wxtag_ids:
                      f99862d9-2726-931f-7559-3dfdf5d070d3: 30
                  app_qos:
                    apps:
                      skype-business-video:
                        dscp: 32
                        dst_subnet: 10.2.0.0/16
                        src_subnet: 10.2.0.0/16
                    enabled: true
                    others:
                    - dscp: 32
                      dst_subnet: 10.2.0.0/16
                      port_ranges: 80,1024-6553
                      protocol: udp
                      src_subnet: 10.2.0.0/16
                  apply_to: site
                  arp_filter: false
                  auth:
                    anticlog_threshold: 16
                    eap_reauth: false
                    enable_mac_auth: false
                    key_idx: 1
                    keys:
                    - string
                    multi_psk_only: false
                    pairwise:
                    - wpa2-ccmp
                    private_wlan: true
                    psk: foryoureyesonly
                    type: psk
                    wep_as_secondary_auth: true
                  auth_server_selection: ordered
                  auth_servers:
                  - host: 1.2.3.4
                    keywrap_enabled: true
                    keywrap_format: hex
                    keywrap_kek: '1122334455'
                    keywrap_mack: '1122334455'
                    port: 1812
                    secret: testing123
                  auth_servers_nas_id: 5c5b350e0101-nas
                  auth_servers_nas_ip: 15.3.1.5
                  auth_servers_retries: 5
                  auth_servers_timeout: 5
                  band: string
                  band_steer: false
                  band_steer_force_band5: false
                  bands:
                  - '24'
                  - '5'
                  block_blacklist_clients: false
                  bonjour:
                    additional_vlan_ids: 10,20
                    enabled: false
                    services:
                      airplay:
                        radius_groups:
                        - teachers
                        scope: same_ap
                  cisco_cwa:
                    allowed_hostnames:
                    - snapchat.com
                    allowed_subnets:
                    - 63.5.3.0/24
                    blocked_subnets:
                    - 192.168.0.0/16
                    enabled: false
                  client_limit_down: 1000
                  client_limit_down_enabled: false
                  client_limit_up: 512
                  client_limit_up_enabled: false
                  coa_servers:
                  - disable_event_timestamp_check: false
                    enabled: false
                    ip: 1.2.3.4
                    port: 3799
                    secret: testing456
                  disable_11ax: false
                  disable_ht_vht_rates: false
                  disable_uapsd: false
                  disable_v1_roam_notify: false
                  disable_v2_roam_notify: false
                  disable_wmm: false
                  dns_server_rewrite:
                    enabled: false
                    radius_groups:
                      contractor: 172.1.1.1
                      guest: 8.8.8.8
                  dtim: 2
                  dynamic_psk:
                    default_psk: foryoureyesonly
                    default_vlan_id: 999
                    enabled: false
                    source: cloud_psks
                  dynamic_vlan:
                    default_vlan_id: 999
                    enabled: false
                    local_vlan_ids:
                    - 1
                    type: airespace-interface-name
                    vlans:
                      '131': default
                      '322': fast,video
                  enable_local_keycaching: false
                  enable_wireless_bridging: false
                  enabled: true
                  fast_dot1x_timers: false
                  hide_ssid: false
                  hostname_ie: false
                  hotspot20:
                    domain_name:
                    - mist.com
                    enabled: true
                    nai_realms:
                    - string
                    operators:
                    - google
                    - att
                    rcoi:
                    - 5A03BA0000
                    venue_name: some_name
                  interface: all
                  isolation: false
                  l2_isolation: false
                  legacy_overds: false
                  limit_bcast: false
                  limit_probe_response: true
                  max_idletime: 1800
                  mist_nac:
                    enabled: false
                  no_static_dns: false
                  no_static_ip: false
                  ssid: demo
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wlan'
                - description: '**Note**: portal_template will be forked out of wlan objects soon. To fetch portal_template, please query portal_template_url. To update portal_template, use Wlan Portal Template.'
                  examples:
                  - allow_ipv6_ndp: true
                    allow_mdns: false
                    allow_ssdp: false
                    arp_filter: false
                    band_steer: false
                    band_steer_force_band5: false
                    bands:
                    - '24'
                    - '5'
                    block_blacklist_clients: false
                    bonjour:
                      additional_vlan_ids: 10, 20
                      enabled: false
                      services:
                        airplay:
                          radius_groups:
                          - teachers
                          scope: same_ap
                    client_limit_down: 1000
                    client_limit_down_enabled: false
                    client_limit_up: 512
                    client_limit_up_enabled: false
                    disable_11ax: false
                    disable_ht_vht_rates: false
                    disable_uapsd: false
                    disable_v1_roam_notify: false
                    disable_v2_roam_notify: false
                    disable_wmm: false
                    dynamic_vlan:
                      default_vlan_id: 999
                      enabled: false
                      local_vlan_ids:
                      - 1
                      type: airespace-interface-name
                      vlans:
                        '131': default
                        '322': fast,video
                    enable_local_keycaching: false
                    enable_wireless_bridging: false
                    enabled: true
                    fast_dot1x_timers: false
                    hide_ssid: false
                    hostname_ie: false
                    ssid: demo
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    allow_ipv6_ndp: true
                    allow_mdns: false
                    allow_ssdp: false
                    arp_filter: false
                    band_steer: false
                    band_steer_force_band5: false
                    bands:
                    - '24'
                    - '5'
                    block_blacklist_clients: false
                    bonjour:
                      additional_vlan_ids: 10, 20
                      enabled: false
                      services:
                        airplay:
                          radius_groups:
                          - teachers
                          scope: same_ap
                    client_limit_down: 1000
                    client_limit_down_enabled: false
                    client_limit_up: 512
                    client_limit_up_enabled: false
                    disable_11ax: false
                    disable_ht_vht_rates: false
                    disable_uapsd: false
                    disable_v1_roam_notify: false
                    disable_v2_roam_notify: false
                    disable_wmm: false
                    dynamic_vlan:
                      default_vlan_id: 999
                      enabled: false
                      local_vlan_ids:
                      - 1
                      type: airespace-interface-name
                      vlans:
                        '131': default
                        '322': fast,video
                    enable_local_keycaching: false
                    enable_wireless_bridging: false
                    enabled: true
                    fast_dot1x_timers: false
                    hide_ssid: false
                    hostname_ie: false
                    ssid: demo
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wlan'
                - description: '**Note**: portal_template will be forked out of wlan objects soon. To fetch portal_template, please query portal_template_url. To update portal_template, use Wlan Portal Template.'
                  examples:
                  - allow_ipv6_ndp: true
                    allow_mdns: false
                    allow_ssdp: false
                    arp_filter: false
                    band_steer: false
                    band_steer_force_band5: false
                    bands:
                    - '24'
                    - '5'
                    block_blacklist_clients: false
                    bonjour:
                      additional_vlan_ids: 10, 20
                      enabled: false
                      services:
                        airplay:
                          radius_groups:
                          - teachers
                          scope: same_ap
                    client_limit_down: 1000
                    client_limit_down_enabled: false
                    client_limit_up: 512
                    client_limit_up_enabled: false
                    disable_11ax: false
                    disable_ht_vht_rates: false
                    disable_uapsd: false
                    disable_v1_roam_notify: false
                    disable_v2_roam_notify: false
                    disable_wmm: false
                    dynamic_vlan:
                      default_vlan_id: 999
                      enabled: false
                      local_vlan_ids:
                      - 1
                      type: airespace-interface-name
                      vlans:
                        '131': default
                        '322': fast,video
                    enable_local_keycaching: false
                    enable_wireless_bridging: false
                    enabled: true
                    fast_dot1x_timers: false
                    hide_ssid: false
                    hostname_ie: false
                    ssid: demo
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    allow_ipv6_ndp: true
                    allow_mdns: false
                    allow_ssdp: false
                    arp_filter: false
                    band_steer: false
                    band_steer_force_band5: false
                    bands:
                    - '24'
                    - '5'
                    block_blacklist_clients: false
                    bonjour:
                      additional_vlan_ids: 10, 20
                      enabled: false
                      services:
                        airplay:
                          radius_groups:
                          - teachers
                          scope: same_ap
                    client_limit_down: 1000
                    client_limit_down_enabled: false
                    client_limit_up: 512
                    client_limit_up_enabled: false
                    disable_11ax: false
                    disable_ht_vht_rates: false
                    disable_uapsd: false
                    disable_v1_roam_notify: false
                    disable_v2_roam_notify: false
                    disable_wmm: false
                    dynamic_vlan:
                      default_vlan_id: 999
                      enabled: false
                      local_vlan_ids:
                      - 1
                      type: airespace-interface-name
                      vlans:
                        '131': default
                        '322': fast,video
                    enable_local_keycaching: false
                    enable_wireless_bridging: false
                    enabled: true
                    fast_dot1x_timers: false
                    hide_ssid: false
                    hostname_ie: false
                    ssid: demo
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/wlans/derived:
    get:
      tags:
      - Sites Wlans
      summary: listSiteWlansDerived
      description: Get the list of derived Wlans for a Site
      operationId: listSiteWlansDerived
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: resolve
        in: query
        description: Whether to resolve SITE_VARS
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          examples:
          - true
      - name: wlan_id
        in: query
        description: Filter by WLAN ID
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 8bfc2490-d726-3587-038d-cb2e71bd2330
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/wlan'
                description: WLAN records returned by a list response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/wlan'
                description: WLAN records returned by a list response
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/wlans/{wlan_id}:
    delete:
      tags:
      - Sites Wlans
      summary: deleteSiteWlan
      description: Delete Site WLAN
      operationId: deleteSiteWlan
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wlan_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Sites Wlans
      summary: getSiteWlan
      description: Get Site WLAN
      operationId: getSiteWlan
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wlan_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wlan'
                - description: '**Note**: portal_template will be forked out of wlan objects soon. To fetch portal_template, please query portal_template_url. To update portal_template, use Wlan Portal Template.'
                  examples:
                  - allow_ipv6_ndp: true
                    allow_mdns: false
                    allow_ssdp: false
                    arp_filter: false
                    band_steer: false
                    band_steer_force_band5: false
                    bands:
                    - '24'
                    - '5'
                    block_blacklist_clients: false
                    bonjour:
                      additional_vlan_ids: 10, 20
                      enabled: false
                      services:
                        airplay:
                          radius_groups:
                          - teachers
                          scope: same_ap
                    client_limit_down: 1000
                    client_limit_down_enabled: false
                    client_limit_up: 512
                    client_limit_up_enabled: false
                    disable_11ax: false
                    disable_ht_vht_rates: false
                    disable_uapsd: false
                    disable_v1_roam_notify: false
                    disable_v2_roam_notify: false
                    disable_wmm: false
                    dynamic_vlan:
                      default_vlan_id: 999
                      enabled: false
                      local_vlan_ids:
                      - 1
                      type: airespace-interface-name
                      vlans:
                        '131': default
                        '322': fast,video
                    enable_local_keycaching: false
                    enable_wireless_bridging: false
                    enabled: true
                    fast_dot1x_timers: false
                    hide_ssid: false
                    hostname_ie: false
                    ssid: demo
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    allow_ipv6_ndp: true
                    allow_mdns: false
                    allow_ssdp: false
                    arp_filter: false
                    band_steer: false
                    band_steer_force_band5: false
                    bands:
                    - '24'
                    - '5'
                    block_blacklist_clients: false
                    bonjour:
                      additional_vlan_ids: 10, 20
                      enabled: false
                      services:
                        airplay:
                          radius_groups:
                          - teachers
                          scope: same_ap
                    client_limit_down: 1000
                    client_limit_down_enabled: false
                    client_limit_up: 512
                    client_limit_up_enabled: false
                    disable_11ax: false
                    disable_ht_vht_rates: false
                    disable_uapsd: false
                    disable_v1_roam_notify: false
                    disable_v2_roam_notify: false
                    disable_wmm: false
                    dynamic_vlan:
                      default_vlan_id: 999
                      enabled: false
                      local_vlan_ids:
                      - 1
                      type: airespace-interface-name
                      vlans:
                        '131': default
                        '322': fast,video
                    enable_local_keycaching: false
                    enable_wireless_bridging: false
                    enabled: true
                    fast_dot1x_timers: false
                    hide_ssid: false
                    hostname_ie: false
                    ssid: demo
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wlan'
                - description: '**Note**: portal_template will be forked out of wlan objects soon. To fetch portal_template, please query portal_template_url. To update portal_template, use Wlan Portal Template.'
                  examples:
                  - allow_ipv6_ndp: true
                    allow_mdns: false
                    allow_ssdp: false
                    arp_filter: false
                    band_steer: false
                    band_steer_force_band5: false
                    bands:
                    - '24'
                    - '5'
                    block_blacklist_clients: false
                    bonjour:
                      additional_vlan_ids: 10, 20
                      enabled: false
                      services:
                        airplay:
                          radius_groups:
                          - teachers
                          scope: same_ap
                    client_limit_down: 1000
                    client_limit_down_enabled: false
                    client_limit_up: 512
                    client_limit_up_enabled: false
                    disable_11ax: false
                    disable_ht_vht_rates: false
                    disable_uapsd: false
                    disable_v1_roam_notify: false
                    disable_v2_roam_notify: false
                    disable_wmm: false
                    dynamic_vlan:
                      default_vlan_id: 999
                      enabled: false
                      local_vlan_ids:
                      - 1
                      type: airespace-interface-name
                      vlans:
                        '131': default
                        '322': fast,video
                    enable_local_keycaching: false
                    enable_wireless_bridging: false
                    enabled: true
                    fast_dot1x_timers: false
                    hide_ssid: false
                    hostname_ie: false
                    ssid: demo
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    allow_ipv6_ndp: true
                    allow_mdns: false
                    allow_ssdp: false
                    arp_filter: false
                    band_steer: false
                    band_steer_force_band5: false
                    bands:
                    - '24'
                    - '5'
                    block_blacklist_clients: false
                    bonjour:
                      additional_vlan_ids: 10, 20
                      enabled: false
                      services:
                        airplay:
                          radius_groups:
                          - teachers
                          scope: same_ap
                    client_limit_down: 1000
                    client_limit_down_enabled: false
                    client_limit_up: 512
                    client_limit_up_enabled: false
                    disable_11ax: false
                    disable_ht_vht_rates: false
                    disable_uapsd: false
                    disable_v1_roam_notify: false
                    disable_v2_roam_notify: false
                    disable_wmm: false
                    dynamic_vlan:
                      default_vlan_id: 999
                      enabled: false
                      local_vlan_ids:
                      - 1
                      type: airespace-interface-name
                      vlans:
                        '131': default
                        '322': fast,video
                    enable_local_keycaching: false
                    enable_wireless_bridging: false
                    enabled: true
                    fast_dot1x_timers: false
                    hide_ssid: false
                    hostname_ie: false
                    ssid: demo
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Sites Wlans
      summary: updateSiteWlan
      description: Update Site WLAN
      operationId: updateSiteWlan
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wlan_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/wlan'
              - description: Request Body
                examples:
                - acct_immediate_update: false
                  acct_interim_interval: 0
                  acct_servers:
                  - host: 1.2.3.4
                    keywrap_enabled: true
                    keywrap_format: hex
                    keywrap_kek: '1122334455'
                    keywrap_mack: '1122334455'
                    port: 1813
                    secret: testing123
                  airwatch:
                    api_key: aHhlbGxvYXNkZmFzZGZhc2Rmc2RmCg=="
                    console_url: https://hs1.airwatchportals.com
                    enabled: true
                    password: user1
                    username: test123
                  allow_ipv6_ndp: true
                  allow_mdns: false
                  allow_ssdp: false
                  ap_ids:
                  - 497f6eca-6276-4993-bfeb-53cbbbbe6f08
                  app_limit:
                    apps:
                      dropbox: 300
                      netflix: 60
                    enabled: false
                    wxtag_ids:
                      f99862d9-2726-931f-7559-3dfdf5d070d3: 30
                  app_qos:
                    apps:
                      skype-business-video:
                        dscp: 32
                        dst_subnet: 10.2.0.0/16
                        src_subnet: 10.2.0.0/16
                    enabled: true
                    others:
                    - dscp: 32
                      dst_subnet: 10.2.0.0/16
                      port_ranges: 80,1024-6553
                      protocol: udp
                      src_subnet: 10.2.0.0/16
                  apply_to: site
                  arp_filter: false
                  auth:
                    anticlog_threshold: 16
                    eap_reauth: false
                    enable_mac_auth: false
                    key_idx: 1
                    keys:
                    - string
                    multi_psk_only: false
                    pairwise:
                    - wpa2-ccmp
                    private_wlan: true
                    psk: foryoureyesonly
                    type: psk
                    wep_as_secondary_auth: true
                  auth_server_selection: ordered
                  auth_servers:
                  - host: 1.2.3.4
                    keywrap_enabled: true
                    keywrap_format: hex
                    keywrap_kek: '1122334455'
                    keywrap_mack: '1122334455'
                    port: 1812
                    secret: testing123
                  auth_servers_nas_id: 5c5b350e0101-nas
                  auth_servers_nas_ip: 15.3.1.5
                  auth_servers_retries: 5
                  auth_servers_timeout: 5
                  band: string
                  band_steer: false
                  band_steer_force_band5: false
                  bands:
                  - '24'
                  - '5'
                  block_blacklist_clients: false
                  bonjour:
                    additional_vlan_ids: 10,20
                    enabled: false
                    services:
                      airplay:
                        radius_groups:
                        - teachers
                        scope: same_ap
                  cisco_cwa:
                    allowed_hostnames:
                    - snapchat.com
                    allowed_subnets:
                    - 63.5.3.0/24
                    blocked_subnets:
                    - 192.168.0.0/16
                    enabled: false
                  client_limit_down: 1000
                  client_limit_down_enabled: false
                  client_limit_up: 512
                  client_limit_up_enabled: false
                  coa_servers:
                  - disable_event_timestamp_check: false
                    enabled: false
                    ip: 1.2.3.4
                    port: 3799
                    secret: testing456
                  disable_11ax: false
                  disable_ht_vht_rates: false
                  disable_uapsd: false
                  disable_v1_roam_notify: false
                  disable_v2_roam_notify: false
                  disable_wmm: false
                  dns_server_rewrite:
                    enabled: false
                    radius_groups:
                      contractor: 172.1.1.1
                      guest: 8.8.8.8
                  dtim: 2
                  dynamic_psk:
                    default_psk: foryoureyesonly
                    default_vlan_id: 999
                    enabled: false
                    source: cloud_psks
                  dynamic_vlan:
                    default_vlan_id: 999
                    enabled: false
                    local_vlan_ids:
                    - 1
                    type: airespace-interface-name
                    vlans:
                      '131': default
                      '322': fast,video
                  enable_local_keycaching: false
                  enable_wireless_bridging: false
                  enabled: true
                  fast_dot1x_timers: false
                  hide_ssid: false
                  hostname_ie: false
                  hotspot20:
                    domain_name:
                    - mist.com
                    enabled: true
                    nai_realms:
                    - string
                    operators:
                    - google
                    - att
                    rcoi:
                    - 5A03BA0000
                    venue_name: some_name
                  interface: all
                  isolation: false
                  l2_isolation: false
                  legacy_overds: false
                  limit_bcast: false
                  limit_probe_response: true
                  max_idletime: 1800
                  mist_nac:
                    enabled: false
                  no_static_dns: false
                  no_static_ip: false
                  ssid: demo
              contentMediaType: application/json
            examples:
              Example:
                value:
                  acct_immediate_update: false
                  acct_interim_interval: 0
                  acct_servers:
                  - host: 1.2.3.4
                    keywrap_enabled: true
                    keywrap_format: hex
                    keywrap_kek: '1122334455'
                    keywrap_mack: '1122334455'
                    port: 1813
                    secret: testing123
                  airwatch:
                    api_key: aHhlbGxvYXNkZmFzZGZhc2Rmc2RmCg=="
                    console_url: https://hs1.airwatchportals.com
                    enabled: true
                    password: user1
                    username: test123
                  allow_ipv6_ndp: true
                  allow_mdns: false
                  allow_ssdp: false
                  ap_ids:
                  - 497f6eca-6276-4993-bfeb-53cbbbbe6f08
                  app_limit:
                    apps:
                      dropbox: 300
                      netflix: 60
                    enabled: false
                    wxtag_ids:
                      f99862d9-2726-931f-7559-3dfdf5d070d3: 30
                  app_qos:
                    apps:
                      skype-business-video:
                        dscp: 32
                        dst_subnet: 10.2.0.0/16
                        src_subnet: 10.2.0.0/16
                    enabled: true
                    others:
                    - dscp: 32
                      dst_subnet: 10.2.0.0/16
                      port_ranges: 80,1024-6553
                      protocol: udp
                      src_subnet: 10.2.0.0/16
                  apply_to: site
                  arp_filter: false
                  auth:
                    anticlog_threshold: 16
                    eap_reauth: false
                    enable_mac_auth: false
                    key_idx: 1
                    keys:
                    - string
                    multi_psk_only: false
                    pairwise:
                    - wpa2-ccmp
                    private_wlan: true
                    psk: foryoureyesonly
                    type: psk
                    wep_as_secondary_auth: true
                  auth_server_selection: ordered
                  auth_servers:
                  - host: 1.2.3.4
                    keywrap_enabled: true
                    keywrap_format: hex
                    keywrap_kek: '1122334455'
                    keywrap_mack: '1122334455'
                    port: 1812
                    secret: testing123
                  auth_servers_nas_id: 5c5b350e0101-nas
                  auth_servers_nas_ip: 15.3.1.5
                  auth_servers_retries: 5
                  auth_servers_timeout: 5
                  band: string
                  band_steer: false
                  band_steer_force_band5: false
                  bands:
                  - '24'
                  - '5'
                  block_blacklist_clients: false
                  bonjour:
                    additional_vlan_ids: 10,20
                    enabled: false
                    services:
                      airplay:
                        radius_groups:
                        - teachers
                        scope: same_ap
                  cisco_cwa:
                    allowed_hostnames:
                    - snapchat.com
                    allowed_subnets:
                    - 63.5.3.0/24
                    blocked_subnets:
                    - 192.168.0.0/16
                    enabled: false
                  client_limit_down: 1000
                  client_limit_down_enabled: false
                  client_limit_up: 512
                  client_limit_up_enabled: false
                  coa_servers:
                  - disable_event_timestamp_check: false
                    enabled: false
                    ip: 1.2.3.4
                    port: 3799
                    secret: testing456
                  disable_11ax: false
                  disable_ht_vht_rates: false
                  disable_uapsd: false
                  disable_v1_roam_notify: false
                  disable_v2_roam_notify: false
                  disable_wmm: false
                  dns_server_rewrite:
                    enabled: false
                    radius_groups:
                      contractor: 172.1.1.1
                      guest: 8.8.8.8
                  dtim: 2
                  dynamic_psk:
                    default_psk: foryoureyesonly
                    default_vlan_id: 999
                    enabled: false
                    source: cloud_psks
                  dynamic_vlan:
                    default_vlan_id: 999
                    enabled: false
                    local_vlan_ids:
                    - 1
                    type: airespace-interface-name
                    vlans:
                      '131': default
                      '322': fast,video
                  enable_local_keycaching: false
                  enable_wireless_bridging: false
                  enabled: true
                  fast_dot1x_timers: false
                  hide_ssid: false
                  hostname_ie: false
                  hotspot20:
                    domain_name:
                    - mist.com
                    enabled: true
                    nai_realms:
                    - string
                    operators:
                    - google
                    - att
                    rcoi:
                    - 5A03BA0000
                    venue_name: some_name
                  interface: all
                  isolation: false
                  l2_isolation: false
                  legacy_overds: false
                  limit_bcast: false
                  limit_probe_response: true
                  max_idletime: 1800
                  mist_nac:
                    enabled: false
                  no_static_dns: false
                  no_static_ip: false
                  ssid: demo
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wlan'
                - description: '**Note**: portal_template will be forked out of wlan objects soon. To fetch portal_template, please query portal_template_url. To update portal_template, use Wlan Portal Template.'
                  examples:
                  - allow_ipv6_ndp: true
                    allow_mdns: false
                    allow_ssdp: false
                    arp_filter: false
                    band_steer: false
                    band_steer_force_band5: false
                    bands:
                    - '24'
                    - '5'
                    block_blacklist_clients: false
                    bonjour:
                      additional_vlan_ids: 10, 20
                      enabled: false
                      services:
                        airplay:
                          radius_groups:
                          - teachers
                          scope: same_ap
                    client_limit_down: 1000
                    client_limit_down_enabled: false
                    client_limit_up: 512
                    client_limit_up_enabled: false
                    disable_11ax: false
                    disable_ht_vht_rates: false
                    disable_uapsd: false
                    disable_v1_roam_notify: false
                    disable_v2_roam_notify: false
                    disable_wmm: false
                    dynamic_vlan:
                      default_vlan_id: 999
                      enabled: false
                      local_vlan_ids:
                      - 1
                      type: airespace-interface-name
                      vlans:
                        '131': default
                        '322': fast,video
                    enable_local_keycaching: false
                    enable_wireless_bridging: false
                    enabled: true
                    fast_dot1x_timers: false
                    hide_ssid: false
                    hostname_ie: false
                    ssid: demo
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    allow_ipv6_ndp: true
                    allow_mdns: false
                    allow_ssdp: false
                    arp_filter: false
                    band_steer: false
                    band_steer_force_band5: false
                    bands:
                    - '24'
                    - '5'
                    block_blacklist_clients: false
                    bonjour:
                      additional_vlan_ids: 10, 20
                      enabled: false
                      services:
                        airplay:
                          radius_groups:
                          - teachers
                          scope: same_ap
                    client_limit_down: 1000
                    client_limit_down_enabled: false
                    client_limit_up: 512
                    client_limit_up_enabled: false
                    disable_11ax: false
                    disable_ht_vht_rates: false
                    disable_uapsd: false
                    disable_v1_roam_notify: false
                    disable_v2_roam_notify: false
                    disable_wmm: false
                    dynamic_vlan:
                      default_vlan_id: 999
                      enabled: false
                      local_vlan_ids:
                      - 1
                      type: airespace-interface-name
                      vlans:
                        '131': default
                        '322': fast,video
                    enable_local_keycaching: false
                    enable_wireless_bridging: false
                    enabled: true
                    fast_dot1x_timers: false
                    hide_ssid: false
                    hostname_ie: false
                    ssid: demo
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wlan'
                - description: '**Note**: portal_template will be forked out of wlan objects soon. To fetch portal_template, please query portal_template_url. To update portal_template, use Wlan Portal Template.'
                  examples:
                  - allow_ipv6_ndp: true
                    allow_mdns: false
                    allow_ssdp: false
                    arp_filter: false
                    band_steer: false
                    band_steer_force_band5: false
                    bands:
                    - '24'
                    - '5'
                    block_blacklist_clients: false
                    bonjour:
                      additional_vlan_ids: 10, 20
                      enabled: false
                      services:
                        airplay:
                          radius_groups:
                          - teachers
                          scope: same_ap
                    client_limit_down: 1000
                    client_limit_down_enabled: false
                    client_limit_up: 512
                    client_limit_up_enabled: false
                    disable_11ax: false
                    disable_ht_vht_rates: false
                    disable_uapsd: false
                    disable_v1_roam_notify: false
                    disable_v2_roam_notify: false
                    disable_wmm: false
                    dynamic_vlan:
                      default_vlan_id: 999
                      enabled: false
                      local_vlan_ids:
                      - 1
                      type: airespace-interface-name
                      vlans:
                        '131': default
                        '322': fast,video
                    enable_local_keycaching: false
                    enable_wireless_bridging: false
                    enabled: true
                    fast_dot1x_timers: false
                    hide_ssid: false
                    hostname_ie: false
                    ssid: demo
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    allow_ipv6_ndp: true
                    allow_mdns: false
                    allow_ssdp: false
                    arp_filter: false
                    band_steer: false
                    band_steer_force_band5: false
                    bands:
                    - '24'
                    - '5'
                    block_blacklist_clients: false
                    bonjour:
                      additional_vlan_ids: 10, 20
                      enabled: false
                      services:
                        airplay:
                          radius_groups:
                          - teachers
                          scope: same_ap
                    client_limit_down: 1000
                    client_limit_down_enabled: false
                    client_limit_up: 512
                    client_limit_up_enabled: false
                    disable_11ax: false
                    disable_ht_vht_rates: false
                    disable_uapsd: false
                    disable_v1_roam_notify: false
                    disable_v2_roam_notify: false
                    disable_wmm: false
                    dynamic_vlan:
                      default_vlan_id: 999
                      enabled: false
                      local_vlan_ids:
                      - 1
                      type: airespace-interface-name
                      vlans:
                        '131': default
                        '322': fast,video
                    enable_local_keycaching: false
                    enable_wireless_bridging: false
                    enabled: true
                    fast_dot1x_timers: false
                    hide_ssid: false
                    hostname_ie: false
                    ssid: demo
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/wlans/{wlan_id}/portal_image:
    delete:
      tags:
      - Sites Wlans
      summary: deleteSiteWlanPortalImage
      description: Delete Site WLAN Portal Image
      operationId: deleteSiteWlanPortalImage
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wlan_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites Wlans
      summary: uploadSiteWlanPortalImage
      description: WLAN Portal Image Upload
      operationId: uploadSiteWlanPortalImage
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wlan_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              required:
              - file
              type: object
              properties:
                file:
                  type: string
                  description: Image file content uploaded as multipart form data
                  contentEncoding: base64
                json:
                  type: string
                  description: Optional JSON metadata submitted with the image upload
              contentMediaType: multipart/form-data
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/wlans/{wlan_id}/portal_template:
    put:
      tags:
      - Sites Wlans
      summary: updateSiteWlanPortalTemplate
      description: >-
        Update a Portal Template


        #### Sponsor Email Template

        Sponsor Email Template supports following template variables:


        | **Name** | **Description** |

        | --- | --- |

        | approve_url | Renders URL to approve the request; optionally &minutes=N query param can be appended to change the Authorization period of the guest, where N is a valid integer denoting number of minutes a guest remains authorized |

        | deny_url | Renders URL to reject the request |

        | guest_email | Renders Email ID of the guest |

        | guest_name | Renders Name of the guest |

        | field1 | Renders value of the Custom Field 1 |

        | field2 | Renders value of the Custom Field 2 |

        | company | Renders value of the Company field |

        | sponsor_link_validity_duration | Renders validity time of the request (i.e. Approve/Deny URL) |

        | auth_expire_minutes | Renders Wlan-level configured Guest Authorization Expiration time period (in minutes), If not configured then default (1 day in minutes) |
      operationId: updateSiteWlanPortalTemplate
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wlan_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/wlan_portal_template'
              - description: Request Body
                examples:
                - portal_template:
                    accessCodeAlternateEmail: string
                    alignment: left
                    authButtonAmazon: string
                    authButtonAzure: string
                    authButtonEmail: string
                    authButtonFacebook: string
                    authButtonGoogle: string
                    authButtonMicrosoft: string
                    authButtonPassphrase: string
                    authButtonSms: string
                    authButtonSponsor: string
                    authLabel: string
                    backLink: string
                    color: string
                    colorDark: string
                    colorLight: string
                    company: true
                    companyError: string
                    companyLabel: string
                    email: true
                    emailAccessDomainError: string
                    emailCancel: string
                    emailCodeError: string
                    emailError: string
                    emailFieldLabel: string
                    emailLabel: string
                    emailMessage: string
                    emailSubmit: string
                    emailTitle: string
                    field1: true
                    field1Error: string
                    field1Label: string
                    field1Required: true
                    field2: true
                    field2Error: string
                    field2Label: string
                    field2Required: true
                    field3: true
                    field3Error: string
                    field3Label: string
                    field3Required: true
                    field4: true
                    field4Error: string
                    field4Label: string
                    field4Required: true
                    message: string
                    name: true
                    nameError: string
                    nameLabel: string
                    optout: true
                    optoutLabel: string
                    pageTitle: string
                    passphraseCancel: string
                    passphraseError: string
                    passphraseLabel: string
                    passphraseMessage: string
                    passphraseSubmit: string
                    passphraseTitle: string
                    poweredBy: true
                    requiredFieldLabel: string
                    signInLabel: string
                    smsCarrierDefault: string
                    smsCarrierError: string
                    smsCarrierFieldLabel: string
                    smsCodeCancel: string
                    smsCodeError: string
                    smsCodeFieldLabel: string
                    smsCodeMessage: string
                    smsCodeSubmit: string
                    smsCodeTitle: string
                    smsCountryFieldLabel: string
                    smsCountryFormat: string
                    smsHaveAccessCode: string
                    smsMessageFormat: string
                    smsNumberCancel: string
                    smsNumberError: string
                    smsNumberFieldLabel: string
                    smsNumberFormat: string
                    smsNumberMessage: string
                    smsNumberSubmit: string
                    smsNumberTitle: string
                    smsUsernameFormat: string
                    smsValidityDuration: 30
                    sponsorBackLink: string
                    sponsorCancel: string
                    sponsorEmail: string
                    sponsorEmailError: string
                    sponsorEmailTemplate: string
                    sponsorInfoApproved: string
                    sponsorInfoDenied: string
                    sponsorInfoPending: string
                    sponsorName: string
                    sponsorNameError: string
                    sponsorNotePending: string
                    sponsorStatusApproved: string
                    sponsorStatusDenied: string
                    sponsorStatusPending: string
                    sponsorSubmit: string
                    sponsorsFieldLabel: string
                    tos: true
                    tosAcceptLabel: string
                    tosError: string
                    tosLink: string
                    tosText: string
              contentMediaType: application/json
            examples:
              Example:
                value:
                  portal_template:
                    accessCodeAlternateEmail: string
                    alignment: left
                    authButtonAmazon: string
                    authButtonAzure: string
                    authButtonEmail: string
                    authButtonFacebook: string
                    authButtonGoogle: string
                    authButtonMicrosoft: string
                    authButtonPassphrase: string
                    authButtonSms: string
                    authButtonSponsor: string
                    authLabel: string
                    backLink: string
                    color: string
                    colorDark: string
                    colorLight: string
                    company: true
                    companyError: string
                    companyLabel: string
                    email: true
                    emailAccessDomainError: string
                    emailCancel: string
                    emailCodeError: string
                    emailError: string
                    emailFieldLabel: string
                    emailLabel: string
                    emailMessage: string
                    emailSubmit: string
                    emailTitle: string
                    field1: true
                    field1Error: string
                    field1Label: string
                    field1Required: true
                    field2: true
                    field2Error: string
                    field2Label: string
                    field2Required: true
                    field3: true
                    field3Error: string
                    field3Label: string
                    field3Required: true
                    field4: true
                    field4Error: string
                    field4Label: string
                    field4Required: true
                    message: string
                    name: true
                    nameError: string
                    nameLabel: string
                    optout: true
                    optoutLabel: string
                    pageTitle: string
                    passphraseCancel: string
                    passphraseError: string
                    passphraseLabel: string
                    passphraseMessage: string
                    passphraseSubmit: string
                    passphraseTitle: string
                    poweredBy: true
                    requiredFieldLabel: string
                    signInLabel: string
                    smsCarrierDefault: string
                    smsCarrierError: string
                    smsCarrierFieldLabel: string
                    smsCodeCancel: string
                    smsCodeError: string
                    smsCodeFieldLabel: string
                    smsCodeMessage: string
                    smsCodeSubmit: string
                    smsCodeTitle: string
                    smsCountryFieldLabel: string
                    smsCountryFormat: string
                    smsHaveAccessCode: string
                    smsMessageFormat: string
                    smsNumberCancel: string
                    smsNumberError: string
                    smsNumberFieldLabel: string
                    smsNumberFormat: string
                    smsNumberMessage: string
                    smsNumberSubmit: string
                    smsNumberTitle: string
                    smsUsernameFormat: string
                    smsValidityDuration: 30
                    sponsorBackLink: string
                    sponsorCancel: string
                    sponsorEmail: string
                    sponsorEmailError: string
                    sponsorEmailTemplate: string
                    sponsorInfoApproved: string
                    sponsorInfoDenied: string
                    sponsorInfoPending: string
                    sponsorName: string
                    sponsorNameError: string
                    sponsorNotePending: string
                    sponsorStatusApproved: string
                    sponsorStatusDenied: string
                    sponsorStatusPending: string
                    sponsorSubmit: string
                    sponsorsFieldLabel: string
                    tos: true
                    tosAcceptLabel: string
                    tosError: string
                    tosLink: string
                    tosText: string
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wlan_portal_template'
                - description: Guest portal template payload for a WLAN
                  examples:
                  - portal_template:
                      accessCodeAlternateEmail: string
                      alignment: left
                      authButtonAmazon: string
                      authButtonAzure: string
                      authButtonEmail: string
                      authButtonFacebook: string
                      authButtonGoogle: string
                      authButtonMicrosoft: string
                      authButtonPassphrase: string
                      authButtonSms: string
                      authButtonSponsor: string
                      authLabel: string
                      backLink: string
                      color: string
                      colorDark: string
                      colorLight: string
                      company: true
                      companyError: string
                      companyLabel: string
                      email: true
                      emailAccessDomainError: string
                      emailCancel: string
                      emailCodeError: string
                      emailError: string
                      emailFieldLabel: string
                      emailLabel: string
                      emailMessage: string
                      emailSubmit: string
                      emailTitle: string
                      field1: true
                      field1Error: string
                      field1Label: string
                      field1Required: true
                      field2: true
                      field2Error: string
                      field2Label: string
                      field2Required: true
                      field3: true
                      field3Error: string
                      field3Label: string
                      field3Required: true
                      field4: true
                      field4Error: string
                      field4Label: string
                      field4Required: true
                      message: string
                      name: true
                      nameError: string
                      nameLabel: string
                      optout: true
                      optoutLabel: string
                      pageTitle: string
                      passphraseCancel: string
                      passphraseError: string
                      passphraseLabel: string
                      passphraseMessage: string
                      passphraseSubmit: string
                      passphraseTitle: string
                      poweredBy: true
                      requiredFieldLabel: string
                      signInLabel: string
                      smsCarrierDefault: string
                      smsCarrierError: string
                      smsCarrierFieldLabel: string
                      smsCodeCancel: string
                      smsCodeError: string
                      smsCodeFieldLabel: string
                      smsCodeMessage: string
                      smsCodeSubmit: string
                      smsCodeTitle: string
                      smsCountryFieldLabel: string
                      smsCountryFormat: string
                      smsHaveAccessCode: string
                      smsMessageFormat: string
                      smsNumberCancel: string
                      smsNumberError: string
                      smsNumberFieldLabel: string
                      smsNumberFormat: string
                      smsNumberMessage: string
                      smsNumberSubmit: string
                      smsNumberTitle: string
                      smsUsernameFormat: string
                      smsValidityDuration: 5
                      sponsorBackLink: string
                      sponsorCancel: string
                      sponsorEmail: string
                      sponsorEmailError: string
                      sponsorEmailTemplate: string
                      sponsorInfoApproved: string
                      sponsorInfoDenied: string
                      sponsorInfoPending: string
                      sponsorName: string
                      sponsorNameError: string
                      sponsorNotePending: string
                      sponsorStatusApproved: string
                      sponsorStatusDenied: string
                      sponsorStatusPending: string
                      sponsorSubmit: string
                      tos: true
                      tosAcceptLabel: string
                      tosError: string
                      tosLink: string
                      tosText: string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    portal_template:
                      accessCodeAlternateEmail: string
                      alignment: left
                      authButtonAmazon: string
                      authButtonAzure: string
                      authButtonEmail: string
                      authButtonFacebook: string
                      authButtonGoogle: string
                      authButtonMicrosoft: string
                      authButtonPassphrase: string
                      authButtonSms: string
                      authButtonSponsor: string
                      authLabel: string
                      backLink: string
                      color: string
                      colorDark: string
                      colorLight: string
                      company: true
                      companyError: string
                      companyLabel: string
                      email: true
                      emailAccessDomainError: string
                      emailCancel: string
                      emailCodeError: string
                      emailError: string
                      emailFieldLabel: string
                      emailLabel: string
                      emailMessage: string
                      emailSubmit: string
                      emailTitle: string
                      field1: true
                      field1Error: string
                      field1Label: string
                      field1Required: true
                      field2: true
                      field2Error: string
                      field2Label: string
                      field2Required: true
                      field3: true
                      field3Error: string
                      field3Label: string
                      field3Required: true
                      field4: true
                      field4Error: string
                      field4Label: string
                      field4Required: true
                      message: string
                      name: true
                      nameError: string
                      nameLabel: string
                      optout: true
                      optoutLabel: string
                      pageTitle: string
                      passphraseCancel: string
                      passphraseError: string
                      passphraseLabel: string
                      passphraseMessage: string
                      passphraseSubmit: string
                      passphraseTitle: string
                      poweredBy: true
                      requiredFieldLabel: string
                      signInLabel: string
                      smsCarrierDefault: string
                      smsCarrierError: string
                      smsCarrierFieldLabel: string
                      smsCodeCancel: string
                      smsCodeError: string
                      smsCodeFieldLabel: string
                      smsCodeMessage: string
                      smsCodeSubmit: string
                      smsCodeTitle: string
                      smsCountryFieldLabel: string
                      smsCountryFormat: string
                      smsHaveAccessCode: string
                      smsMessageFormat: string
                      smsNumberCancel: string
                      smsNumberError: string
                      smsNumberFieldLabel: string
                      smsNumberFormat: string
                      smsNumberMessage: string
                      smsNumberSubmit: string
                      smsNumberTitle: string
                      smsUsernameFormat: string
                      smsValidityDuration: 5
                      sponsorBackLink: string
                      sponsorCancel: string
                      sponsorEmail: string
                      sponsorEmailError: string
                      sponsorEmailTemplate: string
                      sponsorInfoApproved: string
                      sponsorInfoDenied: string
                      sponsorInfoPending: string
                      sponsorName: string
                      sponsorNameError: string
                      sponsorNotePending: string
                      sponsorStatusApproved: string
                      sponsorStatusDenied: string
                      sponsorStatusPending: string
                      sponsorSubmit: string
                      tos: true
                      tosAcceptLabel: string
                      tosError: string
                      tosLink: string
                      tosText: string
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wlan_portal_template'
                - description: Guest portal template payload for a WLAN
                  examples:
                  - portal_template:
                      accessCodeAlternateEmail: string
                      alignment: left
                      authButtonAmazon: string
                      authButtonAzure: string
                      authButtonEmail: string
                      authButtonFacebook: string
                      authButtonGoogle: string
                      authButtonMicrosoft: string
                      authButtonPassphrase: string
                      authButtonSms: string
                      authButtonSponsor: string
                      authLabel: string
                      backLink: string
                      color: string
                      colorDark: string
                      colorLight: string
                      company: true
                      companyError: string
                      companyLabel: string
                      email: true
                      emailAccessDomainError: string
                      emailCancel: string
                      emailCodeError: string
                      emailError: string
                      emailFieldLabel: string
                      emailLabel: string
                      emailMessage: string
                      emailSubmit: string
                      emailTitle: string
                      field1: true
                      field1Error: string
                      field1Label: string
                      field1Required: true
                      field2: true
                      field2Error: string
                      field2Label: string
                      field2Required: true
                      field3: true
                      field3Error: string
                      field3Label: string
                      field3Required: true
                      field4: true
                      field4Error: string
                      field4Label: string
                      field4Required: true
                      message: string
                      name: true
                      nameError: string
                      nameLabel: string
                      optout: true
                      optoutLabel: string
                      pageTitle: string
                      passphraseCancel: string
                      passphraseError: string
                      passphraseLabel: string
                      passphraseMessage: string
                      passphraseSubmit: string
                      passphraseTitle: string
                      poweredBy: true
                      requiredFieldLabel: string
                      signInLabel: string
                      smsCarrierDefault: string
                      smsCarrierError: string
                      smsCarrierFieldLabel: string
                      smsCodeCancel: string
                      smsCodeError: string
                      smsCodeFieldLabel: string
                      smsCodeMessage: string
                      smsCodeSubmit: string
                      smsCodeTitle: string
                      smsCountryFieldLabel: string
                      smsCountryFormat: string
                      smsHaveAccessCode: string
                      smsMessageFormat: string
                      smsNumberCancel: string
                      smsNumberError: string
                      smsNumberFieldLabel: string
                      smsNumberFormat: string
                      smsNumberMessage: string
                      smsNumberSubmit: string
                      smsNumberTitle: string
                      smsUsernameFormat: string
                      smsValidityDuration: 5
                      sponsorBackLink: string
                      sponsorCancel: string
                      sponsorEmail: string
                      sponsorEmailError: string
                      sponsorEmailTemplate: string
                      sponsorInfoApproved: string
                      sponsorInfoDenied: string
                      sponsorInfoPending: string
                      sponsorName: string
                      sponsorNameError: string
                      sponsorNotePending: string
                      sponsorStatusApproved: string
                      sponsorStatusDenied: string
                      sponsorStatusPending: string
                      sponsorSubmit: string
                      tos: true
                      tosAcceptLabel: string
                      tosError: string
                      tosLink: string
                      tosText: string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    portal_template:
                      accessCodeAlternateEmail: string
                      alignment: left
                      authButtonAmazon: string
                      authButtonAzure: string
                      authButtonEmail: string
                      authButtonFacebook: string
                      authButtonGoogle: string
                      authButtonMicrosoft: string
                      authButtonPassphrase: string
                      authButtonSms: string
                      authButtonSponsor: string
                      authLabel: string
                      backLink: string
                      color: string
                      colorDark: string
                      colorLight: string
                      company: true
                      companyError: string
                      companyLabel: string
                      email: true
                      emailAccessDomainError: string
                      emailCancel: string
                      emailCodeError: string
                      emailError: string
                      emailFieldLabel: string
                      emailLabel: string
                      emailMessage: string
                      emailSubmit: string
                      emailTitle: string
                      field1: true
                      field1Error: string
                      field1Label: string
                      field1Required: true
                      field2: true
                      field2Error: string
                      field2Label: string
                      field2Required: true
                      field3: true
                      field3Error: string
                      field3Label: string
                      field3Required: true
                      field4: true
                      field4Error: string
                      field4Label: string
                      field4Required: true
                      message: string
                      name: true
                      nameError: string
                      nameLabel: string
                      optout: true
                      optoutLabel: string
                      pageTitle: string
                      passphraseCancel: string
                      passphraseError: string
                      passphraseLabel: string
                      passphraseMessage: string
                      passphraseSubmit: string
                      passphraseTitle: string
                      poweredBy: true
                      requiredFieldLabel: string
                      signInLabel: string
                      smsCarrierDefault: string
                      smsCarrierError: string
                      smsCarrierFieldLabel: string
                      smsCodeCancel: string
                      smsCodeError: string
                      smsCodeFieldLabel: string
                      smsCodeMessage: string
                      smsCodeSubmit: string
                      smsCodeTitle: string
                      smsCountryFieldLabel: string
                      smsCountryFormat: string
                      smsHaveAccessCode: string
                      smsMessageFormat: string
                      smsNumberCancel: string
                      smsNumberError: string
                      smsNumberFieldLabel: string
                      smsNumberFormat: string
                      smsNumberMessage: string
                      smsNumberSubmit: string
                      smsNumberTitle: string
                      smsUsernameFormat: string
                      smsValidityDuration: 5
                      sponsorBackLink: string
                      sponsorCancel: string
                      sponsorEmail: string
                      sponsorEmailError: string
                      sponsorEmailTemplate: string
                      sponsorInfoApproved: string
                      sponsorInfoDenied: string
                      sponsorInfoPending: string
                      sponsorName: string
                      sponsorNameError: string
                      sponsorNotePending: string
                      sponsorStatusApproved: string
                      sponsorStatusDenied: string
                      sponsorStatusPending: string
                      sponsorSubmit: string
                      tos: true
                      tosAcceptLabel: string
                      tosError: string
                      tosLink: string
                      tosText: string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/wxrules:
    get:
      tags:
      - Sites WxRules
      summary: listSiteWxRules
      description: Get List of Site WxLan Rules
      operationId: listSiteWxRules
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: List of WxRules
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/wxlan_rule'
                description: WxLAN policy rules returned by a list response
                examples:
                - - action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-bfeb-53ebbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-bfeb-53ebbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/wxlan_rule'
                description: WxLAN policy rules returned by a list response
                examples:
                - - action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-bfeb-53ebbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-bfeb-53ebbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites WxRules
      summary: createSiteWxRule
      description: Create Site WxLan Rule
      operationId: createSiteWxRule
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/wxlan_rule'
              - description: Request Body
                examples:
                - action: allow
                  apply_tags:
                  - c049dfcd-0c73-5014-1c64-062e9903f1e5
                  blocked_apps:
                  - mist
                  - all-videos
                  dst_allow_wxtags:
                  - fff34466-eec0-3756-6765-381c728a6037
                  - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                  dst_deny_wxtags:
                  - aaa34466-eec0-3756-6765-381c728a6037
                  - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                  enabled: true
                  order: 1
                  src_wxtags:
                  - 8bfc2490-d726-3587-038d-cb2e71bd2330
                  - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
              contentMediaType: application/json
            examples:
              Example:
                value:
                  action: allow
                  apply_tags:
                  - c049dfcd-0c73-5014-1c64-062e9903f1e5
                  blocked_apps:
                  - mist
                  - all-videos
                  dst_allow_wxtags:
                  - fff34466-eec0-3756-6765-381c728a6037
                  - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                  dst_deny_wxtags:
                  - aaa34466-eec0-3756-6765-381c728a6037
                  - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                  enabled: true
                  order: 1
                  src_wxtags:
                  - 8bfc2490-d726-3587-038d-cb2e71bd2330
                  - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
        required: false
      responses:
        '200':
          description: Wrule
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_rule'
                - description: WxLAN policy rule controlling traffic between WxLAN tags
                  examples:
                  - action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-9feb-53cbbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-9feb-53cbbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_rule'
                - description: WxLAN policy rule controlling traffic between WxLAN tags
                  examples:
                  - action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-9feb-53cbbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-9feb-53cbbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/wxrules/derived:
    get:
      tags:
      - Sites WxRules
      summary: ListSiteWxRulesDerived
      description: Get the list of derived WxLan Rule for a site
      operationId: ListSiteWxRulesDerived
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: List of WxRules
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/wxlan_rule'
                description: WxLAN policy rules returned by a list response
                examples:
                - - action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-bfeb-53ebbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-bfeb-53ebbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/wxlan_rule'
                description: WxLAN policy rules returned by a list response
                examples:
                - - action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-bfeb-53ebbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-bfeb-53ebbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/wxrules/{wxrule_id}:
    delete:
      tags:
      - Sites WxRules
      summary: deleteSiteWxRule
      description: Delete Site WxLan Rule
      operationId: deleteSiteWxRule
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wxrule_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Sites WxRules
      summary: getSiteWxRule
      description: Get Site WxLan Rule Details
      operationId: getSiteWxRule
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wxrule_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Wrule
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_rule'
                - description: WxLAN policy rule controlling traffic between WxLAN tags
                  examples:
                  - action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-9feb-53cbbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-9feb-53cbbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_rule'
                - description: WxLAN policy rule controlling traffic between WxLAN tags
                  examples:
                  - action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-9feb-53cbbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-9feb-53cbbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Sites WxRules
      summary: updateSiteWxRule
      description: Update Site WxLan Rule
      operationId: updateSiteWxRule
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wxrule_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/wxlan_rule'
              - description: Request Body
                examples:
                - action: allow
                  apply_tags:
                  - c049dfcd-0c73-5014-1c64-062e9903f1e5
                  blocked_apps:
                  - mist
                  - all-videos
                  dst_allow_wxtags:
                  - fff34466-eec0-3756-6765-381c728a6037
                  - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                  dst_deny_wxtags:
                  - aaa34466-eec0-3756-6765-381c728a6037
                  - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                  enabled: true
                  order: 1
                  src_wxtags:
                  - 8bfc2490-d726-3587-038d-cb2e71bd2330
                  - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
              contentMediaType: application/json
            examples:
              Example:
                value:
                  action: allow
                  apply_tags:
                  - c049dfcd-0c73-5014-1c64-062e9903f1e5
                  blocked_apps:
                  - mist
                  - all-videos
                  dst_allow_wxtags:
                  - fff34466-eec0-3756-6765-381c728a6037
                  - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                  dst_deny_wxtags:
                  - aaa34466-eec0-3756-6765-381c728a6037
                  - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                  enabled: true
                  order: 1
                  src_wxtags:
                  - 8bfc2490-d726-3587-038d-cb2e71bd2330
                  - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
        required: false
      responses:
        '200':
          description: Wrule
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_rule'
                - description: WxLAN policy rule controlling traffic between WxLAN tags
                  examples:
                  - action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-9feb-53cbbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-9feb-53cbbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_rule'
                - description: WxLAN policy rule controlling traffic between WxLAN tags
                  examples:
                  - action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-9feb-53cbbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    action: allow
                    apply_tags:
                    - c049dfcd-0c73-5014-1c64-062e9903f1e5
                    blocked_apps:
                    - mist
                    - all-videos
                    created_time: 0
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    enabled: true
                    for_site: true
                    id: 497f6eca-6276-4993-9feb-53cbbbba6f08
                    modified_time: 0
                    order: 1
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/wxtags:
    get:
      tags:
      - Sites WxTags
      summary: listSiteWxTags
      description: Get List of Site WxTags
      operationId: listSiteWxTags
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/wxlan_tag'
                description: WxLAN tag records returned by a list response
                examples:
                - - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    last_ips:
                    - string
                    mac: string
                    match: wlan_id
                    modified_time: 0
                    name: string
                    op: in
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    resource_mac: string
                    services:
                    - string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    specs:
                    - port_range: string
                      protocol: tcp
                      subnets:
                      - string
                    subnet: string
                    type: match
                    values:
                    - string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    last_ips:
                    - string
                    mac: string
                    match: wlan_id
                    modified_time: 0
                    name: string
                    op: in
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    resource_mac: string
                    services:
                    - string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    specs:
                    - port_range: string
                      protocol: tcp
                      subnets:
                      - string
                    subnet: string
                    type: match
                    values:
                    - string
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/wxlan_tag'
                description: WxLAN tag records returned by a list response
                examples:
                - - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    last_ips:
                    - string
                    mac: string
                    match: wlan_id
                    modified_time: 0
                    name: string
                    op: in
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    resource_mac: string
                    services:
                    - string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    specs:
                    - port_range: string
                      protocol: tcp
                      subnets:
                      - string
                    subnet: string
                    type: match
                    values:
                    - string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    last_ips:
                    - string
                    mac: string
                    match: wlan_id
                    modified_time: 0
                    name: string
                    op: in
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    resource_mac: string
                    services:
                    - string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    specs:
                    - port_range: string
                      protocol: tcp
                      subnets:
                      - string
                    subnet: string
                    type: match
                    values:
                    - string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites WxTags
      summary: createSiteWxTag
      description: Create Site WxTag
      operationId: createSiteWxTag
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/wxlan_tag'
              - description: Request Body
                examples:
                - '{"match":"app","name":"match app","type":"match","values":["gmail","dropbox"]}'
                - '{"match":"client_mac","name":"file_servers","type":"match","values":["b0c4e7001543","a0c4e7001543","00c4e7001543"]}'
                - '{"match":"hostname","name":"mist","type":"match","values":["mist.com"]}'
                - '{"match":"ip_range_subnet","name":"file_servers","type":"match","values":["10.1.2.1","10.2.3.4/24","10.1.2.5-10.2.3.4"]}'
                - '{"match":"port","name":"web-ports","type":"match","values":["80","8000","8080"]}'
                - '{"match":"psk_name","name":"VIP","type":"match","values":["test_key1","test_key2"]}'
                - '{"match":"psk_role","name":"VIP","type":"match","values":["test_role"]}'
                - '{"match":"radius_group","name":"VIP","type":"match","values":["vip"]}'
                - '{"match":"radius_username","name":"VIP","type":"match","values":["john@abc.com","eric@abc.com"]}'
                - '{"name":"protocol-subnet-port","specs":[{"port_range":"80","protocol":"tcp","subnets":["10.1.2.0/24"]}],"type":"spec"}'
                - '{"name":"vlan-assignment","type":"vlan","vlan_id":1055}'
                - '{"match":"wlan_id","name":"guest-wlan","type":"match","values":["be22bba78e22e1cf5185b880816fe2cf"]}'
              contentMediaType: application/json
            examples:
              app:
                value:
                  match: app
                  name: match app
                  type: match
                  values:
                  - gmail
                  - dropbox
              client_mac:
                value:
                  match: client_mac
                  name: file_servers
                  type: match
                  values:
                  - b0c4e7001543
                  - a0c4e7001543
                  - 00c4e7001543
              hostnames:
                value:
                  match: hostname
                  name: mist
                  type: match
                  values:
                  - mist.com
              ip_range_subnets:
                value:
                  match: ip_range_subnet
                  name: file_servers
                  type: match
                  values:
                  - 10.1.2.1
                  - 10.2.3.4/24
                  - 10.1.2.5-10.2.3.4
              ports:
                value:
                  match: port
                  name: web-ports
                  type: match
                  values:
                  - '80'
                  - '8000'
                  - '8080'
              psk_name:
                value:
                  match: psk_name
                  name: VIP
                  type: match
                  values:
                  - test_key1
                  - test_key2
              psk_role:
                value:
                  match: psk_role
                  name: VIP
                  type: match
                  values:
                  - test_role
              radius_group:
                value:
                  match: radius_group
                  name: VIP
                  type: match
                  values:
                  - vip
              radius_username:
                value:
                  match: radius_username
                  name: VIP
                  type: match
                  values:
                  - john@abc.com
                  - eric@abc.com
              traffic-spec:
                value:
                  name: protocol-subnet-port
                  specs:
                  - port_range: '80'
                    protocol: tcp
                    subnets:
                    - 10.1.2.0/24
                  type: spec
              vlan:
                value:
                  name: vlan-assignment
                  type: vlan
                  vlan_id: 1055
              wlan_id:
                value:
                  match: wlan_id
                  name: guest-wlan
                  type: match
                  values:
                  - be22bba78e22e1cf5185b880816fe2cf
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_tag'
                - description: >-
                    WxLAN Tag
                      * type:
                        * client: created manually (e.g. on wireless client table, when they spot a device of interest, they can create a wxlan tag for it
                        * resource: created automatically when we discover a network resource
                        * subnet: create automatically when a subnet is discovered
                      * match:
                        * wlan_id, ap_id: values are a list of Wlan / Device ids
                        * client_mac: values are a list of MAC addresses
                      * radius_group: this is a smart tag that matches RADIUS-Filter-ID, Airespace-ACL-Name (VendorID=14179, VendorType=6) / Aruba-User-Role (VendorID=14823, VendorType=1)
                      * radius_username: this matches the ATTR-User-Name(1)
                      * radius_class: the matches the ATTR-Class(25)
                      * radius_attr: the values are [ "6=1" , "26=10.2.3.4" ], this support other RADIUS attributes where we know the type
                      * radius_vendor: the values are [ "14179.10=1" , "14178.16=1.2.3.4" ], this matches vendor attributes and will be dynamically evaluated
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    last_ips:
                    - string
                    mac: string
                    match: wlan_id
                    modified_time: 0
                    name: string
                    op: in
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    resource_mac: string
                    services:
                    - string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    specs:
                    - port_range: string
                      protocol: tcp
                      subnets:
                      - string
                    subnet: string
                    type: match
                    values:
                    - string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    last_ips:
                    - string
                    mac: string
                    match: wlan_id
                    modified_time: 0
                    name: string
                    op: in
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    resource_mac: string
                    services:
                    - string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    specs:
                    - port_range: string
                      protocol: tcp
                      subnets:
                      - string
                    subnet: string
                    type: match
                    values:
                    - string
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_tag'
                - description: >-
                    WxLAN Tag
                      * type:
                        * client: created manually (e.g. on wireless client table, when they spot a device of interest, they can create a wxlan tag for it
                        * resource: created automatically when we discover a network resource
                        * subnet: create automatically when a subnet is discovered
                      * match:
                        * wlan_id, ap_id: values are a list of Wlan / Device ids
                        * client_mac: values are a list of MAC addresses
                      * radius_group: this is a smart tag that matches RADIUS-Filter-ID, Airespace-ACL-Name (VendorID=14179, VendorType=6) / Aruba-User-Role (VendorID=14823, VendorType=1)
                      * radius_username: this matches the ATTR-User-Name(1)
                      * radius_class: the matches the ATTR-Class(25)
                      * radius_attr: the values are [ "6=1" , "26=10.2.3.4" ], this support other RADIUS attributes where we know the type
                      * radius_vendor: the values are [ "14179.10=1" , "14178.16=1.2.3.4" ], this matches vendor attributes and will be dynamically evaluated
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    last_ips:
                    - string
                    mac: string
                    match: wlan_id
                    modified_time: 0
                    name: string
                    op: in
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    resource_mac: string
                    services:
                    - string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    specs:
                    - port_range: string
                      protocol: tcp
                      subnets:
                      - string
                    subnet: string
                    type: match
                    values:
                    - string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    last_ips:
                    - string
                    mac: string
                    match: wlan_id
                    modified_time: 0
                    name: string
                    op: in
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    resource_mac: string
                    services:
                    - string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    specs:
                    - port_range: string
                      protocol: tcp
                      subnets:
                      - string
                    subnet: string
                    type: match
                    values:
                    - string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/wxtags/apps:
    get:
      tags:
      - Sites WxTags
      summary: getSiteApplicationList
      description: Get Application List
      operationId: getSiteApplicationList
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: List of Applications
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/search_wxtag_apps_item'
                description: Applications that can be referenced by WxTag rules
                examples:
                - - group: Emails
                    key: gmail
                    name: Gmail - web/app
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - group: Emails
                    key: gmail
                    name: Gmail - web/app
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/search_wxtag_apps_item'
                description: Applications that can be referenced by WxTag rules
                examples:
                - - group: Emails
                    key: gmail
                    name: Gmail - web/app
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - group: Emails
                    key: gmail
                    name: Gmail - web/app
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/wxtags/{wxtag_id}:
    delete:
      tags:
      - Sites WxTags
      summary: deleteSiteWxTag
      description: Delete Site WxTag
      operationId: deleteSiteWxTag
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wxtag_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Sites WxTags
      summary: getSiteWxTag
      description: Get Site WxTag Details
      operationId: getSiteWxTag
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wxtag_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_tag'
                - description: >-
                    WxLAN Tag
                      * type:
                        * client: created manually (e.g. on wireless client table, when they spot a device of interest, they can create a wxlan tag for it
                        * resource: created automatically when we discover a network resource
                        * subnet: create automatically when a subnet is discovered
                      * match:
                        * wlan_id, ap_id: values are a list of Wlan / Device ids
                        * client_mac: values are a list of MAC addresses
                      * radius_group: this is a smart tag that matches RADIUS-Filter-ID, Airespace-ACL-Name (VendorID=14179, VendorType=6) / Aruba-User-Role (VendorID=14823, VendorType=1)
                      * radius_username: this matches the ATTR-User-Name(1)
                      * radius_class: the matches the ATTR-Class(25)
                      * radius_attr: the values are [ "6=1" , "26=10.2.3.4" ], this support other RADIUS attributes where we know the type
                      * radius_vendor: the values are [ "14179.10=1" , "14178.16=1.2.3.4" ], this matches vendor attributes and will be dynamically evaluated
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    last_ips:
                    - string
                    mac: string
                    match: wlan_id
                    modified_time: 0
                    name: string
                    op: in
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    resource_mac: string
                    services:
                    - string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    specs:
                    - port_range: string
                      protocol: tcp
                      subnets:
                      - string
                    subnet: string
                    type: match
                    values:
                    - string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    last_ips:
                    - string
                    mac: string
                    match: wlan_id
                    modified_time: 0
                    name: string
                    op: in
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    resource_mac: string
                    services:
                    - string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    specs:
                    - port_range: string
                      protocol: tcp
                      subnets:
                      - string
                    subnet: string
                    type: match
                    values:
                    - string
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_tag'
                - description: >-
                    WxLAN Tag
                      * type:
                        * client: created manually (e.g. on wireless client table, when they spot a device of interest, they can create a wxlan tag for it
                        * resource: created automatically when we discover a network resource
                        * subnet: create automatically when a subnet is discovered
                      * match:
                        * wlan_id, ap_id: values are a list of Wlan / Device ids
                        * client_mac: values are a list of MAC addresses
                      * radius_group: this is a smart tag that matches RADIUS-Filter-ID, Airespace-ACL-Name (VendorID=14179, VendorType=6) / Aruba-User-Role (VendorID=14823, VendorType=1)
                      * radius_username: this matches the ATTR-User-Name(1)
                      * radius_class: the matches the ATTR-Class(25)
                      * radius_attr: the values are [ "6=1" , "26=10.2.3.4" ], this support other RADIUS attributes where we know the type
                      * radius_vendor: the values are [ "14179.10=1" , "14178.16=1.2.3.4" ], this matches vendor attributes and will be dynamically evaluated
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    last_ips:
                    - string
                    mac: string
                    match: wlan_id
                    modified_time: 0
                    name: string
                    op: in
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    resource_mac: string
                    services:
                    - string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    specs:
                    - port_range: string
                      protocol: tcp
                      subnets:
                      - string
                    subnet: string
                    type: match
                    values:
                    - string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    last_ips:
                    - string
                    mac: string
                    match: wlan_id
                    modified_time: 0
                    name: string
                    op: in
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    resource_mac: string
                    services:
                    - string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    specs:
                    - port_range: string
                      protocol: tcp
                      subnets:
                      - string
                    subnet: string
                    type: match
                    values:
                    - string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Sites WxTags
      summary: updateSiteWxTag
      description: Update Site WxTag
      operationId: updateSiteWxTag
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wxtag_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/wxlan_tag'
              - description: Request Body
                examples:
                - '{"match":"app","name":"match app","type":"match","values":["gmail","dropbox"]}'
                - '{"match":"client_mac","name":"file_servers","type":"match","values":["b0c4e7001543","a0c4e7001543","00c4e7001543"]}'
                - '{"match":"hostname","name":"mist","type":"match","values":["mist.com"]}'
                - '{"match":"ip_range_subnet","name":"file_servers","type":"match","values":["10.1.2.1","10.2.3.4/24","10.1.2.5-10.2.3.4"]}'
                - '{"match":"port","name":"web-ports","type":"match","values":["80","8000","8080"]}'
                - '{"match":"psk_name","name":"VIP","type":"match","values":["test_key1","test_key2"]}'
                - '{"match":"psk_role","name":"VIP","type":"match","values":["test_role"]}'
                - '{"match":"radius_group","name":"VIP","type":"match","values":["vip"]}'
                - '{"match":"radius_username","name":"VIP","type":"match","values":["john@abc.com","eric@abc.com"]}'
                - '{"name":"protocol-subnet-port","specs":[{"port_range":"80","protocol":"tcp","subnets":["10.1.2.0/24"]}],"type":"spec"}'
                - '{"name":"vlan-assignment","type":"vlan","vlan_id":1055}'
                - '{"match":"wlan_id","name":"guest-wlan","type":"match","values":["be22bba78e22e1cf5185b880816fe2cf"]}'
              contentMediaType: application/json
            examples:
              app:
                value:
                  match: app
                  name: match app
                  type: match
                  values:
                  - gmail
                  - dropbox
              client_mac:
                value:
                  match: client_mac
                  name: file_servers
                  type: match
                  values:
                  - b0c4e7001543
                  - a0c4e7001543
                  - 00c4e7001543
              hostnames:
                value:
                  match: hostname
                  name: mist
                  type: match
                  values:
                  - mist.com
              ip_range_subnets:
                value:
                  match: ip_range_subnet
                  name: file_servers
                  type: match
                  values:
                  - 10.1.2.1
                  - 10.2.3.4/24
                  - 10.1.2.5-10.2.3.4
              ports:
                value:
                  match: port
                  name: web-ports
                  type: match
                  values:
                  - '80'
                  - '8000'
                  - '8080'
              psk_name:
                value:
                  match: psk_name
                  name: VIP
                  type: match
                  values:
                  - test_key1
                  - test_key2
              psk_role:
                value:
                  match: psk_role
                  name: VIP
                  type: match
                  values:
                  - test_role
              radius_group:
                value:
                  match: radius_group
                  name: VIP
                  type: match
                  values:
                  - vip
              radius_username:
                value:
                  match: radius_username
                  name: VIP
                  type: match
                  values:
                  - john@abc.com
                  - eric@abc.com
              traffic-spec:
                value:
                  name: protocol-subnet-port
                  specs:
                  - port_range: '80'
                    protocol: tcp
                    subnets:
                    - 10.1.2.0/24
                  type: spec
              vlan:
                value:
                  name: vlan-assignment
                  type: vlan
                  vlan_id: 1055
              wlan_id:
                value:
                  match: wlan_id
                  name: guest-wlan
                  type: match
                  values:
                  - be22bba78e22e1cf5185b880816fe2cf
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_tag'
                - description: >-
                    WxLAN Tag
                      * type:
                        * client: created manually (e.g. on wireless client table, when they spot a device of interest, they can create a wxlan tag for it
                        * resource: created automatically when we discover a network resource
                        * subnet: create automatically when a subnet is discovered
                      * match:
                        * wlan_id, ap_id: values are a list of Wlan / Device ids
                        * client_mac: values are a list of MAC addresses
                      * radius_group: this is a smart tag that matches RADIUS-Filter-ID, Airespace-ACL-Name (VendorID=14179, VendorType=6) / Aruba-User-Role (VendorID=14823, VendorType=1)
                      * radius_username: this matches the ATTR-User-Name(1)
                      * radius_class: the matches the ATTR-Class(25)
                      * radius_attr: the values are [ "6=1" , "26=10.2.3.4" ], this support other RADIUS attributes where we know the type
                      * radius_vendor: the values are [ "14179.10=1" , "14178.16=1.2.3.4" ], this matches vendor attributes and will be dynamically evaluated
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    last_ips:
                    - string
                    mac: string
                    match: wlan_id
                    modified_time: 0
                    name: string
                    op: in
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    resource_mac: string
                    services:
                    - string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    specs:
                    - port_range: string
                      protocol: tcp
                      subnets:
                      - string
                    subnet: string
                    type: match
                    values:
                    - string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    last_ips:
                    - string
                    mac: string
                    match: wlan_id
                    modified_time: 0
                    name: string
                    op: in
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    resource_mac: string
                    services:
                    - string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    specs:
                    - port_range: string
                      protocol: tcp
                      subnets:
                      - string
                    subnet: string
                    type: match
                    values:
                    - string
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_tag'
                - description: >-
                    WxLAN Tag
                      * type:
                        * client: created manually (e.g. on wireless client table, when they spot a device of interest, they can create a wxlan tag for it
                        * resource: created automatically when we discover a network resource
                        * subnet: create automatically when a subnet is discovered
                      * match:
                        * wlan_id, ap_id: values are a list of Wlan / Device ids
                        * client_mac: values are a list of MAC addresses
                      * radius_group: this is a smart tag that matches RADIUS-Filter-ID, Airespace-ACL-Name (VendorID=14179, VendorType=6) / Aruba-User-Role (VendorID=14823, VendorType=1)
                      * radius_username: this matches the ATTR-User-Name(1)
                      * radius_class: the matches the ATTR-Class(25)
                      * radius_attr: the values are [ "6=1" , "26=10.2.3.4" ], this support other RADIUS attributes where we know the type
                      * radius_vendor: the values are [ "14179.10=1" , "14178.16=1.2.3.4" ], this matches vendor attributes and will be dynamically evaluated
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    last_ips:
                    - string
                    mac: string
                    match: wlan_id
                    modified_time: 0
                    name: string
                    op: in
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    resource_mac: string
                    services:
                    - string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    specs:
                    - port_range: string
                      protocol: tcp
                      subnets:
                      - string
                    subnet: string
                    type: match
                    values:
                    - string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    last_ips:
                    - string
                    mac: string
                    match: wlan_id
                    modified_time: 0
                    name: string
                    op: in
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    resource_mac: string
                    services:
                    - string
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    specs:
                    - port_range: string
                      protocol: tcp
                      subnets:
                      - string
                    subnet: string
                    type: match
                    values:
                    - string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/wxtunnels:
    get:
      tags:
      - Sites WxTunnels
      summary: listSiteWxTunnels
      description: Get List of Site WxLan Tunnels
      operationId: listSiteWxTunnels
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/wxlan_tunnel'
                description: WxLAN tunnel records returned by a list response
                examples:
                - - created_time: 0
                    dmvpn:
                      enabled: true
                      holding_time: 0
                      host_routes:
                      - string
                    for_mgmt: true
                    hello_interval: 1
                    hello_retries: 3
                    hostname: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      enabled: true
                      psk: string123
                    is_static: true
                    modified_time: 0
                    mtu: 1500
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    peers:
                    - string
                    router_id: string
                    secret: string
                    sessions:
                    - ap_as_session_id: string
                      comment: string
                      enable_cookie: true
                      ethertype: ethernet
                      local_session_id: 1
                      pseudo_802.1ad_enabled: true
                      remote_id: string
                      remote_session_id: 1
                      use_ap_as_session_ids: true
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    udp_port: 0
                    use_udp: true
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 0
                    dmvpn:
                      enabled: true
                      holding_time: 0
                      host_routes:
                      - string
                    for_mgmt: true
                    hello_interval: 1
                    hello_retries: 3
                    hostname: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      enabled: true
                      psk: string123
                    is_static: true
                    modified_time: 0
                    mtu: 1500
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    peers:
                    - string
                    router_id: string
                    secret: string
                    sessions:
                    - ap_as_session_id: string
                      comment: string
                      enable_cookie: true
                      ethertype: ethernet
                      local_session_id: 1
                      pseudo_802.1ad_enabled: true
                      remote_id: string
                      remote_session_id: 1
                      use_ap_as_session_ids: true
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    udp_port: 0
                    use_udp: true
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/wxlan_tunnel'
                description: WxLAN tunnel records returned by a list response
                examples:
                - - created_time: 0
                    dmvpn:
                      enabled: true
                      holding_time: 0
                      host_routes:
                      - string
                    for_mgmt: true
                    hello_interval: 1
                    hello_retries: 3
                    hostname: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      enabled: true
                      psk: string123
                    is_static: true
                    modified_time: 0
                    mtu: 1500
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    peers:
                    - string
                    router_id: string
                    secret: string
                    sessions:
                    - ap_as_session_id: string
                      comment: string
                      enable_cookie: true
                      ethertype: ethernet
                      local_session_id: 1
                      pseudo_802.1ad_enabled: true
                      remote_id: string
                      remote_session_id: 1
                      use_ap_as_session_ids: true
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    udp_port: 0
                    use_udp: true
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 0
                    dmvpn:
                      enabled: true
                      holding_time: 0
                      host_routes:
                      - string
                    for_mgmt: true
                    hello_interval: 1
                    hello_retries: 3
                    hostname: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      enabled: true
                      psk: string123
                    is_static: true
                    modified_time: 0
                    mtu: 1500
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    peers:
                    - string
                    router_id: string
                    secret: string
                    sessions:
                    - ap_as_session_id: string
                      comment: string
                      enable_cookie: true
                      ethertype: ethernet
                      local_session_id: 1
                      pseudo_802.1ad_enabled: true
                      remote_id: string
                      remote_session_id: 1
                      use_ap_as_session_ids: true
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    udp_port: 0
                    use_udp: true
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites WxTunnels
      summary: createSiteWxTunnel
      description: Create Site WxLan Tunnel
      operationId: createSiteWxTunnel
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/wxlan_tunnel'
              - description: Request Body
                examples:
                - dmvpn:
                    enabled: true
                    holding_time: 0
                    host_routes:
                    - string
                  for_mgmt: true
                  hello_interval: 1
                  hello_retries: 3
                  hostname: string
                  ipsec:
                    enabled: true
                    psk: string123
                  is_static: true
                  mtu: 1500
                  name: string
                  peers:
                  - string
                  router_id: string
                  secret: string
                  sessions:
                  - ap_as_session_id: string
                    comment: string
                    enable_cookie: true
                    ethertype: ethernet
                    local_session_id: 1
                    pseudo_802.1ad_enabled: true
                    remote_id: string
                    remote_session_id: 1
                    use_ap_as_session_ids: true
                  udp_port: 0
                  use_udp: true
              contentMediaType: application/json
            examples:
              Example:
                value:
                  dmvpn:
                    enabled: true
                    holding_time: 0
                    host_routes:
                    - string
                  for_mgmt: true
                  hello_interval: 1
                  hello_retries: 3
                  hostname: string
                  ipsec:
                    enabled: true
                    psk: string123
                  is_static: true
                  mtu: 1500
                  name: string
                  peers:
                  - string
                  router_id: string
                  secret: string
                  sessions:
                  - ap_as_session_id: string
                    comment: string
                    enable_cookie: true
                    ethertype: ethernet
                    local_session_id: 1
                    pseudo_802.1ad_enabled: true
                    remote_id: string
                    remote_session_id: 1
                    use_ap_as_session_ids: true
                  udp_port: 0
                  use_udp: true
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_tunnel'
                - description: WxLAN tunnel configuration for L2TPv3 or DMVPN connectivity
                  examples:
                  - created_time: 0
                    dmvpn:
                      enabled: true
                      holding_time: 0
                      host_routes:
                      - string
                    for_mgmt: true
                    hello_interval: 1
                    hello_retries: 3
                    hostname: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      enabled: true
                      psk: string123
                    is_static: true
                    modified_time: 0
                    mtu: 1500
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    peers:
                    - string
                    router_id: string
                    secret: string
                    sessions:
                    - ap_as_session_id: string
                      comment: string
                      enable_cookie: true
                      ethertype: ethernet
                      local_session_id: 1
                      pseudo_802.1ad_enabled: true
                      remote_id: string
                      remote_session_id: 1
                      use_ap_as_session_ids: true
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    udp_port: 0
                    use_udp: true
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    dmvpn:
                      enabled: true
                      holding_time: 0
                      host_routes:
                      - string
                    for_mgmt: true
                    hello_interval: 1
                    hello_retries: 3
                    hostname: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      enabled: true
                      psk: string123
                    is_static: true
                    modified_time: 0
                    mtu: 1500
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    peers:
                    - string
                    router_id: string
                    secret: string
                    sessions:
                    - ap_as_session_id: string
                      comment: string
                      enable_cookie: true
                      ethertype: ethernet
                      local_session_id: 1
                      pseudo_802.1ad_enabled: true
                      remote_id: string
                      remote_session_id: 1
                      use_ap_as_session_ids: true
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    udp_port: 0
                    use_udp: true
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_tunnel'
                - description: WxLAN tunnel configuration for L2TPv3 or DMVPN connectivity
                  examples:
                  - created_time: 0
                    dmvpn:
                      enabled: true
                      holding_time: 0
                      host_routes:
                      - string
                    for_mgmt: true
                    hello_interval: 1
                    hello_retries: 3
                    hostname: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      enabled: true
                      psk: string123
                    is_static: true
                    modified_time: 0
                    mtu: 1500
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    peers:
                    - string
                    router_id: string
                    secret: string
                    sessions:
                    - ap_as_session_id: string
                      comment: string
                      enable_cookie: true
                      ethertype: ethernet
                      local_session_id: 1
                      pseudo_802.1ad_enabled: true
                      remote_id: string
                      remote_session_id: 1
                      use_ap_as_session_ids: true
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    udp_port: 0
                    use_udp: true
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    dmvpn:
                      enabled: true
                      holding_time: 0
                      host_routes:
                      - string
                    for_mgmt: true
                    hello_interval: 1
                    hello_retries: 3
                    hostname: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      enabled: true
                      psk: string123
                    is_static: true
                    modified_time: 0
                    mtu: 1500
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    peers:
                    - string
                    router_id: string
                    secret: string
                    sessions:
                    - ap_as_session_id: string
                      comment: string
                      enable_cookie: true
                      ethertype: ethernet
                      local_session_id: 1
                      pseudo_802.1ad_enabled: true
                      remote_id: string
                      remote_session_id: 1
                      use_ap_as_session_ids: true
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    udp_port: 0
                    use_udp: true
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/wxtunnels/{wxtunnel_id}:
    delete:
      tags:
      - Sites WxTunnels
      summary: deleteSiteWxTunnel
      description: Delete Site WxLan Tunnel
      operationId: deleteSiteWxTunnel
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wxtunnel_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Sites WxTunnels
      summary: getSiteWxTunnel
      description: Get Site WxLan tunnel Details
      operationId: getSiteWxTunnel
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wxtunnel_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_tunnel'
                - description: WxLAN tunnel configuration for L2TPv3 or DMVPN connectivity
                  examples:
                  - created_time: 0
                    dmvpn:
                      enabled: true
                      holding_time: 0
                      host_routes:
                      - string
                    for_mgmt: true
                    hello_interval: 1
                    hello_retries: 3
                    hostname: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      enabled: true
                      psk: string123
                    is_static: true
                    modified_time: 0
                    mtu: 1500
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    peers:
                    - string
                    router_id: string
                    secret: string
                    sessions:
                    - ap_as_session_id: string
                      comment: string
                      enable_cookie: true
                      ethertype: ethernet
                      local_session_id: 1
                      pseudo_802.1ad_enabled: true
                      remote_id: string
                      remote_session_id: 1
                      use_ap_as_session_ids: true
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    udp_port: 0
                    use_udp: true
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    dmvpn:
                      enabled: true
                      holding_time: 0
                      host_routes:
                      - string
                    for_mgmt: true
                    hello_interval: 1
                    hello_retries: 3
                    hostname: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      enabled: true
                      psk: string123
                    is_static: true
                    modified_time: 0
                    mtu: 1500
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    peers:
                    - string
                    router_id: string
                    secret: string
                    sessions:
                    - ap_as_session_id: string
                      comment: string
                      enable_cookie: true
                      ethertype: ethernet
                      local_session_id: 1
                      pseudo_802.1ad_enabled: true
                      remote_id: string
                      remote_session_id: 1
                      use_ap_as_session_ids: true
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    udp_port: 0
                    use_udp: true
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_tunnel'
                - description: WxLAN tunnel configuration for L2TPv3 or DMVPN connectivity
                  examples:
                  - created_time: 0
                    dmvpn:
                      enabled: true
                      holding_time: 0
                      host_routes:
                      - string
                    for_mgmt: true
                    hello_interval: 1
                    hello_retries: 3
                    hostname: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      enabled: true
                      psk: string123
                    is_static: true
                    modified_time: 0
                    mtu: 1500
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    peers:
                    - string
                    router_id: string
                    secret: string
                    sessions:
                    - ap_as_session_id: string
                      comment: string
                      enable_cookie: true
                      ethertype: ethernet
                      local_session_id: 1
                      pseudo_802.1ad_enabled: true
                      remote_id: string
                      remote_session_id: 1
                      use_ap_as_session_ids: true
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    udp_port: 0
                    use_udp: true
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    dmvpn:
                      enabled: true
                      holding_time: 0
                      host_routes:
                      - string
                    for_mgmt: true
                    hello_interval: 1
                    hello_retries: 3
                    hostname: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      enabled: true
                      psk: string123
                    is_static: true
                    modified_time: 0
                    mtu: 1500
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    peers:
                    - string
                    router_id: string
                    secret: string
                    sessions:
                    - ap_as_session_id: string
                      comment: string
                      enable_cookie: true
                      ethertype: ethernet
                      local_session_id: 1
                      pseudo_802.1ad_enabled: true
                      remote_id: string
                      remote_session_id: 1
                      use_ap_as_session_ids: true
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    udp_port: 0
                    use_udp: true
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Sites WxTunnels
      summary: updateSiteWxTunnel
      description: Update Site WxLan Tunnel
      operationId: updateSiteWxTunnel
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wxtunnel_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/wxlan_tunnel'
              - description: Request Body
                examples:
                - dmvpn:
                    enabled: true
                    holding_time: 0
                    host_routes:
                    - string
                  for_mgmt: true
                  hello_interval: 1
                  hello_retries: 3
                  hostname: string
                  ipsec:
                    enabled: true
                    psk: string123
                  is_static: true
                  mtu: 1500
                  name: string
                  peers:
                  - string
                  router_id: string
                  secret: string
                  sessions:
                  - ap_as_session_id: string
                    comment: string
                    enable_cookie: true
                    ethertype: ethernet
                    local_session_id: 1
                    pseudo_802.1ad_enabled: true
                    remote_id: string
                    remote_session_id: 1
                    use_ap_as_session_ids: true
                  udp_port: 0
                  use_udp: true
              contentMediaType: application/json
            examples:
              Example:
                value:
                  dmvpn:
                    enabled: true
                    holding_time: 0
                    host_routes:
                    - string
                  for_mgmt: true
                  hello_interval: 1
                  hello_retries: 3
                  hostname: string
                  ipsec:
                    enabled: true
                    psk: string123
                  is_static: true
                  mtu: 1500
                  name: string
                  peers:
                  - string
                  router_id: string
                  secret: string
                  sessions:
                  - ap_as_session_id: string
                    comment: string
                    enable_cookie: true
                    ethertype: ethernet
                    local_session_id: 1
                    pseudo_802.1ad_enabled: true
                    remote_id: string
                    remote_session_id: 1
                    use_ap_as_session_ids: true
                  udp_port: 0
                  use_udp: true
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_tunnel'
                - description: WxLAN tunnel configuration for L2TPv3 or DMVPN connectivity
                  examples:
                  - created_time: 0
                    dmvpn:
                      enabled: true
                      holding_time: 0
                      host_routes:
                      - string
                    for_mgmt: true
                    hello_interval: 1
                    hello_retries: 3
                    hostname: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      enabled: true
                      psk: string123
                    is_static: true
                    modified_time: 0
                    mtu: 1500
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    peers:
                    - string
                    router_id: string
                    secret: string
                    sessions:
                    - ap_as_session_id: string
                      comment: string
                      enable_cookie: true
                      ethertype: ethernet
                      local_session_id: 1
                      pseudo_802.1ad_enabled: true
                      remote_id: string
                      remote_session_id: 1
                      use_ap_as_session_ids: true
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    udp_port: 0
                    use_udp: true
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    dmvpn:
                      enabled: true
                      holding_time: 0
                      host_routes:
                      - string
                    for_mgmt: true
                    hello_interval: 1
                    hello_retries: 3
                    hostname: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      enabled: true
                      psk: string123
                    is_static: true
                    modified_time: 0
                    mtu: 1500
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    peers:
                    - string
                    router_id: string
                    secret: string
                    sessions:
                    - ap_as_session_id: string
                      comment: string
                      enable_cookie: true
                      ethertype: ethernet
                      local_session_id: 1
                      pseudo_802.1ad_enabled: true
                      remote_id: string
                      remote_session_id: 1
                      use_ap_as_session_ids: true
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    udp_port: 0
                    use_udp: true
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/wxlan_tunnel'
                - description: WxLAN tunnel configuration for L2TPv3 or DMVPN connectivity
                  examples:
                  - created_time: 0
                    dmvpn:
                      enabled: true
                      holding_time: 0
                      host_routes:
                      - string
                    for_mgmt: true
                    hello_interval: 1
                    hello_retries: 3
                    hostname: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      enabled: true
                      psk: string123
                    is_static: true
                    modified_time: 0
                    mtu: 1500
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    peers:
                    - string
                    router_id: string
                    secret: string
                    sessions:
                    - ap_as_session_id: string
                      comment: string
                      enable_cookie: true
                      ethertype: ethernet
                      local_session_id: 1
                      pseudo_802.1ad_enabled: true
                      remote_id: string
                      remote_session_id: 1
                      use_ap_as_session_ids: true
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    udp_port: 0
                    use_udp: true
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    dmvpn:
                      enabled: true
                      holding_time: 0
                      host_routes:
                      - string
                    for_mgmt: true
                    hello_interval: 1
                    hello_retries: 3
                    hostname: string
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    ipsec:
                      enabled: true
                      psk: string123
                    is_static: true
                    modified_time: 0
                    mtu: 1500
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    peers:
                    - string
                    router_id: string
                    secret: string
                    sessions:
                    - ap_as_session_id: string
                      comment: string
                      enable_cookie: true
                      ethertype: ethernet
                      local_session_id: 1
                      pseudo_802.1ad_enabled: true
                      remote_id: string
                      remote_session_id: 1
                      use_ap_as_session_ids: true
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    udp_port: 0
                    use_udp: true
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/zones:
    get:
      tags:
      - Sites Zones
      summary: listSiteZones
      description: Get List of Site Zones
      operationId: listSiteZones
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/zone'
                description: Zone records returned by a list response
                examples:
                - - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    vertices:
                    - x: 0
                      y: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    vertices:
                    - x: 0
                      y: 0
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/zone'
                description: Zone records returned by a list response
                examples:
                - - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    vertices:
                    - x: 0
                      y: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    vertices:
                    - x: 0
                      y: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Sites Zones
      summary: createSiteZone
      description: Create Site Zone
      operationId: createSiteZone
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/zone'
              - description: Request Body
                examples:
                - name: string
                  vertices:
                  - x: 0
                    y: 0
              contentMediaType: application/json
            examples:
              Example:
                value:
                  name: string
                  vertices:
                  - x: 0
                    y: 0
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone'
                - description: Zone defined on a site map
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    vertices:
                    - x: 0
                      y: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    vertices:
                    - x: 0
                      y: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone'
                - description: Zone defined on a site map
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    vertices:
                    - x: 0
                      y: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    vertices:
                    - x: 0
                      y: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/zones/{zone_id}:
    delete:
      tags:
      - Sites Zones
      summary: deleteSiteZone
      description: Delete Site Zone
      operationId: deleteSiteZone
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: zone_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Sites Zones
      summary: getSiteZone
      description: Get Site Zone Details
      operationId: getSiteZone
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: zone_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone'
                - description: Zone defined on a site map
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    vertices:
                    - x: 0
                      y: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    vertices:
                    - x: 0
                      y: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone'
                - description: Zone defined on a site map
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    vertices:
                    - x: 0
                      y: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    vertices:
                    - x: 0
                      y: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Sites Zones
      summary: updateSiteZone
      description: Update Site Zone
      operationId: updateSiteZone
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: zone_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/zone'
              - description: Request Body
                examples:
                - name: string
                  vertices:
                  - x: 0
                    y: 0
              contentMediaType: application/json
            examples:
              Example:
                value:
                  name: string
                  vertices:
                  - x: 0
                    y: 0
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone'
                - description: Zone defined on a site map
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    vertices:
                    - x: 0
                      y: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    vertices:
                    - x: 0
                      y: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone'
                - description: Zone defined on a site map
                  examples:
                  - created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    vertices:
                    - x: 0
                      y: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 0
                    id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    modified_time: 0
                    name: string
                    org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    vertices:
                    - x: 0
                      y: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/{zone_type}/count:
    get:
      tags:
      - Sites Zones
      summary: countSiteZoneSessions
      description: Count by Distinct Attributes of Site Zone Sessions
      operationId: countSiteZoneSessions
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: zone_type
        in: path
        description: ''
        required: true
        schema:
          $ref: '#/components/schemas/zone_type'
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `scope`, `scope_id`, `user`, `user_type`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/site_zone_count_distinct'
          - description: 'Field used to group this count response. enum: `scope`, `scope_id`, `user`, `user_type`'
            examples:
            - scope_id
      - name: user_type
        in: query
        description: 'Filter results by user type. enum: `asset`, `client`, `sdkclient`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/rf_client_type'
          - description: 'Filter results by user type. enum: `asset`, `client`, `sdkclient`'
      - name: user
        in: query
        description: Client MAC / Asset MAC / SDK UUID
        style: form
        explode: true
        schema:
          type: string
          examples:
          - b0c4e7001543
      - name: scope_id
        in: query
        description: If `scope`==`map`/`zone`/`rssizone`, the scope id
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 8bfc2490-d726-3587-038d-cb2e71bd2330
      - name: scope
        in: query
        description: 'Filter results by scope. enum: `map`, `rssizone`, `site`, `zone`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/zone_scope'
          - description: 'Filter results by scope. enum: `map`, `rssizone`, `site`, `zone`'
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/{zone_type}/visits/search:
    get:
      tags:
      - Sites Zones
      summary: searchSiteZoneSessions
      description: Search Zone Sessions
      operationId: searchSiteZoneSessions
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: zone_type
        in: path
        description: ''
        required: true
        schema:
          $ref: '#/components/schemas/zone_type'
      - name: user_type
        in: query
        description: 'Filter results by user type. enum: `asset`, `client`, `sdkclient`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/rf_client_type'
          - description: 'Filter results by user type. enum: `asset`, `client`, `sdkclient`'
      - name: user
        in: query
        description: Client MAC / Asset MAC / SDK UUID
        style: form
        explode: true
        schema:
          type: string
          examples:
          - b0c4e7001543
      - name: scope_id
        in: query
        description: If `scope`==`map`/`zone`/`rssizone`, the scope id
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 8bfc2490-d726-3587-038d-cb2e71bd2330
      - name: scope
        in: query
        description: 'Filter results by scope. enum: `map`, `rssizone`, `site`, `zone`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/visits_scope'
          - description: 'Filter results by scope. enum: `map`, `rssizone`, `site`, `zone`'
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Result of Search Zone Sessions
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_zone_search'
                - description: Paginated response for site zone visit search results
                  examples:
                  - end: 1541705289.769911
                    limit: 1
                    next: /api/v1/sites/67970e46-4e12-11e6-9188-0242ac110007/zones/visits/search?limit=2&end=1541705247.000&scope_id=85fbba9e-4e12-11e6-9188-0242ac110007&user_type=asset&start=1541618889.77
                    results:
                    - enter: 1541705254
                      scope: map
                      timestamp: 1541705254
                      user: c4b301c81166
                    start: 1541618889.769886
                    total: 5892
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1541705289.769911
                    limit: 1
                    next: /api/v1/sites/67970e46-4e12-11e6-9188-0242ac110007/zones/visits/search?limit=2&end=1541705247.000&scope_id=85fbba9e-4e12-11e6-9188-0242ac110007&user_type=asset&start=1541618889.77
                    results:
                    - enter: 1541705254
                      scope: map
                      timestamp: 1541705254
                      user: c4b301c81166
                    start: 1541618889.769886
                    total: 5892
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_zone_search'
                - description: Paginated response for site zone visit search results
                  examples:
                  - end: 1541705289.769911
                    limit: 1
                    next: /api/v1/sites/67970e46-4e12-11e6-9188-0242ac110007/zones/visits/search?limit=2&end=1541705247.000&scope_id=85fbba9e-4e12-11e6-9188-0242ac110007&user_type=asset&start=1541618889.77
                    results:
                    - enter: 1541705254
                      scope: map
                      timestamp: 1541705254
                      user: c4b301c81166
                    start: 1541618889.769886
                    total: 5892
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1541705289.769911
                    limit: 1
                    next: /api/v1/sites/67970e46-4e12-11e6-9188-0242ac110007/zones/visits/search?limit=2&end=1541705247.000&scope_id=85fbba9e-4e12-11e6-9188-0242ac110007&user_type=asset&start=1541618889.77
                    results:
                    - enter: 1541705254
                      scope: map
                      timestamp: 1541705254
                      user: c4b301c81166
                    start: 1541618889.769886
                    total: 5892
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats:
    get:
      tags:
      - Sites Stats
      summary: getSiteStats
      description: Get Sites Stats
      operationId: getSiteStats
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/stats_site'
                - description: Site metadata and aggregate device/client counts returned by organization site stats endpoints
                  examples:
                  - address: string
                    alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    country_code: string
                    created_time: 0
                    id: 55c29ce5-7c0f-45b5-b99b-599f805fa3a1
                    lat: 0
                    latlng:
                      lat: 0
                      lng: 0
                    lng: 0
                    modified_time: 0
                    msp_id: dca3cad3-0c9b-439b-814f-8d5f23797972
                    name: string
                    networktemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    num_ap: 0
                    num_ap_connected: 0
                    num_clients: 0
                    num_devices: 0
                    num_devices_connected: 0
                    num_gateway: 0
                    num_gateway_connected: 0
                    num_switch: 0
                    num_switch_connected: 0
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    rftemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    sitegroup_ids:
                    - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                    timezone: string
                    tzoffset: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    address: string
                    alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    country_code: string
                    created_time: 0
                    id: 55c29ce5-7c0f-45b5-b99b-599f805fa3a1
                    lat: 0
                    latlng:
                      lat: 0
                      lng: 0
                    lng: 0
                    modified_time: 0
                    msp_id: dca3cad3-0c9b-439b-814f-8d5f23797972
                    name: string
                    networktemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    num_ap: 0
                    num_ap_connected: 0
                    num_clients: 0
                    num_devices: 0
                    num_devices_connected: 0
                    num_gateway: 0
                    num_gateway_connected: 0
                    num_switch: 0
                    num_switch_connected: 0
                    org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                    rftemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    sitegroup_ids:
                    - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                    timezone: string
                    tzoffset: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/apps/count:
    get:
      tags:
      - Sites Stats - Apps
      summary: countSiteApps
      description: Count by Distinct Attributes of Applications
      operationId: countSiteApps
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group application statistics count results. enum: `ap`, `app`, `category`, `device_mac`, `port_id`, `service`, `src_ip`, `ssid`, `wcid`, `wlan_id`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/site_apps_count_distinct'
          - description: 'Field used to group application statistics count results. enum: `ap`, `app`, `category`, `device_mac`, `port_id`, `service`, `src_ip`, `ssid`, `wcid`, `wlan_id`'
      - name: device_mac
        in: query
        description: MAC of the device
        style: form
        explode: true
        schema:
          type: string
          examples:
          - '001122334455'
      - name: app
        in: query
        description: Filter results by application name
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Example App
      - name: wired
        in: query
        description: If a device is wired or wireless. Default is False.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 'False'
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/assets:
    get:
      tags:
      - Sites Stats - Assets
      summary: listSiteAssetsStats
      description: List asset statistics for a site over the requested time range. Use [List Org Asset Stats]($e/Orgs%20Stats%20-%20Assets/listOrgAssetsStats) to retrieve asset statistics across the organization.
      operationId: listSiteAssetsStats
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: map_id
        in: query
        description: Filter assets by map UUID
        style: form
        explode: true
        schema:
          type: string
          contentEncoding: uuid
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/stats_asset'
                description: Asset statistics returned by the request
                examples:
                - - _ttl: 86400
                    battery_voltage: 3370
                    by: asset
                    device_id: 00000000-0000-0000-1000-5c5b35000001
                    device_name: BLE Device
                    eddystone_uid_instance: 5c5b35000001
                    eddystone_uid_namespace: 2818e3868dec25629ede
                    eddystone_url_url: https://www.abc.com
                    ibeacon_major: 13
                    ibeacon_minor: 138
                    ibeacon_uuid: f3f17139-704a-f03a-2786-0400279e37c3
                    id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                    last_seen: 1480716946
                    mac: 4a0222000e31
                    manufacture: Asset Manufacturer Name
                    map_id: 63eda950-c6da-11e4-a628-60f81dd250cc
                    mfg_company_id: 935
                    mfg_data: 648520a1020000
                    name: Asset Name
                    rssi: -45
                    rssizones:
                    - id: 478f6eca-6276-4993-bfeb-5bcbbbbacf08
                      since: 0
                    service_packets:
                    - data: '640'
                      last_rx_time: 1645855923
                      rx_cnt: 213065
                      uuid: 00003e10-0000-1000-8000-00805f9b34fb
                    temperature: 23.5
                    x: 51
                    y: 29
                    zones:
                    - id: 477f6eca-6276-4993-bfeb-5ccbbbbadf08
                      since: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - _ttl: 86400
                    battery_voltage: 3370
                    by: asset
                    device_id: 00000000-0000-0000-1000-5c5b35000001
                    device_name: BLE Device
                    eddystone_uid_instance: 5c5b35000001
                    eddystone_uid_namespace: 2818e3868dec25629ede
                    eddystone_url_url: https://www.abc.com
                    ibeacon_major: 13
                    ibeacon_minor: 138
                    ibeacon_uuid: f3f17139-704a-f03a-2786-0400279e37c3
                    id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                    last_seen: 1480716946
                    mac: 4a0222000e31
                    manufacture: Asset Manufacturer Name
                    map_id: 63eda950-c6da-11e4-a628-60f81dd250cc
                    mfg_company_id: 935
                    mfg_data: 648520a1020000
                    name: Asset Name
                    rssi: -45
                    rssizones:
                    - id: 478f6eca-6276-4993-bfeb-5bcbbbbacf08
                      since: 0
                    service_packets:
                    - data: '640'
                      last_rx_time: 1645855923
                      rx_cnt: 213065
                      uuid: 00003e10-0000-1000-8000-00805f9b34fb
                    temperature: 23.5
                    x: 51
                    y: 29
                    zones:
                    - id: 477f6eca-6276-4993-bfeb-5ccbbbbadf08
                      since: 0
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/stats_asset'
                description: Asset statistics returned by the request
                examples:
                - - _ttl: 86400
                    battery_voltage: 3370
                    by: asset
                    device_id: 00000000-0000-0000-1000-5c5b35000001
                    device_name: BLE Device
                    eddystone_uid_instance: 5c5b35000001
                    eddystone_uid_namespace: 2818e3868dec25629ede
                    eddystone_url_url: https://www.abc.com
                    ibeacon_major: 13
                    ibeacon_minor: 138
                    ibeacon_uuid: f3f17139-704a-f03a-2786-0400279e37c3
                    id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                    last_seen: 1480716946
                    mac: 4a0222000e31
                    manufacture: Asset Manufacturer Name
                    map_id: 63eda950-c6da-11e4-a628-60f81dd250cc
                    mfg_company_id: 935
                    mfg_data: 648520a1020000
                    name: Asset Name
                    rssi: -45
                    rssizones:
                    - id: 478f6eca-6276-4993-bfeb-5bcbbbbacf08
                      since: 0
                    service_packets:
                    - data: '640'
                      last_rx_time: 1645855923
                      rx_cnt: 213065
                      uuid: 00003e10-0000-1000-8000-00805f9b34fb
                    temperature: 23.5
                    x: 51
                    y: 29
                    zones:
                    - id: 477f6eca-6276-4993-bfeb-5ccbbbbadf08
                      since: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - _ttl: 86400
                    battery_voltage: 3370
                    by: asset
                    device_id: 00000000-0000-0000-1000-5c5b35000001
                    device_name: BLE Device
                    eddystone_uid_instance: 5c5b35000001
                    eddystone_uid_namespace: 2818e3868dec25629ede
                    eddystone_url_url: https://www.abc.com
                    ibeacon_major: 13
                    ibeacon_minor: 138
                    ibeacon_uuid: f3f17139-704a-f03a-2786-0400279e37c3
                    id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                    last_seen: 1480716946
                    mac: 4a0222000e31
                    manufacture: Asset Manufacturer Name
                    map_id: 63eda950-c6da-11e4-a628-60f81dd250cc
                    mfg_company_id: 935
                    mfg_data: 648520a1020000
                    name: Asset Name
                    rssi: -45
                    rssizones:
                    - id: 478f6eca-6276-4993-bfeb-5bcbbbbacf08
                      since: 0
                    service_packets:
                    - data: '640'
                      last_rx_time: 1645855923
                      rx_cnt: 213065
                      uuid: 00003e10-0000-1000-8000-00805f9b34fb
                    temperature: 23.5
                    x: 51
                    y: 29
                    zones:
                    - id: 477f6eca-6276-4993-bfeb-5ccbbbbadf08
                      since: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/assets/count:
    get:
      tags:
      - Sites Stats - Assets
      summary: countSiteAssets
      description: Count by Distinct Attributes of Site Asset
      operationId: countSiteAssets
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `by`, `device_name`, `eddystone_uid_instance`, `eddystone_uid_namespace`, `eddystone_url`, `ibeacon_major`, `ibeacon_minor`, `ibeacon_uuid`, `mac`, `map_id`, `name`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/site_assets_count_distinct'
          - description: 'Field used to group this count response. enum: `by`, `device_name`, `eddystone_uid_instance`, `eddystone_uid_namespace`, `eddystone_url`, `ibeacon_major`, `ibeacon_minor`, `ibeacon_uuid`, `mac`, `map_id`, `name`'
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/assets/search:
    get:
      tags:
      - Sites Stats - Assets
      summary: searchSiteAssets
      description: Search asset statistics for a site with filters for asset identifiers, device, map, beacon, AP, RSSI, and time range. Use [Search Org Assets]($e/Orgs%20Stats%20-%20Assets/searchOrgAssets) to search asset statistics across the organization.
      operationId: searchSiteAssets
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - '001122334455'
      - name: map_id
        in: query
        description: Filter results by map identifier
        style: form
        explode: true
        schema:
          type: string
          examples:
          - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
      - name: ibeacon_uuid
        in: query
        description: Filter asset results by iBeacon UUID
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 3ce2ef69-4414-469d-9d55-3ec7fcc38520
      - name: ibeacon_major
        in: query
        description: Filter asset results by iBeacon major value
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
          examples:
          - 1
      - name: ibeacon_minor
        in: query
        description: Filter asset results by iBeacon minor value
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
          examples:
          - 1
      - name: eddystone_uid_namespace
        in: query
        description: Filter asset results by Eddystone UID namespace
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 1234567890abcdef1234567890abcdef
      - name: eddystone_uid_instance
        in: query
        description: Filter asset results by Eddystone UID instance
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 1234567890abcdef1234567890abcdef
      - name: eddystone_url
        in: query
        description: Filter asset results by Eddystone URL
        style: form
        explode: true
        schema:
          type: string
          examples:
          - https://example.com
      - name: device_name
        in: query
        description: Filter asset results by reporting device name
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Device Name
      - name: by
        in: query
        description: Select how the value should be returned
        style: form
        explode: true
        schema:
          type: string
          examples:
          - mac
      - name: name
        in: query
        description: Filter results by name
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Asset Name
      - name: ap_mac
        in: query
        description: Filter asset results by reporting AP MAC address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - '001122334455'
      - name: beam
        in: query
        description: Filter asset results by beam value
        style: form
        explode: true
        schema:
          type: string
          examples:
          - '0'
      - name: rssi
        in: query
        description: Filter asset results by RSSI value
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_stats_assets'
                - description: Paginated response for asset statistics search results
                  examples:
                  - end: 0
                    limit: 0
                    next: string
                    results:
                    - battery_voltage: 0
                      eddystone_uid_instance: string
                      eddystone_uid_namespace: string
                      eddystone_url_url: string
                      ibeacon_major: 1
                      ibeacon_minor: 1
                      ibeacon_uuid: 1f89bc00-d0af-481b-82fe-a6629259a39f
                      last_seen: 0
                      mac: string
                      map_id: 09d2b626-2e4e-45ef-a3c4-e6aeb6c83db1
                      name: string
                      rssizones:
                      - id: 476f6eca-6276-4993-bfeb-5dcbbbbaef08
                        since: 0
                      x: 0
                      y: 0
                      zones:
                      - id: 475f6eca-6276-4993-bfeb-5ecbbbbf6f08
                        since: 0
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 0
                    limit: 0
                    next: string
                    results:
                    - battery_voltage: 0
                      eddystone_uid_instance: string
                      eddystone_uid_namespace: string
                      eddystone_url_url: string
                      ibeacon_major: 1
                      ibeacon_minor: 1
                      ibeacon_uuid: 1f89bc00-d0af-481b-82fe-a6629259a39f
                      last_seen: 0
                      mac: string
                      map_id: 09d2b626-2e4e-45ef-a3c4-e6aeb6c83db1
                      name: string
                      rssizones:
                      - id: 476f6eca-6276-4993-bfeb-5dcbbbbaef08
                        since: 0
                      x: 0
                      y: 0
                      zones:
                      - id: 475f6eca-6276-4993-bfeb-5ecbbbbf6f08
                        since: 0
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_stats_assets'
                - description: Paginated response for asset statistics search results
                  examples:
                  - end: 0
                    limit: 0
                    next: string
                    results:
                    - battery_voltage: 0
                      eddystone_uid_instance: string
                      eddystone_uid_namespace: string
                      eddystone_url_url: string
                      ibeacon_major: 1
                      ibeacon_minor: 1
                      ibeacon_uuid: 1f89bc00-d0af-481b-82fe-a6629259a39f
                      last_seen: 0
                      mac: string
                      map_id: 09d2b626-2e4e-45ef-a3c4-e6aeb6c83db1
                      name: string
                      rssizones:
                      - id: 476f6eca-6276-4993-bfeb-5dcbbbbaef08
                        since: 0
                      x: 0
                      y: 0
                      zones:
                      - id: 475f6eca-6276-4993-bfeb-5ecbbbbf6f08
                        since: 0
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 0
                    limit: 0
                    next: string
                    results:
                    - battery_voltage: 0
                      eddystone_uid_instance: string
                      eddystone_uid_namespace: string
                      eddystone_url_url: string
                      ibeacon_major: 1
                      ibeacon_minor: 1
                      ibeacon_uuid: 1f89bc00-d0af-481b-82fe-a6629259a39f
                      last_seen: 0
                      mac: string
                      map_id: 09d2b626-2e4e-45ef-a3c4-e6aeb6c83db1
                      name: string
                      rssizones:
                      - id: 476f6eca-6276-4993-bfeb-5dcbbbbaef08
                        since: 0
                      x: 0
                      y: 0
                      zones:
                      - id: 475f6eca-6276-4993-bfeb-5ecbbbbf6f08
                        since: 0
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/assets/{asset_id}:
    get:
      tags:
      - Sites Stats - Assets
      summary: getSiteAssetStats
      description: Get Site Asset Details
      operationId: getSiteAssetStats
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: asset_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/stats_asset'
                - description: BLE asset location and advertisement statistics
                  examples:
                  - _ttl: 86400
                    battery_voltage: 3370
                    by: asset
                    device_id: 00000000-0000-0000-1000-5c5b35000001
                    device_name: BLE Device
                    eddystone_uid_instance: 5c5b35000001
                    eddystone_uid_namespace: 2818e3868dec25629ede
                    eddystone_url_url: https://www.abc.com
                    ibeacon_major: 13
                    ibeacon_minor: 138
                    ibeacon_uuid: f3f17139-704a-f03a-2786-0400279e37c3
                    id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                    last_seen: 1480716946
                    mac: 4a0222000e31
                    manufacture: Asset Manufacturer Name
                    map_id: 63eda950-c6da-11e4-a628-60f81dd250cc
                    mfg_company_id: 935
                    mfg_data: 648520a1020000
                    name: Asset Name
                    rssi: -45
                    rssizones:
                    - id: 480f6eca-6276-4993-bfeb-59cbbbbaaf08
                      since: 0
                    service_packets:
                    - data: '640'
                      last_rx_time: 1645855923
                      rx_cnt: 213065
                      uuid: 00003e10-0000-1000-8000-00805f9b34fb
                    temperature: 23.5
                    x: 51
                    y: 29
                    zones:
                    - id: 479f6eca-6276-4993-bfeb-5acbbbbabf08
                      since: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    _ttl: 86400
                    battery_voltage: 3370
                    by: asset
                    device_id: 00000000-0000-0000-1000-5c5b35000001
                    device_name: BLE Device
                    eddystone_uid_instance: 5c5b35000001
                    eddystone_uid_namespace: 2818e3868dec25629ede
                    eddystone_url_url: https://www.abc.com
                    ibeacon_major: 13
                    ibeacon_minor: 138
                    ibeacon_uuid: f3f17139-704a-f03a-2786-0400279e37c3
                    id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                    last_seen: 1480716946
                    mac: 4a0222000e31
                    manufacture: Asset Manufacturer Name
                    map_id: 63eda950-c6da-11e4-a628-60f81dd250cc
                    mfg_company_id: 935
                    mfg_data: 648520a1020000
                    name: Asset Name
                    rssi: -45
                    rssizones:
                    - id: 480f6eca-6276-4993-bfeb-59cbbbbaaf08
                      since: 0
                    service_packets:
                    - data: '640'
                      last_rx_time: 1645855923
                      rx_cnt: 213065
                      uuid: 00003e10-0000-1000-8000-00805f9b34fb
                    temperature: 23.5
                    x: 51
                    y: 29
                    zones:
                    - id: 479f6eca-6276-4993-bfeb-5acbbbbabf08
                      since: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/stats_asset'
                - description: BLE asset location and advertisement statistics
                  examples:
                  - _ttl: 86400
                    battery_voltage: 3370
                    by: asset
                    device_id: 00000000-0000-0000-1000-5c5b35000001
                    device_name: BLE Device
                    eddystone_uid_instance: 5c5b35000001
                    eddystone_uid_namespace: 2818e3868dec25629ede
                    eddystone_url_url: https://www.abc.com
                    ibeacon_major: 13
                    ibeacon_minor: 138
                    ibeacon_uuid: f3f17139-704a-f03a-2786-0400279e37c3
                    id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                    last_seen: 1480716946
                    mac: 4a0222000e31
                    manufacture: Asset Manufacturer Name
                    map_id: 63eda950-c6da-11e4-a628-60f81dd250cc
                    mfg_company_id: 935
                    mfg_data: 648520a1020000
                    name: Asset Name
                    rssi: -45
                    rssizones:
                    - id: 480f6eca-6276-4993-bfeb-59cbbbbaaf08
                      since: 0
                    service_packets:
                    - data: '640'
                      last_rx_time: 1645855923
                      rx_cnt: 213065
                      uuid: 00003e10-0000-1000-8000-00805f9b34fb
                    temperature: 23.5
                    x: 51
                    y: 29
                    zones:
                    - id: 479f6eca-6276-4993-bfeb-5acbbbbabf08
                      since: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    _ttl: 86400
                    battery_voltage: 3370
                    by: asset
                    device_id: 00000000-0000-0000-1000-5c5b35000001
                    device_name: BLE Device
                    eddystone_uid_instance: 5c5b35000001
                    eddystone_uid_namespace: 2818e3868dec25629ede
                    eddystone_url_url: https://www.abc.com
                    ibeacon_major: 13
                    ibeacon_minor: 138
                    ibeacon_uuid: f3f17139-704a-f03a-2786-0400279e37c3
                    id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5
                    last_seen: 1480716946
                    mac: 4a0222000e31
                    manufacture: Asset Manufacturer Name
                    map_id: 63eda950-c6da-11e4-a628-60f81dd250cc
                    mfg_company_id: 935
                    mfg_data: 648520a1020000
                    name: Asset Name
                    rssi: -45
                    rssizones:
                    - id: 480f6eca-6276-4993-bfeb-59cbbbbaaf08
                      since: 0
                    service_packets:
                    - data: '640'
                      last_rx_time: 1645855923
                      rx_cnt: 213065
                      uuid: 00003e10-0000-1000-8000-00805f9b34fb
                    temperature: 23.5
                    x: 51
                    y: 29
                    zones:
                    - id: 479f6eca-6276-4993-bfeb-5acbbbbabf08
                      since: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/discovered_assets:
    get:
      tags:
      - Sites Stats - Assets
      summary: listSiteDiscoveredAssets
      description: Get List of Site Discovered BLE Assets that doesn’t match any of the Asset / Assetfilters
      operationId: listSiteDiscoveredAssets
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/asset'
                description: List of named BLE asset records
                contentMediaType: application/json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/filtered_assets:
    get:
      tags:
      - Sites Stats - Assets
      summary: getSiteAssetsOfInterest
      description: Get a list of BLE beacons that matches Asset or AssetFilter
      operationId: getSiteAssetsOfInterest
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/asset_of_interest'
                description: BLE beacons that matched named assets or asset filters
                examples:
                - - ap_mac: string
                    beam: 0
                    by: string
                    curr_site: string
                    device_name: string
                    id: string
                    last_seen: 0
                    mac: string
                    manufacture: string
                    map_id: string
                    name: string
                    rssi: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - ap_mac: string
                    beam: 0
                    by: string
                    curr_site: string
                    device_name: string
                    id: string
                    last_seen: 0
                    mac: string
                    manufacture: string
                    map_id: string
                    name: string
                    rssi: 0
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/asset_of_interest'
                description: BLE beacons that matched named assets or asset filters
                examples:
                - - ap_mac: string
                    beam: 0
                    by: string
                    curr_site: string
                    device_name: string
                    id: string
                    last_seen: 0
                    mac: string
                    manufacture: string
                    map_id: string
                    name: string
                    rssi: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - ap_mac: string
                    beam: 0
                    by: string
                    curr_site: string
                    device_name: string
                    id: string
                    last_seen: 0
                    mac: string
                    manufacture: string
                    map_id: string
                    name: string
                    rssi: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/maps/{map_id}/discovered_assets:
    get:
      tags:
      - Sites Stats - Assets
      summary: getSiteDiscoveredAssetByMap
      description: Get a list of BLE beacons that we discovered (whether they’ re defined as assets or not)
      operationId: getSiteDiscoveredAssetByMap
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: map_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/stats_asset'
                description: Asset statistics returned by the request
                contentMediaType: application/json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/beacons:
    get:
      tags:
      - Sites Stats - Beacons
      summary: listSiteBeaconsStats
      description: Get List of Site Beacons Stats
      operationId: listSiteBeaconsStats
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                uniqueItems: true
                type: array
                items:
                  $ref: '#/components/schemas/stats_beacon'
                description: BLE beacon statistics returned by the request
                contentMediaType: application/json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/bgp_peers/count:
    get:
      tags:
      - Sites Stats - BGP Peers
      summary: countSiteBgpStats
      description: Count BGP peer statistics for a site, optionally grouped by the `distinct` field and filtered by peer state. Use [Count Org BGP Stats]($e/Orgs%20Stats%20-%20BGP%20Peers/countOrgBgpStats) to count BGP peer statistics across the organization.
      operationId: countSiteBgpStats
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: state
        in: query
        description: Filter peer results by state
        style: form
        explode: true
        schema:
          type: string
          examples:
          - established
      - name: distinct
        in: query
        description: Field used to group this count response
        style: form
        explode: true
        schema:
          type: string
          examples:
          - site_id
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/bgp_peers/search:
    get:
      tags:
      - Sites Stats - BGP Peers
      summary: searchSiteBgpStats
      description: Search BGP peer statistics for a site with filters for device, neighbor, VRF, and time range. Use [Search Org BGP Stats]($e/Orgs%20Stats%20-%20BGP%20Peers/searchOrgBgpStats) to search BGP peer statistics across the organization.
      operationId: searchSiteBgpStats
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: neighbor_mac
        in: query
        description: Filter peer results by neighbor MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: vrf_name
        in: query
        description: Filter peer results by VRF name
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_search_bgps'
                - description: Paginated response for BGP peer statistics search results
                  examples:
                  - end: 0
                    limit: 0
                    results:
                    - evpn_overlay: true
                      for_overlay: true
                      local_as: 65000
                      mac: 020001c04668
                      neighbor: 15.8.3.5
                      neighbor_as: 65000
                      neighbor_mac: 020001c04600
                      node: node0
                      org_id: 0c160b7f-1027-4cd1-923b-744534c4b070
                      rx_pkts: 63366
                      rx_routes: 60
                      site_id: 725a8d34-a126-4f2c-b990-d1219421cb75
                      state: established
                      timestamp: 1666251056.07
                      tx_pkts: 1735
                      tx_routes: 60
                      up: true
                      uptime: 31355
                      vrf_name: default
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 0
                    limit: 0
                    results:
                    - evpn_overlay: true
                      for_overlay: true
                      local_as: 65000
                      mac: 020001c04668
                      neighbor: 15.8.3.5
                      neighbor_as: 65000
                      neighbor_mac: 020001c04600
                      node: node0
                      org_id: 0c160b7f-1027-4cd1-923b-744534c4b070
                      rx_pkts: 63366
                      rx_routes: 60
                      site_id: 725a8d34-a126-4f2c-b990-d1219421cb75
                      state: established
                      timestamp: 1666251056.07
                      tx_pkts: 1735
                      tx_routes: 60
                      up: true
                      uptime: 31355
                      vrf_name: default
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_search_bgps'
                - description: Paginated response for BGP peer statistics search results
                  examples:
                  - end: 0
                    limit: 0
                    results:
                    - evpn_overlay: true
                      for_overlay: true
                      local_as: 65000
                      mac: 020001c04668
                      neighbor: 15.8.3.5
                      neighbor_as: 65000
                      neighbor_mac: 020001c04600
                      node: node0
                      org_id: 0c160b7f-1027-4cd1-923b-744534c4b070
                      rx_pkts: 63366
                      rx_routes: 60
                      site_id: 725a8d34-a126-4f2c-b990-d1219421cb75
                      state: established
                      timestamp: 1666251056.07
                      tx_pkts: 1735
                      tx_routes: 60
                      up: true
                      uptime: 31355
                      vrf_name: default
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 0
                    limit: 0
                    results:
                    - evpn_overlay: true
                      for_overlay: true
                      local_as: 65000
                      mac: 020001c04668
                      neighbor: 15.8.3.5
                      neighbor_as: 65000
                      neighbor_mac: 020001c04600
                      node: node0
                      org_id: 0c160b7f-1027-4cd1-923b-744534c4b070
                      rx_pkts: 63366
                      rx_routes: 60
                      site_id: 725a8d34-a126-4f2c-b990-d1219421cb75
                      state: established
                      timestamp: 1666251056.07
                      tx_pkts: 1735
                      tx_routes: 60
                      up: true
                      uptime: 31355
                      vrf_name: default
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/calls/client/{client_mac}/troubleshoot:
    get:
      tags:
      - Sites Stats - Calls
      summary: troubleshootSiteCall
      description: Troubleshoot a call
      operationId: troubleshootSiteCall
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: client_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      - name: meeting_id
        in: query
        description: Filter results by meeting identifier
        required: true
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 1234567890abcdef
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - '001122334455'
      - name: app
        in: query
        description: Third party app name
        style: form
        explode: true
        schema:
          type: string
          examples:
          - zoom
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/call_troubleshoot'
                - description: Detailed call troubleshooting response
                  examples:
                  - mac: 983a78ea4a44
                    meeting_id: b784d744-9a7c-4fad-9af0-f78858a319b1
                    results:
                    - ap_num_clients: -0.08802365511655807
                      ap_rtt: 0.09924473613500595
                      audio_in:
                        ap_num_clients: -0.6565111
                        ap_rtt: 0.16559607
                        client_cpu: 3.7028809
                        client_n_streams: 0.15803306
                        client_radio_band: 0.5576923
                        client_rssi: -1.0839354
                        client_rx_bytes: 2.2622051
                        client_rx_rates: 0.62357205
                        client_rx_retries: 0.26726437
                        client_tx_bytes: 0.15803306
                        client_tx_rates: 0.62357205
                        client_tx_retries: 0.77553505
                        client_vpn_distance: 1.6474955
                        client_wifi_version: 0.18267937
                        expected: 30.941595
                        radio_bandwidth: -0.06538621
                        radio_channel: -0.73391086
                        radio_tx_power: 0.10027129
                        radio_util: 12.770318
                        radio_util_interference: -3.079999
                        site_num_clients: 0.017364305
                        wan_avg_download_mbps: 1.4803165
                        wan_avg_upload_mbps: -0.038184267
                        wan_jitter: 5.9680853
                        wan_max_download_mbps: 1.4803165
                        wan_max_upload_mbps: -0.038184267
                        wan_rtt: 46.77899
                      audio_out:
                        ap_num_clients: -0.6565111
                        ap_rtt: 0.16559607
                        client_cpu: 3.7028809
                        client_n_streams: 0.15803306
                        client_radio_band: 0.5576923
                        client_rssi: -1.0839354
                        client_rx_bytes: 2.2622051
                        client_rx_rates: 0.62357205
                        client_rx_retries: 0.26726437
                        client_tx_bytes: 0.15803306
                        client_tx_rates: 0.62357205
                        client_tx_retries: 0.77553505
                        client_vpn_distance: 1.6474955
                        client_wifi_version: 0.18267937
                        expected: 30.941595
                        radio_bandwidth: -0.06538621
                        radio_channel: -0.73391086
                        radio_tx_power: 0.10027129
                        radio_util: 12.770318
                        radio_util_interference: -3.079999
                        site_num_clients: 0.017364305
                        wan_avg_download_mbps: 1.4803165
                        wan_avg_upload_mbps: -0.038184267
                        wan_jitter: 5.9680853
                        wan_max_download_mbps: 1.4803165
                        wan_max_upload_mbps: -0.038184267
                        wan_rtt: 46.77899
                      client_cpu: 0.00834270566701889
                      client_n_streams: 0.00734270566701889
                      client_radio_band: 0.5841414928436279
                      client_rssi: 0.7594696879386902
                      client_rx_bytes: 2.365511655807E-05
                      client_rx_rates: 0.02441493794322014
                      client_rx_retries: -0.14325742423534393
                      client_tx_bytes: 0.00102365511655807
                      client_tx_rates: 0.22236637771129608
                      client_tx_retries: 0.3308201730251312
                      client_vpn_distance: -0.0001660545531194657
                      client_wifi_version: 7.0566701889E-07
                      expected: -2.8630001056670187
                      radio_ap_change: 0.01850946433842182
                      radio_bandwidth: -0.021175479516386986
                      radio_channel: 0.11686426401138306
                      radio_rx_failed: 1.1782013177871704
                      radio_tx_power: 0.121039018034935
                      radio_util: 0.2452986091375351
                      radio_util_interference: 3.4367904663085938
                      site_num_clients: 0.055026158690452576
                      site_wan_avg_download_mbps: 3.0566701889E-07
                      site_wan_avg_upload_mbps: 5.566701889E-08
                      site_wan_download_mbps: 8.0566701889E-07
                      site_wan_jitter: 1.00566701889E-06
                      site_wan_rtt: 4.0566701889E-07
                      site_wan_upload_mbps: 2.0566701889E-07
                      timestamp: 1695425115
                      video_in:
                        ap_num_clients: -0.6565111
                        ap_rtt: 0.16559607
                        client_cpu: 3.7028809
                        client_n_streams: 0.15803306
                        client_radio_band: 0.5576923
                        client_rssi: -1.0839354
                        client_rx_bytes: 2.2622051
                        client_rx_rates: 0.62357205
                        client_rx_retries: 0.26726437
                        client_tx_bytes: 0.15803306
                        client_tx_rates: 0.62357205
                        client_tx_retries: 0.77553505
                        client_vpn_distance: 1.6474955
                        client_wifi_version: 0.18267937
                        expected: 30.941595
                        radio_bandwidth: -0.06538621
                        radio_channel: -0.73391086
                        radio_tx_power: 0.10027129
                        radio_util: 12.770318
                        radio_util_interference: -3.079999
                        site_num_clients: 0.017364305
                        wan_avg_download_mbps: 1.4803165
                        wan_avg_upload_mbps: -0.038184267
                        wan_jitter: 5.9680853
                        wan_max_download_mbps: 1.4803165
                        wan_max_upload_mbps: -0.038184267
                        wan_rtt: 46.77899
                      video_out:
                        ap_num_clients: -0.6565111
                        ap_rtt: 0.16559607
                        client_cpu: 3.7028809
                        client_n_streams: 0.15803306
                        client_radio_band: 0.5576923
                        client_rssi: -1.0839354
                        client_rx_bytes: 2.2622051
                        client_rx_rates: 0.62357205
                        client_rx_retries: 0.26726437
                        client_tx_bytes: 0.15803306
                        client_tx_rates: 0.62357205
                        client_tx_retries: 0.77553505
                        client_vpn_distance: 1.6474955
                        client_wifi_version: 0.18267937
                        expected: 30.941595
                        radio_bandwidth: -0.06538621
                        radio_channel: -0.73391086
                        radio_tx_power: 0.10027129
                        radio_util: 12.770318
                        radio_util_interference: -3.079999
                        site_num_clients: 0.017364305
                        wan_avg_download_mbps: 1.4803165
                        wan_avg_upload_mbps: -0.038184267
                        wan_jitter: 5.9680853
                        wan_max_download_mbps: 1.4803165
                        wan_max_upload_mbps: -0.038184267
                        wan_rtt: 46.77899
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    mac: 983a78ea4a44
                    meeting_id: b784d744-9a7c-4fad-9af0-f78858a319b1
                    results:
                    - ap_num_clients: -0.08802365511655807
                      ap_rtt: 0.09924473613500595
                      audio_in:
                        ap_num_clients: -0.6565111
                        ap_rtt: 0.16559607
                        client_cpu: 3.7028809
                        client_n_streams: 0.15803306
                        client_radio_band: 0.5576923
                        client_rssi: -1.0839354
                        client_rx_bytes: 2.2622051
                        client_rx_rates: 0.62357205
                        client_rx_retries: 0.26726437
                        client_tx_bytes: 0.15803306
                        client_tx_rates: 0.62357205
                        client_tx_retries: 0.77553505
                        client_vpn_distance: 1.6474955
                        client_wifi_version: 0.18267937
                        expected: 30.941595
                        radio_bandwidth: -0.06538621
                        radio_channel: -0.73391086
                        radio_tx_power: 0.10027129
                        radio_util: 12.770318
                        radio_util_interference: -3.079999
                        site_num_clients: 0.017364305
                        wan_avg_download_mbps: 1.4803165
                        wan_avg_upload_mbps: -0.038184267
                        wan_jitter: 5.9680853
                        wan_max_download_mbps: 1.4803165
                        wan_max_upload_mbps: -0.038184267
                        wan_rtt: 46.77899
                      audio_out:
                        ap_num_clients: -0.6565111
                        ap_rtt: 0.16559607
                        client_cpu: 3.7028809
                        client_n_streams: 0.15803306
                        client_radio_band: 0.5576923
                        client_rssi: -1.0839354
                        client_rx_bytes: 2.2622051
                        client_rx_rates: 0.62357205
                        client_rx_retries: 0.26726437
                        client_tx_bytes: 0.15803306
                        client_tx_rates: 0.62357205
                        client_tx_retries: 0.77553505
                        client_vpn_distance: 1.6474955
                        client_wifi_version: 0.18267937
                        expected: 30.941595
                        radio_bandwidth: -0.06538621
                        radio_channel: -0.73391086
                        radio_tx_power: 0.10027129
                        radio_util: 12.770318
                        radio_util_interference: -3.079999
                        site_num_clients: 0.017364305
                        wan_avg_download_mbps: 1.4803165
                        wan_avg_upload_mbps: -0.038184267
                        wan_jitter: 5.9680853
                        wan_max_download_mbps: 1.4803165
                        wan_max_upload_mbps: -0.038184267
                        wan_rtt: 46.77899
                      client_cpu: 0.00834270566701889
                      client_n_streams: 0.00734270566701889
                      client_radio_band: 0.5841414928436279
                      client_rssi: 0.7594696879386902
                      client_rx_bytes: 2.365511655807E-05
                      client_rx_rates: 0.02441493794322014
                      client_rx_retries: -0.14325742423534393
                      client_tx_bytes: 0.00102365511655807
                      client_tx_rates: 0.22236637771129608
                      client_tx_retries: 0.3308201730251312
                      client_vpn_distance: -0.0001660545531194657
                      client_wifi_version: 7.0566701889E-07
                      expected: -2.8630001056670187
                      radio_ap_change: 0.01850946433842182
                      radio_bandwidth: -0.021175479516386986
                      radio_channel: 0.11686426401138306
                      radio_rx_failed: 1.1782013177871704
                      radio_tx_power: 0.121039018034935
                      radio_util: 0.2452986091375351
                      radio_util_interference: 3.4367904663085938
                      site_num_clients: 0.055026158690452576
                      site_wan_avg_download_mbps: 3.0566701889E-07
                      site_wan_avg_upload_mbps: 5.566701889E-08
                      site_wan_download_mbps: 8.0566701889E-07
                      site_wan_jitter: 1.00566701889E-06
                      site_wan_rtt: 4.0566701889E-07
                      site_wan_upload_mbps: 2.0566701889E-07
                      timestamp: 1695425115
                      video_in:
                        ap_num_clients: -0.6565111
                        ap_rtt: 0.16559607
                        client_cpu: 3.7028809
                        client_n_streams: 0.15803306
                        client_radio_band: 0.5576923
                        client_rssi: -1.0839354
                        client_rx_bytes: 2.2622051
                        client_rx_rates: 0.62357205
                        client_rx_retries: 0.26726437
                        client_tx_bytes: 0.15803306
                        client_tx_rates: 0.62357205
                        client_tx_retries: 0.77553505
                        client_vpn_distance: 1.6474955
                        client_wifi_version: 0.18267937
                        expected: 30.941595
                        radio_bandwidth: -0.06538621
                        radio_channel: -0.73391086
                        radio_tx_power: 0.10027129
                        radio_util: 12.770318
                        radio_util_interference: -3.079999
                        site_num_clients: 0.017364305
                        wan_avg_download_mbps: 1.4803165
                        wan_avg_upload_mbps: -0.038184267
                        wan_jitter: 5.9680853
                        wan_max_download_mbps: 1.4803165
                        wan_max_upload_mbps: -0.038184267
                        wan_rtt: 46.77899
                      video_out:
                        ap_num_clients: -0.6565111
                        ap_rtt: 0.16559607
                        client_cpu: 3.7028809
                        client_n_streams: 0.15803306
                        client_radio_band: 0.5576923
                        client_rssi: -1.0839354
                        client_rx_bytes: 2.2622051
                        client_rx_rates: 0.62357205
                        client_rx_retries: 0.26726437
                        client_tx_bytes: 0.15803306
                        client_tx_rates: 0.62357205
                        client_tx_retries: 0.77553505
                        client_vpn_distance: 1.6474955
                        client_wifi_version: 0.18267937
                        expected: 30.941595
                        radio_bandwidth: -0.06538621
                        radio_channel: -0.73391086
                        radio_tx_power: 0.10027129
                        radio_util: 12.770318
                        radio_util_interference: -3.079999
                        site_num_clients: 0.017364305
                        wan_avg_download_mbps: 1.4803165
                        wan_avg_upload_mbps: -0.038184267
                        wan_jitter: 5.9680853
                        wan_max_download_mbps: 1.4803165
                        wan_max_upload_mbps: -0.038184267
                        wan_rtt: 46.77899
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/call_troubleshoot'
                - description: Detailed call troubleshooting response
                  examples:
                  - mac: 983a78ea4a44
                    meeting_id: b784d744-9a7c-4fad-9af0-f78858a319b1
                    results:
                    - ap_num_clients: -0.08802365511655807
                      ap_rtt: 0.09924473613500595
                      audio_in:
                        ap_num_clients: -0.6565111
                        ap_rtt: 0.16559607
                        client_cpu: 3.7028809
                        client_n_streams: 0.15803306
                        client_radio_band: 0.5576923
                        client_rssi: -1.0839354
                        client_rx_bytes: 2.2622051
                        client_rx_rates: 0.62357205
                        client_rx_retries: 0.26726437
                        client_tx_bytes: 0.15803306
                        client_tx_rates: 0.62357205
                        client_tx_retries: 0.77553505
                        client_vpn_distance: 1.6474955
                        client_wifi_version: 0.18267937
                        expected: 30.941595
                        radio_bandwidth: -0.06538621
                        radio_channel: -0.73391086
                        radio_tx_power: 0.10027129
                        radio_util: 12.770318
                        radio_util_interference: -3.079999
                        site_num_clients: 0.017364305
                        wan_avg_download_mbps: 1.4803165
                        wan_avg_upload_mbps: -0.038184267
                        wan_jitter: 5.9680853
                        wan_max_download_mbps: 1.4803165
                        wan_max_upload_mbps: -0.038184267
                        wan_rtt: 46.77899
                      audio_out:
                        ap_num_clients: -0.6565111
                        ap_rtt: 0.16559607
                        client_cpu: 3.7028809
                        client_n_streams: 0.15803306
                        client_radio_band: 0.5576923
                        client_rssi: -1.0839354
                        client_rx_bytes: 2.2622051
                        client_rx_rates: 0.62357205
                        client_rx_retries: 0.26726437
                        client_tx_bytes: 0.15803306
                        client_tx_rates: 0.62357205
                        client_tx_retries: 0.77553505
                        client_vpn_distance: 1.6474955
                        client_wifi_version: 0.18267937
                        expected: 30.941595
                        radio_bandwidth: -0.06538621
                        radio_channel: -0.73391086
                        radio_tx_power: 0.10027129
                        radio_util: 12.770318
                        radio_util_interference: -3.079999
                        site_num_clients: 0.017364305
                        wan_avg_download_mbps: 1.4803165
                        wan_avg_upload_mbps: -0.038184267
                        wan_jitter: 5.9680853
                        wan_max_download_mbps: 1.4803165
                        wan_max_upload_mbps: -0.038184267
                        wan_rtt: 46.77899
                      client_cpu: 0.00834270566701889
                      client_n_streams: 0.00734270566701889
                      client_radio_band: 0.5841414928436279
                      client_rssi: 0.7594696879386902
                      client_rx_bytes: 2.365511655807E-05
                      client_rx_rates: 0.02441493794322014
                      client_rx_retries: -0.14325742423534393
                      client_tx_bytes: 0.00102365511655807
                      client_tx_rates: 0.22236637771129608
                      client_tx_retries: 0.3308201730251312
                      client_vpn_distance: -0.0001660545531194657
                      client_wifi_version: 7.0566701889E-07
                      expected: -2.8630001056670187
                      radio_ap_change: 0.01850946433842182
                      radio_bandwidth: -0.021175479516386986
                      radio_channel: 0.11686426401138306
                      radio_rx_failed: 1.1782013177871704
                      radio_tx_power: 0.121039018034935
                      radio_util: 0.2452986091375351
                      radio_util_interference: 3.4367904663085938
                      site_num_clients: 0.055026158690452576
                      site_wan_avg_download_mbps: 3.0566701889E-07
                      site_wan_avg_upload_mbps: 5.566701889E-08
                      site_wan_download_mbps: 8.0566701889E-07
                      site_wan_jitter: 1.00566701889E-06
                      site_wan_rtt: 4.0566701889E-07
                      site_wan_upload_mbps: 2.0566701889E-07
                      timestamp: 1695425115
                      video_in:
                        ap_num_clients: -0.6565111
                        ap_rtt: 0.16559607
                        client_cpu: 3.7028809
                        client_n_streams: 0.15803306
                        client_radio_band: 0.5576923
                        client_rssi: -1.0839354
                        client_rx_bytes: 2.2622051
                        client_rx_rates: 0.62357205
                        client_rx_retries: 0.26726437
                        client_tx_bytes: 0.15803306
                        client_tx_rates: 0.62357205
                        client_tx_retries: 0.77553505
                        client_vpn_distance: 1.6474955
                        client_wifi_version: 0.18267937
                        expected: 30.941595
                        radio_bandwidth: -0.06538621
                        radio_channel: -0.73391086
                        radio_tx_power: 0.10027129
                        radio_util: 12.770318
                        radio_util_interference: -3.079999
                        site_num_clients: 0.017364305
                        wan_avg_download_mbps: 1.4803165
                        wan_avg_upload_mbps: -0.038184267
                        wan_jitter: 5.9680853
                        wan_max_download_mbps: 1.4803165
                        wan_max_upload_mbps: -0.038184267
                        wan_rtt: 46.77899
                      video_out:
                        ap_num_clients: -0.6565111
                        ap_rtt: 0.16559607
                        client_cpu: 3.7028809
                        client_n_streams: 0.15803306
                        client_radio_band: 0.5576923
                        client_rssi: -1.0839354
                        client_rx_bytes: 2.2622051
                        client_rx_rates: 0.62357205
                        client_rx_retries: 0.26726437
                        client_tx_bytes: 0.15803306
                        client_tx_rates: 0.62357205
                        client_tx_retries: 0.77553505
                        client_vpn_distance: 1.6474955
                        client_wifi_version: 0.18267937
                        expected: 30.941595
                        radio_bandwidth: -0.06538621
                        radio_channel: -0.73391086
                        radio_tx_power: 0.10027129
                        radio_util: 12.770318
                        radio_util_interference: -3.079999
                        site_num_clients: 0.017364305
                        wan_avg_download_mbps: 1.4803165
                        wan_avg_upload_mbps: -0.038184267
                        wan_jitter: 5.9680853
                        wan_max_download_mbps: 1.4803165
                        wan_max_upload_mbps: -0.038184267
                        wan_rtt: 46.77899
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    mac: 983a78ea4a44
                    meeting_id: b784d744-9a7c-4fad-9af0-f78858a319b1
                    results:
                    - ap_num_clients: -0.08802365511655807
                      ap_rtt: 0.09924473613500595
                      audio_in:
                        ap_num_clients: -0.6565111
                        ap_rtt: 0.16559607
                        client_cpu: 3.7028809
                        client_n_streams: 0.15803306
                        client_radio_band: 0.5576923
                        client_rssi: -1.0839354
                        client_rx_bytes: 2.2622051
                        client_rx_rates: 0.62357205
                        client_rx_retries: 0.26726437
                        client_tx_bytes: 0.15803306
                        client_tx_rates: 0.62357205
                        client_tx_retries: 0.77553505
                        client_vpn_distance: 1.6474955
                        client_wifi_version: 0.18267937
                        expected: 30.941595
                        radio_bandwidth: -0.06538621
                        radio_channel: -0.73391086
                        radio_tx_power: 0.10027129
                        radio_util: 12.770318
                        radio_util_interference: -3.079999
                        site_num_clients: 0.017364305
                        wan_avg_download_mbps: 1.4803165
                        wan_avg_upload_mbps: -0.038184267
                        wan_jitter: 5.9680853
                        wan_max_download_mbps: 1.4803165
                        wan_max_upload_mbps: -0.038184267
                        wan_rtt: 46.77899
                      audio_out:
                        ap_num_clients: -0.6565111
                        ap_rtt: 0.16559607
                        client_cpu: 3.7028809
                        client_n_streams: 0.15803306
                        client_radio_band: 0.5576923
                        client_rssi: -1.0839354
                        client_rx_bytes: 2.2622051
                        client_rx_rates: 0.62357205
                        client_rx_retries: 0.26726437
                        client_tx_bytes: 0.15803306
                        client_tx_rates: 0.62357205
                        client_tx_retries: 0.77553505
                        client_vpn_distance: 1.6474955
                        client_wifi_version: 0.18267937
                        expected: 30.941595
                        radio_bandwidth: -0.06538621
                        radio_channel: -0.73391086
                        radio_tx_power: 0.10027129
                        radio_util: 12.770318
                        radio_util_interference: -3.079999
                        site_num_clients: 0.017364305
                        wan_avg_download_mbps: 1.4803165
                        wan_avg_upload_mbps: -0.038184267
                        wan_jitter: 5.9680853
                        wan_max_download_mbps: 1.4803165
                        wan_max_upload_mbps: -0.038184267
                        wan_rtt: 46.77899
                      client_cpu: 0.00834270566701889
                      client_n_streams: 0.00734270566701889
                      client_radio_band: 0.5841414928436279
                      client_rssi: 0.7594696879386902
                      client_rx_bytes: 2.365511655807E-05
                      client_rx_rates: 0.02441493794322014
                      client_rx_retries: -0.14325742423534393
                      client_tx_bytes: 0.00102365511655807
                      client_tx_rates: 0.22236637771129608
                      client_tx_retries: 0.3308201730251312
                      client_vpn_distance: -0.0001660545531194657
                      client_wifi_version: 7.0566701889E-07
                      expected: -2.8630001056670187
                      radio_ap_change: 0.01850946433842182
                      radio_bandwidth: -0.021175479516386986
                      radio_channel: 0.11686426401138306
                      radio_rx_failed: 1.1782013177871704
                      radio_tx_power: 0.121039018034935
                      radio_util: 0.2452986091375351
                      radio_util_interference: 3.4367904663085938
                      site_num_clients: 0.055026158690452576
                      site_wan_avg_download_mbps: 3.0566701889E-07
                      site_wan_avg_upload_mbps: 5.566701889E-08
                      site_wan_download_mbps: 8.0566701889E-07
                      site_wan_jitter: 1.00566701889E-06
                      site_wan_rtt: 4.0566701889E-07
                      site_wan_upload_mbps: 2.0566701889E-07
                      timestamp: 1695425115
                      video_in:
                        ap_num_clients: -0.6565111
                        ap_rtt: 0.16559607
                        client_cpu: 3.7028809
                        client_n_streams: 0.15803306
                        client_radio_band: 0.5576923
                        client_rssi: -1.0839354
                        client_rx_bytes: 2.2622051
                        client_rx_rates: 0.62357205
                        client_rx_retries: 0.26726437
                        client_tx_bytes: 0.15803306
                        client_tx_rates: 0.62357205
                        client_tx_retries: 0.77553505
                        client_vpn_distance: 1.6474955
                        client_wifi_version: 0.18267937
                        expected: 30.941595
                        radio_bandwidth: -0.06538621
                        radio_channel: -0.73391086
                        radio_tx_power: 0.10027129
                        radio_util: 12.770318
                        radio_util_interference: -3.079999
                        site_num_clients: 0.017364305
                        wan_avg_download_mbps: 1.4803165
                        wan_avg_upload_mbps: -0.038184267
                        wan_jitter: 5.9680853
                        wan_max_download_mbps: 1.4803165
                        wan_max_upload_mbps: -0.038184267
                        wan_rtt: 46.77899
                      video_out:
                        ap_num_clients: -0.6565111
                        ap_rtt: 0.16559607
                        client_cpu: 3.7028809
                        client_n_streams: 0.15803306
                        client_radio_band: 0.5576923
                        client_rssi: -1.0839354
                        client_rx_bytes: 2.2622051
                        client_rx_rates: 0.62357205
                        client_rx_retries: 0.26726437
                        client_tx_bytes: 0.15803306
                        client_tx_rates: 0.62357205
                        client_tx_retries: 0.77553505
                        client_vpn_distance: 1.6474955
                        client_wifi_version: 0.18267937
                        expected: 30.941595
                        radio_bandwidth: -0.06538621
                        radio_channel: -0.73391086
                        radio_tx_power: 0.10027129
                        radio_util: 12.770318
                        radio_util_interference: -3.079999
                        site_num_clients: 0.017364305
                        wan_avg_download_mbps: 1.4803165
                        wan_avg_upload_mbps: -0.038184267
                        wan_jitter: 5.9680853
                        wan_max_download_mbps: 1.4803165
                        wan_max_upload_mbps: -0.038184267
                        wan_rtt: 46.77899
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/calls/count:
    get:
      tags:
      - Sites Stats - Calls
      summary: countSiteCalls
      description: Count by Distinct Attributes of Calls
      operationId: countSiteCalls
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `mac`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/count_site_calls_distinct'
          - description: 'Field used to group this count response. enum: `mac`'
      - name: rating
        in: query
        description: Feedback rating (e.g. "rating=1" or "rating=1,2")
        style: form
        explode: true
        schema:
          maximum: 5
          minimum: 1
          type: integer
          contentEncoding: int32
          examples:
          - 5
      - name: app
        in: query
        description: Filter application statistics by application name
        style: form
        explode: true
        schema:
          type: string
          examples:
          - zoom
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/calls/search:
    get:
      tags:
      - Sites Stats - Calls
      summary: searchSiteCalls
      description: Search Calls
      operationId: searchSiteCalls
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - '001122334455'
      - name: app
        in: query
        description: Third party app name
        style: form
        explode: true
        schema:
          type: string
          examples:
          - zoom
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_stats_calls'
                - description: Paginated response for site call statistics search results
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_stats_calls'
                - description: Paginated response for site call statistics search results
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/calls/summary:
    get:
      tags:
      - Sites Stats - Calls
      summary: getSiteCallsSummary
      description: Summarized, aggregated stats for the site calls
      operationId: getSiteCallsSummary
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: ap_mac
        in: query
        description: Filter results by AP MAC address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - '001122334455'
      - name: app
        in: query
        description: Filter results by application name
        style: form
        explode: true
        schema:
          type: string
          examples:
          - zoom
      - name: wired
        in: query
        description: Filter results by whether the client is wired
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          examples:
          - false
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_stats_calls_summary'
                - description: Aggregated site call statistics summary
                  examples:
                  - bad_minutes: 5566
                    bad_minutes_client: 526
                    bad_minutes_site_wan: 3612
                    bad_minutes_wireless: 1428
                    num_aps: 1
                    num_users: 3
                    total_minutes: 575217
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    bad_minutes: 5566
                    bad_minutes_client: 526
                    bad_minutes_site_wan: 3612
                    bad_minutes_wireless: 1428
                    num_aps: 1
                    num_users: 3
                    total_minutes: 575217
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_stats_calls_summary'
                - description: Aggregated site call statistics summary
                  examples:
                  - bad_minutes: 5566
                    bad_minutes_client: 526
                    bad_minutes_site_wan: 3612
                    bad_minutes_wireless: 1428
                    num_aps: 1
                    num_users: 3
                    total_minutes: 575217
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    bad_minutes: 5566
                    bad_minutes_client: 526
                    bad_minutes_site_wan: 3612
                    bad_minutes_wireless: 1428
                    num_aps: 1
                    num_users: 3
                    total_minutes: 575217
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/calls/troubleshoot:
    get:
      tags:
      - Sites Stats - Calls
      summary: listSiteTroubleshootCalls
      description: Summary of calls troubleshoot by site
      operationId: listSiteTroubleshootCalls
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: ap
        in: query
        description: Filter results by AP MAC address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - '001122334455'
      - name: meeting_id
        in: query
        description: Filter results by meeting identifier
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 1234567890abcdef
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - '001122334455'
      - name: app
        in: query
        description: Third party app name
        style: form
        explode: true
        schema:
          type: string
          examples:
          - zoom
      - name: wired
        in: query
        description: Filter results by whether the client is wired
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          examples:
          - false
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_call_troubleshoot_summary'
                - description: Site call troubleshooting summary response
                  examples:
                  - mac: 983a78ea4a44
                    meeting_id: b784d744-9a7c-4fad-9af0-f78858a319b1
                    results:
                    - ap_num_clients: -0.08802365511655807
                      ap_rtt: 0.09924473613500595
                      audio_in:
                        ap_num_clients: 45.48306793636746
                        ap_rtt: 6.352042701509264
                        client_cpu: 9.323452578650581
                        client_radio_band: 0.5841414928436279
                        client_rssi: 17.251008563571506
                        client_tx_bytes: 1.8379177401463191
                        client_tx_rates: 10.668423069847954
                        client_tx_retries: 43.323209603627525
                        client_vpn_distance: 112.4420166015625
                        expected: 29.74261474609375
                        radio_bandwidth: -0.1533682727151447
                        radio_channel: 0.662909648484654
                        radio_util: 27.891777674357098
                        radio_util_interference: 4.38913492154744
                        site_num_clients: -0.2855822932389047
                        site_wan_avg_upload_mbps: -0.988989942603641
                        site_wan_jitter: 0.7875519659784105
                        site_wan_rtt: 15.094849904378256
                        site_wan_upload_mbps: -0.8131117953194512
                      audio_out:
                        ap_num_clients: 45.48306793636746
                        ap_rtt: 6.352042701509264
                        client_cpu: 9.323452578650581
                        client_radio_band: 0.5841414928436279
                        client_rssi: 17.251008563571506
                        client_tx_bytes: 1.8379177401463191
                        client_tx_rates: 10.668423069847954
                        client_tx_retries: 43.323209603627525
                        client_vpn_distance: 112.4420166015625
                        expected: 29.74261474609375
                        radio_bandwidth: -0.1533682727151447
                        radio_channel: 0.662909648484654
                        radio_util: 27.891777674357098
                        radio_util_interference: 4.38913492154744
                        site_num_clients: -0.2855822932389047
                        site_wan_avg_upload_mbps: -0.988989942603641
                        site_wan_jitter: 0.7875519659784105
                        site_wan_rtt: 15.094849904378256
                        site_wan_upload_mbps: -0.8131117953194512
                      client_cpu: 0.00834270566701889
                      client_n_streams: 0.00734270566701889
                      client_radio_band: 0.5841414928436279
                      client_rssi: 0.7594696879386902
                      client_rx_bytes: 2.365511655807E-05
                      client_rx_rates: 0.02441493794322014
                      client_rx_retries: -0.14325742423534393
                      client_tx_bytes: 0.00102365511655807
                      client_tx_rates: 0.22236637771129608
                      client_tx_retries: 0.3308201730251312
                      client_vpn_distance: -0.0001660545531194657
                      client_wifi_version: 7.0566701889E-07
                      expected: -2.8630001056670187
                      radio_ap_change: 0.01850946433842182
                      radio_bandwidth: -0.021175479516386986
                      radio_channel: 0.11686426401138306
                      radio_rx_failed: 1.1782013177871704
                      radio_tx_power: 0.121039018034935
                      radio_util: 0.2452986091375351
                      radio_util_interference: 3.4367904663085938
                      site_num_clients: 0.055026158690452576
                      site_wan_avg_download_mbps: 3.0566701889E-07
                      site_wan_avg_upload_mbps: 5.566701889E-08
                      site_wan_download_mbps: 8.0566701889E-07
                      site_wan_jitter: 0.7875519659784105
                      site_wan_rtt: 15.094849904378256
                      site_wan_upload_mbps: 2.0566701889E-07
                      timestamp: 1695425115
                      video_in:
                        ap_num_clients: 45.48306793636746
                        ap_rtt: 6.352042701509264
                        client_cpu: 9.323452578650581
                        client_radio_band: 0.5841414928436279
                        client_rssi: 17.251008563571506
                        client_tx_bytes: 1.8379177401463191
                        client_tx_rates: 10.668423069847954
                        client_tx_retries: 43.323209603627525
                        client_vpn_distance: 112.4420166015625
                        expected: 29.74261474609375
                        radio_bandwidth: -0.1533682727151447
                        radio_channel: 0.662909648484654
                        radio_util: 27.891777674357098
                        radio_util_interference: 4.38913492154744
                        site_num_clients: -0.2855822932389047
                        site_wan_avg_upload_mbps: -0.988989942603641
                        site_wan_jitter: 0.7875519659784105
                        site_wan_rtt: 15.094849904378256
                        site_wan_upload_mbps: -0.8131117953194512
                      video_out:
                        ap_num_clients: 45.48306793636746
                        ap_rtt: 6.352042701509264
                        client_cpu: 9.323452578650581
                        client_radio_band: 0.5841414928436279
                        client_rssi: 17.251008563571506
                        client_tx_bytes: 1.8379177401463191
                        client_tx_rates: 10.668423069847954
                        client_tx_retries: 43.323209603627525
                        client_vpn_distance: 112.4420166015625
                        expected: 29.74261474609375
                        radio_bandwidth: -0.1533682727151447
                        radio_channel: 0.662909648484654
                        radio_util: 27.891777674357098
                        radio_util_interference: 4.38913492154744
                        site_num_clients: -0.2855822932389047
                        site_wan_avg_upload_mbps: -0.988989942603641
                        site_wan_jitter: 0.7875519659784105
                        site_wan_rtt: 15.094849904378256
                        site_wan_upload_mbps: -0.8131117953194512
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    mac: 983a78ea4a44
                    meeting_id: b784d744-9a7c-4fad-9af0-f78858a319b1
                    results:
                    - ap_num_clients: -0.08802365511655807
                      ap_rtt: 0.09924473613500595
                      audio_in:
                        ap_num_clients: 45.48306793636746
                        ap_rtt: 6.352042701509264
                        client_cpu: 9.323452578650581
                        client_radio_band: 0.5841414928436279
                        client_rssi: 17.251008563571506
                        client_tx_bytes: 1.8379177401463191
                        client_tx_rates: 10.668423069847954
                        client_tx_retries: 43.323209603627525
                        client_vpn_distance: 112.4420166015625
                        expected: 29.74261474609375
                        radio_bandwidth: -0.1533682727151447
                        radio_channel: 0.662909648484654
                        radio_util: 27.891777674357098
                        radio_util_interference: 4.38913492154744
                        site_num_clients: -0.2855822932389047
                        site_wan_avg_upload_mbps: -0.988989942603641
                        site_wan_jitter: 0.7875519659784105
                        site_wan_rtt: 15.094849904378256
                        site_wan_upload_mbps: -0.8131117953194512
                      audio_out:
                        ap_num_clients: 45.48306793636746
                        ap_rtt: 6.352042701509264
                        client_cpu: 9.323452578650581
                        client_radio_band: 0.5841414928436279
                        client_rssi: 17.251008563571506
                        client_tx_bytes: 1.8379177401463191
                        client_tx_rates: 10.668423069847954
                        client_tx_retries: 43.323209603627525
                        client_vpn_distance: 112.4420166015625
                        expected: 29.74261474609375
                        radio_bandwidth: -0.1533682727151447
                        radio_channel: 0.662909648484654
                        radio_util: 27.891777674357098
                        radio_util_interference: 4.38913492154744
                        site_num_clients: -0.2855822932389047
                        site_wan_avg_upload_mbps: -0.988989942603641
                        site_wan_jitter: 0.7875519659784105
                        site_wan_rtt: 15.094849904378256
                        site_wan_upload_mbps: -0.8131117953194512
                      client_cpu: 0.00834270566701889
                      client_n_streams: 0.00734270566701889
                      client_radio_band: 0.5841414928436279
                      client_rssi: 0.7594696879386902
                      client_rx_bytes: 2.365511655807E-05
                      client_rx_rates: 0.02441493794322014
                      client_rx_retries: -0.14325742423534393
                      client_tx_bytes: 0.00102365511655807
                      client_tx_rates: 0.22236637771129608
                      client_tx_retries: 0.3308201730251312
                      client_vpn_distance: -0.0001660545531194657
                      client_wifi_version: 7.0566701889E-07
                      expected: -2.8630001056670187
                      radio_ap_change: 0.01850946433842182
                      radio_bandwidth: -0.021175479516386986
                      radio_channel: 0.11686426401138306
                      radio_rx_failed: 1.1782013177871704
                      radio_tx_power: 0.121039018034935
                      radio_util: 0.2452986091375351
                      radio_util_interference: 3.4367904663085938
                      site_num_clients: 0.055026158690452576
                      site_wan_avg_download_mbps: 3.0566701889E-07
                      site_wan_avg_upload_mbps: 5.566701889E-08
                      site_wan_download_mbps: 8.0566701889E-07
                      site_wan_jitter: 0.7875519659784105
                      site_wan_rtt: 15.094849904378256
                      site_wan_upload_mbps: 2.0566701889E-07
                      timestamp: 1695425115
                      video_in:
                        ap_num_clients: 45.48306793636746
                        ap_rtt: 6.352042701509264
                        client_cpu: 9.323452578650581
                        client_radio_band: 0.5841414928436279
                        client_rssi: 17.251008563571506
                        client_tx_bytes: 1.8379177401463191
                        client_tx_rates: 10.668423069847954
                        client_tx_retries: 43.323209603627525
                        client_vpn_distance: 112.4420166015625
                        expected: 29.74261474609375
                        radio_bandwidth: -0.1533682727151447
                        radio_channel: 0.662909648484654
                        radio_util: 27.891777674357098
                        radio_util_interference: 4.38913492154744
                        site_num_clients: -0.2855822932389047
                        site_wan_avg_upload_mbps: -0.988989942603641
                        site_wan_jitter: 0.7875519659784105
                        site_wan_rtt: 15.094849904378256
                        site_wan_upload_mbps: -0.8131117953194512
                      video_out:
                        ap_num_clients: 45.48306793636746
                        ap_rtt: 6.352042701509264
                        client_cpu: 9.323452578650581
                        client_radio_band: 0.5841414928436279
                        client_rssi: 17.251008563571506
                        client_tx_bytes: 1.8379177401463191
                        client_tx_rates: 10.668423069847954
                        client_tx_retries: 43.323209603627525
                        client_vpn_distance: 112.4420166015625
                        expected: 29.74261474609375
                        radio_bandwidth: -0.1533682727151447
                        radio_channel: 0.662909648484654
                        radio_util: 27.891777674357098
                        radio_util_interference: 4.38913492154744
                        site_num_clients: -0.2855822932389047
                        site_wan_avg_upload_mbps: -0.988989942603641
                        site_wan_jitter: 0.7875519659784105
                        site_wan_rtt: 15.094849904378256
                        site_wan_upload_mbps: -0.8131117953194512
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_call_troubleshoot_summary'
                - description: Site call troubleshooting summary response
                  examples:
                  - mac: 983a78ea4a44
                    meeting_id: b784d744-9a7c-4fad-9af0-f78858a319b1
                    results:
                    - ap_num_clients: -0.08802365511655807
                      ap_rtt: 0.09924473613500595
                      audio_in:
                        ap_num_clients: 45.48306793636746
                        ap_rtt: 6.352042701509264
                        client_cpu: 9.323452578650581
                        client_radio_band: 0.5841414928436279
                        client_rssi: 17.251008563571506
                        client_tx_bytes: 1.8379177401463191
                        client_tx_rates: 10.668423069847954
                        client_tx_retries: 43.323209603627525
                        client_vpn_distance: 112.4420166015625
                        expected: 29.74261474609375
                        radio_bandwidth: -0.1533682727151447
                        radio_channel: 0.662909648484654
                        radio_util: 27.891777674357098
                        radio_util_interference: 4.38913492154744
                        site_num_clients: -0.2855822932389047
                        site_wan_avg_upload_mbps: -0.988989942603641
                        site_wan_jitter: 0.7875519659784105
                        site_wan_rtt: 15.094849904378256
                        site_wan_upload_mbps: -0.8131117953194512
                      audio_out:
                        ap_num_clients: 45.48306793636746
                        ap_rtt: 6.352042701509264
                        client_cpu: 9.323452578650581
                        client_radio_band: 0.5841414928436279
                        client_rssi: 17.251008563571506
                        client_tx_bytes: 1.8379177401463191
                        client_tx_rates: 10.668423069847954
                        client_tx_retries: 43.323209603627525
                        client_vpn_distance: 112.4420166015625
                        expected: 29.74261474609375
                        radio_bandwidth: -0.1533682727151447
                        radio_channel: 0.662909648484654
                        radio_util: 27.891777674357098
                        radio_util_interference: 4.38913492154744
                        site_num_clients: -0.2855822932389047
                        site_wan_avg_upload_mbps: -0.988989942603641
                        site_wan_jitter: 0.7875519659784105
                        site_wan_rtt: 15.094849904378256
                        site_wan_upload_mbps: -0.8131117953194512
                      client_cpu: 0.00834270566701889
                      client_n_streams: 0.00734270566701889
                      client_radio_band: 0.5841414928436279
                      client_rssi: 0.7594696879386902
                      client_rx_bytes: 2.365511655807E-05
                      client_rx_rates: 0.02441493794322014
                      client_rx_retries: -0.14325742423534393
                      client_tx_bytes: 0.00102365511655807
                      client_tx_rates: 0.22236637771129608
                      client_tx_retries: 0.3308201730251312
                      client_vpn_distance: -0.0001660545531194657
                      client_wifi_version: 7.0566701889E-07
                      expected: -2.8630001056670187
                      radio_ap_change: 0.01850946433842182
                      radio_bandwidth: -0.021175479516386986
                      radio_channel: 0.11686426401138306
                      radio_rx_failed: 1.1782013177871704
                      radio_tx_power: 0.121039018034935
                      radio_util: 0.2452986091375351
                      radio_util_interference: 3.4367904663085938
                      site_num_clients: 0.055026158690452576
                      site_wan_avg_download_mbps: 3.0566701889E-07
                      site_wan_avg_upload_mbps: 5.566701889E-08
                      site_wan_download_mbps: 8.0566701889E-07
                      site_wan_jitter: 0.7875519659784105
                      site_wan_rtt: 15.094849904378256
                      site_wan_upload_mbps: 2.0566701889E-07
                      timestamp: 1695425115
                      video_in:
                        ap_num_clients: 45.48306793636746
                        ap_rtt: 6.352042701509264
                        client_cpu: 9.323452578650581
                        client_radio_band: 0.5841414928436279
                        client_rssi: 17.251008563571506
                        client_tx_bytes: 1.8379177401463191
                        client_tx_rates: 10.668423069847954
                        client_tx_retries: 43.323209603627525
                        client_vpn_distance: 112.4420166015625
                        expected: 29.74261474609375
                        radio_bandwidth: -0.1533682727151447
                        radio_channel: 0.662909648484654
                        radio_util: 27.891777674357098
                        radio_util_interference: 4.38913492154744
                        site_num_clients: -0.2855822932389047
                        site_wan_avg_upload_mbps: -0.988989942603641
                        site_wan_jitter: 0.7875519659784105
                        site_wan_rtt: 15.094849904378256
                        site_wan_upload_mbps: -0.8131117953194512
                      video_out:
                        ap_num_clients: 45.48306793636746
                        ap_rtt: 6.352042701509264
                        client_cpu: 9.323452578650581
                        client_radio_band: 0.5841414928436279
                        client_rssi: 17.251008563571506
                        client_tx_bytes: 1.8379177401463191
                        client_tx_rates: 10.668423069847954
                        client_tx_retries: 43.323209603627525
                        client_vpn_distance: 112.4420166015625
                        expected: 29.74261474609375
                        radio_bandwidth: -0.1533682727151447
                        radio_channel: 0.662909648484654
                        radio_util: 27.891777674357098
                        radio_util_interference: 4.38913492154744
                        site_num_clients: -0.2855822932389047
                        site_wan_avg_upload_mbps: -0.988989942603641
                        site_wan_jitter: 0.7875519659784105
                        site_wan_rtt: 15.094849904378256
                        site_wan_upload_mbps: -0.8131117953194512
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    mac: 983a78ea4a44
                    meeting_id: b784d744-9a7c-4fad-9af0-f78858a319b1
                    results:
                    - ap_num_clients: -0.08802365511655807
                      ap_rtt: 0.09924473613500595
                      audio_in:
                        ap_num_clients: 45.48306793636746
                        ap_rtt: 6.352042701509264
                        client_cpu: 9.323452578650581
                        client_radio_band: 0.5841414928436279
                        client_rssi: 17.251008563571506
                        client_tx_bytes: 1.8379177401463191
                        client_tx_rates: 10.668423069847954
                        client_tx_retries: 43.323209603627525
                        client_vpn_distance: 112.4420166015625
                        expected: 29.74261474609375
                        radio_bandwidth: -0.1533682727151447
                        radio_channel: 0.662909648484654
                        radio_util: 27.891777674357098
                        radio_util_interference: 4.38913492154744
                        site_num_clients: -0.2855822932389047
                        site_wan_avg_upload_mbps: -0.988989942603641
                        site_wan_jitter: 0.7875519659784105
                        site_wan_rtt: 15.094849904378256
                        site_wan_upload_mbps: -0.8131117953194512
                      audio_out:
                        ap_num_clients: 45.48306793636746
                        ap_rtt: 6.352042701509264
                        client_cpu: 9.323452578650581
                        client_radio_band: 0.5841414928436279
                        client_rssi: 17.251008563571506
                        client_tx_bytes: 1.8379177401463191
                        client_tx_rates: 10.668423069847954
                        client_tx_retries: 43.323209603627525
                        client_vpn_distance: 112.4420166015625
                        expected: 29.74261474609375
                        radio_bandwidth: -0.1533682727151447
                        radio_channel: 0.662909648484654
                        radio_util: 27.891777674357098
                        radio_util_interference: 4.38913492154744
                        site_num_clients: -0.2855822932389047
                        site_wan_avg_upload_mbps: -0.988989942603641
                        site_wan_jitter: 0.7875519659784105
                        site_wan_rtt: 15.094849904378256
                        site_wan_upload_mbps: -0.8131117953194512
                      client_cpu: 0.00834270566701889
                      client_n_streams: 0.00734270566701889
                      client_radio_band: 0.5841414928436279
                      client_rssi: 0.7594696879386902
                      client_rx_bytes: 2.365511655807E-05
                      client_rx_rates: 0.02441493794322014
                      client_rx_retries: -0.14325742423534393
                      client_tx_bytes: 0.00102365511655807
                      client_tx_rates: 0.22236637771129608
                      client_tx_retries: 0.3308201730251312
                      client_vpn_distance: -0.0001660545531194657
                      client_wifi_version: 7.0566701889E-07
                      expected: -2.8630001056670187
                      radio_ap_change: 0.01850946433842182
                      radio_bandwidth: -0.021175479516386986
                      radio_channel: 0.11686426401138306
                      radio_rx_failed: 1.1782013177871704
                      radio_tx_power: 0.121039018034935
                      radio_util: 0.2452986091375351
                      radio_util_interference: 3.4367904663085938
                      site_num_clients: 0.055026158690452576
                      site_wan_avg_download_mbps: 3.0566701889E-07
                      site_wan_avg_upload_mbps: 5.566701889E-08
                      site_wan_download_mbps: 8.0566701889E-07
                      site_wan_jitter: 0.7875519659784105
                      site_wan_rtt: 15.094849904378256
                      site_wan_upload_mbps: 2.0566701889E-07
                      timestamp: 1695425115
                      video_in:
                        ap_num_clients: 45.48306793636746
                        ap_rtt: 6.352042701509264
                        client_cpu: 9.323452578650581
                        client_radio_band: 0.5841414928436279
                        client_rssi: 17.251008563571506
                        client_tx_bytes: 1.8379177401463191
                        client_tx_rates: 10.668423069847954
                        client_tx_retries: 43.323209603627525
                        client_vpn_distance: 112.4420166015625
                        expected: 29.74261474609375
                        radio_bandwidth: -0.1533682727151447
                        radio_channel: 0.662909648484654
                        radio_util: 27.891777674357098
                        radio_util_interference: 4.38913492154744
                        site_num_clients: -0.2855822932389047
                        site_wan_avg_upload_mbps: -0.988989942603641
                        site_wan_jitter: 0.7875519659784105
                        site_wan_rtt: 15.094849904378256
                        site_wan_upload_mbps: -0.8131117953194512
                      video_out:
                        ap_num_clients: 45.48306793636746
                        ap_rtt: 6.352042701509264
                        client_cpu: 9.323452578650581
                        client_radio_band: 0.5841414928436279
                        client_rssi: 17.251008563571506
                        client_tx_bytes: 1.8379177401463191
                        client_tx_rates: 10.668423069847954
                        client_tx_retries: 43.323209603627525
                        client_vpn_distance: 112.4420166015625
                        expected: 29.74261474609375
                        radio_bandwidth: -0.1533682727151447
                        radio_channel: 0.662909648484654
                        radio_util: 27.891777674357098
                        radio_util_interference: 4.38913492154744
                        site_num_clients: -0.2855822932389047
                        site_wan_avg_upload_mbps: -0.988989942603641
                        site_wan_jitter: 0.7875519659784105
                        site_wan_rtt: 15.094849904378256
                        site_wan_upload_mbps: -0.8131117953194512
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/clients:
    get:
      tags:
      - Sites Stats - Clients Wireless
      summary: listSiteWirelessClientsStats
      description: Get List of Site All Clients Stats Details
      operationId: listSiteWirelessClientsStats
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: wired
        in: query
        description: Filter results by whether the client is wired
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          examples:
          - false
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/stats_client'
                description: Client statistics records returned by a stats response
                examples:
                - - annotation: unknown
                    ap_id: 00000000-0000-0000-1000-5c5b35963d70
                    ap_mac: 5c5b358e6fea
                    assoc_time: 1741152905
                    band: '5'
                    bssid: 5c5b358298f2
                    channel: 157
                    dual_band: true
                    family: ''
                    group: ''
                    hostname: android-9b228dc33690
                    idle_time: 5
                    ip: 10.100.0.47
                    is_guest: false
                    key_mgmt: WPA3-SAE-FT/CCMP
                    last_seen: 1741257505
                    mac: dadbfc123456
                    manufacture: Unknown
                    map_id: ed7a0a4e-8835-4c94-ba78-6c1169c9f135
                    model: ''
                    num_locating_aps: 2
                    os: Android 10
                    proto: ac
                    rssi: -39
                    rx_bps: 0
                    rx_bytes: 14451780
                    rx_pkts: 44175
                    rx_rate: 6
                    rx_retries: 2010
                    site_id: 96c348a9-d6d7-4732-b4f5-23350a2843cd
                    snr: 47
                    ssid: Live_demo_only
                    tx_bps: 0
                    tx_bytes: 56364072
                    tx_pkts: 43685
                    tx_rate: 173.3
                    tx_retries: 5413
                    uptime: 104600
                    vlan_id: '1'
                    wlan_id: 497fc18a-79b5-405a-bf5a-192eed31ea60
                    x: 695.3357339330526
                    x_m: 24.086588
                    y: 760.6746524247893
                    y_m: 26.349943
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - annotation: unknown
                    ap_id: 00000000-0000-0000-1000-5c5b35963d70
                    ap_mac: 5c5b358e6fea
                    assoc_time: 1741152905
                    band: '5'
                    bssid: 5c5b358298f2
                    channel: 157
                    dual_band: true
                    family: ''
                    group: ''
                    hostname: android-9b228dc33690
                    idle_time: 5
                    ip: 10.100.0.47
                    is_guest: false
                    key_mgmt: WPA3-SAE-FT/CCMP
                    last_seen: 1741257505
                    mac: dadbfc123456
                    manufacture: Unknown
                    map_id: ed7a0a4e-8835-4c94-ba78-6c1169c9f135
                    model: ''
                    num_locating_aps: 2
                    os: Android 10
                    proto: ac
                    rssi: -39
                    rx_bps: 0
                    rx_bytes: 14451780
                    rx_pkts: 44175
                    rx_rate: 6
                    rx_retries: 2010
                    site_id: 96c348a9-d6d7-4732-b4f5-23350a2843cd
                    snr: 47
                    ssid: Live_demo_only
                    tx_bps: 0
                    tx_bytes: 56364072
                    tx_pkts: 43685
                    tx_rate: 173.3
                    tx_retries: 5413
                    uptime: 104600
                    vlan_id: '1'
                    wlan_id: 497fc18a-79b5-405a-bf5a-192eed31ea60
                    x: 695.3357339330526
                    x_m: 24.086588
                    y: 760.6746524247893
                    y_m: 26.349943
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/stats_client'
                description: Client statistics records returned by a stats response
                examples:
                - - annotation: unknown
                    ap_id: 00000000-0000-0000-1000-5c5b35963d70
                    ap_mac: 5c5b358e6fea
                    assoc_time: 1741152905
                    band: '5'
                    bssid: 5c5b358298f2
                    channel: 157
                    dual_band: true
                    family: ''
                    group: ''
                    hostname: android-9b228dc33690
                    idle_time: 5
                    ip: 10.100.0.47
                    is_guest: false
                    key_mgmt: WPA3-SAE-FT/CCMP
                    last_seen: 1741257505
                    mac: dadbfc123456
                    manufacture: Unknown
                    map_id: ed7a0a4e-8835-4c94-ba78-6c1169c9f135
                    model: ''
                    num_locating_aps: 2
                    os: Android 10
                    proto: ac
                    rssi: -39
                    rx_bps: 0
                    rx_bytes: 14451780
                    rx_pkts: 44175
                    rx_rate: 6
                    rx_retries: 2010
                    site_id: 96c348a9-d6d7-4732-b4f5-23350a2843cd
                    snr: 47
                    ssid: Live_demo_only
                    tx_bps: 0
                    tx_bytes: 56364072
                    tx_pkts: 43685
                    tx_rate: 173.3
                    tx_retries: 5413
                    uptime: 104600
                    vlan_id: '1'
                    wlan_id: 497fc18a-79b5-405a-bf5a-192eed31ea60
                    x: 695.3357339330526
                    x_m: 24.086588
                    y: 760.6746524247893
                    y_m: 26.349943
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - annotation: unknown
                    ap_id: 00000000-0000-0000-1000-5c5b35963d70
                    ap_mac: 5c5b358e6fea
                    assoc_time: 1741152905
                    band: '5'
                    bssid: 5c5b358298f2
                    channel: 157
                    dual_band: true
                    family: ''
                    group: ''
                    hostname: android-9b228dc33690
                    idle_time: 5
                    ip: 10.100.0.47
                    is_guest: false
                    key_mgmt: WPA3-SAE-FT/CCMP
                    last_seen: 1741257505
                    mac: dadbfc123456
                    manufacture: Unknown
                    map_id: ed7a0a4e-8835-4c94-ba78-6c1169c9f135
                    model: ''
                    num_locating_aps: 2
                    os: Android 10
                    proto: ac
                    rssi: -39
                    rx_bps: 0
                    rx_bytes: 14451780
                    rx_pkts: 44175
                    rx_rate: 6
                    rx_retries: 2010
                    site_id: 96c348a9-d6d7-4732-b4f5-23350a2843cd
                    snr: 47
                    ssid: Live_demo_only
                    tx_bps: 0
                    tx_bytes: 56364072
                    tx_pkts: 43685
                    tx_rate: 173.3
                    tx_retries: 5413
                    uptime: 104600
                    vlan_id: '1'
                    wlan_id: 497fc18a-79b5-405a-bf5a-192eed31ea60
                    x: 695.3357339330526
                    x_m: 24.086588
                    y: 760.6746524247893
                    y_m: 26.349943
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/clients/{client_mac}:
    get:
      tags:
      - Sites Stats - Clients Wireless
      summary: getSiteWirelessClientStats
      description: Get Site Client Stats Details
      operationId: getSiteWirelessClientStats
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: client_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      - name: wired
        in: query
        description: Filter results by whether the client is wired
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          examples:
          - false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/stats_client'
                - description: Client statistics record for a wireless or wired client
                  examples:
                  - annotation: unknown
                    ap_id: 00000000-0000-0000-1000-5c5b35963d70
                    ap_mac: 5c5b358e6fea
                    assoc_time: 1741152905
                    band: '5'
                    bssid: 5c5b358298f2
                    channel: 157
                    dual_band: true
                    family: ''
                    group: ''
                    hostname: android-9b228dc33690
                    idle_time: 5
                    ip: 10.100.0.47
                    is_guest: false
                    key_mgmt: WPA3-SAE-FT/CCMP
                    last_seen: 1741257505
                    mac: dadbfc123456
                    manufacture: Unknown
                    map_id: ed7a0a4e-8835-4c94-ba78-6c1169c9f135
                    model: ''
                    num_locating_aps: 2
                    os: Android 10
                    proto: ac
                    rssi: -39
                    rx_bps: 0
                    rx_bytes: 14451780
                    rx_pkts: 44175
                    rx_rate: 6
                    rx_retries: 2010
                    site_id: 96c348a9-d6d7-4732-b4f5-23350a2843cd
                    snr: 47
                    ssid: Live_demo_only
                    tx_bps: 0
                    tx_bytes: 56364072
                    tx_pkts: 43685
                    tx_rate: 173.3
                    tx_retries: 5413
                    uptime: 104600
                    vlan_id: '1'
                    wlan_id: 497fc18a-79b5-405a-bf5a-192eed31ea60
                    x: 695.3357339330526
                    x_m: 24.086588
                    y: 760.6746524247893
                    y_m: 26.349943
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    annotation: unknown
                    ap_id: 00000000-0000-0000-1000-5c5b35963d70
                    ap_mac: 5c5b358e6fea
                    assoc_time: 1741152905
                    band: '5'
                    bssid: 5c5b358298f2
                    channel: 157
                    dual_band: true
                    family: ''
                    group: ''
                    hostname: android-9b228dc33690
                    idle_time: 5
                    ip: 10.100.0.47
                    is_guest: false
                    key_mgmt: WPA3-SAE-FT/CCMP
                    last_seen: 1741257505
                    mac: dadbfc123456
                    manufacture: Unknown
                    map_id: ed7a0a4e-8835-4c94-ba78-6c1169c9f135
                    model: ''
                    num_locating_aps: 2
                    os: Android 10
                    proto: ac
                    rssi: -39
                    rx_bps: 0
                    rx_bytes: 14451780
                    rx_pkts: 44175
                    rx_rate: 6
                    rx_retries: 2010
                    site_id: 96c348a9-d6d7-4732-b4f5-23350a2843cd
                    snr: 47
                    ssid: Live_demo_only
                    tx_bps: 0
                    tx_bytes: 56364072
                    tx_pkts: 43685
                    tx_rate: 173.3
                    tx_retries: 5413
                    uptime: 104600
                    vlan_id: '1'
                    wlan_id: 497fc18a-79b5-405a-bf5a-192eed31ea60
                    x: 695.3357339330526
                    x_m: 24.086588
                    y: 760.6746524247893
                    y_m: 26.349943
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/stats_client'
                - description: Client statistics record for a wireless or wired client
                  examples:
                  - annotation: unknown
                    ap_id: 00000000-0000-0000-1000-5c5b35963d70
                    ap_mac: 5c5b358e6fea
                    assoc_time: 1741152905
                    band: '5'
                    bssid: 5c5b358298f2
                    channel: 157
                    dual_band: true
                    family: ''
                    group: ''
                    hostname: android-9b228dc33690
                    idle_time: 5
                    ip: 10.100.0.47
                    is_guest: false
                    key_mgmt: WPA3-SAE-FT/CCMP
                    last_seen: 1741257505
                    mac: dadbfc123456
                    manufacture: Unknown
                    map_id: ed7a0a4e-8835-4c94-ba78-6c1169c9f135
                    model: ''
                    num_locating_aps: 2
                    os: Android 10
                    proto: ac
                    rssi: -39
                    rx_bps: 0
                    rx_bytes: 14451780
                    rx_pkts: 44175
                    rx_rate: 6
                    rx_retries: 2010
                    site_id: 96c348a9-d6d7-4732-b4f5-23350a2843cd
                    snr: 47
                    ssid: Live_demo_only
                    tx_bps: 0
                    tx_bytes: 56364072
                    tx_pkts: 43685
                    tx_rate: 173.3
                    tx_retries: 5413
                    uptime: 104600
                    vlan_id: '1'
                    wlan_id: 497fc18a-79b5-405a-bf5a-192eed31ea60
                    x: 695.3357339330526
                    x_m: 24.086588
                    y: 760.6746524247893
                    y_m: 26.349943
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    annotation: unknown
                    ap_id: 00000000-0000-0000-1000-5c5b35963d70
                    ap_mac: 5c5b358e6fea
                    assoc_time: 1741152905
                    band: '5'
                    bssid: 5c5b358298f2
                    channel: 157
                    dual_band: true
                    family: ''
                    group: ''
                    hostname: android-9b228dc33690
                    idle_time: 5
                    ip: 10.100.0.47
                    is_guest: false
                    key_mgmt: WPA3-SAE-FT/CCMP
                    last_seen: 1741257505
                    mac: dadbfc123456
                    manufacture: Unknown
                    map_id: ed7a0a4e-8835-4c94-ba78-6c1169c9f135
                    model: ''
                    num_locating_aps: 2
                    os: Android 10
                    proto: ac
                    rssi: -39
                    rx_bps: 0
                    rx_bytes: 14451780
                    rx_pkts: 44175
                    rx_rate: 6
                    rx_retries: 2010
                    site_id: 96c348a9-d6d7-4732-b4f5-23350a2843cd
                    snr: 47
                    ssid: Live_demo_only
                    tx_bps: 0
                    tx_bytes: 56364072
                    tx_pkts: 43685
                    tx_rate: 173.3
                    tx_retries: 5413
                    uptime: 104600
                    vlan_id: '1'
                    wlan_id: 497fc18a-79b5-405a-bf5a-192eed31ea60
                    x: 695.3357339330526
                    x_m: 24.086588
                    y: 760.6746524247893
                    y_m: 26.349943
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/maps/{map_id}/clients:
    get:
      tags:
      - Sites Stats - Clients Wireless
      summary: getSiteWirelessClientsStatsByMap
      description: Get Site Clients Stats By Map
      operationId: getSiteWirelessClientsStatsByMap
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: map_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/stats_wireless_client'
                description: Wireless client statistics records returned by a stats response
                examples:
                - - annotation: unknown
                    ap_id: 00000000-0000-0000-1000-5c5b35963d70
                    ap_mac: 5c5b358e6fea
                    assoc_time: 1741152905
                    band: '5'
                    bssid: 5c5b358298f2
                    channel: 157
                    dual_band: true
                    family: ''
                    group: ''
                    hostname: android-9b228dc33690
                    idle_time: 5
                    ip: 10.100.0.47
                    is_guest: false
                    key_mgmt: WPA3-SAE-FT/CCMP
                    last_seen: 1741257505
                    mac: dadbfc123456
                    manufacture: Unknown
                    map_id: ed7a0a4e-8835-4c94-ba78-6c1169c9f135
                    model: ''
                    num_locating_aps: 2
                    os: Android 10
                    proto: ac
                    rssi: -39
                    rx_bps: 0
                    rx_bytes: 14451780
                    rx_pkts: 44175
                    rx_rate: 6
                    rx_retries: 2010
                    site_id: 96c348a9-d6d7-4732-b4f5-23350a2843cd
                    snr: 47
                    ssid: Live_demo_only
                    tx_bps: 0
                    tx_bytes: 56364072
                    tx_pkts: 43685
                    tx_rate: 173.3
                    tx_retries: 5413
                    uptime: 104600
                    vlan_id: '1'
                    wlan_id: 497fc18a-79b5-405a-bf5a-192eed31ea60
                    x: 695.3357339330526
                    x_m: 24.086588
                    y: 760.6746524247893
                    y_m: 26.349943
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - annotation: unknown
                    ap_id: 00000000-0000-0000-1000-5c5b35963d70
                    ap_mac: 5c5b358e6fea
                    assoc_time: 1741152905
                    band: '5'
                    bssid: 5c5b358298f2
                    channel: 157
                    dual_band: true
                    family: ''
                    group: ''
                    hostname: android-9b228dc33690
                    idle_time: 5
                    ip: 10.100.0.47
                    is_guest: false
                    key_mgmt: WPA3-SAE-FT/CCMP
                    last_seen: 1741257505
                    mac: dadbfc123456
                    manufacture: Unknown
                    map_id: ed7a0a4e-8835-4c94-ba78-6c1169c9f135
                    model: ''
                    num_locating_aps: 2
                    os: Android 10
                    proto: ac
                    rssi: -39
                    rx_bps: 0
                    rx_bytes: 14451780
                    rx_pkts: 44175
                    rx_rate: 6
                    rx_retries: 2010
                    site_id: 96c348a9-d6d7-4732-b4f5-23350a2843cd
                    snr: 47
                    ssid: Live_demo_only
                    tx_bps: 0
                    tx_bytes: 56364072
                    tx_pkts: 43685
                    tx_rate: 173.3
                    tx_retries: 5413
                    uptime: 104600
                    vlan_id: '1'
                    wlan_id: 497fc18a-79b5-405a-bf5a-192eed31ea60
                    x: 695.3357339330526
                    x_m: 24.086588
                    y: 760.6746524247893
                    y_m: 26.349943
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/stats_wireless_client'
                description: Wireless client statistics records returned by a stats response
                examples:
                - - annotation: unknown
                    ap_id: 00000000-0000-0000-1000-5c5b35963d70
                    ap_mac: 5c5b358e6fea
                    assoc_time: 1741152905
                    band: '5'
                    bssid: 5c5b358298f2
                    channel: 157
                    dual_band: true
                    family: ''
                    group: ''
                    hostname: android-9b228dc33690
                    idle_time: 5
                    ip: 10.100.0.47
                    is_guest: false
                    key_mgmt: WPA3-SAE-FT/CCMP
                    last_seen: 1741257505
                    mac: dadbfc123456
                    manufacture: Unknown
                    map_id: ed7a0a4e-8835-4c94-ba78-6c1169c9f135
                    model: ''
                    num_locating_aps: 2
                    os: Android 10
                    proto: ac
                    rssi: -39
                    rx_bps: 0
                    rx_bytes: 14451780
                    rx_pkts: 44175
                    rx_rate: 6
                    rx_retries: 2010
                    site_id: 96c348a9-d6d7-4732-b4f5-23350a2843cd
                    snr: 47
                    ssid: Live_demo_only
                    tx_bps: 0
                    tx_bytes: 56364072
                    tx_pkts: 43685
                    tx_rate: 173.3
                    tx_retries: 5413
                    uptime: 104600
                    vlan_id: '1'
                    wlan_id: 497fc18a-79b5-405a-bf5a-192eed31ea60
                    x: 695.3357339330526
                    x_m: 24.086588
                    y: 760.6746524247893
                    y_m: 26.349943
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - annotation: unknown
                    ap_id: 00000000-0000-0000-1000-5c5b35963d70
                    ap_mac: 5c5b358e6fea
                    assoc_time: 1741152905
                    band: '5'
                    bssid: 5c5b358298f2
                    channel: 157
                    dual_band: true
                    family: ''
                    group: ''
                    hostname: android-9b228dc33690
                    idle_time: 5
                    ip: 10.100.0.47
                    is_guest: false
                    key_mgmt: WPA3-SAE-FT/CCMP
                    last_seen: 1741257505
                    mac: dadbfc123456
                    manufacture: Unknown
                    map_id: ed7a0a4e-8835-4c94-ba78-6c1169c9f135
                    model: ''
                    num_locating_aps: 2
                    os: Android 10
                    proto: ac
                    rssi: -39
                    rx_bps: 0
                    rx_bytes: 14451780
                    rx_pkts: 44175
                    rx_rate: 6
                    rx_retries: 2010
                    site_id: 96c348a9-d6d7-4732-b4f5-23350a2843cd
                    snr: 47
                    ssid: Live_demo_only
                    tx_bps: 0
                    tx_bytes: 56364072
                    tx_pkts: 43685
                    tx_rate: 173.3
                    tx_retries: 5413
                    uptime: 104600
                    vlan_id: '1'
                    wlan_id: 497fc18a-79b5-405a-bf5a-192eed31ea60
                    x: 695.3357339330526
                    x_m: 24.086588
                    y: 760.6746524247893
                    y_m: 26.349943
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/maps/{map_id}/unconnected_clients:
    get:
      tags:
      - Sites Stats - Clients Wireless
      summary: listSiteUnconnectedClientStats
      description: Get List of Site Unconnected Client Location
      operationId: listSiteUnconnectedClientStats
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: map_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/stats_unconnected_client'
                description: Unconnected Wi-Fi client location statistics returned by the request
                examples:
                - - ap_mac: 5c5b350e0410
                    last_seen: 1428939600
                    mac: 5684dae9ac8b
                    manufacture: Apple
                    rssi: -75
                    x: 60
                    y: 80
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - ap_mac: 5c5b350e0410
                    last_seen: 1428939600
                    mac: 5684dae9ac8b
                    manufacture: Apple
                    rssi: -75
                    x: 60
                    y: 80
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/maps/{map_id}/sdkclients:
    get:
      tags:
      - Sites Stats - Clients SDK
      summary: getSiteSdkStatsByMap
      description: Get SdkClient Stats By Map
      operationId: getSiteSdkStatsByMap
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: map_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/stats_sdkclient'
                description: SDK client statistics records returned by a stats response
                contentMediaType: application/json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/sdkclients/{sdkclient_id}:
    get:
      tags:
      - Sites Stats - Clients SDK
      summary: getSiteSdkStats
      description: Get Detail Stats of a SdkClient
      operationId: getSiteSdkStats
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: sdkclient_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sdkstats_wireless_client'
                - description: Detailed statistics for an individual SDK client
                  examples:
                  - id: d56bd5fa-0a0a-4861-a9df-5ac83d3a2eeb
                    last_seen: 1428939600
                    name: John's iPhone
                    network_connection:
                      mac: c3-b6-e5-af-41-15
                      rssi: -75
                      signal_level: 3
                      type: WiFi
                    uuid: ada72f8f-1643-e5c6-94db-f2a5636f1a64
                    vbeacons:
                    - id: d379d29d-24b4-96c5-5dd4-6f2a2dc5aaeb
                      since: 1428939300
                    x: 60
                    y: 80
                    zones:
                    - id: 8ac84899-32db-6327-334c-9b6d58544cfe
                      since: 1428939600
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    id: d56bd5fa-0a0a-4861-a9df-5ac83d3a2eeb
                    last_seen: 1428939600
                    name: John's iPhone
                    network_connection:
                      mac: c3-b6-e5-af-41-15
                      rssi: -75
                      signal_level: 3
                      type: WiFi
                    uuid: ada72f8f-1643-e5c6-94db-f2a5636f1a64
                    vbeacons:
                    - id: d379d29d-24b4-96c5-5dd4-6f2a2dc5aaeb
                      since: 1428939300
                    x: 60
                    y: 80
                    zones:
                    - id: 8ac84899-32db-6327-334c-9b6d58544cfe
                      since: 1428939600
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/devices:
    get:
      tags:
      - Sites Stats - Devices
      summary: listSiteDevicesStats
      description: List device statistics for a site, including high-level status and performance fields over the requested time range. Use [List Org Device Stats]($e/Orgs%20Stats%20-%20Devices/listOrgDevicesStats) to retrieve device statistics across the organization.
      operationId: listSiteDevicesStats
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: type
        in: query
        description: Filter results by type
        style: form
        explode: true
        schema:
          type: string
          default: ap
      - name: status
        in: query
        description: 'Filter results by status. enum: `all`, `connected`, `disconnected`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/stat_device_status_filter'
          - description: 'Filter results by status. enum: `all`, `connected`, `disconnected`'
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/stats_device'
                description: Device statistics records returned by a stats response
                examples:
                - '[{"auto_upgrade_stat":{"lastcheck":1720594762},"ble_stat":{"beacon_enabled":true,"beacon_rate":4,"eddystone_uid_enabled":false,"eddystone_uid_freq_msec":1000,"eddystone_uid_instance":"5c5b35d0077b","eddystone_uid_namespace":"9777c1a06ef611e68bbf","eddystone_url_enabled":false,"eddystone_url_freq_msec":1000,"eddystone_url_url":"","ibeacon_enabled":false,"ibeacon_freq_msec":1000,"ibeacon_major":894,"ibeacon_minor":9328,"ibeacon_uuid":"af010e2b-f829-4975-b49e-2e896ed1d627","major":894,"minors":[9328,9329,9330,9331,9332,9333,9334,9335,-1],"power":8,"rx_bytes":158500843,"rx_pkts":3549163,"tx_bytes":509640,"tx_pkts":85411,"tx_resets":0,"uuid":"af010e2b-f829-4975-b49e-2e896ed1d627"},"config_reverted":false,"cpu_system":21921854,"cpu_user":7496631,"cpu_util":5,"created_time":1718228350,"env_stat":{"accel_x":-0.092,"accel_y":0.004,"accel_z":-1.02,"ambient_temp":43,"attitude":0,"cpu_temp":53,"humidity":9,"magne_x":0,"magne_y":0,"magne_z":0,"pressure":968,"vcore_voltage":0},"ext_ip":"66.129.234.28","hw_rev":"C02","id":"00000000-0000-0000-1000-5c5b35d0077b","inactive_wired_vlans":[],"ip":"192.168.95.3","ip_stat":{"dhcp_server":"192.168.95.1","dns":["8.8.8.8"],"gateway":"192.168.95.1","ip":"192.168.95.3","ip6":"fe80:0:0:0:5e5b:35ff:fed0:77b","ips":{"vlan1":"192.168.95.3/24,fe80:0:0:0:5e5b:35ff:fed0:77b/64"},"netmask":"255.255.255.0","netmask6":"/64"},"last_seen":1720595866,"last_trouble":{"code":"07","timestamp":1720039666},"lldp_stat":{"chassis_id":"d0:07:ca:f5:21:00","lldp_med_supported":false,"mgmt_addr":"100.123.105.1","mgmt_addrs":["100.123.105.1"],"port_desc":"ge-0/0/4","port_id":"ge-0/0/4","power_allocated":0,"power_draw":0,"power_request_count":0,"power_requested":0,"system_desc":"Juniper Networks, Inc. ex4300-48t internet router, kernel JUNOS 20.4R3-S7.2, Build date: 2023-04-21 19:47:18 UTC Copyright (c) 1996-2023 Juniper Networks, Inc.","system_name":"Phoenix-Switch"},"mac":"5c5b35d0077b","mem_total_kb":505468,"mem_used_kb":202096,"model":"AP43","modified_time":1718530662,"mount":"faceup","name":"Phoenix","notes":"","num_clients":1,"org_id":"af010e2b-f829-4975-b49e-2e896ed1d627","port_stat":{"eth0":{"full_duplex":true,"rx_bytes":1284143195,"rx_errors":0,"rx_peak_bps":17585,"rx_pkts":5199816,"speed":1000,"tx_bytes":1283744961,"tx_peak_bps":26484,"tx_pkts":3990463,"up":true},"eth1":{"full_duplex":false,"rx_bytes":0,"rx_errors":0,"rx_peak_bps":0,"rx_pkts":0,"speed":0,"tx_bytes":0,"tx_peak_bps":0,"tx_pkts":0,"up":false}},"power_budget":8400,"power_constrained":false,"power_src":"DC Input","radio_config":{},"radio_stat":{"band_24":{"bandwidth":20,"channel":11,"mac":"5c5b35dea810","noise_floor":-80,"num_clients":0,"power":17,"rx_bytes":12948211,"rx_pkts":65292,"tx_bytes":19071943,"tx_pkts":76926,"usage":"24","util_all":24,"util_non_wifi":2,"util_rx_in_bss":0,"util_rx_other_bss":17,"util_tx":4,"util_undecodable_wifi":0,"util_unknown_wifi":1},"band_5":{"bandwidth":40,"channel":36,"mac":"5c5b35dea7f0","noise_floor":-90,"num_clients":1,"power":17,"rx_bytes":578362619,"rx_pkts":2687577,"tx_bytes":1199571353,"tx_pkts":2479302,"usage":"5","util_all":13,"util_non_wifi":0,"util_rx_in_bss":0,"util_rx_other_bss":10,"util_tx":1,"util_undecodable_wifi":0,"util_unknown_wifi":1}},"rx_bps":9276,"rx_bytes":591310830,"rx_pkts":2752869,"serial":"A0703200709E6","site_id":"46fc665e-9706-4296-8fe2-78f42f2e67e4","status":"connected","switch_redundancy":{"num_redundant_aps":1},"tx_bps":8067,"tx_bytes":1218643296,"tx_pkts":2556228,"type":"ap","uptime":1593120,"version":"0.14.29313"}]'
                - '[{"arp_table_stats":{"arp_table_count":21,"max_entries_supported":64000},"auto_upgrade_stat":{"lastcheck":1720595477},"cert_expiry":1743292763,"cluster_config":{"configuration":"active-active","control_link_info":{"name":"fxp1","status":"Up"},"ethernet_connection":[{"name":"reth0","status":"Up"},{"name":"reth1","status":"Up"},{"name":"reth2","status":"Down"},{"name":"reth3","status":"Down"},{"name":"reth4","status":"Up"}],"fabric_link_info":{"DataPlaneNotifiedStatus":"Up","Interface":[],"InternalStatus":"Up","State":"Enabled","Status":"Enabled"},"last_status_change_reason":"No failures","operational":"active-active","primary_node_health":"Healthy","redundancy_group_information":[{"Id":0,"MonitoringFailure":"none","Threshold":255},{"Id":1,"MonitoringFailure":"interface-monitoring","Threshold":0},{"Id":2,"MonitoringFailure":"none","Threshold":255}],"secondary_node_health":"Not healthy","status":"Green"},"config_status":"COMMITED","config_timestamp":1720182848,"config_version":1720182848,"cpu2_stat":{"idle":86,"interrupt":0,"load_avg":[0.13,0.17,0.16],"system":5,"user":9},"cpu_stat":{"idle":76,"interrupt":0,"load_avg":[0.18,0.31,0.39],"system":10,"user":14},"created_time":1711756611,"deviceprofile_id":"5e5daedf-e650-4013-b41c-845f0d2b9414","deviceprofile_name":"wan_srx_tor_hub1","dhcpd_stat":{"byod_dc1":{"num_ips":100,"num_leased":0},"corp_dc1":{"num_ips":100,"num_leased":4},"guest_dc1":{"num_ips":241,"num_leased":0},"iot_dc1":{"num_ips":100,"num_leased":0},"mgmt_dc1":{"num_ips":100,"num_leased":2},"teleworker":{"num_ips":140,"num_leased":0}},"ext_ip":"69.196.157.189","fwupdate":{"progress":100,"status":"upgraded","status_id":3037,"timestamp":1718392692.580769,"will_retry":false},"has_pcap":false,"hostname":"wan_srx_tor_hub1-srx","id":"00000000-0000-0000-1000-4db14e107134","if_stat":{"ge-0/0/5.130":{"address_mode":"Unknown","nat_addresses":[],"network_name":"","port_id":"ge-0/0/5","port_usage":"lan","rx_bytes":0,"rx_pkts":0,"tx_bytes":0,"tx_pkts":0,"up":true,"vlan":0},"ge-1/0/5.120":{"address_mode":"Unknown","nat_addresses":[],"network_name":"","port_id":"ge-1/0/5","port_usage":"lan","rx_bytes":0,"rx_pkts":0,"tx_bytes":0,"tx_pkts":0,"up":true,"vlan":0}},"ip":"69.196.157.190","ip_stat":{"gateway":"69.196.157.185","ip":"69.196.157.190","ips":{"vlan1":"69.196.157.190,69.196.157.190"},"netmask":"255.255.255.255"},"is_ha":true,"last_seen":1720598726,"mac":"4db14e107134","mac_table_stats":{"mac_table_count":0,"max_mac_entries_supported":160000},"memory2_stat":{"usage":32},"memory_stat":{"usage":39},"model":"SRX300","modified_time":1720092942,"module2_stat":[{"backup_version":"21.2R3-S7.7","fans":[],"last_seen":1720598717,"mac":"ec38739270c0","model":"SRX300","psus":[{"name":"Power Supply 0","status":"ok"}],"recovery_version":"21.2R3-S7.7","serial":"CV2218AF1505","status":"connected","temperatures":[{"celsius":49,"name":"Routing Engine","status":"ok"},{"celsius":64,"name":"Routing Engine CPU","status":"ok"}],"uptime":580964,"vc_links":[{"neighbor_module_idx":0,"neighbor_port_id":"fxp1","port_id":"fxp1"}],"vc_role":"secondary","vc_state":"active","version":"21.2R3-S6.11"}],"module_stat":[{"backup_version":"21.2R3-S7.7","fans":[],"last_seen":1720598716.999985,"mac":"4db14e107134","model":"SRX300","psus":[{"name":"Power Supply 0","status":"ok"}],"recovery_version":"21.2R3-S7.7","serial":"CV0219AN0335","status":"connected","temperatures":[{"celsius":49,"name":"Routing Engine","status":"ok"},{"celsius":65,"name":"Routing Engine CPU","status":"ok"}],"uptime":1945193,"vc_links":[{"neighbor_module_idx":1,"neighbor_port_id":"fxp1","port_id":"fxp1"}],"vc_role":"primary","vc_state":"active","version":"21.2R3-S6.11"}],"name":"wan_srx_tor_hub1-srx","org_id":"af010e2b-f829-4975-b49e-2e896ed1d627","route_summary_stats":{"fib_routes":0,"max_unicast_routes_supported":1240000,"rib_routes":0,"total_routes":0},"serial":"CV0219AN0335","service_stat":{},"service_status":{"appid_status":"enabled","appid_version":3720,"ewf_status":"disabled","idp_install_result":"successful","idp_install_timestamp":"2024-07-10T06:29:11.708164029Z","idp_status":"disabled","idp_update_timestamp":"2024-07-10T06:28:28.567046244Z"},"site_id":"83c31971-ad70-4419-ae20-7f2b90748986","spu2_stat":[{"spu_cpu":0,"spu_current_session":39,"spu_max_session":32768,"spu_memory":31,"spu_pending_session":0,"spu_uptime":1944572,"spu_valid_session":0}],"spu_stat":[{"spu_cpu":1,"spu_current_session":47,"spu_max_session":32768,"spu_memory":34,"spu_pending_session":0,"spu_uptime":1944572,"spu_valid_session":0}],"status":"connected","tag_id":3550217,"tag_uuid":"af010e2b-f829-4975-b49e-2e896ed1d627","type":"gateway","uptime":581259,"version":"21.2R3-S6.11"}]'
                - '[{"ap_redundancy":{"num_aps":1,"num_aps_with_switch_redundancy":1},"arp_table_stats":{"arp_table_count":16,"max_entries_supported":32000},"auto_upgrade_stat":{"lastcheck":1720600596},"cert_expiry":1743932274,"clients":[{"device_mac":"0912f561b653","mac":"001132f5ad23","port_id":"ge-1/0/11"}],"clients_stats":{"total":{"num_aps":[0,0],"num_wired_clients":13}},"config_status":"COMMITED","config_timestamp":1720552389,"config_version":1720552389,"cpu_stat":{"idle":74,"interrupt":0,"load_avg":[0.8,0.75,0.78],"system":13,"user":13},"created_time":1712346090,"dhcpd_stat":{"ifo":{"num_ips":5,"num_leased":0}},"ext_ip":"153.142.221.41","fw_versions_outofsync":false,"fwupdate":{"progress":100,"status":"upgraded","status_id":3037,"timestamp":1712409702.9714448,"will_retry":false},"has_pcap":true,"hostname":"SW-HLAB-ea2e00","hw_rev":"A","id":"00000000-0000-0000-1000-0912f561b653","if_stat":{"ge-0/0/5.0":{"port_id":"ge-0/0/5","rx_bytes":0,"rx_pkts":78110,"tx_bytes":0,"tx_pkts":61037,"up":true},"ge-1/0/0.0":{"port_id":"ge-1/0/0","rx_bytes":0,"rx_pkts":56415,"tx_bytes":0,"tx_pkts":72209,"up":true},"irb.172":{"ips":["10.3.172.41/24"],"port_id":"irb","rx_bytes":0,"rx_pkts":1291755,"servp_info":{},"tx_bytes":0,"tx_pkts":990327,"up":true,"vlan":172},"vme.0":{"port_id":"vme","rx_bytes":0,"rx_pkts":0,"tx_bytes":0,"tx_pkts":0,"up":true}},"ip":"10.3.10.10","ip_stat":{"gateway":"10.3.172.9","ip":"10.3.10.10","ips":{"vlan172":"10.3.172.41"},"netmask":"255.255.255.255"},"last_seen":1720601189,"last_trouble":{"code":"103","timestamp":1712412455215},"mac":"0912f561b653","mac_table_stats":{"mac_table_count":58,"max_mac_entries_supported":64000},"memory_stat":{"usage":16},"model":"EX4100-F-12P","modified_time":1720552388,"module_stat":[{"boot_partition":"junos","cpu_stat":{"idle":74,"interrupt":0,"load_avg":[0.8,0.75,0.78],"system":13,"user":13},"fpc_idx":0,"mac":"0912f561b653","memory_stat":{"usage":16},"model":"EX4100-F-12P","pics":[{"index":0,"model_number":"EX4100-F-12P","port_groups":[{"count":12,"type":"GE"}]},{"index":1,"model_number":"EX4100-F-12P","port_groups":[{"count":4,"type":"SFP/SFP+"}]},{"index":2,"model_number":"EX4100-F-12P","port_groups":[{"count":2,"type":"GE"}]}],"poe":{"max_power":180,"power_draw":7.3},"psus":[{"name":"Power Supply 0","status":"ok"},{"name":"Power Supply 1","status":"absent"},{"name":"Power Supply 2","status":"absent"}],"serial":"FJ0324AV0077","temperatures":[{"celsius":51,"name":"Thermal board Sensor 1","status":"ok"},{"celsius":51,"name":"Thermal board Sensor 2","status":"ok"},{"celsius":50,"name":"Thermal board Sensor 3","status":"ok"},{"celsius":57,"name":"PFE Die Sensor","status":"ok"}],"type":"fpc","uptime":1692720,"vc_links":[{"neighbor_module_idx":1,"neighbor_port_id":"vcp-1/1/1","port_id":"vcp-0/1/0"},{"neighbor_module_idx":1,"neighbor_port_id":"vcp-1/1/0","port_id":"vcp-0/1/1"}],"vc_mode":"HiGiG","vc_role":"master","vc_state":"present","version":"22.4R3.25"},{"boot_partition":"junos","cpu_stat":{"idle":79,"interrupt":0,"load_avg":[0.52,0.46,0.46],"system":6,"user":15},"fpc_idx":1,"mac":"485a0deb2380","memory_stat":{"usage":14},"model":"EX4100-F-12P","pics":[{"index":0,"model_number":"EX4100-F-12P","port_groups":[{"count":12,"type":"GE"}]},{"index":1,"model_number":"EX4100-F-12P","port_groups":[{"count":4,"type":"SFP/SFP+"}]},{"index":2,"model_number":"EX4100-F-12P","port_groups":[{"count":2,"type":"GE"}]}],"poe":{"max_power":180,"power_draw":22.1},"psus":[{"name":"Power Supply 0","status":"ok"},{"name":"Power Supply 1","status":"absent"},{"name":"Power Supply 2","status":"absent"}],"serial":"FJ0424AV0101","temperatures":[{"celsius":52,"name":"Thermal board Sensor 1","status":"ok"},{"celsius":53,"name":"Thermal board Sensor 2","status":"ok"},{"celsius":52,"name":"Thermal board Sensor 3","status":"ok"},{"celsius":59,"name":"PFE Die Sensor","status":"ok"}],"type":"fpc","uptime":1692720,"vc_links":[{"neighbor_module_idx":0,"neighbor_port_id":"vcp-0/1/1","port_id":"vcp-1/1/0"},{"neighbor_module_idx":0,"neighbor_port_id":"vcp-0/1/0","port_id":"vcp-1/1/1"}],"vc_mode":"HiGiG","vc_role":"backup","vc_state":"present","version":"22.4R3.25"}],"name":"SW-HLAB-ea2e00","org_id":"c5324060-19da-48fa-af28-2b530bd08765","route_summary_stats":{"fib_routes":7,"max_unicast_routes_supported":32150,"rib_routes":40,"total_routes":3},"serial":"FJ0324AV0077","site_id":"a0e43ffb-94a6-4f27-92aa-9cf832e1143d","status":"connected","tag_id":3564806,"tag_uuid":"507604a4-6b34-449c-acb3-87955430b006","type":"switch","uptime":1692720,"vc_mac":"0912f561b653","vc_setup_info":{"config_type":"nonprovisioned","err_missing_dev_id_fpc":false},"version":"22.4R3.25"}]'
                contentMediaType: application/json
              examples:
                Access Point Stats:
                  value:
                  - auto_upgrade_stat:
                      lastcheck: 1720594762
                    ble_stat:
                      beacon_enabled: true
                      beacon_rate: 4
                      eddystone_uid_enabled: false
                      eddystone_uid_freq_msec: 1000
                      eddystone_uid_instance: 5c5b35d0077b
                      eddystone_uid_namespace: 9777c1a06ef611e68bbf
                      eddystone_url_enabled: false
                      eddystone_url_freq_msec: 1000
                      eddystone_url_url: ''
                      ibeacon_enabled: false
                      ibeacon_freq_msec: 1000
                      ibeacon_major: 894
                      ibeacon_minor: 9328
                      ibeacon_uuid: af010e2b-f829-4975-b49e-2e896ed1d627
                      major: 894
                      minors:
                      - 9328
                      - 9329
                      - 9330
                      - 9331
                      - 9332
                      - 9333
                      - 9334
                      - 9335
                      - -1
                      power: 8
                      rx_bytes: 158500843
                      rx_pkts: 3549163
                      tx_bytes: 509640
                      tx_pkts: 85411
                      tx_resets: 0
                      uuid: af010e2b-f829-4975-b49e-2e896ed1d627
                    config_reverted: false
                    cpu_system: 21921854
                    cpu_user: 7496631
                    cpu_util: 5
                    created_time: 1718228350
                    env_stat:
                      accel_x: -0.092
                      accel_y: 0.004
                      accel_z: -1.02
                      ambient_temp: 43
                      attitude: 0
                      cpu_temp: 53
                      humidity: 9
                      magne_x: 0
                      magne_y: 0
                      magne_z: 0
                      pressure: 968
                      vcore_voltage: 0
                    ext_ip: 66.129.234.28
                    hw_rev: C02
                    id: 00000000-0000-0000-1000-5c5b35d0077b
                    inactive_wired_vlans: []
                    ip: 192.168.95.3
                    ip_stat:
                      dhcp_server: 192.168.95.1
                      dns:
                      - 8.8.8.8
                      gateway: 192.168.95.1
                      ip: 192.168.95.3
                      ip6: fe80:0:0:0:5e5b:35ff:fed0:77b
                      ips:
                        vlan1: 192.168.95.3/24,fe80:0:0:0:5e5b:35ff:fed0:77b/64
                      netmask: 255.255.255.0
                      netmask6: /64
                    last_seen: 1720595866
                    last_trouble:
                      code: '07'
                      timestamp: 1720039666
                    lldp_stat:
                      chassis_id: d0:07:ca:f5:21:00
                      lldp_med_supported: false
                      mgmt_addr: 100.123.105.1
                      mgmt_addrs:
                      - 100.123.105.1
                      port_desc: ge-0/0/4
                      port_id: ge-0/0/4
                      power_allocated: 0
                      power_draw: 0
                      power_request_count: 0
                      power_requested: 0
                      system_desc: 'Juniper Networks, Inc. ex4300-48t internet router, kernel JUNOS 20.4R3-S7.2, Build date: 2023-04-21 19:47:18 UTC Copyright (c) 1996-2023 Juniper Networks, Inc.'
                      system_name: Phoenix-Switch
                    mac: 5c5b35d0077b
                    mem_total_kb: 505468
                    mem_used_kb: 202096
                    model: AP43
                    modified_time: 1718530662
                    mount: faceup
                    name: Phoenix
                    notes: ''
                    num_clients: 1
                    org_id: af010e2b-f829-4975-b49e-2e896ed1d627
                    port_stat:
                      eth0:
                        full_duplex: true
                        rx_bytes: 1284143195
                        rx_errors: 0
                        rx_peak_bps: 17585
                        rx_pkts: 5199816
                        speed: 1000
                        tx_bytes: 1283744961
                        tx_peak_bps: 26484
                        tx_pkts: 3990463
                        up: true
                      eth1:
                        full_duplex: false
                        rx_bytes: 0
                        rx_errors: 0
                        rx_peak_bps: 0
                        rx_pkts: 0
                        speed: 0
                        tx_bytes: 0
                        tx_peak_bps: 0
                        tx_pkts: 0
                        up: false
                    power_budget: 8400
                    power_constrained: false
                    power_src: DC Input
                    radio_config: {}
                    radio_stat:
                      band_24:
                        bandwidth: 20
                        channel: 11
                        mac: 5c5b35dea810
                        noise_floor: -80
                        num_clients: 0
                        power: 17
                        rx_bytes: 12948211
                        rx_pkts: 65292
                        tx_bytes: 19071943
                        tx_pkts: 76926
                        usage: '24'
                        util_all: 24
                        util_non_wifi: 2
                        util_rx_in_bss: 0
                        util_rx_other_bss: 17
                        util_tx: 4
                        util_undecodable_wifi: 0
                        util_unknown_wifi: 1
                      band_5:
                        bandwidth: 40
                        channel: 36
                        mac: 5c5b35dea7f0
                        noise_floor: -90
                        num_clients: 1
                        power: 17
                        rx_bytes: 578362619
                        rx_pkts: 2687577
                        tx_bytes: 1199571353
                        tx_pkts: 2479302
                        usage: '5'
                        util_all: 13
                        util_non_wifi: 0
                        util_rx_in_bss: 0
                        util_rx_other_bss: 10
                        util_tx: 1
                        util_undecodable_wifi: 0
                        util_unknown_wifi: 1
                    rx_bps: 9276
                    rx_bytes: 591310830
                    rx_pkts: 2752869
                    serial: A0703200709E6
                    site_id: 46fc665e-9706-4296-8fe2-78f42f2e67e4
                    status: connected
                    switch_redundancy:
                      num_redundant_aps: 1
                    tx_bps: 8067
                    tx_bytes: 1218643296
                    tx_pkts: 2556228
                    type: ap
                    uptime: 1593120
                    version: 0.14.29313
                Gateway Stats:
                  value:
                  - arp_table_stats:
                      arp_table_count: 21
                      max_entries_supported: 64000
                    auto_upgrade_stat:
                      lastcheck: 1720595477
                    cert_expiry: 1743292763
                    cluster_config:
                      configuration: active-active
                      control_link_info:
                        name: fxp1
                        status: Up
                      ethernet_connection:
                      - name: reth0
                        status: Up
                      - name: reth1
                        status: Up
                      - name: reth2
                        status: Down
                      - name: reth3
                        status: Down
                      - name: reth4
                        status: Up
                      fabric_link_info:
                        DataPlaneNotifiedStatus: Up
                        Interface: []
                        InternalStatus: Up
                        State: Enabled
                        Status: Enabled
                      last_status_change_reason: No failures
                      operational: active-active
                      primary_node_health: Healthy
                      redundancy_group_information:
                      - Id: 0
                        MonitoringFailure: none
                        Threshold: 255
                      - Id: 1
                        MonitoringFailure: interface-monitoring
                        Threshold: 0
                      - Id: 2
                        MonitoringFailure: none
                        Threshold: 255
                      secondary_node_health: Not healthy
                      status: Green
                    config_status: COMMITED
                    config_timestamp: 1720182848
                    config_version: 1720182848
                    cpu2_stat:
                      idle: 86
                      interrupt: 0
                      load_avg:
                      - 0.13
                      - 0.17
                      - 0.16
                      system: 5
                      user: 9
                    cpu_stat:
                      idle: 76
                      interrupt: 0
                      load_avg:
                      - 0.18
                      - 0.31
                      - 0.39
                      system: 10
                      user: 14
                    created_time: 1711756611
                    deviceprofile_id: 5e5daedf-e650-4013-b41c-845f0d2b9414
                    deviceprofile_name: wan_srx_tor_hub1
                    dhcpd_stat:
                      byod_dc1:
                        num_ips: 100
                        num_leased: 0
                      corp_dc1:
                        num_ips: 100
                        num_leased: 4
                      guest_dc1:
                        num_ips: 241
                        num_leased: 0
                      iot_dc1:
                        num_ips: 100
                        num_leased: 0
                      mgmt_dc1:
                        num_ips: 100
                        num_leased: 2
                      teleworker:
                        num_ips: 140
                        num_leased: 0
                    ext_ip: 69.196.157.189
                    fwupdate:
                      progress: 100
                      status: upgraded
                      status_id: 3037
                      timestamp: 1718392692.580769
                      will_retry: false
                    has_pcap: false
                    hostname: wan_srx_tor_hub1-srx
                    id: 00000000-0000-0000-1000-4db14e107134
                    if_stat:
                      ge-0/0/5.130:
                        address_mode: Unknown
                        nat_addresses: []
                        network_name: ''
                        port_id: ge-0/0/5
                        port_usage: lan
                        rx_bytes: 0
                        rx_pkts: 0
                        tx_bytes: 0
                        tx_pkts: 0
                        up: true
                        vlan: 0
                      ge-1/0/5.120:
                        address_mode: Unknown
                        nat_addresses: []
                        network_name: ''
                        port_id: ge-1/0/5
                        port_usage: lan
                        rx_bytes: 0
                        rx_pkts: 0
                        tx_bytes: 0
                        tx_pkts: 0
                        up: true
                        vlan: 0
                    ip: 69.196.157.190
                    ip_stat:
                      gateway: 69.196.157.185
                      ip: 69.196.157.190
                      ips:
                        vlan1: 69.196.157.190,69.196.157.190
                      netmask: 255.255.255.255
                    is_ha: true
                    last_seen: 1720598726
                    mac: 4db14e107134
                    mac_table_stats:
                      mac_table_count: 0
                      max_mac_entries_supported: 160000
                    memory2_stat:
                      usage: 32
                    memory_stat:
                      usage: 39
                    model: SRX300
                    modified_time: 1720092942
                    module2_stat:
                    - backup_version: 21.2R3-S7.7
                      fans: []
                      last_seen: 1720598717
                      mac: ec38739270c0
                      model: SRX300
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.2R3-S7.7
                      serial: CV2218AF1505
                      status: connected
                      temperatures:
                      - celsius: 49
                        name: Routing Engine
                        status: ok
                      - celsius: 64
                        name: Routing Engine CPU
                        status: ok
                      uptime: 580964
                      vc_links:
                      - neighbor_module_idx: 0
                        neighbor_port_id: fxp1
                        port_id: fxp1
                      vc_role: secondary
                      vc_state: active
                      version: 21.2R3-S6.11
                    module_stat:
                    - backup_version: 21.2R3-S7.7
                      fans: []
                      last_seen: 1720598716.999985
                      mac: 4db14e107134
                      model: SRX300
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.2R3-S7.7
                      serial: CV0219AN0335
                      status: connected
                      temperatures:
                      - celsius: 49
                        name: Routing Engine
                        status: ok
                      - celsius: 65
                        name: Routing Engine CPU
                        status: ok
                      uptime: 1945193
                      vc_links:
                      - neighbor_module_idx: 1
                        neighbor_port_id: fxp1
                        port_id: fxp1
                      vc_role: primary
                      vc_state: active
                      version: 21.2R3-S6.11
                    name: wan_srx_tor_hub1-srx
                    org_id: af010e2b-f829-4975-b49e-2e896ed1d627
                    route_summary_stats:
                      fib_routes: 0
                      max_unicast_routes_supported: 1240000
                      rib_routes: 0
                      total_routes: 0
                    serial: CV0219AN0335
                    service_stat: {}
                    service_status:
                      appid_status: enabled
                      appid_version: 3720
                      ewf_status: disabled
                      idp_install_result: successful
                      idp_install_timestamp: 2024-07-10T06:29:11.708164029Z
                      idp_status: disabled
                      idp_update_timestamp: 2024-07-10T06:28:28.567046244Z
                    site_id: 83c31971-ad70-4419-ae20-7f2b90748986
                    spu2_stat:
                    - spu_cpu: 0
                      spu_current_session: 39
                      spu_max_session: 32768
                      spu_memory: 31
                      spu_pending_session: 0
                      spu_uptime: 1944572
                      spu_valid_session: 0
                    spu_stat:
                    - spu_cpu: 1
                      spu_current_session: 47
                      spu_max_session: 32768
                      spu_memory: 34
                      spu_pending_session: 0
                      spu_uptime: 1944572
                      spu_valid_session: 0
                    status: connected
                    tag_id: 3550217
                    tag_uuid: af010e2b-f829-4975-b49e-2e896ed1d627
                    type: gateway
                    uptime: 581259
                    version: 21.2R3-S6.11
                Switch:
                  value:
                  - ap_redundancy:
                      num_aps: 1
                      num_aps_with_switch_redundancy: 1
                    arp_table_stats:
                      arp_table_count: 16
                      max_entries_supported: 32000
                    auto_upgrade_stat:
                      lastcheck: 1720600596
                    cert_expiry: 1743932274
                    clients:
                    - device_mac: 0912f561b653
                      mac: 001132f5ad23
                      port_id: ge-1/0/11
                    clients_stats:
                      total:
                        num_aps:
                        - 0
                        - 0
                        num_wired_clients: 13
                    config_status: COMMITED
                    config_timestamp: 1720552389
                    config_version: 1720552389
                    cpu_stat:
                      idle: 74
                      interrupt: 0
                      load_avg:
                      - 0.8
                      - 0.75
                      - 0.78
                      system: 13
                      user: 13
                    created_time: 1712346090
                    dhcpd_stat:
                      ifo:
                        num_ips: 5
                        num_leased: 0
                    ext_ip: 153.142.221.41
                    fw_versions_outofsync: false
                    fwupdate:
                      progress: 100
                      status: upgraded
                      status_id: 3037
                      timestamp: 1712409702.9714448
                      will_retry: false
                    has_pcap: true
                    hostname: SW-HLAB-ea2e00
                    hw_rev: A
                    id: 00000000-0000-0000-1000-0912f561b653
                    if_stat:
                      ge-0/0/5.0:
                        port_id: ge-0/0/5
                        rx_bytes: 0
                        rx_pkts: 78110
                        tx_bytes: 0
                        tx_pkts: 61037
                        up: true
                      ge-1/0/0.0:
                        port_id: ge-1/0/0
                        rx_bytes: 0
                        rx_pkts: 56415
                        tx_bytes: 0
                        tx_pkts: 72209
                        up: true
                      irb.172:
                        ips:
                        - 10.3.172.41/24
                        port_id: irb
                        rx_bytes: 0
                        rx_pkts: 1291755
                        servp_info: {}
                        tx_bytes: 0
                        tx_pkts: 990327
                        up: true
                        vlan: 172
                      vme.0:
                        port_id: vme
                        rx_bytes: 0
                        rx_pkts: 0
                        tx_bytes: 0
                        tx_pkts: 0
                        up: true
                    ip: 10.3.10.10
                    ip_stat:
                      gateway: 10.3.172.9
                      ip: 10.3.10.10
                      ips:
                        vlan172: 10.3.172.41
                      netmask: 255.255.255.255
                    last_seen: 1720601189
                    last_trouble:
                      code: '103'
                      timestamp: 1712412455215
                    mac: 0912f561b653
                    mac_table_stats:
                      mac_table_count: 58
                      max_mac_entries_supported: 64000
                    memory_stat:
                      usage: 16
                    model: EX4100-F-12P
                    modified_time: 1720552388
                    module_stat:
                    - boot_partition: junos
                      cpu_stat:
                        idle: 74
                        interrupt: 0
                        load_avg:
                        - 0.8
                        - 0.75
                        - 0.78
                        system: 13
                        user: 13
                      fpc_idx: 0
                      mac: 0912f561b653
                      memory_stat:
                        usage: 16
                      model: EX4100-F-12P
                      pics:
                      - index: 0
                        model_number: EX4100-F-12P
                        port_groups:
                        - count: 12
                          type: GE
                      - index: 1
                        model_number: EX4100-F-12P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      - index: 2
                        model_number: EX4100-F-12P
                        port_groups:
                        - count: 2
                          type: GE
                      poe:
                        max_power: 180
                        power_draw: 7.3
                      psus:
                      - name: Power Supply 0
                        status: ok
                      - name: Power Supply 1
                        status: absent
                      - name: Power Supply 2
                        status: absent
                      serial: FJ0324AV0077
                      temperatures:
                      - celsius: 51
                        name: Thermal board Sensor 1
                        status: ok
                      - celsius: 51
                        name: Thermal board Sensor 2
                        status: ok
                      - celsius: 50
                        name: Thermal board Sensor 3
                        status: ok
                      - celsius: 57
                        name: PFE Die Sensor
                        status: ok
                      type: fpc
                      uptime: 1692720
                      vc_links:
                      - neighbor_module_idx: 1
                        neighbor_port_id: vcp-1/1/1
                        port_id: vcp-0/1/0
                      - neighbor_module_idx: 1
                        neighbor_port_id: vcp-1/1/0
                        port_id: vcp-0/1/1
                      vc_mode: HiGiG
                      vc_role: master
                      vc_state: present
                      version: 22.4R3.25
                    - boot_partition: junos
                      cpu_stat:
                        idle: 79
                        interrupt: 0
                        load_avg:
                        - 0.52
                        - 0.46
                        - 0.46
                        system: 6
                        user: 15
                      fpc_idx: 1
                      mac: 485a0deb2380
                      memory_stat:
                        usage: 14
                      model: EX4100-F-12P
                      pics:
                      - index: 0
                        model_number: EX4100-F-12P
                        port_groups:
                        - count: 12
                          type: GE
                      - index: 1
                        model_number: EX4100-F-12P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      - index: 2
                        model_number: EX4100-F-12P
                        port_groups:
                        - count: 2
                          type: GE
                      poe:
                        max_power: 180
                        power_draw: 22.1
                      psus:
                      - name: Power Supply 0
                        status: ok
                      - name: Power Supply 1
                        status: absent
                      - name: Power Supply 2
                        status: absent
                      serial: FJ0424AV0101
                      temperatures:
                      - celsius: 52
                        name: Thermal board Sensor 1
                        status: ok
                      - celsius: 53
                        name: Thermal board Sensor 2
                        status: ok
                      - celsius: 52
                        name: Thermal board Sensor 3
                        status: ok
                      - celsius: 59
                        name: PFE Die Sensor
                        status: ok
                      type: fpc
                      uptime: 1692720
                      vc_links:
                      - neighbor_module_idx: 0
                        neighbor_port_id: vcp-0/1/1
                        port_id: vcp-1/1/0
                      - neighbor_module_idx: 0
                        neighbor_port_id: vcp-0/1/0
                        port_id: vcp-1/1/1
                      vc_mode: HiGiG
                      vc_role: backup
                      vc_state: present
                      version: 22.4R3.25
                    name: SW-HLAB-ea2e00
                    org_id: c5324060-19da-48fa-af28-2b530bd08765
                    route_summary_stats:
                      fib_routes: 7
                      max_unicast_routes_supported: 32150
                      rib_routes: 40
                      total_routes: 3
                    serial: FJ0324AV0077
                    site_id: a0e43ffb-94a6-4f27-92aa-9cf832e1143d
                    status: connected
                    tag_id: 3564806
                    tag_uuid: 507604a4-6b34-449c-acb3-87955430b006
                    type: switch
                    uptime: 1692720
                    vc_mac: 0912f561b653
                    vc_setup_info:
                      config_type: nonprovisioned
                      err_missing_dev_id_fpc: false
                    version: 22.4R3.25
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/stats_device'
                description: Device statistics records returned by a stats response
                examples:
                - '[{"auto_upgrade_stat":{"lastcheck":1720594762},"ble_stat":{"beacon_enabled":true,"beacon_rate":4,"eddystone_uid_enabled":false,"eddystone_uid_freq_msec":1000,"eddystone_uid_instance":"5c5b35d0077b","eddystone_uid_namespace":"9777c1a06ef611e68bbf","eddystone_url_enabled":false,"eddystone_url_freq_msec":1000,"eddystone_url_url":"","ibeacon_enabled":false,"ibeacon_freq_msec":1000,"ibeacon_major":894,"ibeacon_minor":9328,"ibeacon_uuid":"af010e2b-f829-4975-b49e-2e896ed1d627","major":894,"minors":[9328,9329,9330,9331,9332,9333,9334,9335,-1],"power":8,"rx_bytes":158500843,"rx_pkts":3549163,"tx_bytes":509640,"tx_pkts":85411,"tx_resets":0,"uuid":"af010e2b-f829-4975-b49e-2e896ed1d627"},"config_reverted":false,"cpu_system":21921854,"cpu_user":7496631,"cpu_util":5,"created_time":1718228350,"env_stat":{"accel_x":-0.092,"accel_y":0.004,"accel_z":-1.02,"ambient_temp":43,"attitude":0,"cpu_temp":53,"humidity":9,"magne_x":0,"magne_y":0,"magne_z":0,"pressure":968,"vcore_voltage":0},"ext_ip":"66.129.234.28","hw_rev":"C02","id":"00000000-0000-0000-1000-5c5b35d0077b","inactive_wired_vlans":[],"ip":"192.168.95.3","ip_stat":{"dhcp_server":"192.168.95.1","dns":["8.8.8.8"],"gateway":"192.168.95.1","ip":"192.168.95.3","ip6":"fe80:0:0:0:5e5b:35ff:fed0:77b","ips":{"vlan1":"192.168.95.3/24,fe80:0:0:0:5e5b:35ff:fed0:77b/64"},"netmask":"255.255.255.0","netmask6":"/64"},"last_seen":1720595866,"last_trouble":{"code":"07","timestamp":1720039666},"lldp_stat":{"chassis_id":"d0:07:ca:f5:21:00","lldp_med_supported":false,"mgmt_addr":"100.123.105.1","mgmt_addrs":["100.123.105.1"],"port_desc":"ge-0/0/4","port_id":"ge-0/0/4","power_allocated":0,"power_draw":0,"power_request_count":0,"power_requested":0,"system_desc":"Juniper Networks, Inc. ex4300-48t internet router, kernel JUNOS 20.4R3-S7.2, Build date: 2023-04-21 19:47:18 UTC Copyright (c) 1996-2023 Juniper Networks, Inc.","system_name":"Phoenix-Switch"},"mac":"5c5b35d0077b","mem_total_kb":505468,"mem_used_kb":202096,"model":"AP43","modified_time":1718530662,"mount":"faceup","name":"Phoenix","notes":"","num_clients":1,"org_id":"af010e2b-f829-4975-b49e-2e896ed1d627","port_stat":{"eth0":{"full_duplex":true,"rx_bytes":1284143195,"rx_errors":0,"rx_peak_bps":17585,"rx_pkts":5199816,"speed":1000,"tx_bytes":1283744961,"tx_peak_bps":26484,"tx_pkts":3990463,"up":true},"eth1":{"full_duplex":false,"rx_bytes":0,"rx_errors":0,"rx_peak_bps":0,"rx_pkts":0,"speed":0,"tx_bytes":0,"tx_peak_bps":0,"tx_pkts":0,"up":false}},"power_budget":8400,"power_constrained":false,"power_src":"DC Input","radio_config":{},"radio_stat":{"band_24":{"bandwidth":20,"channel":11,"mac":"5c5b35dea810","noise_floor":-80,"num_clients":0,"power":17,"rx_bytes":12948211,"rx_pkts":65292,"tx_bytes":19071943,"tx_pkts":76926,"usage":"24","util_all":24,"util_non_wifi":2,"util_rx_in_bss":0,"util_rx_other_bss":17,"util_tx":4,"util_undecodable_wifi":0,"util_unknown_wifi":1},"band_5":{"bandwidth":40,"channel":36,"mac":"5c5b35dea7f0","noise_floor":-90,"num_clients":1,"power":17,"rx_bytes":578362619,"rx_pkts":2687577,"tx_bytes":1199571353,"tx_pkts":2479302,"usage":"5","util_all":13,"util_non_wifi":0,"util_rx_in_bss":0,"util_rx_other_bss":10,"util_tx":1,"util_undecodable_wifi":0,"util_unknown_wifi":1}},"rx_bps":9276,"rx_bytes":591310830,"rx_pkts":2752869,"serial":"A0703200709E6","site_id":"46fc665e-9706-4296-8fe2-78f42f2e67e4","status":"connected","switch_redundancy":{"num_redundant_aps":1},"tx_bps":8067,"tx_bytes":1218643296,"tx_pkts":2556228,"type":"ap","uptime":1593120,"version":"0.14.29313"}]'
                - '[{"arp_table_stats":{"arp_table_count":21,"max_entries_supported":64000},"auto_upgrade_stat":{"lastcheck":1720595477},"cert_expiry":1743292763,"cluster_config":{"configuration":"active-active","control_link_info":{"name":"fxp1","status":"Up"},"ethernet_connection":[{"name":"reth0","status":"Up"},{"name":"reth1","status":"Up"},{"name":"reth2","status":"Down"},{"name":"reth3","status":"Down"},{"name":"reth4","status":"Up"}],"fabric_link_info":{"DataPlaneNotifiedStatus":"Up","Interface":[],"InternalStatus":"Up","State":"Enabled","Status":"Enabled"},"last_status_change_reason":"No failures","operational":"active-active","primary_node_health":"Healthy","redundancy_group_information":[{"Id":0,"MonitoringFailure":"none","Threshold":255},{"Id":1,"MonitoringFailure":"interface-monitoring","Threshold":0},{"Id":2,"MonitoringFailure":"none","Threshold":255}],"secondary_node_health":"Not healthy","status":"Green"},"config_status":"COMMITED","config_timestamp":1720182848,"config_version":1720182848,"cpu2_stat":{"idle":86,"interrupt":0,"load_avg":[0.13,0.17,0.16],"system":5,"user":9},"cpu_stat":{"idle":76,"interrupt":0,"load_avg":[0.18,0.31,0.39],"system":10,"user":14},"created_time":1711756611,"deviceprofile_id":"5e5daedf-e650-4013-b41c-845f0d2b9414","deviceprofile_name":"wan_srx_tor_hub1","dhcpd_stat":{"byod_dc1":{"num_ips":100,"num_leased":0},"corp_dc1":{"num_ips":100,"num_leased":4},"guest_dc1":{"num_ips":241,"num_leased":0},"iot_dc1":{"num_ips":100,"num_leased":0},"mgmt_dc1":{"num_ips":100,"num_leased":2},"teleworker":{"num_ips":140,"num_leased":0}},"ext_ip":"69.196.157.189","fwupdate":{"progress":100,"status":"upgraded","status_id":3037,"timestamp":1718392692.580769,"will_retry":false},"has_pcap":false,"hostname":"wan_srx_tor_hub1-srx","id":"00000000-0000-0000-1000-4db14e107134","if_stat":{"ge-0/0/5.130":{"address_mode":"Unknown","nat_addresses":[],"network_name":"","port_id":"ge-0/0/5","port_usage":"lan","rx_bytes":0,"rx_pkts":0,"tx_bytes":0,"tx_pkts":0,"up":true,"vlan":0},"ge-1/0/5.120":{"address_mode":"Unknown","nat_addresses":[],"network_name":"","port_id":"ge-1/0/5","port_usage":"lan","rx_bytes":0,"rx_pkts":0,"tx_bytes":0,"tx_pkts":0,"up":true,"vlan":0}},"ip":"69.196.157.190","ip_stat":{"gateway":"69.196.157.185","ip":"69.196.157.190","ips":{"vlan1":"69.196.157.190,69.196.157.190"},"netmask":"255.255.255.255"},"is_ha":true,"last_seen":1720598726,"mac":"4db14e107134","mac_table_stats":{"mac_table_count":0,"max_mac_entries_supported":160000},"memory2_stat":{"usage":32},"memory_stat":{"usage":39},"model":"SRX300","modified_time":1720092942,"module2_stat":[{"backup_version":"21.2R3-S7.7","fans":[],"last_seen":1720598717,"mac":"ec38739270c0","model":"SRX300","psus":[{"name":"Power Supply 0","status":"ok"}],"recovery_version":"21.2R3-S7.7","serial":"CV2218AF1505","status":"connected","temperatures":[{"celsius":49,"name":"Routing Engine","status":"ok"},{"celsius":64,"name":"Routing Engine CPU","status":"ok"}],"uptime":580964,"vc_links":[{"neighbor_module_idx":0,"neighbor_port_id":"fxp1","port_id":"fxp1"}],"vc_role":"secondary","vc_state":"active","version":"21.2R3-S6.11"}],"module_stat":[{"backup_version":"21.2R3-S7.7","fans":[],"last_seen":1720598716.999985,"mac":"4db14e107134","model":"SRX300","psus":[{"name":"Power Supply 0","status":"ok"}],"recovery_version":"21.2R3-S7.7","serial":"CV0219AN0335","status":"connected","temperatures":[{"celsius":49,"name":"Routing Engine","status":"ok"},{"celsius":65,"name":"Routing Engine CPU","status":"ok"}],"uptime":1945193,"vc_links":[{"neighbor_module_idx":1,"neighbor_port_id":"fxp1","port_id":"fxp1"}],"vc_role":"primary","vc_state":"active","version":"21.2R3-S6.11"}],"name":"wan_srx_tor_hub1-srx","org_id":"af010e2b-f829-4975-b49e-2e896ed1d627","route_summary_stats":{"fib_routes":0,"max_unicast_routes_supported":1240000,"rib_routes":0,"total_routes":0},"serial":"CV0219AN0335","service_stat":{},"service_status":{"appid_status":"enabled","appid_version":3720,"ewf_status":"disabled","idp_install_result":"successful","idp_install_timestamp":"2024-07-10T06:29:11.708164029Z","idp_status":"disabled","idp_update_timestamp":"2024-07-10T06:28:28.567046244Z"},"site_id":"83c31971-ad70-4419-ae20-7f2b90748986","spu2_stat":[{"spu_cpu":0,"spu_current_session":39,"spu_max_session":32768,"spu_memory":31,"spu_pending_session":0,"spu_uptime":1944572,"spu_valid_session":0}],"spu_stat":[{"spu_cpu":1,"spu_current_session":47,"spu_max_session":32768,"spu_memory":34,"spu_pending_session":0,"spu_uptime":1944572,"spu_valid_session":0}],"status":"connected","tag_id":3550217,"tag_uuid":"af010e2b-f829-4975-b49e-2e896ed1d627","type":"gateway","uptime":581259,"version":"21.2R3-S6.11"}]'
                - '[{"ap_redundancy":{"num_aps":1,"num_aps_with_switch_redundancy":1},"arp_table_stats":{"arp_table_count":16,"max_entries_supported":32000},"auto_upgrade_stat":{"lastcheck":1720600596},"cert_expiry":1743932274,"clients":[{"device_mac":"0912f561b653","mac":"001132f5ad23","port_id":"ge-1/0/11"}],"clients_stats":{"total":{"num_aps":[0,0],"num_wired_clients":13}},"config_status":"COMMITED","config_timestamp":1720552389,"config_version":1720552389,"cpu_stat":{"idle":74,"interrupt":0,"load_avg":[0.8,0.75,0.78],"system":13,"user":13},"created_time":1712346090,"dhcpd_stat":{"ifo":{"num_ips":5,"num_leased":0}},"ext_ip":"153.142.221.41","fw_versions_outofsync":false,"fwupdate":{"progress":100,"status":"upgraded","status_id":3037,"timestamp":1712409702.9714448,"will_retry":false},"has_pcap":true,"hostname":"SW-HLAB-ea2e00","hw_rev":"A","id":"00000000-0000-0000-1000-0912f561b653","if_stat":{"ge-0/0/5.0":{"port_id":"ge-0/0/5","rx_bytes":0,"rx_pkts":78110,"tx_bytes":0,"tx_pkts":61037,"up":true},"ge-1/0/0.0":{"port_id":"ge-1/0/0","rx_bytes":0,"rx_pkts":56415,"tx_bytes":0,"tx_pkts":72209,"up":true},"irb.172":{"ips":["10.3.172.41/24"],"port_id":"irb","rx_bytes":0,"rx_pkts":1291755,"servp_info":{},"tx_bytes":0,"tx_pkts":990327,"up":true,"vlan":172},"vme.0":{"port_id":"vme","rx_bytes":0,"rx_pkts":0,"tx_bytes":0,"tx_pkts":0,"up":true}},"ip":"10.3.10.10","ip_stat":{"gateway":"10.3.172.9","ip":"10.3.10.10","ips":{"vlan172":"10.3.172.41"},"netmask":"255.255.255.255"},"last_seen":1720601189,"last_trouble":{"code":"103","timestamp":1712412455215},"mac":"0912f561b653","mac_table_stats":{"mac_table_count":58,"max_mac_entries_supported":64000},"memory_stat":{"usage":16},"model":"EX4100-F-12P","modified_time":1720552388,"module_stat":[{"boot_partition":"junos","cpu_stat":{"idle":74,"interrupt":0,"load_avg":[0.8,0.75,0.78],"system":13,"user":13},"fpc_idx":0,"mac":"0912f561b653","memory_stat":{"usage":16},"model":"EX4100-F-12P","pics":[{"index":0,"model_number":"EX4100-F-12P","port_groups":[{"count":12,"type":"GE"}]},{"index":1,"model_number":"EX4100-F-12P","port_groups":[{"count":4,"type":"SFP/SFP+"}]},{"index":2,"model_number":"EX4100-F-12P","port_groups":[{"count":2,"type":"GE"}]}],"poe":{"max_power":180,"power_draw":7.3},"psus":[{"name":"Power Supply 0","status":"ok"},{"name":"Power Supply 1","status":"absent"},{"name":"Power Supply 2","status":"absent"}],"serial":"FJ0324AV0077","temperatures":[{"celsius":51,"name":"Thermal board Sensor 1","status":"ok"},{"celsius":51,"name":"Thermal board Sensor 2","status":"ok"},{"celsius":50,"name":"Thermal board Sensor 3","status":"ok"},{"celsius":57,"name":"PFE Die Sensor","status":"ok"}],"type":"fpc","uptime":1692720,"vc_links":[{"neighbor_module_idx":1,"neighbor_port_id":"vcp-1/1/1","port_id":"vcp-0/1/0"},{"neighbor_module_idx":1,"neighbor_port_id":"vcp-1/1/0","port_id":"vcp-0/1/1"}],"vc_mode":"HiGiG","vc_role":"master","vc_state":"present","version":"22.4R3.25"},{"boot_partition":"junos","cpu_stat":{"idle":79,"interrupt":0,"load_avg":[0.52,0.46,0.46],"system":6,"user":15},"fpc_idx":1,"mac":"485a0deb2380","memory_stat":{"usage":14},"model":"EX4100-F-12P","pics":[{"index":0,"model_number":"EX4100-F-12P","port_groups":[{"count":12,"type":"GE"}]},{"index":1,"model_number":"EX4100-F-12P","port_groups":[{"count":4,"type":"SFP/SFP+"}]},{"index":2,"model_number":"EX4100-F-12P","port_groups":[{"count":2,"type":"GE"}]}],"poe":{"max_power":180,"power_draw":22.1},"psus":[{"name":"Power Supply 0","status":"ok"},{"name":"Power Supply 1","status":"absent"},{"name":"Power Supply 2","status":"absent"}],"serial":"FJ0424AV0101","temperatures":[{"celsius":52,"name":"Thermal board Sensor 1","status":"ok"},{"celsius":53,"name":"Thermal board Sensor 2","status":"ok"},{"celsius":52,"name":"Thermal board Sensor 3","status":"ok"},{"celsius":59,"name":"PFE Die Sensor","status":"ok"}],"type":"fpc","uptime":1692720,"vc_links":[{"neighbor_module_idx":0,"neighbor_port_id":"vcp-0/1/1","port_id":"vcp-1/1/0"},{"neighbor_module_idx":0,"neighbor_port_id":"vcp-0/1/0","port_id":"vcp-1/1/1"}],"vc_mode":"HiGiG","vc_role":"backup","vc_state":"present","version":"22.4R3.25"}],"name":"SW-HLAB-ea2e00","org_id":"c5324060-19da-48fa-af28-2b530bd08765","route_summary_stats":{"fib_routes":7,"max_unicast_routes_supported":32150,"rib_routes":40,"total_routes":3},"serial":"FJ0324AV0077","site_id":"a0e43ffb-94a6-4f27-92aa-9cf832e1143d","status":"connected","tag_id":3564806,"tag_uuid":"507604a4-6b34-449c-acb3-87955430b006","type":"switch","uptime":1692720,"vc_mac":"0912f561b653","vc_setup_info":{"config_type":"nonprovisioned","err_missing_dev_id_fpc":false},"version":"22.4R3.25"}]'
                contentMediaType: application/vnd.api+json
              examples:
                Access Point Stats:
                  value:
                  - auto_upgrade_stat:
                      lastcheck: 1720594762
                    ble_stat:
                      beacon_enabled: true
                      beacon_rate: 4
                      eddystone_uid_enabled: false
                      eddystone_uid_freq_msec: 1000
                      eddystone_uid_instance: 5c5b35d0077b
                      eddystone_uid_namespace: 9777c1a06ef611e68bbf
                      eddystone_url_enabled: false
                      eddystone_url_freq_msec: 1000
                      eddystone_url_url: ''
                      ibeacon_enabled: false
                      ibeacon_freq_msec: 1000
                      ibeacon_major: 894
                      ibeacon_minor: 9328
                      ibeacon_uuid: af010e2b-f829-4975-b49e-2e896ed1d627
                      major: 894
                      minors:
                      - 9328
                      - 9329
                      - 9330
                      - 9331
                      - 9332
                      - 9333
                      - 9334
                      - 9335
                      - -1
                      power: 8
                      rx_bytes: 158500843
                      rx_pkts: 3549163
                      tx_bytes: 509640
                      tx_pkts: 85411
                      tx_resets: 0
                      uuid: af010e2b-f829-4975-b49e-2e896ed1d627
                    config_reverted: false
                    cpu_system: 21921854
                    cpu_user: 7496631
                    cpu_util: 5
                    created_time: 1718228350
                    env_stat:
                      accel_x: -0.092
                      accel_y: 0.004
                      accel_z: -1.02
                      ambient_temp: 43
                      attitude: 0
                      cpu_temp: 53
                      humidity: 9
                      magne_x: 0
                      magne_y: 0
                      magne_z: 0
                      pressure: 968
                      vcore_voltage: 0
                    ext_ip: 66.129.234.28
                    hw_rev: C02
                    id: 00000000-0000-0000-1000-5c5b35d0077b
                    inactive_wired_vlans: []
                    ip: 192.168.95.3
                    ip_stat:
                      dhcp_server: 192.168.95.1
                      dns:
                      - 8.8.8.8
                      gateway: 192.168.95.1
                      ip: 192.168.95.3
                      ip6: fe80:0:0:0:5e5b:35ff:fed0:77b
                      ips:
                        vlan1: 192.168.95.3/24,fe80:0:0:0:5e5b:35ff:fed0:77b/64
                      netmask: 255.255.255.0
                      netmask6: /64
                    last_seen: 1720595866
                    last_trouble:
                      code: '07'
                      timestamp: 1720039666
                    lldp_stat:
                      chassis_id: d0:07:ca:f5:21:00
                      lldp_med_supported: false
                      mgmt_addr: 100.123.105.1
                      mgmt_addrs:
                      - 100.123.105.1
                      port_desc: ge-0/0/4
                      port_id: ge-0/0/4
                      power_allocated: 0
                      power_draw: 0
                      power_request_count: 0
                      power_requested: 0
                      system_desc: 'Juniper Networks, Inc. ex4300-48t internet router, kernel JUNOS 20.4R3-S7.2, Build date: 2023-04-21 19:47:18 UTC Copyright (c) 1996-2023 Juniper Networks, Inc.'
                      system_name: Phoenix-Switch
                    mac: 5c5b35d0077b
                    mem_total_kb: 505468
                    mem_used_kb: 202096
                    model: AP43
                    modified_time: 1718530662
                    mount: faceup
                    name: Phoenix
                    notes: ''
                    num_clients: 1
                    org_id: af010e2b-f829-4975-b49e-2e896ed1d627
                    port_stat:
                      eth0:
                        full_duplex: true
                        rx_bytes: 1284143195
                        rx_errors: 0
                        rx_peak_bps: 17585
                        rx_pkts: 5199816
                        speed: 1000
                        tx_bytes: 1283744961
                        tx_peak_bps: 26484
                        tx_pkts: 3990463
                        up: true
                      eth1:
                        full_duplex: false
                        rx_bytes: 0
                        rx_errors: 0
                        rx_peak_bps: 0
                        rx_pkts: 0
                        speed: 0
                        tx_bytes: 0
                        tx_peak_bps: 0
                        tx_pkts: 0
                        up: false
                    power_budget: 8400
                    power_constrained: false
                    power_src: DC Input
                    radio_config: {}
                    radio_stat:
                      band_24:
                        bandwidth: 20
                        channel: 11
                        mac: 5c5b35dea810
                        noise_floor: -80
                        num_clients: 0
                        power: 17
                        rx_bytes: 12948211
                        rx_pkts: 65292
                        tx_bytes: 19071943
                        tx_pkts: 76926
                        usage: '24'
                        util_all: 24
                        util_non_wifi: 2
                        util_rx_in_bss: 0
                        util_rx_other_bss: 17
                        util_tx: 4
                        util_undecodable_wifi: 0
                        util_unknown_wifi: 1
                      band_5:
                        bandwidth: 40
                        channel: 36
                        mac: 5c5b35dea7f0
                        noise_floor: -90
                        num_clients: 1
                        power: 17
                        rx_bytes: 578362619
                        rx_pkts: 2687577
                        tx_bytes: 1199571353
                        tx_pkts: 2479302
                        usage: '5'
                        util_all: 13
                        util_non_wifi: 0
                        util_rx_in_bss: 0
                        util_rx_other_bss: 10
                        util_tx: 1
                        util_undecodable_wifi: 0
                        util_unknown_wifi: 1
                    rx_bps: 9276
                    rx_bytes: 591310830
                    rx_pkts: 2752869
                    serial: A0703200709E6
                    site_id: 46fc665e-9706-4296-8fe2-78f42f2e67e4
                    status: connected
                    switch_redundancy:
                      num_redundant_aps: 1
                    tx_bps: 8067
                    tx_bytes: 1218643296
                    tx_pkts: 2556228
                    type: ap
                    uptime: 1593120
                    version: 0.14.29313
                Gateway Stats:
                  value:
                  - arp_table_stats:
                      arp_table_count: 21
                      max_entries_supported: 64000
                    auto_upgrade_stat:
                      lastcheck: 1720595477
                    cert_expiry: 1743292763
                    cluster_config:
                      configuration: active-active
                      control_link_info:
                        name: fxp1
                        status: Up
                      ethernet_connection:
                      - name: reth0
                        status: Up
                      - name: reth1
                        status: Up
                      - name: reth2
                        status: Down
                      - name: reth3
                        status: Down
                      - name: reth4
                        status: Up
                      fabric_link_info:
                        DataPlaneNotifiedStatus: Up
                        Interface: []
                        InternalStatus: Up
                        State: Enabled
                        Status: Enabled
                      last_status_change_reason: No failures
                      operational: active-active
                      primary_node_health: Healthy
                      redundancy_group_information:
                      - Id: 0
                        MonitoringFailure: none
                        Threshold: 255
                      - Id: 1
                        MonitoringFailure: interface-monitoring
                        Threshold: 0
                      - Id: 2
                        MonitoringFailure: none
                        Threshold: 255
                      secondary_node_health: Not healthy
                      status: Green
                    config_status: COMMITED
                    config_timestamp: 1720182848
                    config_version: 1720182848
                    cpu2_stat:
                      idle: 86
                      interrupt: 0
                      load_avg:
                      - 0.13
                      - 0.17
                      - 0.16
                      system: 5
                      user: 9
                    cpu_stat:
                      idle: 76
                      interrupt: 0
                      load_avg:
                      - 0.18
                      - 0.31
                      - 0.39
                      system: 10
                      user: 14
                    created_time: 1711756611
                    deviceprofile_id: 5e5daedf-e650-4013-b41c-845f0d2b9414
                    deviceprofile_name: wan_srx_tor_hub1
                    dhcpd_stat:
                      byod_dc1:
                        num_ips: 100
                        num_leased: 0
                      corp_dc1:
                        num_ips: 100
                        num_leased: 4
                      guest_dc1:
                        num_ips: 241
                        num_leased: 0
                      iot_dc1:
                        num_ips: 100
                        num_leased: 0
                      mgmt_dc1:
                        num_ips: 100
                        num_leased: 2
                      teleworker:
                        num_ips: 140
                        num_leased: 0
                    ext_ip: 69.196.157.189
                    fwupdate:
                      progress: 100
                      status: upgraded
                      status_id: 3037
                      timestamp: 1718392692.580769
                      will_retry: false
                    has_pcap: false
                    hostname: wan_srx_tor_hub1-srx
                    id: 00000000-0000-0000-1000-4db14e107134
                    if_stat:
                      ge-0/0/5.130:
                        address_mode: Unknown
                        nat_addresses: []
                        network_name: ''
                        port_id: ge-0/0/5
                        port_usage: lan
                        rx_bytes: 0
                        rx_pkts: 0
                        tx_bytes: 0
                        tx_pkts: 0
                        up: true
                        vlan: 0
                      ge-1/0/5.120:
                        address_mode: Unknown
                        nat_addresses: []
                        network_name: ''
                        port_id: ge-1/0/5
                        port_usage: lan
                        rx_bytes: 0
                        rx_pkts: 0
                        tx_bytes: 0
                        tx_pkts: 0
                        up: true
                        vlan: 0
                    ip: 69.196.157.190
                    ip_stat:
                      gateway: 69.196.157.185
                      ip: 69.196.157.190
                      ips:
                        vlan1: 69.196.157.190,69.196.157.190
                      netmask: 255.255.255.255
                    is_ha: true
                    last_seen: 1720598726
                    mac: 4db14e107134
                    mac_table_stats:
                      mac_table_count: 0
                      max_mac_entries_supported: 160000
                    memory2_stat:
                      usage: 32
                    memory_stat:
                      usage: 39
                    model: SRX300
                    modified_time: 1720092942
                    module2_stat:
                    - backup_version: 21.2R3-S7.7
                      fans: []
                      last_seen: 1720598717
                      mac: ec38739270c0
                      model: SRX300
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.2R3-S7.7
                      serial: CV2218AF1505
                      status: connected
                      temperatures:
                      - celsius: 49
                        name: Routing Engine
                        status: ok
                      - celsius: 64
                        name: Routing Engine CPU
                        status: ok
                      uptime: 580964
                      vc_links:
                      - neighbor_module_idx: 0
                        neighbor_port_id: fxp1
                        port_id: fxp1
                      vc_role: secondary
                      vc_state: active
                      version: 21.2R3-S6.11
                    module_stat:
                    - backup_version: 21.2R3-S7.7
                      fans: []
                      last_seen: 1720598716.999985
                      mac: 4db14e107134
                      model: SRX300
                      psus:
                      - name: Power Supply 0
                        status: ok
                      recovery_version: 21.2R3-S7.7
                      serial: CV0219AN0335
                      status: connected
                      temperatures:
                      - celsius: 49
                        name: Routing Engine
                        status: ok
                      - celsius: 65
                        name: Routing Engine CPU
                        status: ok
                      uptime: 1945193
                      vc_links:
                      - neighbor_module_idx: 1
                        neighbor_port_id: fxp1
                        port_id: fxp1
                      vc_role: primary
                      vc_state: active
                      version: 21.2R3-S6.11
                    name: wan_srx_tor_hub1-srx
                    org_id: af010e2b-f829-4975-b49e-2e896ed1d627
                    route_summary_stats:
                      fib_routes: 0
                      max_unicast_routes_supported: 1240000
                      rib_routes: 0
                      total_routes: 0
                    serial: CV0219AN0335
                    service_stat: {}
                    service_status:
                      appid_status: enabled
                      appid_version: 3720
                      ewf_status: disabled
                      idp_install_result: successful
                      idp_install_timestamp: 2024-07-10T06:29:11.708164029Z
                      idp_status: disabled
                      idp_update_timestamp: 2024-07-10T06:28:28.567046244Z
                    site_id: 83c31971-ad70-4419-ae20-7f2b90748986
                    spu2_stat:
                    - spu_cpu: 0
                      spu_current_session: 39
                      spu_max_session: 32768
                      spu_memory: 31
                      spu_pending_session: 0
                      spu_uptime: 1944572
                      spu_valid_session: 0
                    spu_stat:
                    - spu_cpu: 1
                      spu_current_session: 47
                      spu_max_session: 32768
                      spu_memory: 34
                      spu_pending_session: 0
                      spu_uptime: 1944572
                      spu_valid_session: 0
                    status: connected
                    tag_id: 3550217
                    tag_uuid: af010e2b-f829-4975-b49e-2e896ed1d627
                    type: gateway
                    uptime: 581259
                    version: 21.2R3-S6.11
                Switch:
                  value:
                  - ap_redundancy:
                      num_aps: 1
                      num_aps_with_switch_redundancy: 1
                    arp_table_stats:
                      arp_table_count: 16
                      max_entries_supported: 32000
                    auto_upgrade_stat:
                      lastcheck: 1720600596
                    cert_expiry: 1743932274
                    clients:
                    - device_mac: 0912f561b653
                      mac: 001132f5ad23
                      port_id: ge-1/0/11
                    clients_stats:
                      total:
                        num_aps:
                        - 0
                        - 0
                        num_wired_clients: 13
                    config_status: COMMITED
                    config_timestamp: 1720552389
                    config_version: 1720552389
                    cpu_stat:
                      idle: 74
                      interrupt: 0
                      load_avg:
                      - 0.8
                      - 0.75
                      - 0.78
                      system: 13
                      user: 13
                    created_time: 1712346090
                    dhcpd_stat:
                      ifo:
                        num_ips: 5
                        num_leased: 0
                    ext_ip: 153.142.221.41
                    fw_versions_outofsync: false
                    fwupdate:
                      progress: 100
                      status: upgraded
                      status_id: 3037
                      timestamp: 1712409702.9714448
                      will_retry: false
                    has_pcap: true
                    hostname: SW-HLAB-ea2e00
                    hw_rev: A
                    id: 00000000-0000-0000-1000-0912f561b653
                    if_stat:
                      ge-0/0/5.0:
                        port_id: ge-0/0/5
                        rx_bytes: 0
                        rx_pkts: 78110
                        tx_bytes: 0
                        tx_pkts: 61037
                        up: true
                      ge-1/0/0.0:
                        port_id: ge-1/0/0
                        rx_bytes: 0
                        rx_pkts: 56415
                        tx_bytes: 0
                        tx_pkts: 72209
                        up: true
                      irb.172:
                        ips:
                        - 10.3.172.41/24
                        port_id: irb
                        rx_bytes: 0
                        rx_pkts: 1291755
                        servp_info: {}
                        tx_bytes: 0
                        tx_pkts: 990327
                        up: true
                        vlan: 172
                      vme.0:
                        port_id: vme
                        rx_bytes: 0
                        rx_pkts: 0
                        tx_bytes: 0
                        tx_pkts: 0
                        up: true
                    ip: 10.3.10.10
                    ip_stat:
                      gateway: 10.3.172.9
                      ip: 10.3.10.10
                      ips:
                        vlan172: 10.3.172.41
                      netmask: 255.255.255.255
                    last_seen: 1720601189
                    last_trouble:
                      code: '103'
                      timestamp: 1712412455215
                    mac: 0912f561b653
                    mac_table_stats:
                      mac_table_count: 58
                      max_mac_entries_supported: 64000
                    memory_stat:
                      usage: 16
                    model: EX4100-F-12P
                    modified_time: 1720552388
                    module_stat:
                    - boot_partition: junos
                      cpu_stat:
                        idle: 74
                        interrupt: 0
                        load_avg:
                        - 0.8
                        - 0.75
                        - 0.78
                        system: 13
                        user: 13
                      fpc_idx: 0
                      mac: 0912f561b653
                      memory_stat:
                        usage: 16
                      model: EX4100-F-12P
                      pics:
                      - index: 0
                        model_number: EX4100-F-12P
                        port_groups:
                        - count: 12
                          type: GE
                      - index: 1
                        model_number: EX4100-F-12P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      - index: 2
                        model_number: EX4100-F-12P
                        port_groups:
                        - count: 2
                          type: GE
                      poe:
                        max_power: 180
                        power_draw: 7.3
                      psus:
                      - name: Power Supply 0
                        status: ok
                      - name: Power Supply 1
                        status: absent
                      - name: Power Supply 2
                        status: absent
                      serial: FJ0324AV0077
                      temperatures:
                      - celsius: 51
                        name: Thermal board Sensor 1
                        status: ok
                      - celsius: 51
                        name: Thermal board Sensor 2
                        status: ok
                      - celsius: 50
                        name: Thermal board Sensor 3
                        status: ok
                      - celsius: 57
                        name: PFE Die Sensor
                        status: ok
                      type: fpc
                      uptime: 1692720
                      vc_links:
                      - neighbor_module_idx: 1
                        neighbor_port_id: vcp-1/1/1
                        port_id: vcp-0/1/0
                      - neighbor_module_idx: 1
                        neighbor_port_id: vcp-1/1/0
                        port_id: vcp-0/1/1
                      vc_mode: HiGiG
                      vc_role: master
                      vc_state: present
                      version: 22.4R3.25
                    - boot_partition: junos
                      cpu_stat:
                        idle: 79
                        interrupt: 0
                        load_avg:
                        - 0.52
                        - 0.46
                        - 0.46
                        system: 6
                        user: 15
                      fpc_idx: 1
                      mac: 485a0deb2380
                      memory_stat:
                        usage: 14
                      model: EX4100-F-12P
                      pics:
                      - index: 0
                        model_number: EX4100-F-12P
                        port_groups:
                        - count: 12
                          type: GE
                      - index: 1
                        model_number: EX4100-F-12P
                        port_groups:
                        - count: 4
                          type: SFP/SFP+
                      - index: 2
                        model_number: EX4100-F-12P
                        port_groups:
                        - count: 2
                          type: GE
                      poe:
                        max_power: 180
                        power_draw: 22.1
                      psus:
                      - name: Power Supply 0
                        status: ok
                      - name: Power Supply 1
                        status: absent
                      - name: Power Supply 2
                        status: absent
                      serial: FJ0424AV0101
                      temperatures:
                      - celsius: 52
                        name: Thermal board Sensor 1
                        status: ok
                      - celsius: 53
                        name: Thermal board Sensor 2
                        status: ok
                      - celsius: 52
                        name: Thermal board Sensor 3
                        status: ok
                      - celsius: 59
                        name: PFE Die Sensor
                        status: ok
                      type: fpc
                      uptime: 1692720
                      vc_links:
                      - neighbor_module_idx: 0
                        neighbor_port_id: vcp-0/1/1
                        port_id: vcp-1/1/0
                      - neighbor_module_idx: 0
                        neighbor_port_id: vcp-0/1/0
                        port_id: vcp-1/1/1
                      vc_mode: HiGiG
                      vc_role: backup
                      vc_state: present
                      version: 22.4R3.25
                    name: SW-HLAB-ea2e00
                    org_id: c5324060-19da-48fa-af28-2b530bd08765
                    route_summary_stats:
                      fib_routes: 7
                      max_unicast_routes_supported: 32150
                      rib_routes: 40
                      total_routes: 3
                    serial: FJ0324AV0077
                    site_id: a0e43ffb-94a6-4f27-92aa-9cf832e1143d
                    status: connected
                    tag_id: 3564806
                    tag_uuid: 507604a4-6b34-449c-acb3-87955430b006
                    type: switch
                    uptime: 1692720
                    vc_mac: 0912f561b653
                    vc_setup_info:
                      config_type: nonprovisioned
                      err_missing_dev_id_fpc: false
                    version: 22.4R3.25
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/devices/{device_id}:
    get:
      tags:
      - Sites Stats - Devices
      summary: getSiteDeviceStats
      description: Get Site Device Stats Details
      operationId: getSiteDeviceStats
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: fields
        in: query
        description: List of additional fields requests, comma separated, or `fields=*` for all of them
        style: form
        explode: true
        schema:
          type: string
          examples:
          - field1,field2
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/stats_device'
                - description: Device statistics record for an AP, switch, or gateway
                  examples:
                  - auto_upgrade_stat:
                      lastcheck: 1720594762
                    ble_stat:
                      beacon_enabled: true
                      beacon_rate: 4
                      eddystone_uid_enabled: false
                      eddystone_uid_freq_msec: 1000
                      eddystone_uid_instance: 5c5b35d0077b
                      eddystone_uid_namespace: 9777c1a06ef611e68bbf
                      eddystone_url_enabled: false
                      eddystone_url_freq_msec: 1000
                      eddystone_url_url: ''
                      ibeacon_enabled: false
                      ibeacon_freq_msec: 1000
                      ibeacon_major: 894
                      ibeacon_minor: 9328
                      ibeacon_uuid: af010e2b-f829-4975-b49e-2e896ed1d627
                      major: 894
                      minors:
                      - 9328
                      - 9329
                      - 9330
                      - 9331
                      - 9332
                      - 9333
                      - 9334
                      - 9335
                      - -1
                      power: 8
                      rx_bytes: 158500843
                      rx_pkts: 3549163
                      tx_bytes: 509640
                      tx_pkts: 85411
                      tx_resets: 0
                      uuid: af010e2b-f829-4975-b49e-2e896ed1d627
                    config_reverted: false
                    cpu_system: 21921854
                    cpu_user: 7496631
                    cpu_util: 5
                    created_time: 1718228350
                    env_stat:
                      accel_x: -0.092
                      accel_y: 0.004
                      accel_z: -1.02
                      ambient_temp: 43
                      attitude: 0
                      cpu_temp: 53
                      humidity: 9
                      magne_x: 0
                      magne_y: 0
                      magne_z: 0
                      pressure: 968
                      vcore_voltage: 0
                    ext_ip: 66.129.234.28
                    hw_rev: C02
                    id: 00000000-0000-0000-1000-5c5b35d0077b
                    inactive_wired_vlans: []
                    ip: 192.168.95.3
                    ip_stat:
                      dhcp_server: 192.168.95.1
                      dns:
                      - 8.8.8.8
                      gateway: 192.168.95.1
                      ip: 192.168.95.3
                      ip6: fe80:0:0:0:5e5b:35ff:fed0:77b
                      ips:
                        vlan1: 192.168.95.3/24,fe80:0:0:0:5e5b:35ff:fed0:77b/64
                      netmask: 255.255.255.0
                      netmask6: /64
                    last_seen: 1720595866
                    last_trouble:
                      code: '07'
                      timestamp: 1720039666
                    lldp_stat:
                      chassis_id: d0:07:ca:f5:21:00
                      lldp_med_supported: false
                      mgmt_addr: 100.123.105.1
                      mgmt_addrs:
                      - 100.123.105.1
                      port_desc: ge-0/0/4
                      port_id: ge-0/0/4
                      power_allocated: 0
                      power_draw: 0
                      power_request_count: 0
                      power_requested: 0
                      system_desc: 'Juniper Networks, Inc. ex4300-48t internet router, kernel JUNOS 20.4R3-S7.2, Build date: 2023-04-21 19:47:18 UTC Copyright (c) 1996-2023 Juniper Networks, Inc.'
                      system_name: Phoenix-Switch
                    mac: 5c5b35d0077b
                    mem_total_kb: 505468
                    mem_used_kb: 202096
                    model: AP43
                    modified_time: 1718530662
                    mount: faceup
                    name: Phoenix
                    notes: ''
                    num_clients: 1
                    org_id: af010e2b-f829-4975-b49e-2e896ed1d627
                    port_stat:
                      eth0:
                        full_duplex: true
                        rx_bytes: 1284143195
                        rx_errors: 0
                        rx_peak_bps: 17585
                        rx_pkts: 5199816
                        speed: 1000
                        tx_bytes: 1283744961
                        tx_peak_bps: 26484
                        tx_pkts: 3990463
                        up: true
                      eth1:
                        full_duplex: false
                        rx_bytes: 0
                        rx_errors: 0
                        rx_peak_bps: 0
                        rx_pkts: 0
                        speed: 0
                        tx_bytes: 0
                        tx_peak_bps: 0
                        tx_pkts: 0
                        up: false
                    power_budget: 8400
                    power_constrained: false
                    power_src: DC Input
                    radio_config: {}
                    radio_stat:
                      band_24:
                        bandwidth: 20
                        channel: 11
                        mac: 5c5b35dea810
                        noise_floor: -80
                        num_clients: 0
                        power: 17
                        rx_bytes: 12948211
                        rx_pkts: 65292
                        tx_bytes: 19071943
                        tx_pkts: 76926
                        usage: '24'
                        util_all: 24
                        util_non_wifi: 2
                        util_rx_in_bss: 0
                        util_rx_other_bss: 17
                        util_tx: 4
                        util_undecodable_wifi: 0
                        util_unknown_wifi: 1
                      band_5:
                        bandwidth: 40
                        channel: 36
                        mac: 5c5b35dea7f0
                        noise_floor: -90
                        num_clients: 1
                        power: 17
                        rx_bytes: 578362619
                        rx_pkts: 2687577
                        tx_bytes: 1199571353
                        tx_pkts: 2479302
                        usage: '5'
                        util_all: 13
                        util_non_wifi: 0
                        util_rx_in_bss: 0
                        util_rx_other_bss: 10
                        util_tx: 1
                        util_undecodable_wifi: 0
                        util_unknown_wifi: 1
                    rx_bps: 9276
                    rx_bytes: 591310830
                    rx_pkts: 2752869
                    serial: A0703200709E6
                    site_id: 46fc665e-9706-4296-8fe2-78f42f2e67e4
                    status: connected
                    switch_redundancy:
                      num_redundant_aps: 1
                    tx_bps: 8067
                    tx_bytes: 1218643296
                    tx_pkts: 2556228
                    type: ap
                    uptime: 1593120
                    version: 0.14.29313
                contentMediaType: application/json
              examples:
                Access Point Stats:
                  value:
                    auto_upgrade_stat:
                      lastcheck: 1720594762
                    ble_stat:
                      beacon_enabled: true
                      beacon_rate: 4
                      eddystone_uid_enabled: false
                      eddystone_uid_freq_msec: 1000
                      eddystone_uid_instance: 5c5b35d0077b
                      eddystone_uid_namespace: 9777c1a06ef611e68bbf
                      eddystone_url_enabled: false
                      eddystone_url_freq_msec: 1000
                      eddystone_url_url: ''
                      ibeacon_enabled: false
                      ibeacon_freq_msec: 1000
                      ibeacon_major: 894
                      ibeacon_minor: 9328
                      ibeacon_uuid: af010e2b-f829-4975-b49e-2e896ed1d627
                      major: 894
                      minors:
                      - 9328
                      - 9329
                      - 9330
                      - 9331
                      - 9332
                      - 9333
                      - 9334
                      - 9335
                      - -1
                      power: 8
                      rx_bytes: 158500843
                      rx_pkts: 3549163
                      tx_bytes: 509640
                      tx_pkts: 85411
                      tx_resets: 0
                      uuid: af010e2b-f829-4975-b49e-2e896ed1d627
                    config_reverted: false
                    cpu_system: 21921854
                    cpu_user: 7496631
                    cpu_util: 5
                    created_time: 1718228350
                    env_stat:
                      accel_x: -0.092
                      accel_y: 0.004
                      accel_z: -1.02
                      ambient_temp: 43
                      attitude: 0
                      cpu_temp: 53
                      humidity: 9
                      magne_x: 0
                      magne_y: 0
                      magne_z: 0
                      pressure: 968
                      vcore_voltage: 0
                    ext_ip: 66.129.234.28
                    hw_rev: C02
                    id: 00000000-0000-0000-1000-5c5b35d0077b
                    inactive_wired_vlans: []
                    ip: 192.168.95.3
                    ip_stat:
                      dhcp_server: 192.168.95.1
                      dns:
                      - 8.8.8.8
                      gateway: 192.168.95.1
                      ip: 192.168.95.3
                      ip6: fe80:0:0:0:5e5b:35ff:fed0:77b
                      ips:
                        vlan1: 192.168.95.3/24,fe80:0:0:0:5e5b:35ff:fed0:77b/64
                      netmask: 255.255.255.0
                      netmask6: /64
                    last_seen: 1720595866
                    last_trouble:
                      code: '07'
                      timestamp: 1720039666
                    lldp_stat:
                      chassis_id: d0:07:ca:f5:21:00
                      lldp_med_supported: false
                      mgmt_addr: 100.123.105.1
                      mgmt_addrs:
                      - 100.123.105.1
                      port_desc: ge-0/0/4
                      port_id: ge-0/0/4
                      power_allocated: 0
                      power_draw: 0
                      power_request_count: 0
                      power_requested: 0
                      system_desc: 'Juniper Networks, Inc. ex4300-48t internet router, kernel JUNOS 20.4R3-S7.2, Build date: 2023-04-21 19:47:18 UTC Copyright (c) 1996-2023 Juniper Networks, Inc.'
                      system_name: Phoenix-Switch
                    mac: 5c5b35d0077b
                    mem_total_kb: 505468
                    mem_used_kb: 202096
                    model: AP43
                    modified_time: 1718530662
                    mount: faceup
                    name: Phoenix
                    notes: ''
                    num_clients: 1
                    org_id: af010e2b-f829-4975-b49e-2e896ed1d627
                    port_stat:
                      eth0:
                        full_duplex: true
                        rx_bytes: 1284143195
                        rx_errors: 0
                        rx_peak_bps: 17585
                        rx_pkts: 5199816
                        speed: 1000
                        tx_bytes: 1283744961
                        tx_peak_bps: 26484
                        tx_pkts: 3990463
                        up: true
                      eth1:
                        full_duplex: false
                        rx_bytes: 0
                        rx_errors: 0
                        rx_peak_bps: 0
                        rx_pkts: 0
                        speed: 0
                        tx_bytes: 0
                        tx_peak_bps: 0
                        tx_pkts: 0
                        up: false
                    power_budget: 8400
                    power_constrained: false
                    power_src: DC Input
                    radio_config: {}
                    radio_stat:
                      band_24:
                        bandwidth: 20
                        channel: 11
                        mac: 5c5b35dea810
                        noise_floor: -80
                        num_clients: 0
                        power: 17
                        rx_bytes: 12948211
                        rx_pkts: 65292
                        tx_bytes: 19071943
                        tx_pkts: 76926
                        usage: '24'
                        util_all: 24
                        util_non_wifi: 2
                        util_rx_in_bss: 0
                        util_rx_other_bss: 17
                        util_tx: 4
                        util_undecodable_wifi: 0
                        util_unknown_wifi: 1
                      band_5:
                        bandwidth: 40
                        channel: 36
                        mac: 5c5b35dea7f0
                        noise_floor: -90
                        num_clients: 1
                        power: 17
                        rx_bytes: 578362619
                        rx_pkts: 2687577
                        tx_bytes: 1199571353
                        tx_pkts: 2479302
                        usage: '5'
                        util_all: 13
                        util_non_wifi: 0
                        util_rx_in_bss: 0
                        util_rx_other_bss: 10
                        util_tx: 1
                        util_undecodable_wifi: 0
                        util_unknown_wifi: 1
                    rx_bps: 9276
                    rx_bytes: 591310830
                    rx_pkts: 2752869
                    serial: A0703200709E6
                    site_id: 46fc665e-9706-4296-8fe2-78f42f2e67e4
                    status: connected
                    switch_redundancy:
                      num_redundant_aps: 1
                    tx_bps: 8067
                    tx_bytes: 1218643296
                    tx_pkts: 2556228
                    type: ap
                    uptime: 1593120
                    version: 0.14.29313
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/stats_device'
                - description: Device statistics record for an AP, switch, or gateway
                  examples:
                  - auto_upgrade_stat:
                      lastcheck: 1720594762
                    ble_stat:
                      beacon_enabled: true
                      beacon_rate: 4
                      eddystone_uid_enabled: false
                      eddystone_uid_freq_msec: 1000
                      eddystone_uid_instance: 5c5b35d0077b
                      eddystone_uid_namespace: 9777c1a06ef611e68bbf
                      eddystone_url_enabled: false
                      eddystone_url_freq_msec: 1000
                      eddystone_url_url: ''
                      ibeacon_enabled: false
                      ibeacon_freq_msec: 1000
                      ibeacon_major: 894
                      ibeacon_minor: 9328
                      ibeacon_uuid: af010e2b-f829-4975-b49e-2e896ed1d627
                      major: 894
                      minors:
                      - 9328
                      - 9329
                      - 9330
                      - 9331
                      - 9332
                      - 9333
                      - 9334
                      - 9335
                      - -1
                      power: 8
                      rx_bytes: 158500843
                      rx_pkts: 3549163
                      tx_bytes: 509640
                      tx_pkts: 85411
                      tx_resets: 0
                      uuid: af010e2b-f829-4975-b49e-2e896ed1d627
                    config_reverted: false
                    cpu_system: 21921854
                    cpu_user: 7496631
                    cpu_util: 5
                    created_time: 1718228350
                    env_stat:
                      accel_x: -0.092
                      accel_y: 0.004
                      accel_z: -1.02
                      ambient_temp: 43
                      attitude: 0
                      cpu_temp: 53
                      humidity: 9
                      magne_x: 0
                      magne_y: 0
                      magne_z: 0
                      pressure: 968
                      vcore_voltage: 0
                    ext_ip: 66.129.234.28
                    hw_rev: C02
                    id: 00000000-0000-0000-1000-5c5b35d0077b
                    inactive_wired_vlans: []
                    ip: 192.168.95.3
                    ip_stat:
                      dhcp_server: 192.168.95.1
                      dns:
                      - 8.8.8.8
                      gateway: 192.168.95.1
                      ip: 192.168.95.3
                      ip6: fe80:0:0:0:5e5b:35ff:fed0:77b
                      ips:
                        vlan1: 192.168.95.3/24,fe80:0:0:0:5e5b:35ff:fed0:77b/64
                      netmask: 255.255.255.0
                      netmask6: /64
                    last_seen: 1720595866
                    last_trouble:
                      code: '07'
                      timestamp: 1720039666
                    lldp_stat:
                      chassis_id: d0:07:ca:f5:21:00
                      lldp_med_supported: false
                      mgmt_addr: 100.123.105.1
                      mgmt_addrs:
                      - 100.123.105.1
                      port_desc: ge-0/0/4
                      port_id: ge-0/0/4
                      power_allocated: 0
                      power_draw: 0
                      power_request_count: 0
                      power_requested: 0
                      system_desc: 'Juniper Networks, Inc. ex4300-48t internet router, kernel JUNOS 20.4R3-S7.2, Build date: 2023-04-21 19:47:18 UTC Copyright (c) 1996-2023 Juniper Networks, Inc.'
                      system_name: Phoenix-Switch
                    mac: 5c5b35d0077b
                    mem_total_kb: 505468
                    mem_used_kb: 202096
                    model: AP43
                    modified_time: 1718530662
                    mount: faceup
                    name: Phoenix
                    notes: ''
                    num_clients: 1
                    org_id: af010e2b-f829-4975-b49e-2e896ed1d627
                    port_stat:
                      eth0:
                        full_duplex: true
                        rx_bytes: 1284143195
                        rx_errors: 0
                        rx_peak_bps: 17585
                        rx_pkts: 5199816
                        speed: 1000
                        tx_bytes: 1283744961
                        tx_peak_bps: 26484
                        tx_pkts: 3990463
                        up: true
                      eth1:
                        full_duplex: false
                        rx_bytes: 0
                        rx_errors: 0
                        rx_peak_bps: 0
                        rx_pkts: 0
                        speed: 0
                        tx_bytes: 0
                        tx_peak_bps: 0
                        tx_pkts: 0
                        up: false
                    power_budget: 8400
                    power_constrained: false
                    power_src: DC Input
                    radio_config: {}
                    radio_stat:
                      band_24:
                        bandwidth: 20
                        channel: 11
                        mac: 5c5b35dea810
                        noise_floor: -80
                        num_clients: 0
                        power: 17
                        rx_bytes: 12948211
                        rx_pkts: 65292
                        tx_bytes: 19071943
                        tx_pkts: 76926
                        usage: '24'
                        util_all: 24
                        util_non_wifi: 2
                        util_rx_in_bss: 0
                        util_rx_other_bss: 17
                        util_tx: 4
                        util_undecodable_wifi: 0
                        util_unknown_wifi: 1
                      band_5:
                        bandwidth: 40
                        channel: 36
                        mac: 5c5b35dea7f0
                        noise_floor: -90
                        num_clients: 1
                        power: 17
                        rx_bytes: 578362619
                        rx_pkts: 2687577
                        tx_bytes: 1199571353
                        tx_pkts: 2479302
                        usage: '5'
                        util_all: 13
                        util_non_wifi: 0
                        util_rx_in_bss: 0
                        util_rx_other_bss: 10
                        util_tx: 1
                        util_undecodable_wifi: 0
                        util_unknown_wifi: 1
                    rx_bps: 9276
                    rx_bytes: 591310830
                    rx_pkts: 2752869
                    serial: A0703200709E6
                    site_id: 46fc665e-9706-4296-8fe2-78f42f2e67e4
                    status: connected
                    switch_redundancy:
                      num_redundant_aps: 1
                    tx_bps: 8067
                    tx_bytes: 1218643296
                    tx_pkts: 2556228
                    type: ap
                    uptime: 1593120
                    version: 0.14.29313
                contentMediaType: application/vnd.api+json
              examples:
                Access Point Stats:
                  value:
                    auto_upgrade_stat:
                      lastcheck: 1720594762
                    ble_stat:
                      beacon_enabled: true
                      beacon_rate: 4
                      eddystone_uid_enabled: false
                      eddystone_uid_freq_msec: 1000
                      eddystone_uid_instance: 5c5b35d0077b
                      eddystone_uid_namespace: 9777c1a06ef611e68bbf
                      eddystone_url_enabled: false
                      eddystone_url_freq_msec: 1000
                      eddystone_url_url: ''
                      ibeacon_enabled: false
                      ibeacon_freq_msec: 1000
                      ibeacon_major: 894
                      ibeacon_minor: 9328
                      ibeacon_uuid: af010e2b-f829-4975-b49e-2e896ed1d627
                      major: 894
                      minors:
                      - 9328
                      - 9329
                      - 9330
                      - 9331
                      - 9332
                      - 9333
                      - 9334
                      - 9335
                      - -1
                      power: 8
                      rx_bytes: 158500843
                      rx_pkts: 3549163
                      tx_bytes: 509640
                      tx_pkts: 85411
                      tx_resets: 0
                      uuid: af010e2b-f829-4975-b49e-2e896ed1d627
                    config_reverted: false
                    cpu_system: 21921854
                    cpu_user: 7496631
                    cpu_util: 5
                    created_time: 1718228350
                    env_stat:
                      accel_x: -0.092
                      accel_y: 0.004
                      accel_z: -1.02
                      ambient_temp: 43
                      attitude: 0
                      cpu_temp: 53
                      humidity: 9
                      magne_x: 0
                      magne_y: 0
                      magne_z: 0
                      pressure: 968
                      vcore_voltage: 0
                    ext_ip: 66.129.234.28
                    hw_rev: C02
                    id: 00000000-0000-0000-1000-5c5b35d0077b
                    inactive_wired_vlans: []
                    ip: 192.168.95.3
                    ip_stat:
                      dhcp_server: 192.168.95.1
                      dns:
                      - 8.8.8.8
                      gateway: 192.168.95.1
                      ip: 192.168.95.3
                      ip6: fe80:0:0:0:5e5b:35ff:fed0:77b
                      ips:
                        vlan1: 192.168.95.3/24,fe80:0:0:0:5e5b:35ff:fed0:77b/64
                      netmask: 255.255.255.0
                      netmask6: /64
                    last_seen: 1720595866
                    last_trouble:
                      code: '07'
                      timestamp: 1720039666
                    lldp_stat:
                      chassis_id: d0:07:ca:f5:21:00
                      lldp_med_supported: false
                      mgmt_addr: 100.123.105.1
                      mgmt_addrs:
                      - 100.123.105.1
                      port_desc: ge-0/0/4
                      port_id: ge-0/0/4
                      power_allocated: 0
                      power_draw: 0
                      power_request_count: 0
                      power_requested: 0
                      system_desc: 'Juniper Networks, Inc. ex4300-48t internet router, kernel JUNOS 20.4R3-S7.2, Build date: 2023-04-21 19:47:18 UTC Copyright (c) 1996-2023 Juniper Networks, Inc.'
                      system_name: Phoenix-Switch
                    mac: 5c5b35d0077b
                    mem_total_kb: 505468
                    mem_used_kb: 202096
                    model: AP43
                    modified_time: 1718530662
                    mount: faceup
                    name: Phoenix
                    notes: ''
                    num_clients: 1
                    org_id: af010e2b-f829-4975-b49e-2e896ed1d627
                    port_stat:
                      eth0:
                        full_duplex: true
                        rx_bytes: 1284143195
                        rx_errors: 0
                        rx_peak_bps: 17585
                        rx_pkts: 5199816
                        speed: 1000
                        tx_bytes: 1283744961
                        tx_peak_bps: 26484
                        tx_pkts: 3990463
                        up: true
                      eth1:
                        full_duplex: false
                        rx_bytes: 0
                        rx_errors: 0
                        rx_peak_bps: 0
                        rx_pkts: 0
                        speed: 0
                        tx_bytes: 0
                        tx_peak_bps: 0
                        tx_pkts: 0
                        up: false
                    power_budget: 8400
                    power_constrained: false
                    power_src: DC Input
                    radio_config: {}
                    radio_stat:
                      band_24:
                        bandwidth: 20
                        channel: 11
                        mac: 5c5b35dea810
                        noise_floor: -80
                        num_clients: 0
                        power: 17
                        rx_bytes: 12948211
                        rx_pkts: 65292
                        tx_bytes: 19071943
                        tx_pkts: 76926
                        usage: '24'
                        util_all: 24
                        util_non_wifi: 2
                        util_rx_in_bss: 0
                        util_rx_other_bss: 17
                        util_tx: 4
                        util_undecodable_wifi: 0
                        util_unknown_wifi: 1
                      band_5:
                        bandwidth: 40
                        channel: 36
                        mac: 5c5b35dea7f0
                        noise_floor: -90
                        num_clients: 1
                        power: 17
                        rx_bytes: 578362619
                        rx_pkts: 2687577
                        tx_bytes: 1199571353
                        tx_pkts: 2479302
                        usage: '5'
                        util_all: 13
                        util_non_wifi: 0
                        util_rx_in_bss: 0
                        util_rx_other_bss: 10
                        util_tx: 1
                        util_undecodable_wifi: 0
                        util_unknown_wifi: 1
                    rx_bps: 9276
                    rx_bytes: 591310830
                    rx_pkts: 2752869
                    serial: A0703200709E6
                    site_id: 46fc665e-9706-4296-8fe2-78f42f2e67e4
                    status: connected
                    switch_redundancy:
                      num_redundant_aps: 1
                    tx_bps: 8067
                    tx_bytes: 1218643296
                    tx_pkts: 2556228
                    type: ap
                    uptime: 1593120
                    version: 0.14.29313
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/devices/{device_id}/clients:
    get:
      tags:
      - Sites Stats - Devices
      summary: getSiteAllClientsStatsByDevice
      description: Get wireless client stat by Device
      operationId: getSiteAllClientsStatsByDevice
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/stats_wireless_client'
                description: Wireless client statistics records returned by a stats response
                contentMediaType: application/json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/gateways/metrics:
    get:
      tags:
      - Sites Stats - Devices
      summary: getSiteGatewayMetrics
      description: Get Site Gateway Metrics
      operationId: getSiteGatewayMetrics
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/gateway_metrics'
                - description: Gateway metric scores returned by the site gateway metrics API
                  examples:
                  - config_success: 99.9
                    version_compliance:
                      major_version:
                        SRX320:
                          major_count: 0
                          major_version: 19.4R2-S1.2
                      score: 99.9
                      type: gateway
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    config_success: 99.9
                    version_compliance:
                      major_version:
                        SRX320:
                          major_count: 0
                          major_version: 19.4R2-S1.2
                      score: 99.9
                      type: gateway
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/gateway_metrics'
                - description: Gateway metric scores returned by the site gateway metrics API
                  examples:
                  - config_success: 99.9
                    version_compliance:
                      major_version:
                        SRX320:
                          major_count: 0
                          major_version: 19.4R2-S1.2
                      score: 99.9
                      type: gateway
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    config_success: 99.9
                    version_compliance:
                      major_version:
                        SRX320:
                          major_count: 0
                          major_version: 19.4R2-S1.2
                      score: 99.9
                      type: gateway
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/switches/metrics:
    get:
      tags:
      - Sites Stats - Devices
      summary: getSiteSwitchesMetrics
      description: Get version compliance metrics for managed or monitored switches
      operationId: getSiteSwitchesMetrics
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: type
        in: query
        description: 'Filter results by type. enum: `active_ports_summary`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/switch_metric_type'
          - description: 'Filter results by type. enum: `active_ports_summary`'
      - name: scope
        in: query
        description: 'Filter results by scope. enum: `site`, `switch`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/switch_metric_scope'
          - description: 'Filter results by scope. enum: `site`, `switch`'
      - name: switch_mac
        in: query
        description: Switch mac, used only with metric `type`==`active_ports_summary`
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b350e0410
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_switch_metrics'
                - description: Switch metrics returned for the requested site or switch scope
                  examples:
                  - '{"active_ports_summary":{"details":{"active_port_count":4,"total_port_count":4},"score":100,"total_switch_count":2},"config_success":{"details":{"config_success_count":2},"score":100,"total_switch_count":2},"version_compliance":{"details":{"major_versions":[{"major_count":1,"major_version":"21.4R3.5","model":"EX2300-C-12P","system_names":[]},{"major_count":1,"major_version":"6.0.4-11","model":"SSR120","system_names":[]}]},"score":100,"total_switch_count":2}}'
                  - '{"active_ports_summary":{"details":{"active_port_count":1,"total_port_count":2},"score":50,"total_switch_count":1}}'
                contentMediaType: application/json
              examples:
                Site Scoped:
                  value:
                    active_ports_summary:
                      details:
                        active_port_count: 4
                        total_port_count: 4
                      score: 100
                      total_switch_count: 2
                    config_success:
                      details:
                        config_success_count: 2
                      score: 100
                      total_switch_count: 2
                    version_compliance:
                      details:
                        major_versions:
                        - major_count: 1
                          major_version: 21.4R3.5
                          model: EX2300-C-12P
                          system_names: []
                        - major_count: 1
                          major_version: 6.0.4-11
                          model: SSR120
                          system_names: []
                      score: 100
                      total_switch_count: 2
                Switch Scoped:
                  value:
                    active_ports_summary:
                      details:
                        active_port_count: 1
                        total_port_count: 2
                      score: 50
                      total_switch_count: 1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_switch_metrics'
                - description: Switch metrics returned for the requested site or switch scope
                  examples:
                  - '{"active_ports_summary":{"details":{"active_port_count":4,"total_port_count":4},"score":100,"total_switch_count":2},"config_success":{"details":{"config_success_count":2},"score":100,"total_switch_count":2},"version_compliance":{"details":{"major_versions":[{"major_count":1,"major_version":"21.4R3.5","model":"EX2300-C-12P","system_names":[]},{"major_count":1,"major_version":"6.0.4-11","model":"SSR120","system_names":[]}]},"score":100,"total_switch_count":2}}'
                  - '{"active_ports_summary":{"details":{"active_port_count":1,"total_port_count":2},"score":50,"total_switch_count":1}}'
                contentMediaType: application/vnd.api+json
              examples:
                Site Scoped:
                  value:
                    active_ports_summary:
                      details:
                        active_port_count: 4
                        total_port_count: 4
                      score: 100
                      total_switch_count: 2
                    config_success:
                      details:
                        config_success_count: 2
                      score: 100
                      total_switch_count: 2
                    version_compliance:
                      details:
                        major_versions:
                        - major_count: 1
                          major_version: 21.4R3.5
                          model: EX2300-C-12P
                          system_names: []
                        - major_count: 1
                          major_version: 6.0.4-11
                          model: SSR120
                          system_names: []
                      score: 100
                      total_switch_count: 2
                Switch Scoped:
                  value:
                    active_ports_summary:
                      details:
                        active_port_count: 1
                        total_port_count: 2
                      score: 50
                      total_switch_count: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/mxedges:
    get:
      tags:
      - Sites Stats - MxEdges
      summary: listSiteMxEdgesStats
      description: List Mist Edge statistics for a site over the requested time range. Use [List Org Mist Edge Stats]($e/Orgs%20Stats%20-%20MxEdges/listOrgMxEdgesStats) to retrieve Mist Edge statistics across the organization.
      operationId: listSiteMxEdgesStats
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: List of MxEdge Stats
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/stats_mxedge'
                description: Mist Edge statistics records returned by a stats response
                examples:
                - - cpu_stat:
                      cpus:
                        cpu0:
                          idle: 89
                          interrupt: 0
                          system: 8
                          usage: 10
                          user: 1
                        cpu1:
                          idle: 81
                          interrupt: 0
                          system: 4
                          usage: 18
                          user: 13
                        cpu2:
                          idle: 81
                          interrupt: 0
                          system: 4
                          usage: 18
                          user: 13
                        cpu3:
                          idle: 2
                          interrupt: 0
                          system: 50
                          usage: 97
                          user: 46
                      idle: 62
                      interrupt: 0
                      system: 17
                      usage: 37
                      user: 19
                    created_time: 1632684398
                    for_site: false
                    id: 00000000-0000-0000-1000-020000a80cb4
                    ip_stat:
                      ip: 192.168.1.244
                      ips:
                        ens18: 192.168.1.244/24,fe80::104c:ffff:fee0:caf8/64
                      macs:
                        ens18: e4434b217044
                    lag_stat:
                      lacp0:
                        active_ports:
                        - port0
                        - port1
                    last_seen: 1633721215
                    mac: 020000a80cb4
                    memory_stat:
                      active: 394936320
                      available: 4699291648
                      buffers: 107646976
                      cached: 478060544
                      free: 4330659840
                      inactive: 211980288
                      swap_cached: 0
                      swap_free: 1022357504
                      swap_total: 1022357504
                      total: 8365957120
                      usage: 48
                    model: ME-VM
                    modified_time: 1633643629
                    mxagent_registered: true
                    mxcluster_id: 678bc339-7635-4556-bbc0-e77ad493ef8b
                    name: me-vm-1
                    num_tunnels: 0
                    oob_ip_config:
                      dns:
                      - 8.8.8.8
                      - 1.1.1.1
                      gateway: 10.0.0.1
                      ip: 10.0.0.10
                      netmask: 255.255.255.0
                      type: static
                    org_id: 11b08247-b1ee-4152-9b25-312b323ce480
                    port_stat:
                      port0:
                        full_duplex: true
                        mac: 9e294e49091d
                        rx_bytes: 646898375700
                        rx_errors: 0
                        rx_pkts: 8784449574
                        speed: 10000
                        state: forwarding
                        tx_bytes: 647200748038
                        tx_errors: 0
                        tx_pkts: 8788647466
                        up: true
                      port1:
                        full_duplex: true
                        mac: a270fe53437e
                        rx_bytes: 647200437652
                        rx_errors: 0
                        rx_pkts: 8788644886
                        speed: 10000
                        state: forwarding
                        tx_bytes: 646898681650
                        tx_errors: 0
                        tx_pkts: 8784452092
                        up: true
                    serial: string
                    service_stat:
                      mxagent:
                        ext_ip: 99.0.86.164
                        last_seen: 1633721215
                        package_state: Installed
                        package_version: 3.1.1037-1
                        running_state: Running
                        uptime: 21240
                      tunterm:
                        ext_ip: 99.0.86.164
                        last_seen: 1633721203
                        package_state: Installed
                        package_version: 0.1.2449+deb10
                        running_state: Running
                        uptime: 76261
                    services:
                    - tunterm
                    site_id: 00000000-0000-0000-0000-000000000000
                    status: connected
                    tunterm_ip_config:
                      gateway: 192.168.11.1
                      ip: 192.168.11.91
                      netmask: 255.255.255.0
                    tunterm_port_config:
                      downstream_ports:
                      - '0'
                      - '1'
                      separate_upstream_downstream: false
                      upstream_ports:
                      - '0'
                      - '1'
                    tunterm_registered: true
                    tunterm_stat:
                      monitoring_failed: false
                    uptime: 76281
                    virtualization_type: KVM
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - cpu_stat:
                      cpus:
                        cpu0:
                          idle: 89
                          interrupt: 0
                          system: 8
                          usage: 10
                          user: 1
                        cpu1:
                          idle: 81
                          interrupt: 0
                          system: 4
                          usage: 18
                          user: 13
                        cpu2:
                          idle: 81
                          interrupt: 0
                          system: 4
                          usage: 18
                          user: 13
                        cpu3:
                          idle: 2
                          interrupt: 0
                          system: 50
                          usage: 97
                          user: 46
                      idle: 62
                      interrupt: 0
                      system: 17
                      usage: 37
                      user: 19
                    created_time: 1632684398
                    for_site: false
                    id: 00000000-0000-0000-1000-020000a80cb4
                    ip_stat:
                      ip: 192.168.1.244
                      ips:
                        ens18: 192.168.1.244/24,fe80::104c:ffff:fee0:caf8/64
                      macs:
                        ens18: e4434b217044
                    lag_stat:
                      lacp0:
                        active_ports:
                        - port0
                        - port1
                    last_seen: 1633721215
                    mac: 020000a80cb4
                    memory_stat:
                      active: 394936320
                      available: 4699291648
                      buffers: 107646976
                      cached: 478060544
                      free: 4330659840
                      inactive: 211980288
                      swap_cached: 0
                      swap_free: 1022357504
                      swap_total: 1022357504
                      total: 8365957120
                      usage: 48
                    model: ME-VM
                    modified_time: 1633643629
                    mxagent_registered: true
                    mxcluster_id: 678bc339-7635-4556-bbc0-e77ad493ef8b
                    name: me-vm-1
                    num_tunnels: 0
                    oob_ip_config:
                      dns:
                      - 8.8.8.8
                      - 1.1.1.1
                      gateway: 10.0.0.1
                      ip: 10.0.0.10
                      netmask: 255.255.255.0
                      type: static
                    org_id: 11b08247-b1ee-4152-9b25-312b323ce480
                    port_stat:
                      port0:
                        full_duplex: true
                        mac: 9e294e49091d
                        rx_bytes: 646898375700
                        rx_errors: 0
                        rx_pkts: 8784449574
                        speed: 10000
                        state: forwarding
                        tx_bytes: 647200748038
                        tx_errors: 0
                        tx_pkts: 8788647466
                        up: true
                      port1:
                        full_duplex: true
                        mac: a270fe53437e
                        rx_bytes: 647200437652
                        rx_errors: 0
                        rx_pkts: 8788644886
                        speed: 10000
                        state: forwarding
                        tx_bytes: 646898681650
                        tx_errors: 0
                        tx_pkts: 8784452092
                        up: true
                    serial: string
                    service_stat:
                      mxagent:
                        ext_ip: 99.0.86.164
                        last_seen: 1633721215
                        package_state: Installed
                        package_version: 3.1.1037-1
                        running_state: Running
                        uptime: 21240
                      tunterm:
                        ext_ip: 99.0.86.164
                        last_seen: 1633721203
                        package_state: Installed
                        package_version: 0.1.2449+deb10
                        running_state: Running
                        uptime: 76261
                    services:
                    - tunterm
                    site_id: 00000000-0000-0000-0000-000000000000
                    status: connected
                    tunterm_ip_config:
                      gateway: 192.168.11.1
                      ip: 192.168.11.91
                      netmask: 255.255.255.0
                    tunterm_port_config:
                      downstream_ports:
                      - '0'
                      - '1'
                      separate_upstream_downstream: false
                      upstream_ports:
                      - '0'
                      - '1'
                    tunterm_registered: true
                    tunterm_stat:
                      monitoring_failed: false
                    uptime: 76281
                    virtualization_type: KVM
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/stats_mxedge'
                description: Mist Edge statistics records returned by a stats response
                examples:
                - - cpu_stat:
                      cpus:
                        cpu0:
                          idle: 89
                          interrupt: 0
                          system: 8
                          usage: 10
                          user: 1
                        cpu1:
                          idle: 81
                          interrupt: 0
                          system: 4
                          usage: 18
                          user: 13
                        cpu2:
                          idle: 81
                          interrupt: 0
                          system: 4
                          usage: 18
                          user: 13
                        cpu3:
                          idle: 2
                          interrupt: 0
                          system: 50
                          usage: 97
                          user: 46
                      idle: 62
                      interrupt: 0
                      system: 17
                      usage: 37
                      user: 19
                    created_time: 1632684398
                    for_site: false
                    id: 00000000-0000-0000-1000-020000a80cb4
                    ip_stat:
                      ip: 192.168.1.244
                      ips:
                        ens18: 192.168.1.244/24,fe80::104c:ffff:fee0:caf8/64
                      macs:
                        ens18: e4434b217044
                    lag_stat:
                      lacp0:
                        active_ports:
                        - port0
                        - port1
                    last_seen: 1633721215
                    mac: 020000a80cb4
                    memory_stat:
                      active: 394936320
                      available: 4699291648
                      buffers: 107646976
                      cached: 478060544
                      free: 4330659840
                      inactive: 211980288
                      swap_cached: 0
                      swap_free: 1022357504
                      swap_total: 1022357504
                      total: 8365957120
                      usage: 48
                    model: ME-VM
                    modified_time: 1633643629
                    mxagent_registered: true
                    mxcluster_id: 678bc339-7635-4556-bbc0-e77ad493ef8b
                    name: me-vm-1
                    num_tunnels: 0
                    oob_ip_config:
                      dns:
                      - 8.8.8.8
                      - 1.1.1.1
                      gateway: 10.0.0.1
                      ip: 10.0.0.10
                      netmask: 255.255.255.0
                      type: static
                    org_id: 11b08247-b1ee-4152-9b25-312b323ce480
                    port_stat:
                      port0:
                        full_duplex: true
                        mac: 9e294e49091d
                        rx_bytes: 646898375700
                        rx_errors: 0
                        rx_pkts: 8784449574
                        speed: 10000
                        state: forwarding
                        tx_bytes: 647200748038
                        tx_errors: 0
                        tx_pkts: 8788647466
                        up: true
                      port1:
                        full_duplex: true
                        mac: a270fe53437e
                        rx_bytes: 647200437652
                        rx_errors: 0
                        rx_pkts: 8788644886
                        speed: 10000
                        state: forwarding
                        tx_bytes: 646898681650
                        tx_errors: 0
                        tx_pkts: 8784452092
                        up: true
                    serial: string
                    service_stat:
                      mxagent:
                        ext_ip: 99.0.86.164
                        last_seen: 1633721215
                        package_state: Installed
                        package_version: 3.1.1037-1
                        running_state: Running
                        uptime: 21240
                      tunterm:
                        ext_ip: 99.0.86.164
                        last_seen: 1633721203
                        package_state: Installed
                        package_version: 0.1.2449+deb10
                        running_state: Running
                        uptime: 76261
                    services:
                    - tunterm
                    site_id: 00000000-0000-0000-0000-000000000000
                    status: connected
                    tunterm_ip_config:
                      gateway: 192.168.11.1
                      ip: 192.168.11.91
                      netmask: 255.255.255.0
                    tunterm_port_config:
                      downstream_ports:
                      - '0'
                      - '1'
                      separate_upstream_downstream: false
                      upstream_ports:
                      - '0'
                      - '1'
                    tunterm_registered: true
                    tunterm_stat:
                      monitoring_failed: false
                    uptime: 76281
                    virtualization_type: KVM
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - cpu_stat:
                      cpus:
                        cpu0:
                          idle: 89
                          interrupt: 0
                          system: 8
                          usage: 10
                          user: 1
                        cpu1:
                          idle: 81
                          interrupt: 0
                          system: 4
                          usage: 18
                          user: 13
                        cpu2:
                          idle: 81
                          interrupt: 0
                          system: 4
                          usage: 18
                          user: 13
                        cpu3:
                          idle: 2
                          interrupt: 0
                          system: 50
                          usage: 97
                          user: 46
                      idle: 62
                      interrupt: 0
                      system: 17
                      usage: 37
                      user: 19
                    created_time: 1632684398
                    for_site: false
                    id: 00000000-0000-0000-1000-020000a80cb4
                    ip_stat:
                      ip: 192.168.1.244
                      ips:
                        ens18: 192.168.1.244/24,fe80::104c:ffff:fee0:caf8/64
                      macs:
                        ens18: e4434b217044
                    lag_stat:
                      lacp0:
                        active_ports:
                        - port0
                        - port1
                    last_seen: 1633721215
                    mac: 020000a80cb4
                    memory_stat:
                      active: 394936320
                      available: 4699291648
                      buffers: 107646976
                      cached: 478060544
                      free: 4330659840
                      inactive: 211980288
                      swap_cached: 0
                      swap_free: 1022357504
                      swap_total: 1022357504
                      total: 8365957120
                      usage: 48
                    model: ME-VM
                    modified_time: 1633643629
                    mxagent_registered: true
                    mxcluster_id: 678bc339-7635-4556-bbc0-e77ad493ef8b
                    name: me-vm-1
                    num_tunnels: 0
                    oob_ip_config:
                      dns:
                      - 8.8.8.8
                      - 1.1.1.1
                      gateway: 10.0.0.1
                      ip: 10.0.0.10
                      netmask: 255.255.255.0
                      type: static
                    org_id: 11b08247-b1ee-4152-9b25-312b323ce480
                    port_stat:
                      port0:
                        full_duplex: true
                        mac: 9e294e49091d
                        rx_bytes: 646898375700
                        rx_errors: 0
                        rx_pkts: 8784449574
                        speed: 10000
                        state: forwarding
                        tx_bytes: 647200748038
                        tx_errors: 0
                        tx_pkts: 8788647466
                        up: true
                      port1:
                        full_duplex: true
                        mac: a270fe53437e
                        rx_bytes: 647200437652
                        rx_errors: 0
                        rx_pkts: 8788644886
                        speed: 10000
                        state: forwarding
                        tx_bytes: 646898681650
                        tx_errors: 0
                        tx_pkts: 8784452092
                        up: true
                    serial: string
                    service_stat:
                      mxagent:
                        ext_ip: 99.0.86.164
                        last_seen: 1633721215
                        package_state: Installed
                        package_version: 3.1.1037-1
                        running_state: Running
                        uptime: 21240
                      tunterm:
                        ext_ip: 99.0.86.164
                        last_seen: 1633721203
                        package_state: Installed
                        package_version: 0.1.2449+deb10
                        running_state: Running
                        uptime: 76261
                    services:
                    - tunterm
                    site_id: 00000000-0000-0000-0000-000000000000
                    status: connected
                    tunterm_ip_config:
                      gateway: 192.168.11.1
                      ip: 192.168.11.91
                      netmask: 255.255.255.0
                    tunterm_port_config:
                      downstream_ports:
                      - '0'
                      - '1'
                      separate_upstream_downstream: false
                      upstream_ports:
                      - '0'
                      - '1'
                    tunterm_registered: true
                    tunterm_stat:
                      monitoring_failed: false
                    uptime: 76281
                    virtualization_type: KVM
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/mxedges/{mxedge_id}:
    get:
      tags:
      - Sites Stats - MxEdges
      summary: getSiteMxEdgeStats
      description: Get One Site MxEdge Stats
      operationId: getSiteMxEdgeStats
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mxedge_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      responses:
        '200':
          description: MxEdge Stats
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/stats_mxedge'
                - description: Statistics for a Mist Edge appliance returned by stats endpoints
                  examples:
                  - cpu_stat:
                      cpus:
                        cpu0:
                          idle: 89
                          interrupt: 0
                          system: 8
                          usage: 10
                          user: 1
                        cpu1:
                          idle: 81
                          interrupt: 0
                          system: 4
                          usage: 18
                          user: 13
                        cpu2:
                          idle: 81
                          interrupt: 0
                          system: 4
                          usage: 18
                          user: 13
                        cpu3:
                          idle: 2
                          interrupt: 0
                          system: 50
                          usage: 97
                          user: 46
                      idle: 62
                      interrupt: 0
                      system: 17
                      usage: 37
                      user: 19
                    created_time: 1632684398
                    for_site: false
                    id: 00000000-0000-0000-1000-020000a80cb4
                    inactive_vlan_strs:
                      wired:
                      - '100'
                      - 102-106
                    ip_stat:
                      ip: 192.168.1.244
                      ips:
                        ens18: 192.168.1.244/24,fe80::104c:ffff:fee0:caf8/64
                      macs:
                        ens18: e4434b217044
                    lag_stat:
                      lacp0:
                        active_ports:
                        - port0
                        - port1
                    last_seen: 1633721215
                    mac: 020000a80cb4
                    memory_stat:
                      active: 394936320
                      available: 4699291648
                      buffers: 107646976
                      cached: 478060544
                      free: 4330659840
                      inactive: 211980288
                      swap_cached: 0
                      swap_free: 1022357504
                      swap_total: 1022357504
                      total: 8365957120
                      usage: 48
                    model: ME-VM
                    modified_time: 1633643629
                    mxagent_registered: true
                    mxcluster_id: 678bc339-7635-4556-bbc0-e77ad493ef8b
                    name: me-vm-1
                    num_tunnels: 0
                    oob_ip_config:
                      dns:
                      - 8.8.8.8
                      - 1.1.1.1
                      gateway: 10.0.0.1
                      ip: 10.0.0.10
                      netmask: 255.255.255.0
                      type: static
                    org_id: 11b08247-b1ee-4152-9b25-312b323ce480
                    port_stat:
                      port0:
                        full_duplex: true
                        mac: 9e294e49091d
                        rx_bytes: 646898375700
                        rx_errors: 0
                        rx_pkts: 8784449574
                        speed: 10000
                        state: forwarding
                        tx_bytes: 647200748038
                        tx_errors: 0
                        tx_pkts: 8788647466
                        up: true
                      port1:
                        full_duplex: true
                        mac: a270fe53437e
                        rx_bytes: 647200437652
                        rx_errors: 0
                        rx_pkts: 8788644886
                        speed: 10000
                        state: forwarding
                        tx_bytes: 646898681650
                        tx_errors: 0
                        tx_pkts: 8784452092
                        up: true
                    serial: string
                    service_stat:
                      mxagent:
                        ext_ip: 99.0.86.164
                        last_seen: 1633721215
                        package_state: Installed
                        package_version: 3.1.1037-1
                        running_state: Running
                        uptime: 21240
                      tunterm:
                        ext_ip: 99.0.86.164
                        last_seen: 1633721203
                        package_state: Installed
                        package_version: 0.1.2449+deb10
                        running_state: Running
                        uptime: 76261
                    services:
                    - tunterm
                    site_id: 00000000-0000-0000-0000-000000000000
                    status: connected
                    tunterm_ip_config:
                      gateway: 192.168.11.1
                      ip: 192.168.11.91
                      netmask: 255.255.255.0
                    tunterm_port_config:
                      downstream_ports:
                      - '0'
                      - '1'
                      separate_upstream_downstream: false
                      upstream_ports:
                      - '0'
                      - '1'
                    tunterm_registered: true
                    tunterm_stat:
                      monitoring_failed: false
                    uptime: 76281
                    virtualization_type: KVM
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    cpu_stat:
                      cpus:
                        cpu0:
                          idle: 89
                          interrupt: 0
                          system: 8
                          usage: 10
                          user: 1
                        cpu1:
                          idle: 81
                          interrupt: 0
                          system: 4
                          usage: 18
                          user: 13
                        cpu2:
                          idle: 81
                          interrupt: 0
                          system: 4
                          usage: 18
                          user: 13
                        cpu3:
                          idle: 2
                          interrupt: 0
                          system: 50
                          usage: 97
                          user: 46
                      idle: 62
                      interrupt: 0
                      system: 17
                      usage: 37
                      user: 19
                    created_time: 1632684398
                    for_site: false
                    id: 00000000-0000-0000-1000-020000a80cb4
                    inactive_vlan_strs:
                      wired:
                      - '100'
                      - 102-106
                    ip_stat:
                      ip: 192.168.1.244
                      ips:
                        ens18: 192.168.1.244/24,fe80::104c:ffff:fee0:caf8/64
                      macs:
                        ens18: e4434b217044
                    lag_stat:
                      lacp0:
                        active_ports:
                        - port0
                        - port1
                    last_seen: 1633721215
                    mac: 020000a80cb4
                    memory_stat:
                      active: 394936320
                      available: 4699291648
                      buffers: 107646976
                      cached: 478060544
                      free: 4330659840
                      inactive: 211980288
                      swap_cached: 0
                      swap_free: 1022357504
                      swap_total: 1022357504
                      total: 8365957120
                      usage: 48
                    model: ME-VM
                    modified_time: 1633643629
                    mxagent_registered: true
                    mxcluster_id: 678bc339-7635-4556-bbc0-e77ad493ef8b
                    name: me-vm-1
                    num_tunnels: 0
                    oob_ip_config:
                      dns:
                      - 8.8.8.8
                      - 1.1.1.1
                      gateway: 10.0.0.1
                      ip: 10.0.0.10
                      netmask: 255.255.255.0
                      type: static
                    org_id: 11b08247-b1ee-4152-9b25-312b323ce480
                    port_stat:
                      port0:
                        full_duplex: true
                        mac: 9e294e49091d
                        rx_bytes: 646898375700
                        rx_errors: 0
                        rx_pkts: 8784449574
                        speed: 10000
                        state: forwarding
                        tx_bytes: 647200748038
                        tx_errors: 0
                        tx_pkts: 8788647466
                        up: true
                      port1:
                        full_duplex: true
                        mac: a270fe53437e
                        rx_bytes: 647200437652
                        rx_errors: 0
                        rx_pkts: 8788644886
                        speed: 10000
                        state: forwarding
                        tx_bytes: 646898681650
                        tx_errors: 0
                        tx_pkts: 8784452092
                        up: true
                    serial: string
                    service_stat:
                      mxagent:
                        ext_ip: 99.0.86.164
                        last_seen: 1633721215
                        package_state: Installed
                        package_version: 3.1.1037-1
                        running_state: Running
                        uptime: 21240
                      tunterm:
                        ext_ip: 99.0.86.164
                        last_seen: 1633721203
                        package_state: Installed
                        package_version: 0.1.2449+deb10
                        running_state: Running
                        uptime: 76261
                    services:
                    - tunterm
                    site_id: 00000000-0000-0000-0000-000000000000
                    status: connected
                    tunterm_ip_config:
                      gateway: 192.168.11.1
                      ip: 192.168.11.91
                      netmask: 255.255.255.0
                    tunterm_port_config:
                      downstream_ports:
                      - '0'
                      - '1'
                      separate_upstream_downstream: false
                      upstream_ports:
                      - '0'
                      - '1'
                    tunterm_registered: true
                    tunterm_stat:
                      monitoring_failed: false
                    uptime: 76281
                    virtualization_type: KVM
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/stats_mxedge'
                - description: Statistics for a Mist Edge appliance returned by stats endpoints
                  examples:
                  - cpu_stat:
                      cpus:
                        cpu0:
                          idle: 89
                          interrupt: 0
                          system: 8
                          usage: 10
                          user: 1
                        cpu1:
                          idle: 81
                          interrupt: 0
                          system: 4
                          usage: 18
                          user: 13
                        cpu2:
                          idle: 81
                          interrupt: 0
                          system: 4
                          usage: 18
                          user: 13
                        cpu3:
                          idle: 2
                          interrupt: 0
                          system: 50
                          usage: 97
                          user: 46
                      idle: 62
                      interrupt: 0
                      system: 17
                      usage: 37
                      user: 19
                    created_time: 1632684398
                    for_site: false
                    id: 00000000-0000-0000-1000-020000a80cb4
                    inactive_vlan_strs:
                      wired:
                      - '100'
                      - 102-106
                    ip_stat:
                      ip: 192.168.1.244
                      ips:
                        ens18: 192.168.1.244/24,fe80::104c:ffff:fee0:caf8/64
                      macs:
                        ens18: e4434b217044
                    lag_stat:
                      lacp0:
                        active_ports:
                        - port0
                        - port1
                    last_seen: 1633721215
                    mac: 020000a80cb4
                    memory_stat:
                      active: 394936320
                      available: 4699291648
                      buffers: 107646976
                      cached: 478060544
                      free: 4330659840
                      inactive: 211980288
                      swap_cached: 0
                      swap_free: 1022357504
                      swap_total: 1022357504
                      total: 8365957120
                      usage: 48
                    model: ME-VM
                    modified_time: 1633643629
                    mxagent_registered: true
                    mxcluster_id: 678bc339-7635-4556-bbc0-e77ad493ef8b
                    name: me-vm-1
                    num_tunnels: 0
                    oob_ip_config:
                      dns:
                      - 8.8.8.8
                      - 1.1.1.1
                      gateway: 10.0.0.1
                      ip: 10.0.0.10
                      netmask: 255.255.255.0
                      type: static
                    org_id: 11b08247-b1ee-4152-9b25-312b323ce480
                    port_stat:
                      port0:
                        full_duplex: true
                        mac: 9e294e49091d
                        rx_bytes: 646898375700
                        rx_errors: 0
                        rx_pkts: 8784449574
                        speed: 10000
                        state: forwarding
                        tx_bytes: 647200748038
                        tx_errors: 0
                        tx_pkts: 8788647466
                        up: true
                      port1:
                        full_duplex: true
                        mac: a270fe53437e
                        rx_bytes: 647200437652
                        rx_errors: 0
                        rx_pkts: 8788644886
                        speed: 10000
                        state: forwarding
                        tx_bytes: 646898681650
                        tx_errors: 0
                        tx_pkts: 8784452092
                        up: true
                    serial: string
                    service_stat:
                      mxagent:
                        ext_ip: 99.0.86.164
                        last_seen: 1633721215
                        package_state: Installed
                        package_version: 3.1.1037-1
                        running_state: Running
                        uptime: 21240
                      tunterm:
                        ext_ip: 99.0.86.164
                        last_seen: 1633721203
                        package_state: Installed
                        package_version: 0.1.2449+deb10
                        running_state: Running
                        uptime: 76261
                    services:
                    - tunterm
                    site_id: 00000000-0000-0000-0000-000000000000
                    status: connected
                    tunterm_ip_config:
                      gateway: 192.168.11.1
                      ip: 192.168.11.91
                      netmask: 255.255.255.0
                    tunterm_port_config:
                      downstream_ports:
                      - '0'
                      - '1'
                      separate_upstream_downstream: false
                      upstream_ports:
                      - '0'
                      - '1'
                    tunterm_registered: true
                    tunterm_stat:
                      monitoring_failed: false
                    uptime: 76281
                    virtualization_type: KVM
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    cpu_stat:
                      cpus:
                        cpu0:
                          idle: 89
                          interrupt: 0
                          system: 8
                          usage: 10
                          user: 1
                        cpu1:
                          idle: 81
                          interrupt: 0
                          system: 4
                          usage: 18
                          user: 13
                        cpu2:
                          idle: 81
                          interrupt: 0
                          system: 4
                          usage: 18
                          user: 13
                        cpu3:
                          idle: 2
                          interrupt: 0
                          system: 50
                          usage: 97
                          user: 46
                      idle: 62
                      interrupt: 0
                      system: 17
                      usage: 37
                      user: 19
                    created_time: 1632684398
                    for_site: false
                    id: 00000000-0000-0000-1000-020000a80cb4
                    inactive_vlan_strs:
                      wired:
                      - '100'
                      - 102-106
                    ip_stat:
                      ip: 192.168.1.244
                      ips:
                        ens18: 192.168.1.244/24,fe80::104c:ffff:fee0:caf8/64
                      macs:
                        ens18: e4434b217044
                    lag_stat:
                      lacp0:
                        active_ports:
                        - port0
                        - port1
                    last_seen: 1633721215
                    mac: 020000a80cb4
                    memory_stat:
                      active: 394936320
                      available: 4699291648
                      buffers: 107646976
                      cached: 478060544
                      free: 4330659840
                      inactive: 211980288
                      swap_cached: 0
                      swap_free: 1022357504
                      swap_total: 1022357504
                      total: 8365957120
                      usage: 48
                    model: ME-VM
                    modified_time: 1633643629
                    mxagent_registered: true
                    mxcluster_id: 678bc339-7635-4556-bbc0-e77ad493ef8b
                    name: me-vm-1
                    num_tunnels: 0
                    oob_ip_config:
                      dns:
                      - 8.8.8.8
                      - 1.1.1.1
                      gateway: 10.0.0.1
                      ip: 10.0.0.10
                      netmask: 255.255.255.0
                      type: static
                    org_id: 11b08247-b1ee-4152-9b25-312b323ce480
                    port_stat:
                      port0:
                        full_duplex: true
                        mac: 9e294e49091d
                        rx_bytes: 646898375700
                        rx_errors: 0
                        rx_pkts: 8784449574
                        speed: 10000
                        state: forwarding
                        tx_bytes: 647200748038
                        tx_errors: 0
                        tx_pkts: 8788647466
                        up: true
                      port1:
                        full_duplex: true
                        mac: a270fe53437e
                        rx_bytes: 647200437652
                        rx_errors: 0
                        rx_pkts: 8788644886
                        speed: 10000
                        state: forwarding
                        tx_bytes: 646898681650
                        tx_errors: 0
                        tx_pkts: 8784452092
                        up: true
                    serial: string
                    service_stat:
                      mxagent:
                        ext_ip: 99.0.86.164
                        last_seen: 1633721215
                        package_state: Installed
                        package_version: 3.1.1037-1
                        running_state: Running
                        uptime: 21240
                      tunterm:
                        ext_ip: 99.0.86.164
                        last_seen: 1633721203
                        package_state: Installed
                        package_version: 0.1.2449+deb10
                        running_state: Running
                        uptime: 76261
                    services:
                    - tunterm
                    site_id: 00000000-0000-0000-0000-000000000000
                    status: connected
                    tunterm_ip_config:
                      gateway: 192.168.11.1
                      ip: 192.168.11.91
                      netmask: 255.255.255.0
                    tunterm_port_config:
                      downstream_ports:
                      - '0'
                      - '1'
                      separate_upstream_downstream: false
                      upstream_ports:
                      - '0'
                      - '1'
                    tunterm_registered: true
                    tunterm_stat:
                      monitoring_failed: false
                    uptime: 76281
                    virtualization_type: KVM
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/ospf_peers/count:
    get:
      tags:
      - Sites Stats - Ospf
      summary: countSiteOspfStats
      description: Count OSPF peer statistics for a site, optionally grouped by the `distinct` field and filtered by time range. Use [Count Org OSPF Stats]($e/Orgs%20Stats%20-%20Ospf/countOrgOspfStats) to count OSPF peer statistics across the organization.
      operationId: countSiteOspfStats
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `site_id`, `org_id`, `mac`, `peer_ip`, `port_id`, `state`, `vrf_name`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/ospf_peer_stats_count_distinct'
          - description: 'Field used to group this count response. enum: `site_id`, `org_id`, `mac`, `peer_ip`, `port_id`, `state`, `vrf_name`'
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/ospf_peers/search:
    get:
      tags:
      - Sites Stats - Ospf
      summary: searchSiteOspfStats
      description: Search OSPF peer statistics for a site with filters for device, VRF, peer IP, and time range. Use [Search Org OSPF Stats]($e/Orgs%20Stats%20-%20Ospf/searchOrgOspfStats) to search OSPF peer statistics across the organization.
      operationId: searchSiteOspfStats
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: vrf_name
        in: query
        description: Filter peer results by VRF name
        style: form
        explode: true
        schema:
          type: string
      - name: peer_ip
        in: query
        description: Filter peer results by peer IP address
        style: form
        explode: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ospf_peer_stats_search_result'
                - description: Paginated OSPF peer statistics search result
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ospf_peer_stats_search_result'
                - description: Paginated OSPF peer statistics search result
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/ports/count:
    get:
      tags:
      - Sites Stats - Ports
      summary: countSiteSwOrGwPorts
      description: Count switch and gateway port statistics for a site, optionally grouped by the `distinct` field and filtered by port, neighbor, PoE, STP, traffic, and time attributes. Use [Count Org Switch/Gateway Ports]($e/Orgs%20Stats%20-%20Ports/countOrgSwOrGwPorts) to count switch and gateway port statistics across the organization.
      operationId: countSiteSwOrGwPorts
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `full_duplex`, `mac`, `neighbor_mac`, `neighbor_port_desc`, `neighbor_system_name`, `poe_disabled`, `poe_mode`, `poe_on`, `port_id`, `port_mac`, `speed`, `up`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/site_ports_count_distinct'
          - description: 'Field used to group this count response. enum: `full_duplex`, `mac`, `neighbor_mac`, `neighbor_port_desc`, `neighbor_system_name`, `poe_disabled`, `poe_mode`, `poe_on`, `port_id`, `port_mac`, `speed`, `up`'
      - name: full_duplex
        in: query
        description: Indicates full or half duplex
        style: form
        explode: true
        schema:
          type: boolean
          examples:
          - true
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b350e0410
      - name: neighbor_mac
        in: query
        description: Chassis identifier of the chassis type listed
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b350e0410
      - name: neighbor_port_desc
        in: query
        description: Description supplied by the system on the interface E.g. "GigabitEthernet2/0/39"
        style: form
        explode: true
        schema:
          type: string
          examples:
          - ge-2/0/39
      - name: neighbor_system_name
        in: query
        description: Name supplied by the system on the interface E.g. neighbor system name E.g. "Kumar-Acc-SW.mist.local"
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Kumar-Acc-SW.mist.local
      - name: poe_disabled
        in: query
        description: Is the POE configured not be disabled.
        style: form
        explode: true
        schema:
          type: boolean
          examples:
          - false
      - name: poe_mode
        in: query
        description: POE mode depending on class E.g. "802.3at"
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 802.3at
      - name: poe_on
        in: query
        description: Is the device attached to POE
        style: form
        explode: true
        schema:
          type: boolean
          examples:
          - true
      - name: port_id
        in: query
        description: Filter results by port identifier
        style: form
        explode: true
        schema:
          type: string
          examples:
          - ge-2/0/39
      - name: port_mac
        in: query
        description: Filter results by port MAC address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b350e0410
      - name: power_draw
        in: query
        description: Amount of power being used by the interface at the time the command is executed. Unit in watts.
        style: form
        explode: true
        schema:
          type: number
          contentEncoding: double
          examples:
          - 15.4
      - name: tx_pkts
        in: query
        description: Filter results by transmitted packet count
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
          examples:
          - 1000000
      - name: rx_pkts
        in: query
        description: Filter results by received packet count
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
          examples:
          - 1000000
      - name: rx_bytes
        in: query
        description: Filter results by received byte count
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
          examples:
          - 1000000
      - name: tx_bps
        in: query
        description: Filter results by transmit rate
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
          examples:
          - 1000000
      - name: rx_bps
        in: query
        description: Filter results by receive rate
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
          examples:
          - 1000000
      - name: tx_mcast_pkts
        in: query
        description: Filter results by transmitted multicast packet count
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
          examples:
          - 1000000
      - name: tx_bcast_pkts
        in: query
        description: Filter results by transmitted broadcast packet count
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
          examples:
          - 1000000
      - name: rx_mcast_pkts
        in: query
        description: Filter results by received multicast packet count
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
          examples:
          - 1000000
      - name: rx_bcast_pkts
        in: query
        description: Filter results by received broadcast packet count
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
          examples:
          - 1000000
      - name: speed
        in: query
        description: Filter results by port speed
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
          examples:
          - 1000000000
      - name: stp_state
        in: query
        description: 'STP state used to filter port results when `up`==`true`. enum: `""`, `blocking`, `disabled`, `forwarding`, `learning`, `listening`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/port_stp_state'
          - description: 'STP state used to filter port results when `up`==`true`. enum: `""`, `blocking`, `disabled`, `forwarding`, `learning`, `listening`'
      - name: stp_role
        in: query
        description: 'STP role used to filter port results when `up`==`true`. enum: `""`, `alternate`, `backup`, `designated`, `disabled`, `root`, `root-prevented`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/port_stp_role'
          - description: 'STP role used to filter port results when `up`==`true`. enum: `""`, `alternate`, `backup`, `designated`, `disabled`, `root`, `root-prevented`'
      - name: auth_state
        in: query
        description: 'Authentication state used to filter port results when `up`==`true` and the port has an authenticator role. enum: `""`, `authenticated`, `authenticating`, `held`, `init`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/port_auth_state'
          - description: 'Authentication state used to filter port results when `up`==`true` and the port has an authenticator role. enum: `""`, `authenticated`, `authenticating`, `held`, `init`'
      - name: up
        in: query
        description: Indicates if interface is up
        style: form
        explode: true
        schema:
          type: boolean
          examples:
          - true
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/ports/search:
    get:
      tags:
      - Sites Stats - Ports
      summary: searchSiteSwOrGwPorts
      description: >-
        Search switch and gateway port statistics for a site.

        Returns ports that match the search criteria, including current or most recent port status and statistics within the hour.


        Traffic information (Tx/Rx) is reported as cumulative counters since the last device reboot. Use [Search Org Switch/Gateway Ports]($e/Orgs%20Stats%20-%20Ports/searchOrgSwOrGwPorts) to search switch and gateway port statistics across the organization.
      operationId: searchSiteSwOrGwPorts
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_type
        in: query
        description: 'Type of device. enum: `switch`, `gateway`, `all`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/search_org_sw_or_gw_ports_type'
          - description: 'Type of device. enum: `switch`, `gateway`, `all`'
      - name: auth_state
        in: query
        description: 'Authentication state used to filter port results when `up`==`true` and the port has an authenticator role. enum: `""`, `authenticated`, `authenticating`, `held`, `init`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/port_auth_state'
          - description: 'Authentication state used to filter port results when `up`==`true` and the port has an authenticator role. enum: `""`, `authenticated`, `authenticating`, `held`, `init`'
      - name: full_duplex
        in: query
        description: Indicates full or half duplex
        style: form
        explode: true
        schema:
          type: boolean
      - name: lte_imsi
        in: query
        description: LTE IMSI value, Check for null/empty
        style: form
        explode: true
        schema:
          type: string
          examples:
          - '310260000000001'
      - name: lte_iccid
        in: query
        description: LTE ICCID value, Check for null/empty
        style: form
        explode: true
        schema:
          type: string
          examples:
          - '89014103211118510720'
      - name: lte_imei
        in: query
        description: LTE IMEI value, Check for null/empty
        style: form
        explode: true
        schema:
          type: string
          examples:
          - '123456789012345'
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: neighbor_mac
        in: query
        description: Chassis identifier of the chassis type listed
        style: form
        explode: true
        schema:
          type: string
      - name: neighbor_port_desc
        in: query
        description: Description supplied by the system on the interface E.g. "GigabitEthernet2/0/39"
        style: form
        explode: true
        schema:
          type: string
      - name: neighbor_system_name
        in: query
        description: Name supplied by the system on the interface E.g. neighbor system name E.g. "Kumar-Acc-SW.mist.local"
        style: form
        explode: true
        schema:
          type: string
      - name: poe_disabled
        in: query
        description: Is the POE configured not be disabled.
        style: form
        explode: true
        schema:
          type: boolean
      - name: poe_mode
        in: query
        description: POE mode depending on class E.g. "802.3at"
        style: form
        explode: true
        schema:
          type: string
      - name: poe_on
        in: query
        description: Is the device attached to POE
        style: form
        explode: true
        schema:
          type: boolean
      - name: poe_priority
        in: query
        description: 'PoE priority used to filter switch port results. enum: `low`, `high`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/poe_priority'
          - description: 'PoE priority used to filter switch port results. enum: `low`, `high`'
      - name: port_id
        in: query
        description: Filter results by port identifier
        style: form
        explode: true
        schema:
          type: string
      - name: port_mac
        in: query
        description: Filter results by port MAC address
        style: form
        explode: true
        schema:
          type: string
      - name: speed
        in: query
        description: Filter results by port speed
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: stp_state
        in: query
        description: 'STP state used to filter port results when `up`==`true`. enum: `""`, `blocking`, `disabled`, `forwarding`, `learning`, `listening`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/port_stp_state'
          - description: 'STP state used to filter port results when `up`==`true`. enum: `""`, `blocking`, `disabled`, `forwarding`, `learning`, `listening`'
      - name: stp_role
        in: query
        description: 'STP role used to filter port results when `up`==`true`. enum: `""`, `alternate`, `backup`, `designated`, `disabled`, `root`, `root-prevented`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/port_stp_role'
          - description: 'STP role used to filter port results when `up`==`true`. enum: `""`, `alternate`, `backup`, `designated`, `disabled`, `root`, `root-prevented`'
      - name: up
        in: query
        description: Indicates if interface is up
        style: form
        explode: true
        schema:
          type: boolean
      - name: xcvr_part_number
        in: query
        description: Optic Slot Partnumber, Check for null/empty
        style: form
        explode: true
        schema:
          type: string
          examples:
          - SFP-10G-SR
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: List of Switch Ports Stats
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_switch_port_search'
                - description: Paginated response for switch and gateway port statistics search results
                  examples:
                  - end: 1513177200
                    limit: 10
                    results:
                    - active: true
                      auth_state: init
                      for_site: true
                      full_duplex: true
                      jitter: 0
                      latency: 0
                      loss: 0
                      lte_iccid: string
                      lte_imei: string
                      lte_imsi: string
                      mac: 5c4527a96580
                      mac_count: 0
                      mac_limit: 0
                      neighbor_mac: 64d814353400
                      neighbor_port_desc: GigabitEthernet1/0/21
                      neighbor_system_name: CORP-D-SW-2
                      org_id: c168ddee-c14c-11e5-8e81-1258369c38a9
                      poe_disabled: true
                      poe_mode: 802.3af
                      poe_on: true
                      port_id: ge-0/0/0
                      port_mac: 5c4527a96580
                      port_usage: lan
                      power_draw: 0
                      rx_bcast_pkts: 0
                      rx_bps: 0
                      rx_bytes: 4563443626
                      rx_errors: 0
                      rx_mcast_pkts: 0
                      rx_pkts: 0
                      site_id: c1698122-c14c-11e5-8e81-1258369c38a9
                      speed: 1000
                      stp_role: designated
                      stp_state: forwarding
                      tx_bcast_pkts: 0
                      tx_bps: 0
                      tx_bytes: 11299516780
                      tx_errors: 0
                      tx_mcast_pkts: 0
                      tx_pkts: 492176
                      type: gateway
                      up: true
                      xcvr_part_number: string
                    start: 1511967600
                    total: 100
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1513177200
                    limit: 10
                    results:
                    - active: true
                      auth_state: init
                      for_site: true
                      full_duplex: true
                      jitter: 0
                      latency: 0
                      loss: 0
                      lte_iccid: string
                      lte_imei: string
                      lte_imsi: string
                      mac: 5c4527a96580
                      mac_count: 0
                      mac_limit: 0
                      neighbor_mac: 64d814353400
                      neighbor_port_desc: GigabitEthernet1/0/21
                      neighbor_system_name: CORP-D-SW-2
                      org_id: c168ddee-c14c-11e5-8e81-1258369c38a9
                      poe_disabled: true
                      poe_mode: 802.3af
                      poe_on: true
                      port_id: ge-0/0/0
                      port_mac: 5c4527a96580
                      port_usage: lan
                      power_draw: 0
                      rx_bcast_pkts: 0
                      rx_bps: 0
                      rx_bytes: 4563443626
                      rx_errors: 0
                      rx_mcast_pkts: 0
                      rx_pkts: 0
                      site_id: c1698122-c14c-11e5-8e81-1258369c38a9
                      speed: 1000
                      stp_role: designated
                      stp_state: forwarding
                      tx_bcast_pkts: 0
                      tx_bps: 0
                      tx_bytes: 11299516780
                      tx_errors: 0
                      tx_mcast_pkts: 0
                      tx_pkts: 492176
                      type: gateway
                      up: true
                      xcvr_part_number: string
                    start: 1511967600
                    total: 100
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_switch_port_search'
                - description: Paginated response for switch and gateway port statistics search results
                  examples:
                  - end: 1513177200
                    limit: 10
                    results:
                    - active: true
                      auth_state: init
                      for_site: true
                      full_duplex: true
                      jitter: 0
                      latency: 0
                      loss: 0
                      lte_iccid: string
                      lte_imei: string
                      lte_imsi: string
                      mac: 5c4527a96580
                      mac_count: 0
                      mac_limit: 0
                      neighbor_mac: 64d814353400
                      neighbor_port_desc: GigabitEthernet1/0/21
                      neighbor_system_name: CORP-D-SW-2
                      org_id: c168ddee-c14c-11e5-8e81-1258369c38a9
                      poe_disabled: true
                      poe_mode: 802.3af
                      poe_on: true
                      port_id: ge-0/0/0
                      port_mac: 5c4527a96580
                      port_usage: lan
                      power_draw: 0
                      rx_bcast_pkts: 0
                      rx_bps: 0
                      rx_bytes: 4563443626
                      rx_errors: 0
                      rx_mcast_pkts: 0
                      rx_pkts: 0
                      site_id: c1698122-c14c-11e5-8e81-1258369c38a9
                      speed: 1000
                      stp_role: designated
                      stp_state: forwarding
                      tx_bcast_pkts: 0
                      tx_bps: 0
                      tx_bytes: 11299516780
                      tx_errors: 0
                      tx_mcast_pkts: 0
                      tx_pkts: 492176
                      type: gateway
                      up: true
                      xcvr_part_number: string
                    start: 1511967600
                    total: 100
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1513177200
                    limit: 10
                    results:
                    - active: true
                      auth_state: init
                      for_site: true
                      full_duplex: true
                      jitter: 0
                      latency: 0
                      loss: 0
                      lte_iccid: string
                      lte_imei: string
                      lte_imsi: string
                      mac: 5c4527a96580
                      mac_count: 0
                      mac_limit: 0
                      neighbor_mac: 64d814353400
                      neighbor_port_desc: GigabitEthernet1/0/21
                      neighbor_system_name: CORP-D-SW-2
                      org_id: c168ddee-c14c-11e5-8e81-1258369c38a9
                      poe_disabled: true
                      poe_mode: 802.3af
                      poe_on: true
                      port_id: ge-0/0/0
                      port_mac: 5c4527a96580
                      port_usage: lan
                      power_draw: 0
                      rx_bcast_pkts: 0
                      rx_bps: 0
                      rx_bytes: 4563443626
                      rx_errors: 0
                      rx_mcast_pkts: 0
                      rx_pkts: 0
                      site_id: c1698122-c14c-11e5-8e81-1258369c38a9
                      speed: 1000
                      stp_role: designated
                      stp_state: forwarding
                      tx_bcast_pkts: 0
                      tx_bps: 0
                      tx_bytes: 11299516780
                      tx_errors: 0
                      tx_mcast_pkts: 0
                      tx_pkts: 492176
                      type: gateway
                      up: true
                      xcvr_part_number: string
                    start: 1511967600
                    total: 100
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/wxrules:
    get:
      tags:
      - Sites Stats - WxRules
      summary: getSiteWxRulesUsage
      description: Get Wxlan Rule usage
      operationId: getSiteWxRulesUsage
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: WxRule Stats
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/stats_wxrule'
                description: WxLAN rule usage statistics returned by the request
                examples:
                - - action: allow
                    client_mac:
                    - 3bbbf819bb6f
                    - bd96cbc4910f
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_wxtags:
                    - d4134466-eec0-3756-6765-381c728a6037
                    - 1a42c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    name: Guest
                    order: 1
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
                    usage:
                      1a42c7b0-d1d0-5a30-f349-e35fa43dc3b3:
                        num_flows: 60
                      d4134466-eec0-3756-6765-381c728a6037:
                        num_flows: 60
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - action: allow
                    client_mac:
                    - 3bbbf819bb6f
                    - bd96cbc4910f
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_wxtags:
                    - d4134466-eec0-3756-6765-381c728a6037
                    - 1a42c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    name: Guest
                    order: 1
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
                    usage:
                      1a42c7b0-d1d0-5a30-f349-e35fa43dc3b3:
                        num_flows: 60
                      d4134466-eec0-3756-6765-381c728a6037:
                        num_flows: 60
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/stats_wxrule'
                description: WxLAN rule usage statistics returned by the request
                examples:
                - - action: allow
                    client_mac:
                    - 3bbbf819bb6f
                    - bd96cbc4910f
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_wxtags:
                    - d4134466-eec0-3756-6765-381c728a6037
                    - 1a42c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    name: Guest
                    order: 1
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
                    usage:
                      1a42c7b0-d1d0-5a30-f349-e35fa43dc3b3:
                        num_flows: 60
                      d4134466-eec0-3756-6765-381c728a6037:
                        num_flows: 60
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - action: allow
                    client_mac:
                    - 3bbbf819bb6f
                    - bd96cbc4910f
                    dst_allow_wxtags:
                    - fff34466-eec0-3756-6765-381c728a6037
                    - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_deny_wxtags:
                    - aaa34466-eec0-3756-6765-381c728a6037
                    - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    dst_wxtags:
                    - d4134466-eec0-3756-6765-381c728a6037
                    - 1a42c7b0-d1d0-5a30-f349-e35fa43dc3b3
                    name: Guest
                    order: 1
                    src_wxtags:
                    - 8bfc2490-d726-3587-038d-cb2e71bd2330
                    - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
                    usage:
                      1a42c7b0-d1d0-5a30-f349-e35fa43dc3b3:
                        num_flows: 60
                      d4134466-eec0-3756-6765-381c728a6037:
                        num_flows: 60
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/rssizones:
    get:
      tags:
      - Sites Stats - Zones
      summary: listSiteRssiZonesStats
      description: Get List of Site RSSI Zones Stats
      operationId: listSiteRssiZonesStats
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/stats_rssi_zone'
                description: RSSI-based zone statistics returned by the request
                examples:
                - - assets_wait:
                      avg: 0
                      max: 0
                      min: 0
                      p95: 0
                    clients_wait:
                      avg: 39259.333333333336
                      max: 58361
                      min: 12376
                      p95: 58361
                    created_time: 1733864928
                    devices:
                    - device_id: 00000000-0000-0000-1000-c8786708bb5d
                      rssi: -70
                    discovered_assets_wait:
                      avg: 0
                      max: 0
                      min: 0
                      p95: 0
                    id: 17ef7169-e000-4dcd-abc7-f721f0a8ffda
                    modified_time: 1733864928
                    name: proximity openspace
                    num_assets: 0
                    num_clients: 3
                    num_discovered_assets: 0
                    num_sdkclients: 0
                    num_unconnected_clients: 7
                    org_id: c5fbc9e4-12bf-436e-98c4-1c842c66ab6c
                    sdkclients_wait:
                      avg: 0
                      max: 0
                      min: 0
                      p95: 0
                    site_id: 079fafd3-ef5c-4b23-90f0-9fcebec0023a
                    unconnected_clients_wait:
                      avg: 37552.857142857145
                      max: 68342
                      min: 6649
                      p95: 68342
                contentMediaType: application/json
              examples:
                Example-1:
                  value:
                  - assets_wait:
                      avg: 0
                      max: 0
                      min: 0
                      p95: 0
                    clients_wait:
                      avg: 39259.333333333336
                      max: 58361
                      min: 12376
                      p95: 58361
                    created_time: 1733864928
                    devices:
                    - device_id: 00000000-0000-0000-1000-c8786708bb5d
                      rssi: -70
                    discovered_assets_wait:
                      avg: 0
                      max: 0
                      min: 0
                      p95: 0
                    id: 17ef7169-e000-4dcd-abc7-f721f0a8ffda
                    modified_time: 1733864928
                    name: proximity openspace
                    num_assets: 0
                    num_clients: 3
                    num_discovered_assets: 0
                    num_sdkclients: 0
                    num_unconnected_clients: 7
                    org_id: c5fbc9e4-12bf-436e-98c4-1c842c66ab6c
                    sdkclients_wait:
                      avg: 0
                      max: 0
                      min: 0
                      p95: 0
                    site_id: 079fafd3-ef5c-4b23-90f0-9fcebec0023a
                    unconnected_clients_wait:
                      avg: 37552.857142857145
                      max: 68342
                      min: 6649
                      p95: 68342
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/stats_rssi_zone'
                description: RSSI-based zone statistics returned by the request
                examples:
                - - assets_wait:
                      avg: 0
                      max: 0
                      min: 0
                      p95: 0
                    clients_wait:
                      avg: 39259.333333333336
                      max: 58361
                      min: 12376
                      p95: 58361
                    created_time: 1733864928
                    devices:
                    - device_id: 00000000-0000-0000-1000-c8786708bb5d
                      rssi: -70
                    discovered_assets_wait:
                      avg: 0
                      max: 0
                      min: 0
                      p95: 0
                    id: 17ef7169-e000-4dcd-abc7-f721f0a8ffda
                    modified_time: 1733864928
                    name: proximity openspace
                    num_assets: 0
                    num_clients: 3
                    num_discovered_assets: 0
                    num_sdkclients: 0
                    num_unconnected_clients: 7
                    org_id: c5fbc9e4-12bf-436e-98c4-1c842c66ab6c
                    sdkclients_wait:
                      avg: 0
                      max: 0
                      min: 0
                      p95: 0
                    site_id: 079fafd3-ef5c-4b23-90f0-9fcebec0023a
                    unconnected_clients_wait:
                      avg: 37552.857142857145
                      max: 68342
                      min: 6649
                      p95: 68342
                contentMediaType: application/vnd.api+json
              examples:
                Example-1:
                  value:
                  - assets_wait:
                      avg: 0
                      max: 0
                      min: 0
                      p95: 0
                    clients_wait:
                      avg: 39259.333333333336
                      max: 58361
                      min: 12376
                      p95: 58361
                    created_time: 1733864928
                    devices:
                    - device_id: 00000000-0000-0000-1000-c8786708bb5d
                      rssi: -70
                    discovered_assets_wait:
                      avg: 0
                      max: 0
                      min: 0
                      p95: 0
                    id: 17ef7169-e000-4dcd-abc7-f721f0a8ffda
                    modified_time: 1733864928
                    name: proximity openspace
                    num_assets: 0
                    num_clients: 3
                    num_discovered_assets: 0
                    num_sdkclients: 0
                    num_unconnected_clients: 7
                    org_id: c5fbc9e4-12bf-436e-98c4-1c842c66ab6c
                    sdkclients_wait:
                      avg: 0
                      max: 0
                      min: 0
                      p95: 0
                    site_id: 079fafd3-ef5c-4b23-90f0-9fcebec0023a
                    unconnected_clients_wait:
                      avg: 37552.857142857145
                      max: 68342
                      min: 6649
                      p95: 68342
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/rssizones/{zone_id}:
    get:
      tags:
      - Sites Stats - Zones
      summary: getSiteRssiZoneStats
      description: Get Detail RSSI Zone Stats
      operationId: getSiteRssiZoneStats
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: zone_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Zone Stats
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/stats_zone_details'
                - description: Detailed zone statistics and occupants for a site map zone
                  examples:
                  - assets:
                    - df8dff06ae90
                    client_waits:
                      avg: 1200
                      max: 3610
                      min: 600
                      p95: 2800
                    clients:
                    - 5684dae9ac8b
                    id: 8ac84899-32db-6327-334c-9b6d58544cfe
                    map_id: 63eda950-c6da-11e4-a628-60f81dd250cc
                    name: Board Room
                    num_clients: 80
                    num_sdkclients: 0
                    sdkclients:
                    - 7e2b463d-c91c-ff7d-f3c0-6eccc6949ff8
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    assets:
                    - df8dff06ae90
                    client_waits:
                      avg: 1200
                      max: 3610
                      min: 600
                      p95: 2800
                    clients:
                    - 5684dae9ac8b
                    id: 8ac84899-32db-6327-334c-9b6d58544cfe
                    map_id: 63eda950-c6da-11e4-a628-60f81dd250cc
                    name: Board Room
                    num_clients: 80
                    num_sdkclients: 0
                    sdkclients:
                    - 7e2b463d-c91c-ff7d-f3c0-6eccc6949ff8
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/stats_zone_details'
                - description: Detailed zone statistics and occupants for a site map zone
                  examples:
                  - assets:
                    - df8dff06ae90
                    client_waits:
                      avg: 1200
                      max: 3610
                      min: 600
                      p95: 2800
                    clients:
                    - 5684dae9ac8b
                    id: 8ac84899-32db-6327-334c-9b6d58544cfe
                    map_id: 63eda950-c6da-11e4-a628-60f81dd250cc
                    name: Board Room
                    num_clients: 80
                    num_sdkclients: 0
                    sdkclients:
                    - 7e2b463d-c91c-ff7d-f3c0-6eccc6949ff8
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    assets:
                    - df8dff06ae90
                    client_waits:
                      avg: 1200
                      max: 3610
                      min: 600
                      p95: 2800
                    clients:
                    - 5684dae9ac8b
                    id: 8ac84899-32db-6327-334c-9b6d58544cfe
                    map_id: 63eda950-c6da-11e4-a628-60f81dd250cc
                    name: Board Room
                    num_clients: 80
                    num_sdkclients: 0
                    sdkclients:
                    - 7e2b463d-c91c-ff7d-f3c0-6eccc6949ff8
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/zones:
    get:
      tags:
      - Sites Stats - Zones
      summary: listSiteZonesStats
      description: Get List of Site Zones Stats
      operationId: listSiteZonesStats
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: map_id
        in: query
        description: Filter results by map identifier
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 00000000-0000-0000-0000-000000000000
      - name: min_duration
        in: query
        description: Filter results by minimum duration
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
          examples:
          - 120
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/stats_zone'
                description: Zone statistics records returned by a stats response
                examples:
                - '[{"assets_wait":{"avg":0,"max":0,"min":0,"p95":0},"clients_wait":{"avg":1200,"max":3610,"min":600,"p95":2800},"created_time":1616625211,"id":"123470c7-5d9d-424a-8475-8b344c621234","map_id":"123449d4-d12f-4feb-b40f-5be0e2ae1234","modified_time":1616625211,"name":"Zone A","num_assets":0,"num_clients":80,"num_sdkclients":10,"occupancy_limit":4,"org_id":"1234c1a0-6ef6-11e6-8bbf-02e208b21234","sdkclients_wait":{"avg":1200,"max":3610,"min":600,"p95":2800},"site_id":"123448e6-6ef6-11e6-8bbf-02e208b21234","vertices":[{"x":732,"y":1821},{"x":732.5,"y":1731},{"x":837.5,"y":1731.5},{"x":839,"y":1821}],"vertices_m":[{"x":24.1983341951072,"y":60.198314985369144},{"x":24.21486311190714,"y":57.22310996138056},{"x":27.685935639893827,"y":57.23963887818049},{"x":27.73552239029364,"y":60.198314985369144}]}]'
                - '[{"created_time":1616625211,"id":"123470c7-5d9d-424a-8475-8b344c621234","map_id":"123449d4-d12f-4feb-b40f-5be0e2ae1234","modified_time":1616625211,"name":"Zone A","occupancy_limit":4,"org_id":"1234c1a0-6ef6-11e6-8bbf-02e208b21234","site_id":"123448e6-6ef6-11e6-8bbf-02e208b21234","vertices":[{"x":732,"y":1821},{"x":732.5,"y":1731},{"x":837.5,"y":1731.5},{"x":839,"y":1821}],"vertices_m":[{"x":24.1983341951072,"y":60.198314985369144},{"x":24.21486311190714,"y":57.22310996138056},{"x":27.685935639893827,"y":57.23963887818049},{"x":27.73552239029364,"y":60.198314985369144}]}]'
                contentMediaType: application/json
              examples:
                Example-1:
                  value:
                  - assets_wait:
                      avg: 0
                      max: 0
                      min: 0
                      p95: 0
                    clients_wait:
                      avg: 1200
                      max: 3610
                      min: 600
                      p95: 2800
                    created_time: 1616625211
                    id: 123470c7-5d9d-424a-8475-8b344c621234
                    map_id: 123449d4-d12f-4feb-b40f-5be0e2ae1234
                    modified_time: 1616625211
                    name: Zone A
                    num_assets: 0
                    num_clients: 80
                    num_sdkclients: 10
                    occupancy_limit: 4
                    org_id: 1234c1a0-6ef6-11e6-8bbf-02e208b21234
                    sdkclients_wait:
                      avg: 1200
                      max: 3610
                      min: 600
                      p95: 2800
                    site_id: 123448e6-6ef6-11e6-8bbf-02e208b21234
                    vertices:
                    - x: 732
                      y: 1821
                    - x: 732.5
                      y: 1731
                    - x: 837.5
                      y: 1731.5
                    - x: 839
                      y: 1821
                    vertices_m:
                    - x: 24.1983341951072
                      y: 60.198314985369144
                    - x: 24.21486311190714
                      y: 57.22310996138056
                    - x: 27.685935639893827
                      y: 57.23963887818049
                    - x: 27.73552239029364
                      y: 60.198314985369144
                without-map_id-query-param:
                  value:
                  - created_time: 1616625211
                    id: 123470c7-5d9d-424a-8475-8b344c621234
                    map_id: 123449d4-d12f-4feb-b40f-5be0e2ae1234
                    modified_time: 1616625211
                    name: Zone A
                    occupancy_limit: 4
                    org_id: 1234c1a0-6ef6-11e6-8bbf-02e208b21234
                    site_id: 123448e6-6ef6-11e6-8bbf-02e208b21234
                    vertices:
                    - x: 732
                      y: 1821
                    - x: 732.5
                      y: 1731
                    - x: 837.5
                      y: 1731.5
                    - x: 839
                      y: 1821
                    vertices_m:
                    - x: 24.1983341951072
                      y: 60.198314985369144
                    - x: 24.21486311190714
                      y: 57.22310996138056
                    - x: 27.685935639893827
                      y: 57.23963887818049
                    - x: 27.73552239029364
                      y: 60.198314985369144
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/stats_zone'
                description: Zone statistics records returned by a stats response
                examples:
                - '[{"assets_wait":{"avg":0,"max":0,"min":0,"p95":0},"clients_wait":{"avg":1200,"max":3610,"min":600,"p95":2800},"created_time":1616625211,"id":"123470c7-5d9d-424a-8475-8b344c621234","map_id":"123449d4-d12f-4feb-b40f-5be0e2ae1234","modified_time":1616625211,"name":"Zone A","num_assets":0,"num_clients":80,"num_sdkclients":10,"occupancy_limit":4,"org_id":"1234c1a0-6ef6-11e6-8bbf-02e208b21234","sdkclients_wait":{"avg":1200,"max":3610,"min":600,"p95":2800},"site_id":"123448e6-6ef6-11e6-8bbf-02e208b21234","vertices":[{"x":732,"y":1821},{"x":732.5,"y":1731},{"x":837.5,"y":1731.5},{"x":839,"y":1821}],"vertices_m":[{"x":24.1983341951072,"y":60.198314985369144},{"x":24.21486311190714,"y":57.22310996138056},{"x":27.685935639893827,"y":57.23963887818049},{"x":27.73552239029364,"y":60.198314985369144}]}]'
                - '[{"created_time":1616625211,"id":"123470c7-5d9d-424a-8475-8b344c621234","map_id":"123449d4-d12f-4feb-b40f-5be0e2ae1234","modified_time":1616625211,"name":"Zone A","occupancy_limit":4,"org_id":"1234c1a0-6ef6-11e6-8bbf-02e208b21234","site_id":"123448e6-6ef6-11e6-8bbf-02e208b21234","vertices":[{"x":732,"y":1821},{"x":732.5,"y":1731},{"x":837.5,"y":1731.5},{"x":839,"y":1821}],"vertices_m":[{"x":24.1983341951072,"y":60.198314985369144},{"x":24.21486311190714,"y":57.22310996138056},{"x":27.685935639893827,"y":57.23963887818049},{"x":27.73552239029364,"y":60.198314985369144}]}]'
                contentMediaType: application/vnd.api+json
              examples:
                Example-1:
                  value:
                  - assets_wait:
                      avg: 0
                      max: 0
                      min: 0
                      p95: 0
                    clients_wait:
                      avg: 1200
                      max: 3610
                      min: 600
                      p95: 2800
                    created_time: 1616625211
                    id: 123470c7-5d9d-424a-8475-8b344c621234
                    map_id: 123449d4-d12f-4feb-b40f-5be0e2ae1234
                    modified_time: 1616625211
                    name: Zone A
                    num_assets: 0
                    num_clients: 80
                    num_sdkclients: 10
                    occupancy_limit: 4
                    org_id: 1234c1a0-6ef6-11e6-8bbf-02e208b21234
                    sdkclients_wait:
                      avg: 1200
                      max: 3610
                      min: 600
                      p95: 2800
                    site_id: 123448e6-6ef6-11e6-8bbf-02e208b21234
                    vertices:
                    - x: 732
                      y: 1821
                    - x: 732.5
                      y: 1731
                    - x: 837.5
                      y: 1731.5
                    - x: 839
                      y: 1821
                    vertices_m:
                    - x: 24.1983341951072
                      y: 60.198314985369144
                    - x: 24.21486311190714
                      y: 57.22310996138056
                    - x: 27.685935639893827
                      y: 57.23963887818049
                    - x: 27.73552239029364
                      y: 60.198314985369144
                without-map_id-query-param:
                  value:
                  - created_time: 1616625211
                    id: 123470c7-5d9d-424a-8475-8b344c621234
                    map_id: 123449d4-d12f-4feb-b40f-5be0e2ae1234
                    modified_time: 1616625211
                    name: Zone A
                    occupancy_limit: 4
                    org_id: 1234c1a0-6ef6-11e6-8bbf-02e208b21234
                    site_id: 123448e6-6ef6-11e6-8bbf-02e208b21234
                    vertices:
                    - x: 732
                      y: 1821
                    - x: 732.5
                      y: 1731
                    - x: 837.5
                      y: 1731.5
                    - x: 839
                      y: 1821
                    vertices_m:
                    - x: 24.1983341951072
                      y: 60.198314985369144
                    - x: 24.21486311190714
                      y: 57.22310996138056
                    - x: 27.685935639893827
                      y: 57.23963887818049
                    - x: 27.73552239029364
                      y: 60.198314985369144
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/zones/{zone_id}:
    get:
      tags:
      - Sites Stats - Zones
      summary: getSiteZoneStats
      description: Get Detail Zone Stats
      operationId: getSiteZoneStats
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: zone_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Zone Stats
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/stats_zone_details'
                - description: Detailed zone statistics and occupants for a site map zone
                  examples:
                  - assets:
                    - df8dff06ae90
                    client_waits:
                      avg: 1200
                      max: 3610
                      min: 600
                      p95: 2800
                    clients:
                    - 5684dae9ac8b
                    id: 8ac84899-32db-6327-334c-9b6d58544cfe
                    map_id: 63eda950-c6da-11e4-a628-60f81dd250cc
                    name: Board Room
                    num_clients: 80
                    num_sdkclients: 0
                    sdkclients:
                    - 7e2b463d-c91c-ff7d-f3c0-6eccc6949ff8
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    assets:
                    - df8dff06ae90
                    client_waits:
                      avg: 1200
                      max: 3610
                      min: 600
                      p95: 2800
                    clients:
                    - 5684dae9ac8b
                    id: 8ac84899-32db-6327-334c-9b6d58544cfe
                    map_id: 63eda950-c6da-11e4-a628-60f81dd250cc
                    name: Board Room
                    num_clients: 80
                    num_sdkclients: 0
                    sdkclients:
                    - 7e2b463d-c91c-ff7d-f3c0-6eccc6949ff8
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/stats_zone_details'
                - description: Detailed zone statistics and occupants for a site map zone
                  examples:
                  - assets:
                    - df8dff06ae90
                    client_waits:
                      avg: 1200
                      max: 3610
                      min: 600
                      p95: 2800
                    clients:
                    - 5684dae9ac8b
                    id: 8ac84899-32db-6327-334c-9b6d58544cfe
                    map_id: 63eda950-c6da-11e4-a628-60f81dd250cc
                    name: Board Room
                    num_clients: 80
                    num_sdkclients: 0
                    sdkclients:
                    - 7e2b463d-c91c-ff7d-f3c0-6eccc6949ff8
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    assets:
                    - df8dff06ae90
                    client_waits:
                      avg: 1200
                      max: 3610
                      min: 600
                      p95: 2800
                    clients:
                    - 5684dae9ac8b
                    id: 8ac84899-32db-6327-334c-9b6d58544cfe
                    map_id: 63eda950-c6da-11e4-a628-60f81dd250cc
                    name: Board Room
                    num_clients: 80
                    num_sdkclients: 0
                    sdkclients:
                    - 7e2b463d-c91c-ff7d-f3c0-6eccc6949ff8
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/discovered_switch_metrics/search:
    get:
      tags:
      - Sites Stats - Discovered Switches
      summary: searchSiteDiscoveredSwitchesMetrics
      description: Search Discovered Switch Metrics
      operationId: searchSiteDiscoveredSwitchesMetrics
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: scope
        in: query
        description: 'Filter results by scope. enum: `site`, `switch`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/discovered_switches_metric_scope'
          - description: 'Filter results by scope. enum: `site`, `switch`'
      - name: type
        in: query
        description: 'Metric type. enum: `inactive_wired_vlans`, `poe_compliance`, `switch_ap_affinity`, `version_compliance`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/discovered_switch_metric_type'
          - description: 'Metric type. enum: `inactive_wired_vlans`, `poe_compliance`, `switch_ap_affinity`, `version_compliance`'
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_discovered_switch_metrics'
                - description: Paginated response for discovered switch metric search results
                  examples:
                  - end: 1675193686.0191767
                    limit: 1
                    next: /api/v1/sites/f5fcbee5-fbca-45b3-8bf1-1619ede87879/stats/discovered_switch_metrics/search?end=1675193686.0191767&limit=1&search_after=%5B1675193400000%5D&start=1675107286.0191767
                    results:
                    - org_id: 203d3d02-dbc0-4c1b-9f41-76896a3330f4
                      scope: site
                      score: 100
                      site_id: f5fcbee5-fbca-45b3-8bf1-1619ede87879
                      timestamp: 1675193400
                      type: inactive_wired_vlans
                    start: 1675107286.0191767
                    total: 3
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1675193686.0191767
                    limit: 1
                    next: /api/v1/sites/f5fcbee5-fbca-45b3-8bf1-1619ede87879/stats/discovered_switch_metrics/search?end=1675193686.0191767&limit=1&search_after=%5B1675193400000%5D&start=1675107286.0191767
                    results:
                    - org_id: 203d3d02-dbc0-4c1b-9f41-76896a3330f4
                      scope: site
                      score: 100
                      site_id: f5fcbee5-fbca-45b3-8bf1-1619ede87879
                      timestamp: 1675193400
                      type: inactive_wired_vlans
                    start: 1675107286.0191767
                    total: 3
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_discovered_switch_metrics'
                - description: Paginated response for discovered switch metric search results
                  examples:
                  - end: 1675193686.0191767
                    limit: 1
                    next: /api/v1/sites/f5fcbee5-fbca-45b3-8bf1-1619ede87879/stats/discovered_switch_metrics/search?end=1675193686.0191767&limit=1&search_after=%5B1675193400000%5D&start=1675107286.0191767
                    results:
                    - org_id: 203d3d02-dbc0-4c1b-9f41-76896a3330f4
                      scope: site
                      score: 100
                      site_id: f5fcbee5-fbca-45b3-8bf1-1619ede87879
                      timestamp: 1675193400
                      type: inactive_wired_vlans
                    start: 1675107286.0191767
                    total: 3
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1675193686.0191767
                    limit: 1
                    next: /api/v1/sites/f5fcbee5-fbca-45b3-8bf1-1619ede87879/stats/discovered_switch_metrics/search?end=1675193686.0191767&limit=1&search_after=%5B1675193400000%5D&start=1675107286.0191767
                    results:
                    - org_id: 203d3d02-dbc0-4c1b-9f41-76896a3330f4
                      scope: site
                      score: 100
                      site_id: f5fcbee5-fbca-45b3-8bf1-1619ede87879
                      timestamp: 1675193400
                      type: inactive_wired_vlans
                    start: 1675107286.0191767
                    total: 3
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/discovered_switches/count:
    get:
      tags:
      - Sites Stats - Discovered Switches
      summary: countSiteDiscoveredSwitches
      description: Count Discovered Switches
      operationId: countSiteDiscoveredSwitches
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `mgmt_addr`, `model`, `system_name`, `version`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/site_discovered_switches_count_distinct'
          - description: 'Field used to group this count response. enum: `mgmt_addr`, `model`, `system_name`, `version`'
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/discovered_switches/metrics:
    get:
      tags:
      - Sites Stats - Discovered Switches
      summary: listSiteDiscoveredSwitchesMetrics
      description: Discovered switches related metrics, lists related switch system names & details if not compliant
      operationId: listSiteDiscoveredSwitchesMetrics
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: threshold
        in: query
        description: 'Configurable # ap per switch threshold, default 12'
        style: form
        explode: true
        schema:
          type: string
          examples:
          - '12'
      - name: system_name
        in: query
        description: System name for switch level metrics, optional
        style: form
        explode: true
        schema:
          type: string
          examples:
          - switch1.example.com
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_dswitches_metrics'
                - description: Metrics summary returned for discovered switch compliance checks
                  examples:
                  - inactive_wired_vlans:
                      details: {}
                      score: 100
                    poe_compliance:
                      details:
                        total_aps: 63
                        total_power: 981500
                      score: 100
                    switch_ap_affinity:
                      details:
                        system_name:
                        - mist-lab-ex2300c
                        - switch1
                        threshold: 12
                      score: 33.3333
                    version_compliance:
                      details:
                        major_versions:
                        - major_count: 2
                          model: EX2300-C-12P
                          system_names:
                          - switch1
                          - mist-lab-ex2300c
                        - major_count: 1
                          model: EX4300-48P
                          system_names: []
                        total_switch_count: 5
                      score: 75
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    inactive_wired_vlans:
                      details: {}
                      score: 100
                    poe_compliance:
                      details:
                        total_aps: 63
                        total_power: 981500
                      score: 100
                    switch_ap_affinity:
                      details:
                        system_name:
                        - mist-lab-ex2300c
                        - switch1
                        threshold: 12
                      score: 33.3333
                    version_compliance:
                      details:
                        major_versions:
                        - major_count: 2
                          model: EX2300-C-12P
                          system_names:
                          - switch1
                          - mist-lab-ex2300c
                        - major_count: 1
                          model: EX4300-48P
                          system_names: []
                        total_switch_count: 5
                      score: 75
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_dswitches_metrics'
                - description: Metrics summary returned for discovered switch compliance checks
                  examples:
                  - inactive_wired_vlans:
                      details: {}
                      score: 100
                    poe_compliance:
                      details:
                        total_aps: 63
                        total_power: 981500
                      score: 100
                    switch_ap_affinity:
                      details:
                        system_name:
                        - mist-lab-ex2300c
                        - switch1
                        threshold: 12
                      score: 33.3333
                    version_compliance:
                      details:
                        major_versions:
                        - major_count: 2
                          model: EX2300-C-12P
                          system_names:
                          - switch1
                          - mist-lab-ex2300c
                        - major_count: 1
                          model: EX4300-48P
                          system_names: []
                        total_switch_count: 5
                      score: 75
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    inactive_wired_vlans:
                      details: {}
                      score: 100
                    poe_compliance:
                      details:
                        total_aps: 63
                        total_power: 981500
                      score: 100
                    switch_ap_affinity:
                      details:
                        system_name:
                        - mist-lab-ex2300c
                        - switch1
                        threshold: 12
                      score: 33.3333
                    version_compliance:
                      details:
                        major_versions:
                        - major_count: 2
                          model: EX2300-C-12P
                          system_names:
                          - switch1
                          - mist-lab-ex2300c
                        - major_count: 1
                          model: EX4300-48P
                          system_names: []
                        total_switch_count: 5
                      score: 75
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/stats/discovered_switches/search:
    get:
      tags:
      - Sites Stats - Discovered Switches
      summary: searchSiteDiscoveredSwitches
      description: Search Discovered Switches
      operationId: searchSiteDiscoveredSwitches
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: adopted
        in: query
        description: Filter results by whether the device is adopted
        style: form
        explode: true
        schema:
          type: boolean
          examples:
          - true
      - name: system_name
        in: query
        description: Filter discovered switch results by system name
        style: form
        explode: true
        schema:
          type: string
          examples:
          - switch1.example.com
      - name: hostname
        in: query
        description: Filter results by hostname
        style: form
        explode: true
        schema:
          type: string
          examples:
          - switch1
      - name: vendor
        in: query
        description: Filter results by vendor
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Cisco
      - name: model
        in: query
        description: Filter results by device model
        style: form
        explode: true
        schema:
          type: string
          examples:
          - WS-C3850-24P
      - name: version
        in: query
        description: Filter results by software version
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 1.0.0
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_discovered_switches'
                - description: Paginated response for discovered switch search results
                  examples:
                  - end: 1604496474.8978634
                    limit: 1000
                    results:
                    - aps:
                      - hostname: ap41nearlab
                        inactive_wired_vlans: []
                        mac: 5c5b352e2001
                        poe_status: true
                        when: 2019-06-13T19:53:16.870+0000
                      mgmt_addr: 10.1.1.1
                      model: EX2300-C-12P
                      org_id: 6748cfa6-4e12-11e6-9188-0242ac110007
                      site_id: 67970e46-4e12-11e6-9188-0242ac110007
                      system_desc: 'Juniper Networks, Inc. ex2300-c-12p Ethernet Switch, kernel JUNOS 18.2R2.6, Build date: 2018-12-07 13:19:04 UTC Copyright (c) 1996-2018 Juniper Networks, Inc.'
                      system_name: mist-lab-ex2300c
                      timestamp: 1560457177.037
                      vendor: Juniper Networks
                      version: 18.2R2.6
                    start: 1604410074.8978484
                    total: 1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1604496474.8978634
                    limit: 1000
                    results:
                    - aps:
                      - hostname: ap41nearlab
                        inactive_wired_vlans: []
                        mac: 5c5b352e2001
                        poe_status: true
                        when: 2019-06-13T19:53:16.870+0000
                      mgmt_addr: 10.1.1.1
                      model: EX2300-C-12P
                      org_id: 6748cfa6-4e12-11e6-9188-0242ac110007
                      site_id: 67970e46-4e12-11e6-9188-0242ac110007
                      system_desc: 'Juniper Networks, Inc. ex2300-c-12p Ethernet Switch, kernel JUNOS 18.2R2.6, Build date: 2018-12-07 13:19:04 UTC Copyright (c) 1996-2018 Juniper Networks, Inc.'
                      system_name: mist-lab-ex2300c
                      timestamp: 1560457177.037
                      vendor: Juniper Networks
                      version: 18.2R2.6
                    start: 1604410074.8978484
                    total: 1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_discovered_switches'
                - description: Paginated response for discovered switch search results
                  examples:
                  - end: 1604496474.8978634
                    limit: 1000
                    results:
                    - aps:
                      - hostname: ap41nearlab
                        inactive_wired_vlans: []
                        mac: 5c5b352e2001
                        poe_status: true
                        when: 2019-06-13T19:53:16.870+0000
                      mgmt_addr: 10.1.1.1
                      model: EX2300-C-12P
                      org_id: 6748cfa6-4e12-11e6-9188-0242ac110007
                      site_id: 67970e46-4e12-11e6-9188-0242ac110007
                      system_desc: 'Juniper Networks, Inc. ex2300-c-12p Ethernet Switch, kernel JUNOS 18.2R2.6, Build date: 2018-12-07 13:19:04 UTC Copyright (c) 1996-2018 Juniper Networks, Inc.'
                      system_name: mist-lab-ex2300c
                      timestamp: 1560457177.037
                      vendor: Juniper Networks
                      version: 18.2R2.6
                    start: 1604410074.8978484
                    total: 1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1604496474.8978634
                    limit: 1000
                    results:
                    - aps:
                      - hostname: ap41nearlab
                        inactive_wired_vlans: []
                        mac: 5c5b352e2001
                        poe_status: true
                        when: 2019-06-13T19:53:16.870+0000
                      mgmt_addr: 10.1.1.1
                      model: EX2300-C-12P
                      org_id: 6748cfa6-4e12-11e6-9188-0242ac110007
                      site_id: 67970e46-4e12-11e6-9188-0242ac110007
                      system_desc: 'Juniper Networks, Inc. ex2300-c-12p Ethernet Switch, kernel JUNOS 18.2R2.6, Build date: 2018-12-07 13:19:04 UTC Copyright (c) 1996-2018 Juniper Networks, Inc.'
                      system_name: mist-lab-ex2300c
                      timestamp: 1560457177.037
                      vendor: Juniper Networks
                      version: 18.2R2.6
                    start: 1604410074.8978484
                    total: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/iotendpoints/count:
    get:
      tags:
      - Sites Stats - IoT Endpoints
      summary: countSiteIotEndpoints
      description: Count IoT Endpoints
      operationId: countSiteIotEndpoints
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: distinct
        in: query
        description: 'Field used to group this count response. enum: `ap_mac`, `mac`, `site_id`, `type`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/site_iotendpoints_count_distinct'
          - description: 'Field used to group this count response. enum: `ap_mac`, `mac`, `site_id`, `type`'
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      responses:
        '200':
          description: Result of Count
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_count'
                - description: Distinct count response for time-bounded search results
                  examples:
                  - distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    distinct: string
                    end: 0
                    limit: 0
                    results:
                    - count: 0
                      property: string
                    start: 0
                    total: 0
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/iotendpoints/search:
    get:
      tags:
      - Sites Stats - IoT Endpoints
      summary: searchSiteIotEndpoints
      description: Search IoT Endpoints
      operationId: searchSiteIotEndpoints
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: ap_mac
        in: query
        description: Filter results by AP MAC address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 5c5b350e0001
      - name: mac
        in: query
        description: Filter results by MAC address
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 63f9e299182b63f9
      - name: type
        in: query
        description: 'IoT endpoint type. enum: `zigbee`'
        style: form
        explode: true
        schema:
          type: string
          examples:
          - zigbee
      - name: mfg
        in: query
        description: Filter results by manufacturer
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Assa Abloy
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_iot_endpoints_search'
                - description: Time-bounded response for IoT endpoint search results
                  examples:
                  - end: 1531862583
                    results:
                    - ap_mac: 5c5b350e0001
                      id: 63f9e299182b63f9
                      lqi: 178
                      mac: 63f9e299182b63f9
                      mfg: Assa Abloy
                      model: Assa Abloy
                      timestamp: 1531782218
                      type: zigbee
                    start: 1531776183
                    total: 2
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1531862583
                    results:
                    - ap_mac: 5c5b350e0001
                      id: 63f9e299182b63f9
                      lqi: 178
                      mac: 63f9e299182b63f9
                      mfg: Assa Abloy
                      model: Assa Abloy
                      timestamp: 1531782218
                      type: zigbee
                    start: 1531776183
                    total: 2
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_iot_endpoints_search'
                - description: Time-bounded response for IoT endpoint search results
                  examples:
                  - end: 1531862583
                    results:
                    - ap_mac: 5c5b350e0001
                      id: 63f9e299182b63f9
                      lqi: 178
                      mac: 63f9e299182b63f9
                      mfg: Assa Abloy
                      model: Assa Abloy
                      timestamp: 1531782218
                      type: zigbee
                    start: 1531776183
                    total: 2
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1531862583
                    results:
                    - ap_mac: 5c5b350e0001
                      id: 63f9e299182b63f9
                      lqi: 178
                      mac: 63f9e299182b63f9
                      mfg: Assa Abloy
                      model: Assa Abloy
                      timestamp: 1531782218
                      type: zigbee
                    start: 1531776183
                    total: 2
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/iotendpoints/{id}/zigbee_rejoin:
    post:
      tags:
      - Sites Stats - IoT Endpoints
      summary: rejoinSiteIotEndpointZigbee
      description: Trigger a Zigbee endpoint to rejoin the network
      operationId: rejoinSiteIotEndpointZigbee
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: id
        in: path
        description: ID of the IoT Endpoint
        required: true
        schema:
          type: string
          contentEncoding: uuid
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/const/ap_channels:
    get:
      tags:
      - Constants Definitions
      summary: listApChannels
      description: Return supported AP radio channels for the requested country code, based on the regulatory domain used by Mist AP configuration.
      operationId: listApChannels
      parameters:
      - name: country_code
        in: query
        description: Country code, in two-character
        style: form
        explode: true
        schema:
          pattern: ^[a-zA-Z]{2}$
          type: string
          examples:
          - US
      responses:
        '200':
          description: AP Channels
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/const_ap_channel'
                - description: Country and regulatory-domain channel capabilities for AP radios
                  examples:
                  - band24_40mhz_allowed: true
                    band24_channels:
                      '20':
                      - 1
                      - 2
                      - 3
                      - 4
                      - 5
                      - 6
                      - 7
                      - 8
                      - 9
                      - 10
                      - 11
                      '40':
                      - 1
                      - 2
                      - 3
                      - 4
                      - 5
                      - 6
                      - 7
                      - 8
                      - 9
                      - 10
                      - 11
                    band24_enabled: true
                    band5_channels:
                      '20':
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      - 149
                      - 153
                      - 157
                      - 161
                      - 165
                      '40':
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      - 149
                      - 153
                      - 157
                      - 161
                      '80':
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      - 149
                      - 153
                      - 157
                      - 161
                      dfs:
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      outdoor:
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      - 149
                      - 153
                      - 157
                      - 161
                      - 165
                    band5_enabled: true
                    band6_channels:
                      '160':
                      - 1
                      - 5
                      - 9
                      - 13
                      - 17
                      - 21
                      - 25
                      - 29
                      - 33
                      - 37
                      - 41
                      - 45
                      - 49
                      - 53
                      - 57
                      - 61
                      - 65
                      - 69
                      - 73
                      - 77
                      - 81
                      - 85
                      - 89
                      - 93
                      - 97
                      - 101
                      - 105
                      - 109
                      - 113
                      - 117
                      - 121
                      - 125
                      - 129
                      - 133
                      - 137
                      - 141
                      - 145
                      - 149
                      - 153
                      - 157
                      - 161
                      - 165
                      - 169
                      - 173
                      - 177
                      - 181
                      - 185
                      - 189
                      - 193
                      - 197
                      - 201
                      - 205
                      - 209
                      - 213
                      - 217
                      - 221
                      '20':
                      - 1
                      - 5
                      - 9
                      - 13
                      - 17
                      - 21
                      - 25
                      - 29
                      - 33
                      - 37
                      - 41
                      - 45
                      - 49
                      - 53
                      - 57
                      - 61
                      - 65
                      - 69
                      - 73
                      - 77
                      - 81
                      - 85
                      - 89
                      - 93
                      - 97
                      - 101
                      - 105
                      - 109
                      - 113
                      - 117
                      - 121
                      - 125
                      - 129
                      - 133
                      - 137
                      - 141
                      - 145
                      - 149
                      - 153
                      - 157
                      - 161
                      - 165
                      - 169
                      - 173
                      - 177
                      - 181
                      - 185
                      - 189
                      - 193
                      - 197
                      - 201
                      - 205
                      - 209
                      - 213
                      - 217
                      - 221
                      - 225
                      - 229
                      - 233
                      '40':
                      - 1
                      - 5
                      - 9
                      - 13
                      - 17
                      - 21
                      - 25
                      - 29
                      - 33
                      - 37
                      - 41
                      - 45
                      - 49
                      - 53
                      - 57
                      - 61
                      - 65
                      - 69
                      - 73
                      - 77
                      - 81
                      - 85
                      - 89
                      - 93
                      - 97
                      - 101
                      - 105
                      - 109
                      - 113
                      - 117
                      - 121
                      - 125
                      - 129
                      - 133
                      - 137
                      - 141
                      - 145
                      - 149
                      - 153
                      - 157
                      - 161
                      - 165
                      - 169
                      - 173
                      - 177
                      - 181
                      - 185
                      - 189
                      - 193
                      - 197
                      - 201
                      - 205
                      - 209
                      - 213
                      - 217
                      - 221
                      - 225
                      - 229
                      '80':
                      - 1
                      - 5
                      - 9
                      - 13
                      - 17
                      - 21
                      - 25
                      - 29
                      - 33
                      - 37
                      - 41
                      - 45
                      - 49
                      - 53
                      - 57
                      - 61
                      - 65
                      - 69
                      - 73
                      - 77
                      - 81
                      - 85
                      - 89
                      - 93
                      - 97
                      - 101
                      - 105
                      - 109
                      - 113
                      - 117
                      - 121
                      - 125
                      - 129
                      - 133
                      - 137
                      - 141
                      - 145
                      - 149
                      - 153
                      - 157
                      - 161
                      - 165
                      - 169
                      - 173
                      - 177
                      - 181
                      - 185
                      - 189
                      - 193
                      - 197
                      - 201
                      - 205
                      - 209
                      - 213
                      - 217
                      - 221
                      psc:
                      - 5
                      - 21
                      - 37
                      - 53
                      - 69
                      - 85
                      - 101
                      - 117
                      - 133
                      - 149
                      - 165
                      - 181
                      - 197
                      - 213
                      - 229
                    band6_enabled: true
                    certified: true
                    code: 840
                    dfs_ok: true
                    key: US
                    name: United States
                    uses: US_FCC
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    band24_40mhz_allowed: true
                    band24_channels:
                      '20':
                      - 1
                      - 2
                      - 3
                      - 4
                      - 5
                      - 6
                      - 7
                      - 8
                      - 9
                      - 10
                      - 11
                      '40':
                      - 1
                      - 2
                      - 3
                      - 4
                      - 5
                      - 6
                      - 7
                      - 8
                      - 9
                      - 10
                      - 11
                    band24_enabled: true
                    band5_channels:
                      '20':
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      - 149
                      - 153
                      - 157
                      - 161
                      - 165
                      '40':
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      - 149
                      - 153
                      - 157
                      - 161
                      '80':
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      - 149
                      - 153
                      - 157
                      - 161
                      dfs:
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      outdoor:
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      - 149
                      - 153
                      - 157
                      - 161
                      - 165
                    band5_enabled: true
                    band6_channels:
                      '160':
                      - 1
                      - 5
                      - 9
                      - 13
                      - 17
                      - 21
                      - 25
                      - 29
                      - 33
                      - 37
                      - 41
                      - 45
                      - 49
                      - 53
                      - 57
                      - 61
                      - 65
                      - 69
                      - 73
                      - 77
                      - 81
                      - 85
                      - 89
                      - 93
                      - 97
                      - 101
                      - 105
                      - 109
                      - 113
                      - 117
                      - 121
                      - 125
                      - 129
                      - 133
                      - 137
                      - 141
                      - 145
                      - 149
                      - 153
                      - 157
                      - 161
                      - 165
                      - 169
                      - 173
                      - 177
                      - 181
                      - 185
                      - 189
                      - 193
                      - 197
                      - 201
                      - 205
                      - 209
                      - 213
                      - 217
                      - 221
                      '20':
                      - 1
                      - 5
                      - 9
                      - 13
                      - 17
                      - 21
                      - 25
                      - 29
                      - 33
                      - 37
                      - 41
                      - 45
                      - 49
                      - 53
                      - 57
                      - 61
                      - 65
                      - 69
                      - 73
                      - 77
                      - 81
                      - 85
                      - 89
                      - 93
                      - 97
                      - 101
                      - 105
                      - 109
                      - 113
                      - 117
                      - 121
                      - 125
                      - 129
                      - 133
                      - 137
                      - 141
                      - 145
                      - 149
                      - 153
                      - 157
                      - 161
                      - 165
                      - 169
                      - 173
                      - 177
                      - 181
                      - 185
                      - 189
                      - 193
                      - 197
                      - 201
                      - 205
                      - 209
                      - 213
                      - 217
                      - 221
                      - 225
                      - 229
                      - 233
                      '40':
                      - 1
                      - 5
                      - 9
                      - 13
                      - 17
                      - 21
                      - 25
                      - 29
                      - 33
                      - 37
                      - 41
                      - 45
                      - 49
                      - 53
                      - 57
                      - 61
                      - 65
                      - 69
                      - 73
                      - 77
                      - 81
                      - 85
                      - 89
                      - 93
                      - 97
                      - 101
                      - 105
                      - 109
                      - 113
                      - 117
                      - 121
                      - 125
                      - 129
                      - 133
                      - 137
                      - 141
                      - 145
                      - 149
                      - 153
                      - 157
                      - 161
                      - 165
                      - 169
                      - 173
                      - 177
                      - 181
                      - 185
                      - 189
                      - 193
                      - 197
                      - 201
                      - 205
                      - 209
                      - 213
                      - 217
                      - 221
                      - 225
                      - 229
                      '80':
                      - 1
                      - 5
                      - 9
                      - 13
                      - 17
                      - 21
                      - 25
                      - 29
                      - 33
                      - 37
                      - 41
                      - 45
                      - 49
                      - 53
                      - 57
                      - 61
                      - 65
                      - 69
                      - 73
                      - 77
                      - 81
                      - 85
                      - 89
                      - 93
                      - 97
                      - 101
                      - 105
                      - 109
                      - 113
                      - 117
                      - 121
                      - 125
                      - 129
                      - 133
                      - 137
                      - 141
                      - 145
                      - 149
                      - 153
                      - 157
                      - 161
                      - 165
                      - 169
                      - 173
                      - 177
                      - 181
                      - 185
                      - 189
                      - 193
                      - 197
                      - 201
                      - 205
                      - 209
                      - 213
                      - 217
                      - 221
                      psc:
                      - 5
                      - 21
                      - 37
                      - 53
                      - 69
                      - 85
                      - 101
                      - 117
                      - 133
                      - 149
                      - 165
                      - 181
                      - 197
                      - 213
                      - 229
                    band6_enabled: true
                    certified: true
                    code: 840
                    dfs_ok: true
                    key: US
                    name: United States
                    uses: US_FCC
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/const_ap_channel'
                - description: Country and regulatory-domain channel capabilities for AP radios
                  examples:
                  - band24_40mhz_allowed: true
                    band24_channels:
                      '20':
                      - 1
                      - 2
                      - 3
                      - 4
                      - 5
                      - 6
                      - 7
                      - 8
                      - 9
                      - 10
                      - 11
                      '40':
                      - 1
                      - 2
                      - 3
                      - 4
                      - 5
                      - 6
                      - 7
                      - 8
                      - 9
                      - 10
                      - 11
                    band24_enabled: true
                    band5_channels:
                      '20':
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      - 149
                      - 153
                      - 157
                      - 161
                      - 165
                      '40':
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      - 149
                      - 153
                      - 157
                      - 161
                      '80':
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      - 149
                      - 153
                      - 157
                      - 161
                      dfs:
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      outdoor:
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      - 149
                      - 153
                      - 157
                      - 161
                      - 165
                    band5_enabled: true
                    band6_channels:
                      '160':
                      - 1
                      - 5
                      - 9
                      - 13
                      - 17
                      - 21
                      - 25
                      - 29
                      - 33
                      - 37
                      - 41
                      - 45
                      - 49
                      - 53
                      - 57
                      - 61
                      - 65
                      - 69
                      - 73
                      - 77
                      - 81
                      - 85
                      - 89
                      - 93
                      - 97
                      - 101
                      - 105
                      - 109
                      - 113
                      - 117
                      - 121
                      - 125
                      - 129
                      - 133
                      - 137
                      - 141
                      - 145
                      - 149
                      - 153
                      - 157
                      - 161
                      - 165
                      - 169
                      - 173
                      - 177
                      - 181
                      - 185
                      - 189
                      - 193
                      - 197
                      - 201
                      - 205
                      - 209
                      - 213
                      - 217
                      - 221
                      '20':
                      - 1
                      - 5
                      - 9
                      - 13
                      - 17
                      - 21
                      - 25
                      - 29
                      - 33
                      - 37
                      - 41
                      - 45
                      - 49
                      - 53
                      - 57
                      - 61
                      - 65
                      - 69
                      - 73
                      - 77
                      - 81
                      - 85
                      - 89
                      - 93
                      - 97
                      - 101
                      - 105
                      - 109
                      - 113
                      - 117
                      - 121
                      - 125
                      - 129
                      - 133
                      - 137
                      - 141
                      - 145
                      - 149
                      - 153
                      - 157
                      - 161
                      - 165
                      - 169
                      - 173
                      - 177
                      - 181
                      - 185
                      - 189
                      - 193
                      - 197
                      - 201
                      - 205
                      - 209
                      - 213
                      - 217
                      - 221
                      - 225
                      - 229
                      - 233
                      '40':
                      - 1
                      - 5
                      - 9
                      - 13
                      - 17
                      - 21
                      - 25
                      - 29
                      - 33
                      - 37
                      - 41
                      - 45
                      - 49
                      - 53
                      - 57
                      - 61
                      - 65
                      - 69
                      - 73
                      - 77
                      - 81
                      - 85
                      - 89
                      - 93
                      - 97
                      - 101
                      - 105
                      - 109
                      - 113
                      - 117
                      - 121
                      - 125
                      - 129
                      - 133
                      - 137
                      - 141
                      - 145
                      - 149
                      - 153
                      - 157
                      - 161
                      - 165
                      - 169
                      - 173
                      - 177
                      - 181
                      - 185
                      - 189
                      - 193
                      - 197
                      - 201
                      - 205
                      - 209
                      - 213
                      - 217
                      - 221
                      - 225
                      - 229
                      '80':
                      - 1
                      - 5
                      - 9
                      - 13
                      - 17
                      - 21
                      - 25
                      - 29
                      - 33
                      - 37
                      - 41
                      - 45
                      - 49
                      - 53
                      - 57
                      - 61
                      - 65
                      - 69
                      - 73
                      - 77
                      - 81
                      - 85
                      - 89
                      - 93
                      - 97
                      - 101
                      - 105
                      - 109
                      - 113
                      - 117
                      - 121
                      - 125
                      - 129
                      - 133
                      - 137
                      - 141
                      - 145
                      - 149
                      - 153
                      - 157
                      - 161
                      - 165
                      - 169
                      - 173
                      - 177
                      - 181
                      - 185
                      - 189
                      - 193
                      - 197
                      - 201
                      - 205
                      - 209
                      - 213
                      - 217
                      - 221
                      psc:
                      - 5
                      - 21
                      - 37
                      - 53
                      - 69
                      - 85
                      - 101
                      - 117
                      - 133
                      - 149
                      - 165
                      - 181
                      - 197
                      - 213
                      - 229
                    band6_enabled: true
                    certified: true
                    code: 840
                    dfs_ok: true
                    key: US
                    name: United States
                    uses: US_FCC
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    band24_40mhz_allowed: true
                    band24_channels:
                      '20':
                      - 1
                      - 2
                      - 3
                      - 4
                      - 5
                      - 6
                      - 7
                      - 8
                      - 9
                      - 10
                      - 11
                      '40':
                      - 1
                      - 2
                      - 3
                      - 4
                      - 5
                      - 6
                      - 7
                      - 8
                      - 9
                      - 10
                      - 11
                    band24_enabled: true
                    band5_channels:
                      '20':
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      - 149
                      - 153
                      - 157
                      - 161
                      - 165
                      '40':
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      - 149
                      - 153
                      - 157
                      - 161
                      '80':
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      - 149
                      - 153
                      - 157
                      - 161
                      dfs:
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      outdoor:
                      - 36
                      - 40
                      - 44
                      - 48
                      - 52
                      - 56
                      - 60
                      - 64
                      - 100
                      - 104
                      - 108
                      - 112
                      - 116
                      - 120
                      - 124
                      - 128
                      - 132
                      - 136
                      - 140
                      - 144
                      - 149
                      - 153
                      - 157
                      - 161
                      - 165
                    band5_enabled: true
                    band6_channels:
                      '160':
                      - 1
                      - 5
                      - 9
                      - 13
                      - 17
                      - 21
                      - 25
                      - 29
                      - 33
                      - 37
                      - 41
                      - 45
                      - 49
                      - 53
                      - 57
                      - 61
                      - 65
                      - 69
                      - 73
                      - 77
                      - 81
                      - 85
                      - 89
                      - 93
                      - 97
                      - 101
                      - 105
                      - 109
                      - 113
                      - 117
                      - 121
                      - 125
                      - 129
                      - 133
                      - 137
                      - 141
                      - 145
                      - 149
                      - 153
                      - 157
                      - 161
                      - 165
                      - 169
                      - 173
                      - 177
                      - 181
                      - 185
                      - 189
                      - 193
                      - 197
                      - 201
                      - 205
                      - 209
                      - 213
                      - 217
                      - 221
                      '20':
                      - 1
                      - 5
                      - 9
                      - 13
                      - 17
                      - 21
                      - 25
                      - 29
                      - 33
                      - 37
                      - 41
                      - 45
                      - 49
                      - 53
                      - 57
                      - 61
                      - 65
                      - 69
                      - 73
                      - 77
                      - 81
                      - 85
                      - 89
                      - 93
                      - 97
                      - 101
                      - 105
                      - 109
                      - 113
                      - 117
                      - 121
                      - 125
                      - 129
                      - 133
                      - 137
                      - 141
                      - 145
                      - 149
                      - 153
                      - 157
                      - 161
                      - 165
                      - 169
                      - 173
                      - 177
                      - 181
                      - 185
                      - 189
                      - 193
                      - 197
                      - 201
                      - 205
                      - 209
                      - 213
                      - 217
                      - 221
                      - 225
                      - 229
                      - 233
                      '40':
                      - 1
                      - 5
                      - 9
                      - 13
                      - 17
                      - 21
                      - 25
                      - 29
                      - 33
                      - 37
                      - 41
                      - 45
                      - 49
                      - 53
                      - 57
                      - 61
                      - 65
                      - 69
                      - 73
                      - 77
                      - 81
                      - 85
                      - 89
                      - 93
                      - 97
                      - 101
                      - 105
                      - 109
                      - 113
                      - 117
                      - 121
                      - 125
                      - 129
                      - 133
                      - 137
                      - 141
                      - 145
                      - 149
                      - 153
                      - 157
                      - 161
                      - 165
                      - 169
                      - 173
                      - 177
                      - 181
                      - 185
                      - 189
                      - 193
                      - 197
                      - 201
                      - 205
                      - 209
                      - 213
                      - 217
                      - 221
                      - 225
                      - 229
                      '80':
                      - 1
                      - 5
                      - 9
                      - 13
                      - 17
                      - 21
                      - 25
                      - 29
                      - 33
                      - 37
                      - 41
                      - 45
                      - 49
                      - 53
                      - 57
                      - 61
                      - 65
                      - 69
                      - 73
                      - 77
                      - 81
                      - 85
                      - 89
                      - 93
                      - 97
                      - 101
                      - 105
                      - 109
                      - 113
                      - 117
                      - 121
                      - 125
                      - 129
                      - 133
                      - 137
                      - 141
                      - 145
                      - 149
                      - 153
                      - 157
                      - 161
                      - 165
                      - 169
                      - 173
                      - 177
                      - 181
                      - 185
                      - 189
                      - 193
                      - 197
                      - 201
                      - 205
                      - 209
                      - 213
                      - 217
                      - 221
                      psc:
                      - 5
                      - 21
                      - 37
                      - 53
                      - 69
                      - 85
                      - 101
                      - 117
                      - 133
                      - 149
                      - 165
                      - 181
                      - 197
                      - 213
                      - 229
                    band6_enabled: true
                    certified: true
                    code: 840
                    dfs_ok: true
                    key: US
                    name: United States
                    uses: US_FCC
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/const/ap_esl_versions:
    get:
      tags:
      - Constants Definitions
      summary: listApLEslVersions
      description: Return Electronic Shelf Label (ESL) firmware versions available per AP model.
      operationId: listApLEslVersions
      parameters: []
      responses:
        '200':
          description: List of Available AP ESL Versions
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_ap_esl_version'
                description: Supported Electronic Shelf Label versions by AP model
                examples:
                - - esl_version: 2.5.1
                    model: AP34
                  - esl_version: 2.5.0
                    model: AP43
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - esl_version: 2.5.1
                    model: AP34
                  - esl_version: 2.5.0
                    model: AP43
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_ap_esl_version'
                description: Supported Electronic Shelf Label versions by AP model
                examples:
                - - esl_version: 2.5.1
                    model: AP34
                  - esl_version: 2.5.0
                    model: AP43
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - esl_version: 2.5.1
                    model: AP34
                  - esl_version: 2.5.0
                    model: AP43
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/const/ap_led_status:
    get:
      tags:
      - Constants Definitions
      summary: listApLedDefinition
      description: Return AP LED status definitions, including the values used to describe LED behavior and the corresponding `error_code` value.
      operationId: listApLedDefinition
      parameters: []
      responses:
        '200':
          description: List of AP Led Status
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_ap_led'
                description: AP LED status and trouble-code definitions returned by the constants API
                examples:
                - - code: '01'
                    description: LED not working
                    key: LED_FAILURE
                    name: LED Failure
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - code: '01'
                    description: LED not working
                    key: LED_FAILURE
                    name: LED Failure
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_ap_led'
                description: AP LED status and trouble-code definitions returned by the constants API
                examples:
                - - code: '01'
                    description: LED not working
                    key: LED_FAILURE
                    name: LED Failure
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - code: '01'
                    description: LED not working
                    key: LED_FAILURE
                    name: LED Failure
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/const/app_categories:
    get:
      tags:
      - Constants Definitions
      summary: listAppCategoryDefinitions
      description: Return supported application categories used for application identification, traffic classification, and policy matching.
      operationId: listAppCategoryDefinitions
      parameters: []
      responses:
        '200':
          description: List of Application Categories Definitions
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_app_category_definition'
                description: Application category definitions returned by the constants API
                examples:
                - - display: Images
                    filters:
                      srx:
                      - Enhanced_Images_Media
                      - Enhanced_Web_Images
                      - Enhanced_Image_Servers
                    key: Images
                  - display: Standard
                    includes:
                    - Adult
                    - FileSharing
                    - Games
                    - Images
                    - Malware
                    - NewsAndReference
                    - Recreation
                    - Religion
                    - Security
                    - Sports
                    - Technology
                    - Violence
                    key: Standard
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - display: Images
                    filters:
                      srx:
                      - Enhanced_Images_Media
                      - Enhanced_Web_Images
                      - Enhanced_Image_Servers
                    key: Images
                  - display: Standard
                    includes:
                    - Adult
                    - FileSharing
                    - Games
                    - Images
                    - Malware
                    - NewsAndReference
                    - Recreation
                    - Religion
                    - Security
                    - Sports
                    - Technology
                    - Violence
                    key: Standard
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_app_category_definition'
                description: Application category definitions returned by the constants API
                examples:
                - - display: Images
                    filters:
                      srx:
                      - Enhanced_Images_Media
                      - Enhanced_Web_Images
                      - Enhanced_Image_Servers
                    key: Images
                  - display: Standard
                    includes:
                    - Adult
                    - FileSharing
                    - Games
                    - Images
                    - Malware
                    - NewsAndReference
                    - Recreation
                    - Religion
                    - Security
                    - Sports
                    - Technology
                    - Violence
                    key: Standard
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - display: Images
                    filters:
                      srx:
                      - Enhanced_Images_Media
                      - Enhanced_Web_Images
                      - Enhanced_Image_Servers
                    key: Images
                  - display: Standard
                    includes:
                    - Adult
                    - FileSharing
                    - Games
                    - Images
                    - Malware
                    - NewsAndReference
                    - Recreation
                    - Religion
                    - Security
                    - Sports
                    - Technology
                    - Violence
                    key: Standard
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/const/app_subcategories:
    get:
      tags:
      - Constants Definitions
      summary: listAppSubCategoryDefinitions
      description: Return supported application subcategories used for application identification, traffic classification, and policy matching.
      operationId: listAppSubCategoryDefinitions
      parameters: []
      responses:
        '200':
          description: List of Application Sub-categories Definitions
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_app_subcategory_definition'
                description: Application subcategory definitions returned by the constants API
                examples:
                - - display: Office Documents
                    key: Office_Documents
                    traffic_type: data_interactive
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - display: Office Documents
                    key: Office_Documents
                    traffic_type: data_interactive
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_app_subcategory_definition'
                description: Application subcategory definitions returned by the constants API
                examples:
                - - display: Office Documents
                    key: Office_Documents
                    traffic_type: data_interactive
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - display: Office Documents
                    key: Office_Documents
                    traffic_type: data_interactive
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/const/applications:
    get:
      tags:
      - Constants Definitions
      summary: listApplications
      description: Return applications recognized by Juniper Mist devices for traffic classification and application analytics.
      operationId: listApplications
      parameters: []
      responses:
        '200':
          description: List of Applications
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_application_definition'
                description: Application definitions returned by the constants API
                examples:
                - - app_id: true
                    app_image_url: ''
                    app_probe: true
                    category: FileSharing
                    group: File Sharing
                    key: dropbox
                    name: Dropbox
                    signature_based: true
                    ssr_app_id: true
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - app_id: true
                    app_image_url: ''
                    app_probe: true
                    category: FileSharing
                    group: File Sharing
                    key: dropbox
                    name: Dropbox
                    signature_based: true
                    ssr_app_id: true
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_application_definition'
                description: Application definitions returned by the constants API
                examples:
                - - app_id: true
                    app_image_url: ''
                    app_probe: true
                    category: FileSharing
                    group: File Sharing
                    key: dropbox
                    name: Dropbox
                    signature_based: true
                    ssr_app_id: true
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - app_id: true
                    app_image_url: ''
                    app_probe: true
                    category: FileSharing
                    group: File Sharing
                    key: dropbox
                    name: Dropbox
                    signature_based: true
                    ssr_app_id: true
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/const/countries:
    get:
      tags:
      - Constants Definitions
      summary: listCountryCodes
      description: Return supported country codes for Mist configuration. Set `extend=true` to include additional country codes when available.
      operationId: listCountryCodes
      parameters:
      - name: extend
        in: query
        description: Will include more country codes if true
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: List of Countries
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_country'
                description: Country definitions returned by the constants API
                examples:
                - - alpha2: FR
                    certified: true
                    name: France
                    numeric: 250
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - alpha2: FR
                    certified: true
                    name: France
                    numeric: 250
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_country'
                description: Country definitions returned by the constants API
                examples:
                - - alpha2: FR
                    certified: true
                    name: France
                    numeric: 250
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - alpha2: FR
                    certified: true
                    name: France
                    numeric: 250
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/const/fingerprint_types:
    get:
      tags:
      - Constants Definitions
      summary: listFingerprintTypes
      description: Return supported client fingerprint attribute values (`family`, `model`, `mfg`, and `os_type`) that can be used in [Mist NAC Rules]($h/Orgs%20NAC%20Rules/_overview) `matching` conditions.
      operationId: listFingerprintTypes
      parameters: []
      responses:
        '200':
          description: List of Fingerprint Types
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/const_fingerprint_types'
                - description: Supported client fingerprint values for NAC matching
                  examples:
                  - family:
                    - 2Wire Router
                    - 3Com Switches
                    - ACTi Corporation Network Camera
                    - APC Video Equipment
                    - APC-Schneider UPS
                    - Aastra VoIP
                    - Acer
                    - Actiontec Wireless Router
                    - Aerohive Access Point
                    - Alcatel
                    - Alcatel VoIP
                    - Amazon Echo
                    mfg:
                    - 100fio Networks Technology llc
                    - 10NET COMMUNICATIONS/DCA
                    - 11wave Technonlogy Co.,Ltd
                    - 12Sided Technology, LLC
                    - 1Net Corporation
                    - 1Verge Internet Technology (Beijing) Co., Ltd.
                    model:
                    - 10T Lite
                    - 10T Pro
                    - 10th Gen
                    - 11 Lite
                    - 11 Pro
                    - 11 Pro Max
                    os:
                    - Android
                    - Apple OS
                    - Asha Platform OS
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    family:
                    - 2Wire Router
                    - 3Com Switches
                    - ACTi Corporation Network Camera
                    - APC Video Equipment
                    - APC-Schneider UPS
                    - Aastra VoIP
                    - Acer
                    - Actiontec Wireless Router
                    - Aerohive Access Point
                    - Alcatel
                    - Alcatel VoIP
                    - Amazon Echo
                    mfg:
                    - 100fio Networks Technology llc
                    - 10NET COMMUNICATIONS/DCA
                    - 11wave Technonlogy Co.,Ltd
                    - 12Sided Technology, LLC
                    - 1Net Corporation
                    - 1Verge Internet Technology (Beijing) Co., Ltd.
                    model:
                    - 10T Lite
                    - 10T Pro
                    - 10th Gen
                    - 11 Lite
                    - 11 Pro
                    - 11 Pro Max
                    os:
                    - Android
                    - Apple OS
                    - Asha Platform OS
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/const_fingerprint_types'
                - description: Supported client fingerprint values for NAC matching
                  examples:
                  - family:
                    - 2Wire Router
                    - 3Com Switches
                    - ACTi Corporation Network Camera
                    - APC Video Equipment
                    - APC-Schneider UPS
                    - Aastra VoIP
                    - Acer
                    - Actiontec Wireless Router
                    - Aerohive Access Point
                    - Alcatel
                    - Alcatel VoIP
                    - Amazon Echo
                    mfg:
                    - 100fio Networks Technology llc
                    - 10NET COMMUNICATIONS/DCA
                    - 11wave Technonlogy Co.,Ltd
                    - 12Sided Technology, LLC
                    - 1Net Corporation
                    - 1Verge Internet Technology (Beijing) Co., Ltd.
                    model:
                    - 10T Lite
                    - 10T Pro
                    - 10th Gen
                    - 11 Lite
                    - 11 Pro
                    - 11 Pro Max
                    os:
                    - Android
                    - Apple OS
                    - Asha Platform OS
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    family:
                    - 2Wire Router
                    - 3Com Switches
                    - ACTi Corporation Network Camera
                    - APC Video Equipment
                    - APC-Schneider UPS
                    - Aastra VoIP
                    - Acer
                    - Actiontec Wireless Router
                    - Aerohive Access Point
                    - Alcatel
                    - Alcatel VoIP
                    - Amazon Echo
                    mfg:
                    - 100fio Networks Technology llc
                    - 10NET COMMUNICATIONS/DCA
                    - 11wave Technonlogy Co.,Ltd
                    - 12Sided Technology, LLC
                    - 1Net Corporation
                    - 1Verge Internet Technology (Beijing) Co., Ltd.
                    model:
                    - 10T Lite
                    - 10T Pro
                    - 10th Gen
                    - 11 Lite
                    - 11 Pro
                    - 11 Pro Max
                    os:
                    - Android
                    - Apple OS
                    - Asha Platform OS
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/const/gateway_applications:
    get:
      tags:
      - Constants Definitions
      summary: listGatewayApplications
      description: Return applications recognized by Mist gateways for traffic classification.
      operationId: listGatewayApplications
      parameters: []
      responses:
        '200':
          description: List of Alarm Definitions
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_gateway_applications_definition'
                description: Gateway application definitions returned by the constants API
                examples:
                - - app_id: true
                    key: 4shared
                    name: 4shared
                    ssr_app_id: true
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - app_id: true
                    key: 4shared
                    name: 4shared
                    ssr_app_id: true
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_gateway_applications_definition'
                description: Gateway application definitions returned by the constants API
                examples:
                - - app_id: true
                    key: 4shared
                    name: 4shared
                    ssr_app_id: true
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - app_id: true
                    key: 4shared
                    name: 4shared
                    ssr_app_id: true
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/const/insight_metrics:
    get:
      tags:
      - Constants Definitions
      summary: listInsightMetrics
      description: Return supported insight metric names and metadata used by insight and SLE APIs.
      operationId: listInsightMetrics
      parameters: []
      responses:
        '200':
          description: Insight Metrics Definition
          headers: {}
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  $ref: '#/components/schemas/const_insight_metrics_property'
                description: Property key is the metric name
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                type: object
                additionalProperties:
                  $ref: '#/components/schemas/const_insight_metrics_property'
                description: Property key is the metric name
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/const/languages:
    get:
      tags:
      - Constants Definitions
      summary: listSiteLanguages
      description: Return supported language codes for localized Mist configuration and user-facing portals.
      operationId: listSiteLanguages
      parameters: []
      responses:
        '200':
          description: List of Languages
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_language'
                description: Language options returned by the constants API
                examples:
                - - display: English (US)
                    display_native: English (US)
                    key: en-US
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - display: English (US)
                    display_native: English (US)
                    key: en-US
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_language'
                description: Language options returned by the constants API
                examples:
                - - display: English (US)
                    display_native: English (US)
                    key: en-US
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - display: English (US)
                    display_native: English (US)
                    key: en-US
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/const/license_types:
    get:
      tags:
      - Constants Definitions
      summary: listLicenseTypes
      description: Return Mist license type definitions used by inventory and subscription APIs.
      operationId: listLicenseTypes
      parameters: []
      responses:
        '200':
          description: List of License Types
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_license_type'
                description: License type definitions returned by the constants API
                examples:
                - - description: Wired Assurance 12
                    includes:
                    - sub_ex12a
                    - sub_ex12p
                    key: sub_ex12
                    name: SUB-EX12
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - description: Wired Assurance 12
                    includes:
                    - sub_ex12a
                    - sub_ex12p
                    key: sub_ex12
                    name: SUB-EX12
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_license_type'
                description: License type definitions returned by the constants API
                examples:
                - - description: Wired Assurance 12
                    includes:
                    - sub_ex12a
                    - sub_ex12p
                    key: sub_ex12
                    name: SUB-EX12
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - description: Wired Assurance 12
                    includes:
                    - sub_ex12a
                    - sub_ex12p
                    key: sub_ex12
                    name: SUB-EX12
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/const/marvisclient_events:
    get:
      tags:
      - Constants Definitions
      summary: listMarvisClientEventsDefinitions
      description: Return Marvis Client event type definitions used by the Marvis Client event search and count APIs.
      operationId: listMarvisClientEventsDefinitions
      parameters: []
      responses:
        '200':
          description: List of Marvis Client event type definitions
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_marvisclient_event'
                description: Marvis Client event type definitions returned by the constants API
                examples:
                - - display: Marvis Client Roamed
                    key: MARVISCLIENT_ROAMED
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - display: Marvis Client Roamed
                    key: MARVISCLIENT_ROAMED
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_marvisclient_event'
                description: Marvis Client event type definitions returned by the constants API
                examples:
                - - display: Marvis Client Roamed
                    key: MARVISCLIENT_ROAMED
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - display: Marvis Client Roamed
                    key: MARVISCLIENT_ROAMED
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/const/marvisclient_versions:
    get:
      tags:
      - Constants Definitions
      summary: listMarvisClientVersions
      description: Return available Marvis Client application versions for tracking or managing Marvis Client deployments.
      operationId: listMarvisClientVersions
      parameters: []
      responses:
        '200':
          description: List of Webhook Topics
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_marvis_client_version'
                description: Marvis Client installer versions returned by the constants API
                examples:
                - - label: latest
                    notes: ''
                    os: android
                    url: https://mobile.mist.com/installers/marvisclient/android/1.1.9/marvisclient-installer.apk
                    version: 1.1.9
                  - label: rc1
                    notes: ''
                    os: macos
                    url: https://mobile.mist.com/installers/marvisclient/macos/0.100.29/marvisclient-installer.dmg
                    version: 0.100.29
                  - label: default
                    notes: ''
                    os: windows
                    url: https://mobile.mist.com/installers/marvisclient/windows/0.100.26/marvisclient-installer.zip
                    version: 0.100.26
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - label: latest
                    notes: ''
                    os: android
                    url: https://mobile.mist.com/installers/marvisclient/android/1.1.9/marvisclient-installer.apk
                    version: 1.1.9
                  - label: rc1
                    notes: ''
                    os: macos
                    url: https://mobile.mist.com/installers/marvisclient/macos/0.100.29/marvisclient-installer.dmg
                    version: 0.100.29
                  - label: default
                    notes: ''
                    os: windows
                    url: https://mobile.mist.com/installers/marvisclient/windows/0.100.26/marvisclient-installer.zip
                    version: 0.100.26
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_marvis_client_version'
                description: Marvis Client installer versions returned by the constants API
                examples:
                - - label: latest
                    notes: ''
                    os: android
                    url: https://mobile.mist.com/installers/marvisclient/android/1.1.9/marvisclient-installer.apk
                    version: 1.1.9
                  - label: rc1
                    notes: ''
                    os: macos
                    url: https://mobile.mist.com/installers/marvisclient/macos/0.100.29/marvisclient-installer.dmg
                    version: 0.100.29
                  - label: default
                    notes: ''
                    os: windows
                    url: https://mobile.mist.com/installers/marvisclient/windows/0.100.26/marvisclient-installer.zip
                    version: 0.100.26
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - label: latest
                    notes: ''
                    os: android
                    url: https://mobile.mist.com/installers/marvisclient/android/1.1.9/marvisclient-installer.apk
                    version: 1.1.9
                  - label: rc1
                    notes: ''
                    os: macos
                    url: https://mobile.mist.com/installers/marvisclient/macos/0.100.29/marvisclient-installer.dmg
                    version: 0.100.29
                  - label: default
                    notes: ''
                    os: windows
                    url: https://mobile.mist.com/installers/marvisclient/windows/0.100.26/marvisclient-installer.zip
                    version: 0.100.26
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/const/states:
    get:
      tags:
      - Constants Definitions
      summary: listStates
      description: Return ISO state or province codes for the supplied country code.
      operationId: listStates
      parameters:
      - name: country_code
        in: query
        description: Country code, in [two-character]($e/Constants%20Definitions/listCountryCodes)
        required: true
        style: form
        explode: true
        schema:
          type: string
          examples:
          - US
      responses:
        '200':
          description: List of Countries
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_state'
                description: State and territory definitions returned by the constants API
                examples:
                - - iso_code: AK
                    name: Alaska
                  - iso_code: AL
                    name: Alabama
                  - iso_code: AS
                    name: American Samoa
                  - iso_code: AZ
                    name: Arizona
                  - iso_code: CA
                    name: California
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - iso_code: AK
                    name: Alaska
                  - iso_code: AL
                    name: Alabama
                  - iso_code: AS
                    name: American Samoa
                  - iso_code: AZ
                    name: Arizona
                  - iso_code: CA
                    name: California
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_state'
                description: State and territory definitions returned by the constants API
                examples:
                - - iso_code: AK
                    name: Alaska
                  - iso_code: AL
                    name: Alabama
                  - iso_code: AS
                    name: American Samoa
                  - iso_code: AZ
                    name: Arizona
                  - iso_code: CA
                    name: California
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - iso_code: AK
                    name: Alaska
                  - iso_code: AL
                    name: Alabama
                  - iso_code: AS
                    name: American Samoa
                  - iso_code: AZ
                    name: Arizona
                  - iso_code: CA
                    name: California
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/const/traffic_types:
    get:
      tags:
      - Constants Definitions
      summary: listTrafficTypes
      description: Return traffic type definitions used to classify recognized network traffic.
      operationId: listTrafficTypes
      parameters: []
      responses:
        '200':
          description: List of Traffic Types
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_traffic_type'
                description: Traffic type definitions returned by the constants API
                examples:
                - - display: VoIP Video
                    dscp: 32
                    failover_policy: non_revertible
                    max_jitter: 250
                    max_latency: 1500
                    max_loss: 35
                    name: voip_video
                    traffic_class: medium
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - display: VoIP Video
                    dscp: 32
                    failover_policy: non_revertible
                    max_jitter: 250
                    max_latency: 1500
                    max_loss: 35
                    name: voip_video
                    traffic_class: medium
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_traffic_type'
                description: Traffic type definitions returned by the constants API
                examples:
                - - display: VoIP Video
                    dscp: 32
                    failover_policy: non_revertible
                    max_jitter: 250
                    max_latency: 1500
                    max_loss: 35
                    name: voip_video
                    traffic_class: medium
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - display: VoIP Video
                    dscp: 32
                    failover_policy: non_revertible
                    max_jitter: 250
                    max_latency: 1500
                    max_loss: 35
                    name: voip_video
                    traffic_class: medium
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/const/webhook_topics:
    get:
      tags:
      - Constants Definitions
      summary: listWebhookTopics
      description: Return webhook topic definitions that can be subscribed to in webhook configuration.
      operationId: listWebhookTopics
      parameters: []
      responses:
        '200':
          description: List of Webhook Topics
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_webhook_topic'
                description: Webhook topic definitions returned by the constants API
                examples:
                - - for_org: true
                    has_delivery_results: true
                    key: alarms
                  - key: asset-raw-rssi
                  - for_org: true
                    has_delivery_results: true
                    key: audits
                  - for_org: true
                    key: client-info
                  - for_org: true
                    key: client-join
                  - key: client-latency
                  - for_org: true
                    key: client-sessions
                  - allows_single_event_per_message: true
                    for_org: true
                    key: device-events
                  - for_org: true
                    has_delivery_results: true
                    key: device-updowns
                  - for_org: true
                    key: minis-reachability
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - for_org: true
                    has_delivery_results: true
                    key: alarms
                  - key: asset-raw-rssi
                  - for_org: true
                    has_delivery_results: true
                    key: audits
                  - for_org: true
                    key: client-info
                  - for_org: true
                    key: client-join
                  - key: client-latency
                  - for_org: true
                    key: client-sessions
                  - allows_single_event_per_message: true
                    for_org: true
                    key: device-events
                  - for_org: true
                    has_delivery_results: true
                    key: device-updowns
                  - for_org: true
                    key: minis-reachability
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_webhook_topic'
                description: Webhook topic definitions returned by the constants API
                examples:
                - - for_org: true
                    has_delivery_results: true
                    key: alarms
                  - key: asset-raw-rssi
                  - for_org: true
                    has_delivery_results: true
                    key: audits
                  - for_org: true
                    key: client-info
                  - for_org: true
                    key: client-join
                  - key: client-latency
                  - for_org: true
                    key: client-sessions
                  - allows_single_event_per_message: true
                    for_org: true
                    key: device-events
                  - for_org: true
                    has_delivery_results: true
                    key: device-updowns
                  - for_org: true
                    key: minis-reachability
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - for_org: true
                    has_delivery_results: true
                    key: alarms
                  - key: asset-raw-rssi
                  - for_org: true
                    has_delivery_results: true
                    key: audits
                  - for_org: true
                    key: client-info
                  - for_org: true
                    key: client-join
                  - key: client-latency
                  - for_org: true
                    key: client-sessions
                  - allows_single_event_per_message: true
                    for_org: true
                    key: device-events
                  - for_org: true
                    has_delivery_results: true
                    key: device-updowns
                  - for_org: true
                    key: minis-reachability
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/const/alarm_defs:
    get:
      tags:
      - Constants Events
      summary: listAlarmDefinitions
      description: >-
        Return alarm type definitions used by alarm search results, alarm templates, and the `alarm` webhook topic. The `example` field shows representative webhook payload content.

        HA cluster node names are returned in the `node` field, when applicable.
      operationId: listAlarmDefinitions
      parameters: []
      responses:
        '200':
          description: List of Alarm Definitions
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_alarm_definition'
                description: Alarm type definitions returned by the constants API
                examples:
                - - display: Device offline
                    example:
                      aps:
                      - d420b02000fa
                      count: 1
                      group: infrastructure
                      hostnames:
                      - Vendor_AP2
                      id: e70c308f-7007-4866-9ecd-0d01842979ea
                      last_seen: 1629753888
                      org_id: 09dac91f-6e73-4100-89f7-698e0fafbb1b
                      severity: warn
                      site_id: dcfb31a1-d615-4361-8c95-b9dde05aa704
                      timestamp: 1629753888
                      type: device_down
                    fields:
                    - aps
                    - hostnames
                    group: infrastructure
                    key: device_down
                    marvis_suggestion_category: string
                    severity: warn
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - display: Device offline
                    example:
                      aps:
                      - d420b02000fa
                      count: 1
                      group: infrastructure
                      hostnames:
                      - Vendor_AP2
                      id: e70c308f-7007-4866-9ecd-0d01842979ea
                      last_seen: 1629753888
                      org_id: 09dac91f-6e73-4100-89f7-698e0fafbb1b
                      severity: warn
                      site_id: dcfb31a1-d615-4361-8c95-b9dde05aa704
                      timestamp: 1629753888
                      type: device_down
                    fields:
                    - aps
                    - hostnames
                    group: infrastructure
                    key: device_down
                    marvis_suggestion_category: string
                    severity: warn
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_alarm_definition'
                description: Alarm type definitions returned by the constants API
                examples:
                - - display: Device offline
                    example:
                      aps:
                      - d420b02000fa
                      count: 1
                      group: infrastructure
                      hostnames:
                      - Vendor_AP2
                      id: e70c308f-7007-4866-9ecd-0d01842979ea
                      last_seen: 1629753888
                      org_id: 09dac91f-6e73-4100-89f7-698e0fafbb1b
                      severity: warn
                      site_id: dcfb31a1-d615-4361-8c95-b9dde05aa704
                      timestamp: 1629753888
                      type: device_down
                    fields:
                    - aps
                    - hostnames
                    group: infrastructure
                    key: device_down
                    marvis_suggestion_category: string
                    severity: warn
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - display: Device offline
                    example:
                      aps:
                      - d420b02000fa
                      count: 1
                      group: infrastructure
                      hostnames:
                      - Vendor_AP2
                      id: e70c308f-7007-4866-9ecd-0d01842979ea
                      last_seen: 1629753888
                      org_id: 09dac91f-6e73-4100-89f7-698e0fafbb1b
                      severity: warn
                      site_id: dcfb31a1-d615-4361-8c95-b9dde05aa704
                      timestamp: 1629753888
                      type: device_down
                    fields:
                    - aps
                    - hostnames
                    group: infrastructure
                    key: device_down
                    marvis_suggestion_category: string
                    severity: warn
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/const/client_events:
    get:
      tags:
      - Constants Events
      summary: listClientEventsDefinitions
      description: Return client event definitions used by client event search and count APIs, including event keys and metadata.
      operationId: listClientEventsDefinitions
      parameters: []
      responses:
        '200':
          description: List of Client Events definitions
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_event'
                description: Event type definitions returned by the constants API
                examples:
                - - display: 11r Association
                    key: CLIENT_AUTH_ASSOCIATION_11R
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - display: 11r Association
                    key: CLIENT_AUTH_ASSOCIATION_11R
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_event'
                description: Event type definitions returned by the constants API
                examples:
                - - display: 11r Association
                    key: CLIENT_AUTH_ASSOCIATION_11R
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - display: 11r Association
                    key: CLIENT_AUTH_ASSOCIATION_11R
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/const/device_events:
    get:
      tags:
      - Constants Events
      summary: listDeviceEventsDefinitions
      description: Return device event definitions used by device event search and count APIs and the `device-events` webhook topic, including event keys and metadata.
      operationId: listDeviceEventsDefinitions
      parameters: []
      responses:
        '200':
          description: List of Device Events Definitions
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_event'
                description: Event type definitions returned by the constants API
                examples:
                - - description: AP was assigned to a site
                    display: AP Assigned
                    example:
                      ap: 5c5b35000001
                      audit_id: e9a88814-fa81-5bdc-34b0-84e8735420e5
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      timestamp: 1552408871
                      type: AP_ASSIGNED
                    key: AP_ASSIGNED
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - description: AP was assigned to a site
                    display: AP Assigned
                    example:
                      ap: 5c5b35000001
                      audit_id: e9a88814-fa81-5bdc-34b0-84e8735420e5
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      timestamp: 1552408871
                      type: AP_ASSIGNED
                    key: AP_ASSIGNED
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_event'
                description: Event type definitions returned by the constants API
                examples:
                - - description: AP was assigned to a site
                    display: AP Assigned
                    example:
                      ap: 5c5b35000001
                      audit_id: e9a88814-fa81-5bdc-34b0-84e8735420e5
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      timestamp: 1552408871
                      type: AP_ASSIGNED
                    key: AP_ASSIGNED
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - description: AP was assigned to a site
                    display: AP Assigned
                    example:
                      ap: 5c5b35000001
                      audit_id: e9a88814-fa81-5bdc-34b0-84e8735420e5
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      timestamp: 1552408871
                      type: AP_ASSIGNED
                    key: AP_ASSIGNED
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/const/mxedge_events:
    get:
      tags:
      - Constants Events
      summary: listMxEdgeEventsDefinitions
      description: Return Mist Edge event definitions used by Mist Edge event search and count APIs, and `mexedge-events` webhook topic.
      operationId: listMxEdgeEventsDefinitions
      parameters: []
      responses:
        '200':
          description: List of MxEdge Events definitions
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_event'
                description: Event type definitions returned by the constants API
                examples:
                - - description: Config change on ME was triggered as a result of change made by user
                    display: ME Config changed by user
                    example:
                      audit_id: e9a88814-fa81-5bdc-34b0-84e8735420e5
                      mxcluster_id: ed4665ed-c9ad-4835-8ca5-dda642765ad3
                      mxedge_id: 387804a7-3474-85ce-15a2-f9a9684c9c9
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      service: mxagent
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      timestamp: 1552408871
                      type: ME_CONFIG_CHANGED_BY_USER
                    key: ME_CONFIG_CHANGED_BY_USER
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - description: Config change on ME was triggered as a result of change made by user
                    display: ME Config changed by user
                    example:
                      audit_id: e9a88814-fa81-5bdc-34b0-84e8735420e5
                      mxcluster_id: ed4665ed-c9ad-4835-8ca5-dda642765ad3
                      mxedge_id: 387804a7-3474-85ce-15a2-f9a9684c9c9
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      service: mxagent
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      timestamp: 1552408871
                      type: ME_CONFIG_CHANGED_BY_USER
                    key: ME_CONFIG_CHANGED_BY_USER
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_event'
                description: Event type definitions returned by the constants API
                examples:
                - - description: Config change on ME was triggered as a result of change made by user
                    display: ME Config changed by user
                    example:
                      audit_id: e9a88814-fa81-5bdc-34b0-84e8735420e5
                      mxcluster_id: ed4665ed-c9ad-4835-8ca5-dda642765ad3
                      mxedge_id: 387804a7-3474-85ce-15a2-f9a9684c9c9
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      service: mxagent
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      timestamp: 1552408871
                      type: ME_CONFIG_CHANGED_BY_USER
                    key: ME_CONFIG_CHANGED_BY_USER
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - description: Config change on ME was triggered as a result of change made by user
                    display: ME Config changed by user
                    example:
                      audit_id: e9a88814-fa81-5bdc-34b0-84e8735420e5
                      mxcluster_id: ed4665ed-c9ad-4835-8ca5-dda642765ad3
                      mxedge_id: 387804a7-3474-85ce-15a2-f9a9684c9c9
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      service: mxagent
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      timestamp: 1552408871
                      type: ME_CONFIG_CHANGED_BY_USER
                    key: ME_CONFIG_CHANGED_BY_USER
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/const/nac_events:
    get:
      tags:
      - Constants Events
      summary: listNacEventsDefinitions
      description: Return NAC client event definitions used by NAC client event search and count APIs, and `nac-events` webhook topic.
      operationId: listNacEventsDefinitions
      parameters: []
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_nac_event'
                description: NAC event example payloads returned by the constants API
                examples:
                - - ap: 5c5b355008c0
                    bssid: 5c5b35548892
                    cert_cn: suriyas
                    cert_expiry: 1711557441
                    cert_issuer: /DC=net/DC=jnpr/CN=Juniper Networks Issuing AWS1 CA
                    cert_san_upn:
                    - suriyas@juniper.net
                    cert_serial: 1300103d29e56ef083797bedc2000100103d29
                    cert_subject: /CN=suriyas/emailAddress=suriyas@juniper.net
                    eap_type: EAP-TLS
                    nas_vendor: Mist
                    org_id: 94de66e8-556a-4d56-8780-a114620a5c42
                    random_mac: true
                    site_id: b5a005ab-47d4-41f7-97bf-733f9cc252dd
                    ssid: Test_Suriya-SSID
                    timestamp: 1685658478.438995
                    type: NAC_CLIENT_CERT_CHECK_SUCCESS
                    username: suriyas@juniper.net
                    wcid: b43637b0-f0d9-0a1d-1ec2-73c394a9f679
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - ap: 5c5b355008c0
                    bssid: 5c5b35548892
                    cert_cn: suriyas
                    cert_expiry: 1711557441
                    cert_issuer: /DC=net/DC=jnpr/CN=Juniper Networks Issuing AWS1 CA
                    cert_san_upn:
                    - suriyas@juniper.net
                    cert_serial: 1300103d29e56ef083797bedc2000100103d29
                    cert_subject: /CN=suriyas/emailAddress=suriyas@juniper.net
                    eap_type: EAP-TLS
                    nas_vendor: Mist
                    org_id: 94de66e8-556a-4d56-8780-a114620a5c42
                    random_mac: true
                    site_id: b5a005ab-47d4-41f7-97bf-733f9cc252dd
                    ssid: Test_Suriya-SSID
                    timestamp: 1685658478.438995
                    type: NAC_CLIENT_CERT_CHECK_SUCCESS
                    username: suriyas@juniper.net
                    wcid: b43637b0-f0d9-0a1d-1ec2-73c394a9f679
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_nac_event'
                description: NAC event example payloads returned by the constants API
                examples:
                - - ap: 5c5b355008c0
                    bssid: 5c5b35548892
                    cert_cn: suriyas
                    cert_expiry: 1711557441
                    cert_issuer: /DC=net/DC=jnpr/CN=Juniper Networks Issuing AWS1 CA
                    cert_san_upn:
                    - suriyas@juniper.net
                    cert_serial: 1300103d29e56ef083797bedc2000100103d29
                    cert_subject: /CN=suriyas/emailAddress=suriyas@juniper.net
                    eap_type: EAP-TLS
                    nas_vendor: Mist
                    org_id: 94de66e8-556a-4d56-8780-a114620a5c42
                    random_mac: true
                    site_id: b5a005ab-47d4-41f7-97bf-733f9cc252dd
                    ssid: Test_Suriya-SSID
                    timestamp: 1685658478.438995
                    type: NAC_CLIENT_CERT_CHECK_SUCCESS
                    username: suriyas@juniper.net
                    wcid: b43637b0-f0d9-0a1d-1ec2-73c394a9f679
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - ap: 5c5b355008c0
                    bssid: 5c5b35548892
                    cert_cn: suriyas
                    cert_expiry: 1711557441
                    cert_issuer: /DC=net/DC=jnpr/CN=Juniper Networks Issuing AWS1 CA
                    cert_san_upn:
                    - suriyas@juniper.net
                    cert_serial: 1300103d29e56ef083797bedc2000100103d29
                    cert_subject: /CN=suriyas/emailAddress=suriyas@juniper.net
                    eap_type: EAP-TLS
                    nas_vendor: Mist
                    org_id: 94de66e8-556a-4d56-8780-a114620a5c42
                    random_mac: true
                    site_id: b5a005ab-47d4-41f7-97bf-733f9cc252dd
                    ssid: Test_Suriya-SSID
                    timestamp: 1685658478.438995
                    type: NAC_CLIENT_CERT_CHECK_SUCCESS
                    username: suriyas@juniper.net
                    wcid: b43637b0-f0d9-0a1d-1ec2-73c394a9f679
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/const/otherdevice_events:
    get:
      tags:
      - Constants Events
      summary: listOtherDeviceEventsDefinitions
      description: Return event definitions for other or third-party devices managed or monitored by Mist.
      operationId: listOtherDeviceEventsDefinitions
      parameters: []
      responses:
        '200':
          description: List of Other Device Events definitions
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_event'
                description: Event type definitions returned by the constants API
                examples:
                - - display: Connected to NCM
                    example:
                      device_mac: 5c5b351e13b5
                      mac: 0030447771c0
                      org_id: c080ce4d-4e35-4373-bdc4-08df15d257f5
                      site_id: 1df889ad-9111-4c0e-a00b-8a008b83eb68
                      text: Connected to NCM
                      timestamp: 1675827825.765
                      type: CELLULAR_EDGE_CONNECTED_TO_NCM
                      vendor: cradlepoint
                    key: CELLULAR_EDGE_CONNECTED_TO_NCM
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - display: Connected to NCM
                    example:
                      device_mac: 5c5b351e13b5
                      mac: 0030447771c0
                      org_id: c080ce4d-4e35-4373-bdc4-08df15d257f5
                      site_id: 1df889ad-9111-4c0e-a00b-8a008b83eb68
                      text: Connected to NCM
                      timestamp: 1675827825.765
                      type: CELLULAR_EDGE_CONNECTED_TO_NCM
                      vendor: cradlepoint
                    key: CELLULAR_EDGE_CONNECTED_TO_NCM
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_event'
                description: Event type definitions returned by the constants API
                examples:
                - - display: Connected to NCM
                    example:
                      device_mac: 5c5b351e13b5
                      mac: 0030447771c0
                      org_id: c080ce4d-4e35-4373-bdc4-08df15d257f5
                      site_id: 1df889ad-9111-4c0e-a00b-8a008b83eb68
                      text: Connected to NCM
                      timestamp: 1675827825.765
                      type: CELLULAR_EDGE_CONNECTED_TO_NCM
                      vendor: cradlepoint
                    key: CELLULAR_EDGE_CONNECTED_TO_NCM
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - display: Connected to NCM
                    example:
                      device_mac: 5c5b351e13b5
                      mac: 0030447771c0
                      org_id: c080ce4d-4e35-4373-bdc4-08df15d257f5
                      site_id: 1df889ad-9111-4c0e-a00b-8a008b83eb68
                      text: Connected to NCM
                      timestamp: 1675827825.765
                      type: CELLULAR_EDGE_CONNECTED_TO_NCM
                      vendor: cradlepoint
                    key: CELLULAR_EDGE_CONNECTED_TO_NCM
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/const/system_events:
    get:
      tags:
      - Constants Events
      summary: listSystemEventsDefinitions
      description: Return system event definitions used by system event search APIs.
      operationId: listSystemEventsDefinitions
      parameters: []
      responses:
        '200':
          description: List of System Events definitions
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_event'
                description: Event type definitions returned by the constants API
                examples:
                - - display: AP Disconnect
                    group: ap_health
                    key: ap_disconnected
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - display: AP Disconnect
                    group: ap_health
                    key: ap_disconnected
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_event'
                description: Event type definitions returned by the constants API
                examples:
                - - display: AP Disconnect
                    group: ap_health
                    key: ap_disconnected
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - display: AP Disconnect
                    group: ap_health
                    key: ap_disconnected
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/const/default_gateway_config:
    get:
      tags:
      - Constants Models
      summary: getGatewayDefaultConfig
      description: Generate the default gateway configuration for the requested model and HA mode.
      operationId: getGatewayDefaultConfig
      parameters:
      - name: model
        in: query
        description: Device model for which to generate the default gateway config.
        required: true
        style: form
        explode: true
        schema:
          type: string
          examples:
          - srx550
      - name: ha
        in: query
        description: Whether the config is intended for HA
        style: form
        explode: true
        schema:
          type: string
          examples:
          - 'false'
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: object
                examples:
                - dhcpd_config:
                    lan:
                      ip_end: 192.168.1.254
                      ip_start: 192.168.1.2
                  ip_configs:
                    lan:
                      ip: 192.168.1.1
                      type: static
                  networks:
                    lan:
                      name: lan
                      subnet: 192.168.1.0/24
                      vlan_id: 1
                  path_preferences:
                    wan:
                      paths:
                      - name: wan
                        type: wan
                  port_config:
                    cl-1/0/0:
                      ip_config:
                        type: dhcp
                      name: lte
                      usage: wan
                      wan_type: lte
                    ge-0/0/0,ge-0/0/7:
                      ip_config:
                        type: dhcp
                      name: wan
                      usage: wan
                    ge-0/0/1-6:
                      port_network: lan
                      usage: lan
                  service_policies:
                  - action: allow
                    name: Internet
                    path_preference: wan
                    services:
                    - any
                    tenants:
                    - lan
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    dhcpd_config:
                      lan:
                        ip_end: 192.168.1.254
                        ip_start: 192.168.1.2
                    ip_configs:
                      lan:
                        ip: 192.168.1.1
                        type: static
                    networks:
                      lan:
                        name: lan
                        subnet: 192.168.1.0/24
                        vlan_id: 1
                    path_preferences:
                      wan:
                        paths:
                        - name: wan
                          type: wan
                    port_config:
                      cl-1/0/0:
                        ip_config:
                          type: dhcp
                        name: lte
                        usage: wan
                        wan_type: lte
                      ge-0/0/0,ge-0/0/7:
                        ip_config:
                          type: dhcp
                        name: wan
                        usage: wan
                      ge-0/0/1-6:
                        port_network: lan
                        usage: lan
                    service_policies:
                    - action: allow
                      name: Internet
                      path_preference: wan
                      services:
                      - any
                      tenants:
                      - lan
            application/vnd.api+json:
              schema:
                type: object
                examples:
                - dhcpd_config:
                    lan:
                      ip_end: 192.168.1.254
                      ip_start: 192.168.1.2
                  ip_configs:
                    lan:
                      ip: 192.168.1.1
                      type: static
                  networks:
                    lan:
                      name: lan
                      subnet: 192.168.1.0/24
                      vlan_id: 1
                  path_preferences:
                    wan:
                      paths:
                      - name: wan
                        type: wan
                  port_config:
                    cl-1/0/0:
                      ip_config:
                        type: dhcp
                      name: lte
                      usage: wan
                      wan_type: lte
                    ge-0/0/0,ge-0/0/7:
                      ip_config:
                        type: dhcp
                      name: wan
                      usage: wan
                    ge-0/0/1-6:
                      port_network: lan
                      usage: lan
                  service_policies:
                  - action: allow
                    name: Internet
                    path_preference: wan
                    services:
                    - any
                    tenants:
                    - lan
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    dhcpd_config:
                      lan:
                        ip_end: 192.168.1.254
                        ip_start: 192.168.1.2
                    ip_configs:
                      lan:
                        ip: 192.168.1.1
                        type: static
                    networks:
                      lan:
                        name: lan
                        subnet: 192.168.1.0/24
                        vlan_id: 1
                    path_preferences:
                      wan:
                        paths:
                        - name: wan
                          type: wan
                    port_config:
                      cl-1/0/0:
                        ip_config:
                          type: dhcp
                        name: lte
                        usage: wan
                        wan_type: lte
                      ge-0/0/0,ge-0/0/7:
                        ip_config:
                          type: dhcp
                        name: wan
                        usage: wan
                      ge-0/0/1-6:
                        port_network: lan
                        usage: lan
                    service_policies:
                    - action: allow
                      name: Internet
                      path_preference: wan
                      services:
                      - any
                      tenants:
                      - lan
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/const/device_models:
    get:
      tags:
      - Constants Models
      summary: listDeviceModels
      description: Return AP, Switch and Gateway device models supported by Mist, including their features and capabilities.
      operationId: listDeviceModels
      parameters: []
      responses:
        '200':
          description: List of supported device models
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_device_model'
                description: Device model definitions returned by the constants API
                examples:
                - '[{"defaults":{"ha_control_port":"ge-0/0/1","ha_data_ports":"ge-0/0/2,ge-3/0/2","ha_fxp0_port":"ge-0/0/0","ha_lan_ports":"ge-0/0/4,ge-3/0/4","ha_wan_ports":"ge-0/0/3,ge-3/0/3","lan_ports":"ge-0/0/1-6","lte_wan_ports":"cl-1/0/0","wan_ports":"ge-0/0/0,ge-0/0/7"},"description":"Juniper SRX320 Series","fans_pluggable":false,"ha_node0_fpc":3,"ha_node1_fpc":3,"has_bgp":true,"has_fxp0":false,"has_ha_control":false,"has_ha_data":false,"has_irb":true,"has_poe_out":true,"has_snapshot":true,"irb_disabled_by_default":false,"model":"SRX320","number_fans":1,"oc_device":true,"pic":{"0":"ge*6, sfp*2"},"sub_required":"wan1","type":"gateway"}]'
                - '[{"alias":"EX4100-48P-CHAS","defaults":{"_ports":"ge-0/0/0-47, et-0/1/0-3, xe-0/2/0-3, ge-0/2/0-3"},"description":"Juniper EX4100 Series","display":"EX4100-48P","evolved_os":false,"evpn_ri_type":"mac-vrf","fans_pluggable":true,"has_bgp":true,"has_ets":true,"has_evpn":true,"has_irb":true,"has_poe_out":true,"model":"EX4100-48P","modular":true,"number_fans":2,"oc_device":true,"oob_interface":"re0:mgmt-0, re1:mgmt-0","pic":{"0":"ge*48","1":"qsfp+*4","2":"sfp+*4 (uplink)"},"sub_required":"string","type":"switch"}]'
                contentMediaType: application/json
              examples:
                Gateway:
                  value:
                  - defaults:
                      ha_control_port: ge-0/0/1
                      ha_data_ports: ge-0/0/2,ge-3/0/2
                      ha_fxp0_port: ge-0/0/0
                      ha_lan_ports: ge-0/0/4,ge-3/0/4
                      ha_wan_ports: ge-0/0/3,ge-3/0/3
                      lan_ports: ge-0/0/1-6
                      lte_wan_ports: cl-1/0/0
                      wan_ports: ge-0/0/0,ge-0/0/7
                    description: Juniper SRX320 Series
                    fans_pluggable: false
                    ha_node0_fpc: 3
                    ha_node1_fpc: 3
                    has_bgp: true
                    has_fxp0: false
                    has_ha_control: false
                    has_ha_data: false
                    has_irb: true
                    has_poe_out: true
                    has_snapshot: true
                    irb_disabled_by_default: false
                    model: SRX320
                    number_fans: 1
                    oc_device: true
                    pic:
                      '0': ge*6, sfp*2
                    sub_required: wan1
                    type: gateway
                Switch:
                  value:
                  - alias: EX4100-48P-CHAS
                    defaults:
                      _ports: ge-0/0/0-47, et-0/1/0-3, xe-0/2/0-3, ge-0/2/0-3
                    description: Juniper EX4100 Series
                    display: EX4100-48P
                    evolved_os: false
                    evpn_ri_type: mac-vrf
                    fans_pluggable: true
                    has_bgp: true
                    has_ets: true
                    has_evpn: true
                    has_irb: true
                    has_poe_out: true
                    model: EX4100-48P
                    modular: true
                    number_fans: 2
                    oc_device: true
                    oob_interface: re0:mgmt-0, re1:mgmt-0
                    pic:
                      '0': ge*48
                      '1': qsfp+*4
                      '2': sfp+*4 (uplink)
                    sub_required: string
                    type: switch
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_device_model'
                description: Device model definitions returned by the constants API
                examples:
                - '[{"defaults":{"ha_control_port":"ge-0/0/1","ha_data_ports":"ge-0/0/2,ge-3/0/2","ha_fxp0_port":"ge-0/0/0","ha_lan_ports":"ge-0/0/4,ge-3/0/4","ha_wan_ports":"ge-0/0/3,ge-3/0/3","lan_ports":"ge-0/0/1-6","lte_wan_ports":"cl-1/0/0","wan_ports":"ge-0/0/0,ge-0/0/7"},"description":"Juniper SRX320 Series","fans_pluggable":false,"ha_node0_fpc":3,"ha_node1_fpc":3,"has_bgp":true,"has_fxp0":false,"has_ha_control":false,"has_ha_data":false,"has_irb":true,"has_poe_out":true,"has_snapshot":true,"irb_disabled_by_default":false,"model":"SRX320","number_fans":1,"oc_device":true,"pic":{"0":"ge*6, sfp*2"},"sub_required":"wan1","type":"gateway"}]'
                - '[{"alias":"EX4100-48P-CHAS","defaults":{"_ports":"ge-0/0/0-47, et-0/1/0-3, xe-0/2/0-3, ge-0/2/0-3"},"description":"Juniper EX4100 Series","display":"EX4100-48P","evolved_os":false,"evpn_ri_type":"mac-vrf","fans_pluggable":true,"has_bgp":true,"has_ets":true,"has_evpn":true,"has_irb":true,"has_poe_out":true,"model":"EX4100-48P","modular":true,"number_fans":2,"oc_device":true,"oob_interface":"re0:mgmt-0, re1:mgmt-0","pic":{"0":"ge*48","1":"qsfp+*4","2":"sfp+*4 (uplink)"},"sub_required":"string","type":"switch"}]'
                contentMediaType: application/vnd.api+json
              examples:
                Gateway:
                  value:
                  - defaults:
                      ha_control_port: ge-0/0/1
                      ha_data_ports: ge-0/0/2,ge-3/0/2
                      ha_fxp0_port: ge-0/0/0
                      ha_lan_ports: ge-0/0/4,ge-3/0/4
                      ha_wan_ports: ge-0/0/3,ge-3/0/3
                      lan_ports: ge-0/0/1-6
                      lte_wan_ports: cl-1/0/0
                      wan_ports: ge-0/0/0,ge-0/0/7
                    description: Juniper SRX320 Series
                    fans_pluggable: false
                    ha_node0_fpc: 3
                    ha_node1_fpc: 3
                    has_bgp: true
                    has_fxp0: false
                    has_ha_control: false
                    has_ha_data: false
                    has_irb: true
                    has_poe_out: true
                    has_snapshot: true
                    irb_disabled_by_default: false
                    model: SRX320
                    number_fans: 1
                    oc_device: true
                    pic:
                      '0': ge*6, sfp*2
                    sub_required: wan1
                    type: gateway
                Switch:
                  value:
                  - alias: EX4100-48P-CHAS
                    defaults:
                      _ports: ge-0/0/0-47, et-0/1/0-3, xe-0/2/0-3, ge-0/2/0-3
                    description: Juniper EX4100 Series
                    display: EX4100-48P
                    evolved_os: false
                    evpn_ri_type: mac-vrf
                    fans_pluggable: true
                    has_bgp: true
                    has_ets: true
                    has_evpn: true
                    has_irb: true
                    has_poe_out: true
                    model: EX4100-48P
                    modular: true
                    number_fans: 2
                    oc_device: true
                    oob_interface: re0:mgmt-0, re1:mgmt-0
                    pic:
                      '0': ge*48
                      '1': qsfp+*4
                      '2': sfp+*4 (uplink)
                    sub_required: string
                    type: switch
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/const/mxedge_models:
    get:
      tags:
      - Constants Models
      summary: listMxEdgeModels
      description: Return Mist Edge models supported by Mist, including their capabilities.
      operationId: listMxEdgeModels
      parameters: []
      responses:
        '200':
          description: List of MxEdge Models
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_mxedge_model'
                description: Mist Edge model definitions returned by the constants API
                examples:
                - - display: X10
                    model: ME-X10
                    ports:
                      '0':
                        display: xe0
                        speed: 10000
                      '1':
                        display: xe1
                        speed: 10000
                      '2':
                        display: xe2
                        speed: 10000
                      '3':
                        display: xe3
                        speed: 10000
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - display: X10
                    model: ME-X10
                    ports:
                      '0':
                        display: xe0
                        speed: 10000
                      '1':
                        display: xe1
                        speed: 10000
                      '2':
                        display: xe2
                        speed: 10000
                      '3':
                        display: xe3
                        speed: 10000
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_mxedge_model'
                description: Mist Edge model definitions returned by the constants API
                examples:
                - - display: X10
                    model: ME-X10
                    ports:
                      '0':
                        display: xe0
                        speed: 10000
                      '1':
                        display: xe1
                        speed: 10000
                      '2':
                        display: xe2
                        speed: 10000
                      '3':
                        display: xe3
                        speed: 10000
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - display: X10
                    model: ME-X10
                    ports:
                      '0':
                        display: xe0
                        speed: 10000
                      '1':
                        display: xe1
                        speed: 10000
                      '2':
                        display: xe2
                        speed: 10000
                      '3':
                        display: xe3
                        speed: 10000
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/const/otherdevice_models:
    get:
      tags:
      - Constants Models
      summary: listSupportedOtherDeviceModels
      description: Return supported models for other or third-party devices.
      operationId: listSupportedOtherDeviceModels
      parameters: []
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_other_device_model'
                description: Other-device model definitions returned by the constants API
                examples:
                - - _vendor_model_id: '65'
                    display: W1850
                    model: W1850
                    type: router
                    vendor: cradlepoint
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - _vendor_model_id: '65'
                    display: W1850
                    model: W1850
                    type: router
                    vendor: cradlepoint
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/const_other_device_model'
                description: Other-device model definitions returned by the constants API
                examples:
                - - _vendor_model_id: '65'
                    display: W1850
                    model: W1850
                    type: router
                    vendor: cradlepoint
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - _vendor_model_id: '65'
                    display: W1850
                    model: W1850
                    type: router
                    vendor: cradlepoint
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/self:
    delete:
      tags:
      - Self Account
      summary: deleteSelf
      description: >-
        To delete ones account and every associated with it. The effects:


        the account would be deleted

        any orphaned Org (that only has this account as admin) will be deleted

        along with all data with Org (sites, wlans, devices) will be gone.
      operationId: deleteSelf
      parameters: []
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/error_delete_failed'
                - description: Error response returned when an organization delete request is blocked
                  examples:
                  - detail: inventory not empty
                    org_id: 424f6eca-7276-4993-bfeb-53cbbbba6f05
                contentMediaType: application/json
              examples:
                If Any Of The Org To Be Deleted Still Has Inventory:
                  value:
                    detail: inventory not empty
                    org_id: 424f6eca-7276-4993-bfeb-53cbbbba6f05
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/error_delete_failed'
                - description: Error response returned when an organization delete request is blocked
                  examples:
                  - detail: inventory not empty
                    org_id: 424f6eca-7276-4993-bfeb-53cbbbba6f05
                contentMediaType: application/vnd.api+json
              examples:
                If Any Of The Org To Be Deleted Still Has Inventory:
                  value:
                    detail: inventory not empty
                    org_id: 424f6eca-7276-4993-bfeb-53cbbbba6f05
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Self Account
      summary: getSelf
      description: Get ‘whoami’ and privileges (which org and which sites I have access to)
      operationId: getSelf
      parameters: []
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/admin'
                - description: Mist administrator account or organization API token details
                  examples:
                  - admin_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    email: user@example.com
                    first_name: string
                    last_name: string
                    password_modified_time: 1656353525
                    privileges:
                    - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      msp_name: string
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      org_name: string
                      orggroup_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sitegroup_ids:
                      - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    admin_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    email: user@example.com
                    first_name: string
                    last_name: string
                    password_modified_time: 1656353525
                    privileges:
                    - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      msp_name: string
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      org_name: string
                      orggroup_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sitegroup_ids:
                      - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/admin'
                - description: Mist administrator account or organization API token details
                  examples:
                  - admin_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    email: user@example.com
                    first_name: string
                    last_name: string
                    password_modified_time: 1656353525
                    privileges:
                    - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      msp_name: string
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      org_name: string
                      orggroup_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sitegroup_ids:
                      - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    admin_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    email: user@example.com
                    first_name: string
                    last_name: string
                    password_modified_time: 1656353525
                    privileges:
                    - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      msp_name: string
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      org_name: string
                      orggroup_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sitegroup_ids:
                      - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Self Account
      summary: updateSelf
      description: Update Account Information
      operationId: updateSelf
      parameters: []
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/admin'
              - description: Request Body
                examples:
                - email: john.smith@mycorp.net
                  first_name: John
                  last_name: Smith
                  persona: security
                  phone: '14081112222'
                  phone2: '14083334444'
              contentMediaType: application/json
            examples:
              Example:
                value:
                  email: john.smith@mycorp.net
                  first_name: John
                  last_name: Smith
                  persona: security
                  phone: '14081112222'
                  phone2: '14083334444'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/admin'
                - description: Mist administrator account or organization API token details
                  examples:
                  - admin_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    email: user@example.com
                    first_name: string
                    last_name: string
                    password_modified_time: 1656353525
                    privileges:
                    - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      msp_name: string
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      org_name: string
                      orggroup_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sitegroup_ids:
                      - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    admin_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    email: user@example.com
                    first_name: string
                    last_name: string
                    password_modified_time: 1656353525
                    privileges:
                    - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      msp_name: string
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      org_name: string
                      orggroup_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sitegroup_ids:
                      - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/admin'
                - description: Mist administrator account or organization API token details
                  examples:
                  - admin_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    email: user@example.com
                    first_name: string
                    last_name: string
                    password_modified_time: 1656353525
                    privileges:
                    - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      msp_name: string
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      org_name: string
                      orggroup_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sitegroup_ids:
                      - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    admin_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                    email: user@example.com
                    first_name: string
                    last_name: string
                    password_modified_time: 1656353525
                    privileges:
                    - msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      msp_name: string
                      name: string
                      org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      org_name: string
                      orggroup_ids:
                      - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      role: admin
                      scope: org
                      site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
                      sitegroup_ids:
                      - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/self/login_failures:
    get:
      tags:
      - Self Account
      summary: getSelfLoginFailures
      description: Get a list of failed login attempts across all Orgs for the current admin
      operationId: getSelfLoginFailures
      parameters: []
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/login_failures'
                - description: Failed login attempt summary with source IPs and user agents
                  examples:
                  - email: admin@test.com
                    last_failure_at: 1509161968
                    num_attempts: 40
                    src_ips:
                    - 192.168.1.39
                    - 192.168.1.38
                    - 192.168.1.37
                    user_agents:
                    - Test UA 39
                    - Test UA 38
                    - Test UA 37
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    email: admin@test.com
                    last_failure_at: 1509161968
                    num_attempts: 40
                    src_ips:
                    - 192.168.1.39
                    - 192.168.1.38
                    - 192.168.1.37
                    user_agents:
                    - Test UA 39
                    - Test UA 38
                    - Test UA 37
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/login_failures'
                - description: Failed login attempt summary with source IPs and user agents
                  examples:
                  - email: admin@test.com
                    last_failure_at: 1509161968
                    num_attempts: 40
                    src_ips:
                    - 192.168.1.39
                    - 192.168.1.38
                    - 192.168.1.37
                    user_agents:
                    - Test UA 39
                    - Test UA 38
                    - Test UA 37
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    email: admin@test.com
                    last_failure_at: 1509161968
                    num_attempts: 40
                    src_ips:
                    - 192.168.1.39
                    - 192.168.1.38
                    - 192.168.1.37
                    user_agents:
                    - Test UA 39
                    - Test UA 38
                    - Test UA 37
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/self/update:
    post:
      tags:
      - Self Account
      summary: updateSelfEmail
      description: >-
        Change Email

        We require the user to verify that they actually own the email address they intend to change it to.


        After the API call, the user will receive an email to the new email address with a link like https://manage.mist.com/verify/update?expire=:exp_time&email=:admin_email&token=:token


        Upon clicking the link, the user is provided with a login page to authenticate using existing credentials. After successful login, the email address of the user gets updated


        **Note**: The request parameter email can be used by UI to validate that the current session (if any) belongs to the admin or provide a login page (by pre-populating the email on login screen). UI can also use the request parameter expire to validate token expiry.
      operationId: updateSelfEmail
      parameters: []
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/email_string'
              - description: Request Body
                examples:
                - email: new@mistsys.com
              contentMediaType: application/json
            examples:
              Example:
                value:
                  email: new@mistsys.com
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Invalid email address or new email address already exists
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_detail_string'
                - description: Response containing a human-readable detail message
                  examples:
                  - '{}'
                  - '{"detail":"email already existed"}'
                contentMediaType: application/json
              examples:
                Invalid Email Address:
                  value: {}
                New Email Address Already Exists:
                  value:
                    detail: email already existed
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_detail_string'
                - description: Response containing a human-readable detail message
                  examples:
                  - '{}'
                  - '{"detail":"email already existed"}'
                contentMediaType: application/vnd.api+json
              examples:
                Invalid Email Address:
                  value: {}
                New Email Address Already Exists:
                  value:
                    detail: email already existed
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/self/update/verify/{token}:
    get:
      tags:
      - Self Account
      summary: verifySelfEmail
      description: Verify Email change
      operationId: verifySelfEmail
      parameters:
      - name: token
        in: path
        description: ''
        required: true
        schema:
          type: string
      responses:
        '200':
          description: With correct verification, the email address of the user will be updated
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_detail_string'
                - description: Response containing a human-readable detail message
                  examples:
                  - '{"detail":"invalid token"}'
                  - '{"detail":"email already existed"}'
                  - '{"detail":"invalid token"}'
                contentMediaType: application/json
              examples:
                Invalid Or Expired Token:
                  value:
                    detail: invalid token
                New Email Address Already Exists:
                  value:
                    detail: email already existed
                Request Comes From Authenticated Users Other Than Admin:
                  value:
                    detail: invalid token
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_detail_string'
                - description: Response containing a human-readable detail message
                  examples:
                  - '{"detail":"invalid token"}'
                  - '{"detail":"email already existed"}'
                  - '{"detail":"invalid token"}'
                contentMediaType: application/vnd.api+json
              examples:
                Invalid Or Expired Token:
                  value:
                    detail: invalid token
                New Email Address Already Exists:
                  value:
                    detail: email already existed
                Request Comes From Authenticated Users Other Than Admin:
                  value:
                    detail: invalid token
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/self/usage:
    get:
      tags:
      - Self Account
      summary: getSelfApiUsage
      description: Get the status of the API usage for the current user or API Token
      operationId: getSelfApiUsage
      parameters: []
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api_usage'
                - description: API rate-limit usage status for the current user or API token
                  examples:
                  - request_limit: 5000
                    requests: 5
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    request_limit: 5000
                    requests: 5
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api_usage'
                - description: API rate-limit usage status for the current user or API token
                  examples:
                  - request_limit: 5000
                    requests: 5
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    request_limit: 5000
                    requests: 5
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/self/apitokens:
    get:
      tags:
      - Self API Token
      summary: listApiTokens
      description: Get List of Current User API Tokens
      operationId: listApiTokens
      parameters: []
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/user_apitoken'
                description: List of user API tokens
                examples:
                - - created_time: 1626875902
                    id: 864f351a-1377-4ad9-83f8-72f3fe6199ba
                    key: 1qkb...QQCL
                    last_used: 1690115110
                    name: org_token_xyz
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 1626875902
                    id: 864f351a-1377-4ad9-83f8-72f3fe6199ba
                    key: 1qkb...QQCL
                    last_used: 1690115110
                    name: org_token_xyz
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/user_apitoken'
                description: List of user API tokens
                examples:
                - - created_time: 1626875902
                    id: 864f351a-1377-4ad9-83f8-72f3fe6199ba
                    key: 1qkb...QQCL
                    last_used: 1690115110
                    name: org_token_xyz
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 1626875902
                    id: 864f351a-1377-4ad9-83f8-72f3fe6199ba
                    key: 1qkb...QQCL
                    last_used: 1690115110
                    name: org_token_xyz
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Self API Token
      summary: createApiToken
      description: >-
        Create API Token

        Note that the key is only available during creation time.
      operationId: createApiToken
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/user_apitoken'
              - examples:
                - name: org_token_xyz
              contentMediaType: application/json
            examples:
              Example:
                value:
                  name: org_token_xyz
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/user_apitoken'
                description: List of user API tokens
                examples:
                - - created_time: 1626875902
                    id: 864f351a-1377-4ad9-83f8-72f3fe6199ba
                    key: 1qkb...QQCL
                    last_used: 1690115110
                    name: org_token_xyz
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - created_time: 1626875902
                    id: 864f351a-1377-4ad9-83f8-72f3fe6199ba
                    key: 1qkb...QQCL
                    last_used: 1690115110
                    name: org_token_xyz
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/user_apitoken'
                description: List of user API tokens
                examples:
                - - created_time: 1626875902
                    id: 864f351a-1377-4ad9-83f8-72f3fe6199ba
                    key: 1qkb...QQCL
                    last_used: 1690115110
                    name: org_token_xyz
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - created_time: 1626875902
                    id: 864f351a-1377-4ad9-83f8-72f3fe6199ba
                    key: 1qkb...QQCL
                    last_used: 1690115110
                    name: org_token_xyz
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/self/apitokens/{apitoken_id}:
    delete:
      tags:
      - Self API Token
      summary: deleteApiToken
      description: Delete an API Token
      operationId: deleteApiToken
      parameters:
      - name: apitoken_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Self API Token
      summary: getApiToken
      description: Get User API Token
      operationId: getApiToken
      parameters:
      - name: apitoken_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/user_apitoken'
                - description: User API token metadata
                  examples:
                  - created_time: 1626875902
                    id: 864f351a-1377-4ad9-83f8-72f3fe6199ba
                    key: 1qkb...QQCL
                    last_used: 1690115110
                    name: org_token_xyz
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 1626875902
                    id: 864f351a-1377-4ad9-83f8-72f3fe6199ba
                    key: 1qkb...QQCL
                    last_used: 1690115110
                    name: org_token_xyz
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/user_apitoken'
                - description: User API token metadata
                  examples:
                  - created_time: 1626875902
                    id: 864f351a-1377-4ad9-83f8-72f3fe6199ba
                    key: 1qkb...QQCL
                    last_used: 1690115110
                    name: org_token_xyz
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 1626875902
                    id: 864f351a-1377-4ad9-83f8-72f3fe6199ba
                    key: 1qkb...QQCL
                    last_used: 1690115110
                    name: org_token_xyz
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Self API Token
      summary: updateApiToken
      description: Update User API Token
      operationId: updateApiToken
      parameters:
      - name: apitoken_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/user_apitoken'
              - examples:
                - name: org_token_xyz
              contentMediaType: application/json
            examples:
              Example:
                value:
                  name: org_token_xyz
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/user_apitoken'
                - description: User API token metadata
                  examples:
                  - created_time: 1626875902
                    id: 864f351a-1377-4ad9-83f8-72f3fe6199ba
                    key: 1qkb...QQCL
                    last_used: 1690115110
                    name: org_token_xyz
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    created_time: 1626875902
                    id: 864f351a-1377-4ad9-83f8-72f3fe6199ba
                    key: 1qkb...QQCL
                    last_used: 1690115110
                    name: org_token_xyz
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/user_apitoken'
                - description: User API token metadata
                  examples:
                  - created_time: 1626875902
                    id: 864f351a-1377-4ad9-83f8-72f3fe6199ba
                    key: 1qkb...QQCL
                    last_used: 1690115110
                    name: org_token_xyz
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    created_time: 1626875902
                    id: 864f351a-1377-4ad9-83f8-72f3fe6199ba
                    key: 1qkb...QQCL
                    last_used: 1690115110
                    name: org_token_xyz
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/self/oauth/{provider}:
    get:
      tags:
      - Self OAuth2
      summary: getOauth2UrlForLinking
      description: Obtain Authorization URL for Linking
      operationId: getOauth2UrlForLinking
      parameters:
      - name: provider
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: forward
        in: query
        description: Callback URL to forward to after the OAuth login flow
        style: form
        explode: true
        schema:
          type: string
          examples:
          - https://manage.mist.com/oauth/callback.html
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_self_oauth_url'
                - description: OAuth2 authorization URL response for linking the current Mist account
                  examples:
                  - authorization_url: https://accounts.google.com/o/oauth2/v2/auth?.....
                    linked: false
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    authorization_url: https://accounts.google.com/o/oauth2/v2/auth?.....
                    linked: false
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_self_oauth_url'
                - description: OAuth2 authorization URL response for linking the current Mist account
                  examples:
                  - authorization_url: https://accounts.google.com/o/oauth2/v2/auth?.....
                    linked: false
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    authorization_url: https://accounts.google.com/o/oauth2/v2/auth?.....
                    linked: false
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Self OAuth2
      summary: linkOauth2MistAccount
      description: Link Mist account with an OAuth2 Provider
      operationId: linkOauth2MistAccount
      parameters:
      - name: provider
        in: path
        description: ''
        required: true
        schema:
          type: string
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/code_string'
              - description: Request Body
                examples:
                - code: 4/S9tegDeLkrYg0L9pWNXV4cgMVbbr3SR9t693A2kSHzw
              contentMediaType: application/json
            examples:
              Example:
                value:
                  code: 4/S9tegDeLkrYg0L9pWNXV4cgMVbbr3SR9t693A2kSHzw
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_self_oauth_link_success'
                - description: OAuth2 account-linking success response
                  examples:
                  - action: oauth account linked
                    id: google_user_id
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    action: oauth account linked
                    id: google_user_id
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_self_oauth_link_success'
                - description: OAuth2 account-linking success response
                  examples:
                  - action: oauth account linked
                    id: google_user_id
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    action: oauth account linked
                    id: google_user_id
        '400':
          description: Authorization Error
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_self_oauth_link_failure'
                - description: OAuth2 account-linking failure response
                  examples:
                  - error: access_denied
                    error_description: The resource owner or authorization server denied the request.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    error: access_denied
                    error_description: The resource owner or authorization server denied the request.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_self_oauth_link_failure'
                - description: OAuth2 account-linking failure response
                  examples:
                  - error: access_denied
                    error_description: The resource owner or authorization server denied the request.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    error: access_denied
                    error_description: The resource owner or authorization server denied the request.
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/self/two_factor/token:
    get:
      tags:
      - Self MFA
      summary: generateSecretFor2faVerification
      description: Generate Secret Key for 2FA verification
      operationId: generateSecretFor2faVerification
      parameters:
      - name: by
        in: query
        description: 'Secret response format. If `by`==`qrcode`, returns the secret as a QR code image. enum: `qrcode`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/mfa_secret_type'
          - description: 'Secret response format. If `by`==`qrcode`, returns the secret as a QR code image. enum: `qrcode`'
      responses:
        '200':
          description: Two Factor configuration Token
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_two_factor_json'
                - description: Response body containing a generated two-factor authentication secret
                  examples:
                  - two_factor_secret: NRMTSTRWNBVECY3GJVYEY3DDJFRGSNCZGJUDO4RVN5FDM3DUMJSA
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    two_factor_secret: NRMTSTRWNBVECY3GJVYEY3DDJFRGSNCZGJUDO4RVN5FDM3DUMJSA
            application/octet-stream:
              schema:
                type: string
                description: If `by`==`qrcode`, returns the secret as a qrcode image
                contentEncoding: base64
                contentMediaType: application/octet-stream
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_two_factor_json'
                - description: Response body containing a generated two-factor authentication secret
                  examples:
                  - two_factor_secret: NRMTSTRWNBVECY3GJVYEY3DDJFRGSNCZGJUDO4RVN5FDM3DUMJSA
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    two_factor_secret: NRMTSTRWNBVECY3GJVYEY3DDJFRGSNCZGJUDO4RVN5FDM3DUMJSA
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/self/two_factor/verify:
    post:
      tags:
      - Self MFA
      summary: verifyTwoFactor
      description: >
        Verify Two-factor (OTP)


        To verify two-factor authentication by using a code generated by app (e.g. Google Authenticator, Authy). Upon successful verification, the `two_factor_passed` will be set to true if it hasn’t already been.
      operationId: verifyTwoFactor
      parameters: []
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/two_factor_code'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: Response when 2FA verification is successful
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/self/subscriptions:
    get:
      tags:
      - Self Alarms
      summary: listAlarmSubscriptions
      description: Get List of all the subscriptions
      operationId: listAlarmSubscriptions
      parameters: []
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                uniqueItems: true
                type: array
                items:
                  $ref: '#/components/schemas/response_self_subscription'
                description: Subscription records visible to the current account
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                uniqueItems: true
                type: array
                items:
                  $ref: '#/components/schemas/response_self_subscription'
                description: Subscription records visible to the current account
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/self/logs:
    get:
      tags:
      - Self Audit Logs
      summary: listSelfAuditLogs
      description: >-
        Get List of change logs across all Orgs for current admin

        Audit logs records all administrative activities done by current admin across all orgs
      operationId: listSelfAuditLogs
      parameters:
      - name: message
        in: query
        description: Filter results by message text
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Created a new site
      - name: sort
        in: query
        description: 'Field used to sort results; a leading `-` indicates descending order. enum: `-timestamp`, `admin_id`, `site_id`, `timestamp`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/list_org_logs_sort'
          - description: 'Field used to sort results; a leading `-` indicates descending order. enum: `-timestamp`, `admin_id`, `site_id`, `timestamp`'
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_self_audit_logs'
                - description: Paginated response for audit logs for the current admin across organizations
                  examples:
                  - end: 1428954000
                    limit: 100
                    page: 1
                    results:
                    - admin_id: 72bfa2bd-e58a-4670-9d20-a1468f7a6f58
                      admin_name: test@mistsys.com
                      after:
                        auth:
                          type: open
                      before:
                        auth:
                          type: psk
                      id: c6f9347b-b0a4-4a23-b927-fa9249f2ffb2
                      message: Update WLAN "Corporate"
                      org_id: 423f6eca-6276-4994-bfeb-53cbbbba6f04
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      timestamp: 1431382121
                    start: 1428939600
                    total: 135
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1428954000
                    limit: 100
                    page: 1
                    results:
                    - admin_id: 72bfa2bd-e58a-4670-9d20-a1468f7a6f58
                      admin_name: test@mistsys.com
                      after:
                        auth:
                          type: open
                      before:
                        auth:
                          type: psk
                      id: c6f9347b-b0a4-4a23-b927-fa9249f2ffb2
                      message: Update WLAN "Corporate"
                      org_id: 423f6eca-6276-4994-bfeb-53cbbbba6f04
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      timestamp: 1431382121
                    start: 1428939600
                    total: 135
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_self_audit_logs'
                - description: Paginated response for audit logs for the current admin across organizations
                  examples:
                  - end: 1428954000
                    limit: 100
                    page: 1
                    results:
                    - admin_id: 72bfa2bd-e58a-4670-9d20-a1468f7a6f58
                      admin_name: test@mistsys.com
                      after:
                        auth:
                          type: open
                      before:
                        auth:
                          type: psk
                      id: c6f9347b-b0a4-4a23-b927-fa9249f2ffb2
                      message: Update WLAN "Corporate"
                      org_id: 423f6eca-6276-4994-bfeb-53cbbbba6f04
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      timestamp: 1431382121
                    start: 1428939600
                    total: 135
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1428954000
                    limit: 100
                    page: 1
                    results:
                    - admin_id: 72bfa2bd-e58a-4670-9d20-a1468f7a6f58
                      admin_name: test@mistsys.com
                      after:
                        auth:
                          type: open
                      before:
                        auth:
                          type: psk
                      id: c6f9347b-b0a4-4a23-b927-fa9249f2ffb2
                      message: Update WLAN "Corporate"
                      org_id: 423f6eca-6276-4994-bfeb-53cbbbba6f04
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      timestamp: 1431382121
                    start: 1428939600
                    total: 135
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/restart:
    post:
      tags:
      - Utilities Common
      summary: restartSiteMultipleDevices
      description: Note that only the devices that are connected will be restarted.
      operationId: restartSiteMultipleDevices
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/utils_devices_restart_multi'
              - description: Request Body
                examples:
                - '{"device_ids":["00000000-0000-0000-1000-5c5b35584a6f","00000000-0000-0000-1000-5c5b350ea3b3"]}'
                - '{"device_ids":["421f6eca-6276-4893-bfeb-53cbbbba6f02"],"node":"node0"}'
              contentMediaType: application/json
            examples:
              Example:
                value:
                  device_ids:
                  - 00000000-0000-0000-1000-5c5b35584a6f
                  - 00000000-0000-0000-1000-5c5b350ea3b3
              Example2:
                value:
                  device_ids:
                  - 421f6eca-6276-4893-bfeb-53cbbbba6f02
                  node: node0
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/arp:
    post:
      tags:
      - Utilities Common
      summary: arpFromDevice
      description: "ARP can be performed on the Device. The output will be available through websocket. As there can be multiple commands issued against the same AP at the same time and the output all goes through the same websocket stream, session is introduced for demux.\n\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n    \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n##### Example output from ws stream\n```json\n{ \n \"event\": \"data\", \n \"channel\": \"/sites/4ac1dcf4-9d8b-7211-65c4-057819f0862b/devices/00000000-0000-0000-1000-5c5b350e0060/cmd\", \n \"data\": { \n   \"session\": \"session_id\", \n   \"raw\": \n   \"Output\": \"\\tMAC\\t\\tDEV\\tVLAN\\tRx Packets\\t\\t Rx Bytes\\t\\tTx Packets\\t\\t Tx Bytes\\tFlows\\tIdle sec\\n-----------------------------------------------------------------------------------------------------------------------\"\n  } \n}\n```"
      operationId: arpFromDevice
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ha_cluster_node'
              - examples:
                - node: node0
              contentMediaType: application/json
            examples:
              Example:
                value:
                  node: node0
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/bounce_port:
    post:
      tags:
      - Utilities Common
      summary: bounceDevicePort
      description: >-
        Port Bounce can be performed from Switch/Gateway.

         **Note:** Ports starting with vme, ae, irb, and HA control ports (for SSR only) are not supported

        The output will be available through websocket. As there can be multiple commands issued against the same AP at the same time and the output all goes through the same websocket stream, session is introduced for demux.


        #### Subscribe to Device Command outputs

        `WS /api-ws/v1/stream`


        ```json

        {
            "subscribe": "/sites/{site_id}/devices/{device_id}/cmd"
        }

        ```

        ##### Example output from ws stream

        ```json

        {
            "event": "data",
            "channel": "/sites/4ac1dcf4-9d8b-7211-65c4-057819f0862b/devices/00000000-0000-0000-1000-5c5b350e0060/cmd",
            "data": {
                "session": "session_id",
                "raw": "Port bounce complete."
            }
        }

        ```
      operationId: bounceDevicePort
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/utils_bounce_port'
              - description: Request Body
                examples:
                - ports:
                  - ge-0/0/0
                  - ge-0/0/1
              contentMediaType: application/json
            examples:
              Example:
                value:
                  ports:
                  - ge-0/0/0
                  - ge-0/0/1
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/clear_mac_table:
    post:
      tags:
      - Utilities Common
      summary: clearSiteDeviceMacTable
      description: >
        Clear MAC Table from the Device.


        The output will be available through websocket. As there can be multiple commands issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.


        #### Subscribe to Device Command outputs

        `WS /api-ws/v1/stream`


        ```json

        {
            "subscribe": "/sites/{site_id}/devices/{device_id}/cmd"
        }

        ```
      operationId: clearSiteDeviceMacTable
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: All attributes are optional
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/utils_mac_table'
              - description: All attributes are optional
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/clear_policy_hit_count:
    post:
      tags:
      - Utilities Common
      summary: clearSiteDevicePolicyHitCount
      description: Clear application policy hit counts for the specified policy.
      operationId: clearSiteDevicePolicyHitCount
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/clear_policy_hit_count'
              - examples:
                - policy_name: http
              contentMediaType: application/json
            examples:
              Example:
                value:
                  policy_name: http
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session_with_url'
                - description: Response containing a WebSocket session handle and connection URL
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session_with_url'
                - description: Response containing a WebSocket session handle and connection URL
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/config_cmd:
    get:
      tags:
      - Utilities Common
      summary: getSiteDeviceConfigCmd
      description: >-
        Get Config CLI Commands

        For a brown-field switch deployment where we adopted the switch through Adoption Command, we do not wipe out / overwrite the existing config automatically. Instead, we generate CLI commands that we would have generated. The user can inspect, modify, and incorporate this into their existing config manually.


        Once they feel comfortable about the config we generate, they can enable allow_mist_config where we will take full control of their config like a claimed switch
      operationId: getSiteDeviceConfigCmd
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: sort
        in: query
        description: Make output cmds sorted (for better readability) or not.
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_device_config_cli'
                - description: Device configuration rendered as CLI commands
                  examples:
                  - cli:
                    - set system hostname corp-a135
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    cli:
                    - set system hostname corp-a135
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_device_config_cli'
                - description: Device configuration rendered as CLI commands
                  examples:
                  - cli:
                    - set system hostname corp-a135
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    cli:
                    - set system hostname corp-a135
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/locate:
    post:
      tags:
      - Utilities Common
      summary: startSiteLocateDevice
      description: "### Access Points\nLocate an Access Point by blinking it's LED.\nIt is a persisted state that has to be stopped by calling Stop Locating API\n\n### Switches\nLocate a Switch by blinking all port LEDs. \nBy default, request is sent to `master` switch and LEDs will keep flashing for 5 minutes.\nIn case of virtual chassis (VC) the desired member mac has to be passed in the request payload. \nAt anypoint, only one VC member can be requested to flash the LED. \nTo stop LED flashing before the duration ends /unlocate API request can be made. \nIf /unlocate API is not called LED will continue to flash on device for the given duration. \nDefault duration is 5 minutes and 120 minutes is the maximum."
      operationId: startSiteLocateDevice
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/locate_switch'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/monitor_traffic:
    post:
      tags:
      - Utilities Common
      summary: monitorSiteDeviceTraffic
      description: >-
        Monitor traffic on switches and SRX.
          * JUNOS uses cmd "monitor interface <port>" to monitor traffic on particular <port>
          * JUNOS uses cmd "monitor interface traffic" to monitor traffic on all ports
      operationId: monitorSiteDeviceTraffic
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/utils_monitor_traffic'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session_with_url'
                - description: Response containing a WebSocket session handle and connection URL
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session_with_url'
                - description: Response containing a WebSocket session handle and connection URL
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/ping:
    post:
      tags:
      - Utilities Common
      summary: pingFromDevice
      description: >-
        Ping from AP, Switch and SSR


        Ping can be performed from the Device. The output will be available through websocket. As there can be multiple commands issued against the same AP at the same time and the output all goes through the same websocket stream, session is introduced for demux.


        #### Subscribe to Device Command outputs

        `WS /api-ws/v1/stream`


        ```json

        {
            "subscribe": "/sites/{site_id}/devices/{device_id}/cmd"
        }

        ```

        ##### Example output from ws stream

        ```json

        {
            "event": "data",
            "channel": "/sites/4ac1dcf4-9d8b-7211-65c4-057819f0862b/devices/00000000-0000-0000-1000-5c5b350e0060/cmd",
            "data": {
                "session": "session_id",
                "raw": "64 bytes from 23.211.0.110: seq=8 ttl=58 time=12.323 ms\n"
            }
        }

        ```
      operationId: pingFromDevice
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/utils_ping'
              - description: Request Body
                examples:
                - count: 10
                  host: 1.1.1.1
              contentMediaType: application/json
            examples:
              Example:
                value:
                  count: 10
                  host: 1.1.1.1
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/readopt:
    post:
      tags:
      - Utilities Common
      summary: readoptSiteOctermDevice
      description: For the octerm devices, the device ID must come from fpc0. However, for a VC, the users may change the original fpc0 from CLI. To fix the issue, the readopt API could be used to trigger the readopt process so the device would get the correct device ID to connect the cloud.
      operationId: readoptSiteOctermDevice
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/release_dhcp_leases:
    post:
      tags:
      - Utilities Common
      summary: releaseSiteDeviceDhcpLease
      description: Releases an active DHCP lease.
      operationId: releaseSiteDeviceDhcpLease
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/utils_release_dhcp_leases'
              - examples:
                - port_id: ge-0/0/1.10
              contentMediaType: application/json
            examples:
              Example:
                value:
                  port_id: ge-0/0/1.10
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Parameter `port ` absent
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/reprovision:
    post:
      tags:
      - Utilities Common
      summary: reprovisionSiteOctermDevice
      description: To force one device to reprovision itself again.
      operationId: reprovisionSiteOctermDevice
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/request_ztp_password:
    post:
      tags:
      - Utilities Common
      summary: getSiteDeviceZtpPassword
      description: In the case where something happens during/after ZTP, the root-password is modified (required for ZTP to set up outbound-ssh) but the user-defined password config has not be configured. This API can be used to retrieve the temporary password.
      operationId: getSiteDeviceZtpPassword
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/root_password_string'
                - description: Temporary root password response for device ZTP recovery
                  examples:
                  - root_password: ef8070ef8f924edb592e1819ed64b31172ab8de9d5cde75d3f46acd9506202ab9b1cbb97e381c5aa11037f17e5ed7b4b609461cd813d944670549d410ef82f2e
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    root_password: ef8070ef8f924edb592e1819ed64b31172ab8de9d5cde75d3f46acd9506202ab9b1cbb97e381c5aa11037f17e5ed7b4b609461cd813d944670549d410ef82f2e
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/restart:
    post:
      tags:
      - Utilities Common
      summary: restartSiteDevice
      description: Restart / Reboot a device
      operationId: restartSiteDevice
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/utils_devices_restart'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/shell:
    post:
      tags:
      - Utilities Common
      summary: createSiteDeviceShellSession
      description: Create Shell Session
      operationId: createSiteDeviceShellSession
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/shell_node'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session_with_url'
                - description: Response containing a WebSocket session handle and connection URL
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session_with_url'
                - description: Response containing a WebSocket session handle and connection URL
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/show_bgp_summary:
    post:
      tags:
      - Utilities Common
      summary: showSiteDeviceBgpSummary
      description: >-
        Get BGP Summary from SSR, SRX and Switch.



        The output will be available through websocket. As there can be multiple commands issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.


        #### Subscribe to Device Command outputs

        `WS /api-ws/v1/stream`


        ```json

        {
            "subscribe": "/sites/{site_id}/devices/{device_id}/cmd"

        }

        ```


        ##### Example output from ws stream

        ```

        Tue 2024-04-23 16:36:06 UTC

        Retrieving bgp entries...

        BGP table version is 354, local router ID is 10.224.8.16, vrf id 0

        Default local pref 100, local AS 65000

        Status codes:  s suppressed, d damped, h history, * valid, > best, = multipath,
                      i internal, r RIB_failure, S Stale, R Removed
        Nexthop codes: @NNN nexthop's vrf id, < announce-nh-self

        Origin codes:  i - IGP, e - EGP, ? - incomplete

        RPKI validation codes: V valid, I invalid, N Not found

          Network                                      Next Hop                                  Metric LocPrf Weight Path
        *> 161.161.161.0/24

        ```"
      operationId: showSiteDeviceBgpSummary
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: All attributes are optional
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/utils_show_bgp_summary'
              - description: All attributes are optional
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/show_dhcp_leases:
    post:
      tags:
      - Utilities Common
      summary: showSiteDeviceDhcpLeases
      description: Shows DHCP leases
      operationId: showSiteDeviceDhcpLeases
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/utils_show_dhcp_leases'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/show_dot1x:
    post:
      tags:
      - Utilities Common
      summary: showSiteDeviceDot1xTable
      description: >
        Get Dot1X Table from the Device.


        The output will be available through websocket. As there can be multiple commands issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.


        #### Subscribe to Device Command outputs

        `WS /api-ws/v1/stream`


        ```json

        {
            "subscribe": "/sites/{site_id}/devices/{device_id}/cmd"
        }

        ```
      operationId: showSiteDeviceDot1xTable
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: All attributes are optional
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/utils_show_dot1x'
              - description: All attributes are optional
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/show_evpn_database:
    post:
      tags:
      - Utilities Common
      summary: showSiteDeviceEvpnDatabase
      description: Get EVPN Database from the Device. The output will be available through websocket.
      operationId: showSiteDeviceEvpnDatabase
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: All attributes are optional
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/utils_show_evpn_database'
              - description: All attributes are optional
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/show_forwarding_table:
    post:
      tags:
      - Utilities Common
      summary: showSiteDeviceForwardingTable
      description: >
        Get forwarding table from the Device. The output will be available through websocket. As there can be multiple commands issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.


        #### Subscribe to Device Command outputs

        `WS /api-ws/v1/stream`


        ```json

        {
            "subscribe": "/sites/{site_id}/devices/{device_id}/cmd"
        }

        ```


        ##### Example output from ws stream

        ```

        Mon 2024-05-20 16:47:30 UTC Retrieving fib entries… Entry Count: 3268 Capacity:    22668 ==================== ====== ======= ================== ===== ====================== =========== =========== ====== IP Prefix            Port   Proto   Tenant             VRF   Service                Next Hops   Vector      Cost ==================== ====== ======= ================== ===== ====================== =========== =========== ====== 0.0.0.0/0               0   None    Old_Mgmt           -     internet-wan_and_lte   1-2.0       broadband      1 1-4.0       lte           10 branch1-Kiosk      -     internet-wan_and_lte   1-2.0       broadband      1 1-4.0       lte           10 branch1-MGT        -     internet-wan_and_lte   1-2.0       broadband      1 1-4.0       lte           10 3.1.1.0/24              0   None    Old_Mgmt           -     internet-wan_and_lte   1-2.0       broadband      1 1-4.0       lte           10 branch1-Kiosk      -     internet-wan_and_lte   1-2.0       broadband      1 1-4.0       lte           10 branch1-MGT        -     internet-wan_and_lte   1-2.0       broadband      1 1-4.0       lte           10


        ```
      operationId: showSiteDeviceForwardingTable
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: All attributes are optional
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/utils_show_forwarding_table'
              - description: All attributes are optional
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/show_mac_table:
    post:
      tags:
      - Utilities Common
      summary: showSiteDeviceMacTable
      description: "Get MAC Table from the Device.\n\nThe output will be available through websocket. As there can be multiple commands issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.\n\n\n\n#### Subscribe to Device Command outputs\n\n`WS /api-ws/v1/stream`\n\n```json\n{\n    \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n```\n\n\n#### Example output from ws stream\n\n```json \n{\n    \"event\": \"data\",\n    \"channel\": \"/sites/d6fb4f96-xxxx-xxxx-xxxx-a8d7b85087ac/devices/00000000-0000-0000-1000-209339xxxxxx/cmd\",\n    \"data\": \"{\\\"event\\\": \\\"data\\\", \\\"channel\\\": \\\"/sites/d6fb4f96-xxxx-xxxx-xxxx-a8d7b85087ac/devices/209339xxxxxx/cmd\\\", \\\"data\\\": {\\\"session\\\": \\\"eec2b6e4-1e63-4f9f-9cf8-ef7f9632861e\\\", \\\"raw\\\": \\\"\\\\nMAC flags (S - static MAC, D - dynamic MAC, L - locally learned, P - Persistent static, C - Control MAC\\\\n           SE - statistics enabled, NM - non configured MAC, R - remote PE MAC, O - ovsdb MAC\\\\n           GBP - group based policy, B - Blocked MAC)\\\\n\\\\n\\\\nE\\\"}}\"\n}\n{\n    \"event\": \"data\",\n    \"channel\": \"/sites/d6fb4f96-xxxx-xxxx-xxxx-a8d7b85087ac/devices/00000000-0000-0000-1000-209339xxxxxx/cmd\",\n    \"data\": \"{\\\"event\\\": \\\"data\\\", \\\"channel\\\": \\\"/sites/d6fb4f96-xxxx-xxxx-xxxx-a8d7b85087ac/devices/209339xxxxxx/cmd\\\", \\\"data\\\": {\\\"session\\\": \\\"eec2b6e4-1e63-4f9f-9cf8-ef7f9632861e\\\", \\\"raw\\\": \\\"thernet switching table : 59 entries, 59 learned\\\\nRouting instance : default-switch\\\\n    Vlan                MAC                 MAC         Age   GBP     Logical                NH        MAC        RTR\\\\n    name                address             flags      \\\"}}\"\n}\n{\n    \"event\": \"data\",\n    \"channel\": \"/sites/d6fb4f96-xxxx-xxxx-xxxx-a8d7b85087ac/devices/00000000-0000-0000-1000-209339xxxxxx/cmd\",\n    \"data\": \"{\\\"event\\\": \\\"data\\\", \\\"channel\\\": \\\"/sites/d6fb4f96-xxxx-xxxx-xxxx-a8d7b85087ac/devices/209339xxxxxx/cmd\\\", \\\"data\\\": {\\\"session\\\": \\\"eec2b6e4-1e63-4f9f-9cf8-ef7f9632861e\\\", \\\"raw\\\": \\\"       Tag     interface              Index     property   ID\\\\n    corp                00:50:56:87:4f:69   D             -           xe-0/1/3.0             0                    0       \\\\n    corp                00:50:56:87:ce:f5   D             -           x\\\"}}\"\n}\n{\n    \"event\": \"data\",\n    \"channel\": \"/sites/d6fb4f96-xxxx-xxxx-xxxx-a8d7b85087ac/devices/00000000-0000-0000-1000-209339xxxxxx/cmd\",\n    \"data\": \"{\\\"event\\\": \\\"data\\\", \\\"channel\\\": \\\"/sites/d6fb4f96-xxxx-xxxx-xxxx-a8d7b85087ac/devices/209339xxxxxx/cmd\\\", \\\"data\\\": {\\\"session\\\": \\\"eec2b6e4-1e63-4f9f-9cf8-ef7f9632861e\\\", \\\"raw\\\": \\\"e-0/1/3.0             0                    0       \\\\n    corp                20:93:39:0f:62:00   D             -           xe-0/1/3.0             0                    0       \\\\n    ifo                 00:50:56:87:2d:42   D             -           xe-0/1/3.0 \\\"}}\"\n}\n...\n```"
      operationId: showSiteDeviceMacTable
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: All attributes are optional
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/utils_mac_table'
              - description: All attributes are optional
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/support:
    post:
      tags:
      - Utilities Common
      summary: uploadSiteDeviceSupportFile
      description: >-
        Support / Upload device support files


        #### Info Param

        | Name | Type | Description |

        | --- | --- | --- |

        | process | string | Upload 1 file with output of show system processes extensive |

        | outbound-ssh | string | Upload 1 file that concatenates all /var/log/outbound-ssh.log* files |

        | messages | string | Upload 1 to 10 /var/log/messages* files |

        | core-dumps | string | Upload all core dump files, if any. Uploads for all members of VC on switches.|

        | full | string | Upload 1 file with output of request support information, 1 file that concatenates all /var/log/outbound-ssh.log files, all core dump files, the 3 most recent /var/log/messages files, and Mist agent logs (for Junos devices running the Mist agent) |

        | var-logs | string | Upload all non-empty files in the /var/log/ directory |

        | jma-logs | string | Upload Mist agent logs (for Junos devices running the Mist agent only) |

        "
      operationId: uploadSiteDeviceSupportFile
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/utils_send_support_logs'
              - description: Request Body
                examples:
                - info: full
              contentMediaType: application/json
            examples:
              Example:
                value:
                  info: full
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Device not online
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/traceroute:
    post:
      tags:
      - Utilities Common
      summary: tracerouteFromDevice
      description: >-
        Traceroute can be performed from the Device.


        The output will be available through websocket. As there can be multiple commands issued against the same Device at the same time and the output all goes through the same websocket stream, session is introduced for demux.



        #### Subscribe to Device Command outputs


        `WS /api-ws/v1/stream`


        ```json

        {
            "subscribe": "/sites/{site_id}/devices/{device_id}/cmd"
        }

        ```



        #### Example output from ws stream

        ```json

        {
          "channel": "/sites/d6fb4f96-xxxx-xxxx-xxxx-xxxxxxxxxxxx/devices/00000000-0000-0000-1000-xxxxxxxxxxxx/cmd",
          "event": "data",
          "data": {
            "session": "9106e908-74dc-4a4f-9050-9c2adcaf44a5",
            "raw": "Running traceroute...\ntraceroute to 8.8.8.8, 64 hops max\n 0  192.168.1.1 1 ms  192.168.1.1 1 ms  192.168.1.1 1 ms\n 1  80.10.236.81 2 ms  80.10.236.81 4 ms  80.10.236.81 2 ms\n 2  193.253.80.250 3 ms  193.253.80.250 2 ms  193.253.80.250 2 ms\n 3  193.252.159.41 2 ms  193.252.159.41 1 ms  193.252.159.41 3 ms\n"
        }

        ```
      operationId: tracerouteFromDevice
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/utils_traceroute'
              - description: Request Body
                examples:
                - host: string
                  port: 33434
                  protocol: udp
              contentMediaType: application/json
            examples:
              Example:
                value:
                  host: string
                  port: 33434
                  protocol: udp
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/unlocate:
    post:
      tags:
      - Utilities Common
      summary: stopSiteLocateDevice
      description: Stop Locate a Device
      operationId: stopSiteLocateDevice
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/clear_arp:
    post:
      tags:
      - Utilities WAN
      summary: clearSiteSsrArpCache
      description: >-
        Clear ARP cache for SSR, SRX and Switch


        Clear the entire ARP cache or a subset if arguments are provided.


        *Note*: port_id is optional if neither vlan nor ip is specified
      operationId: clearSiteSsrArpCache
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/utils_clear_arp'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/clear_bgp:
    post:
      tags:
      - Utilities WAN
      summary: clearSiteSsrBgpRoutes
      description: Clear routes associated with one or all BGP neighbors
      operationId: clearSiteSsrBgpRoutes
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/utils_clear_bgp'
              - examples:
                - neighbor: all
                  type: in
                  vrf: TestVrf
              contentMediaType: application/json
            examples:
              Example:
                value:
                  neighbor: all
                  type: in
                  vrf: TestVrf
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/vnd.api+json
        '400':
          description: Parameter neighbor absent
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/clear_session:
    post:
      tags:
      - Utilities WAN
      summary: clearSiteDeviceSession
      description: Clear session
      operationId: clearSiteDeviceSession
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/utils_clear_session'
              - examples:
                - port_id: ge-0/0/1.10
              contentMediaType: application/json
            examples:
              Example:
                value:
                  port_id: ge-0/0/1.10
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/release_dhcp:
    post:
      tags:
      - Utilities WAN
      summary: releaseSiteSsrDhcpLease
      description: >-
        Releases an active DHCP lease.



        The output will be available through websocket.


        As there can be multiple commands issued against the same Device at the same

        time and the output all goes through the same websocket stream, session is

        introduced for demux.




        #### Subscribe to Device Command outputs



        `WS /api-ws/v1/stream`



        ```json


        { "subscribe": "/sites/{site_id}/devices/{device_id}/cmd" }


        ```




        #### Example output from ws stream



        ```json

        {
            "event": "data",
            "channel": "/sites/d6fb4f96-3ba4-4cf5-8af2-a8d7b85087ac/devices/00000000-0000-0000-1000-0200010edbca/cmd",
            "data": "{\"event\": \"data\", \"channel\": \"/sites/d6fb4f96-xxxx-xxxx-xxxx-a8d7b85087ac/devices/0200010edbca/cmd\",\"data\": {\"session\": \"356b2150-7307-4165-8411-52794c1ee8b0\",\"raw\": \"Releasing dhcp...\"}}"
        }

        {
            "event": "data",
            "channel": "/sites/d6fb4f96-3ba4-4cf5-8af2-a8d7b85087ac/devices/00000000-0000-0000-1000-0200010edbca/cmd",
            "data": "{\"event\": \"data\", \"channel\": \"/sites/d6fb4f96-xxxx-xxxx-xxxx-a8d7b85087ac/devices/0200010edbca/cmd\",\"data\": {\"session\": \"356b2150-7307-4165-8411-52794c1ee8b0\",\"raw\": \"Successfully released DHCP lease.\"}}"
        }

        ```
      operationId: releaseSiteSsrDhcpLease
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/utils_release_dhcp'
              - examples:
                - port_id: ge-0/0/1.10
              contentMediaType: application/json
            examples:
              Example:
                value:
                  port_id: ge-0/0/1.10
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/vnd.api+json
        '400':
          description: Parameter `port ` absent
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/resolve_dns:
    post:
      tags:
      - Utilities WAN
      summary: testSiteSsrDnsResolution
      description: "DNS resolutions are performed on the Device.\n\nThe output will be available through websocket. As there can be multiple commands issued against the same SSR at the same time and the output all goes through the same websocket stream, `session` is used for demux.\n \n #### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n    \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n##### Example output from ws stream\n```\n Router      | Hostname               | Resolved | Last Resolved        | Expiration\n-------------|------------------------|----------|----------------------|---------------------\n test-device | xxx.yyy.net            | Y        | 2022-03-28T03:56:49Z | 2022-03-28T03:57:49Z\n```"
      operationId: testSiteSsrDnsResolution
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/run_top:
    post:
      tags:
      - Utilities WAN
      summary: runSiteSrxTopCommand
      description: "Run top command on switches and SRX. The output will be available through websocket. \n\nAs there can be multiple commands issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n  \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```"
      operationId: runSiteSrxTopCommand
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session_with_url'
                - description: Response containing a WebSocket session handle and connection URL
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session_with_url'
                - description: Response containing a WebSocket session handle and connection URL
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/service_ping:
    post:
      tags:
      - Utilities WAN
      summary: servicePingFromSsr
      description: >-
        Ping from SSR


        Service Ping can be performed from the Device. The output will be available through websocket. As there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, session is introduced for demux.


        #### Subscribe to Device Command outputs

        `WS /api-ws/v1/stream`


        ```json

        {
            "subscribe": "/sites/{site_id}/devices/{device_id}/cmd"
        }

        ```

        ##### Example output from ws stream

        ```json

        {
            "event": "data",
            "channel": "/sites/4ac1dcf4-9d8b-7211-65c4-057819f0862b/devices/00000000-0000-0000-1000-5c5b350e0060/cmd",
            "data": {
                "session": "session_id",
                "raw": "64 bytes from 23.211.0.110: seq=8 ttl=58 time=12.323 ms\n"
            }
        }

        ```
      operationId: servicePingFromSsr
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/utils_service_ping'
              - description: Request Body
                examples:
                - count: 10
                  host: 1.1.1.1
                  service: web-session
              contentMediaType: application/json
            examples:
              Example:
                value:
                  count: 10
                  host: 1.1.1.1
                  service: web-session
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/show_ospf_database:
    post:
      tags:
      - Utilities WAN
      summary: showSiteGatewayOspfDatabase
      description: "Get OSPF Database from SSR and SRX. The output will be available through websocket. \n\nAs there can be multiple commands issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n  \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n\n#### Example output from ws stream\n```\n===== ==================== ========== ======= ======== ================ =================== =================\nVrf   Neighbor Router ID   Priority   State   Uptime   Dead Timer Due   Interface Address   Interface State\n===== ==================== ========== ======= ======== ================ =================== =================\n      1.0.0.3                     1   Full       852               38   172.16.3.2          Backup\n      1.0.0.4                     1   Full       811               33   172.16.3.2          DROther\n      1.0.0.3                     1   Full       852               38   172.16.4.2          Backup\n      1.0.0.4                     1   Full       811               34   172.16.4.2          DROther\n```"
      operationId: showSiteGatewayOspfDatabase
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: All attributes are optional
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/utils_show_ospf_database'
              - description: All attributes are optional
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/show_ospf_interfaces:
    post:
      tags:
      - Utilities WAN
      summary: showSiteGatewayOspfInterfaces
      description: "Get OSPF interfaces from SSR and SRX. The output will be available through websocket. \n\nAs there can be multiple commands issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n  \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n\n#### Example output from ws stream\n```\n===== ================== =================== ============== =============== =========== ========= ===========\nVrf   Device Interface   Network Interface   Interface Up   IP address      OSPF Type   Area ID   Area Type\n===== ================== =================== ============== =============== =========== ========= ===========\n      net1               g1                          True   172.16.1.2/24   Broadcast   0.0.0.0   default\n      net3               g3                          True   172.16.3.2/24   Broadcast   0.0.0.0   default\n      net4               g4                          True   172.16.4.2/24   Broadcast   0.0.0.4   default\n```"
      operationId: showSiteGatewayOspfInterfaces
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: All attributes are optional
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/utils_show_ospf_interfaces'
              - description: All attributes are optional
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/show_ospf_neighbors:
    post:
      tags:
      - Utilities WAN
      summary: showSiteGatewayOspfNeighbors
      description: "Get OSPF Neighbors from SSR and SRX. The output will be available through websocket. \n\nAs there can be multiple commands issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n  \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n\n#### Example output from ws stream\n```\n===== ==================== ========== ======= ======== ================ =================== =================\nVrf   Neighbor Router ID   Priority   State   Uptime   Dead Timer Due   Interface Address   Interface State\n===== ==================== ========== ======= ======== ================ =================== =================\n      1.0.0.3                     1   Full       852               38   172.16.3.2          Backup\n      1.0.0.4                     1   Full       811               33   172.16.3.2          DROther\n      1.0.0.3                     1   Full       852               38   172.16.4.2          Backup\n      1.0.0.4                     1   Full       811               34   172.16.4.2          DROther\n```"
      operationId: showSiteGatewayOspfNeighbors
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: All attributes are optional
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/utils_show_ospf_neighbors'
              - description: All attributes are optional
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/show_ospf_summary:
    post:
      tags:
      - Utilities WAN
      summary: showSiteGatewayOspfSummary
      description: "Get OSPF summary from SSR and SRX. The output will be available through websocket. \n\nAs there can be multiple commands issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n  \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n\n#### Example output from ws stream\n```\n===== =========== ========== ============= ==================== ========= =========== =============\nVrf   Router ID   ABR Type   ASBR Router   External LSA Count   Area ID   Area Type   Area Border\n                                                                                      Router\n===== =========== ========== ============= ==================== ========= =========== =============\n      1.0.0.2     cisco            False                    0   0.0.0.0\n      1.0.0.2     cisco            False                    0   0.0.0.4   default\n```"
      operationId: showSiteGatewayOspfSummary
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: All attributes are optional
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/utils_show_ospf_summary'
              - description: All attributes are optional
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/show_route:
    post:
      tags:
      - Utilities WAN
      summary: showSiteSsrAndSrxRoutes
      description: "Get routes from SSR, SRX and Switch. \n\nThe output will be available through websocket. As there can be multiple commands issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n    \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n##### Example output from ws stream\n```\nadmin@labsystem1.fiedler# show bgp neighbors\nBGP neighbor is 192.168.4.1, remote AS 4200000001, local AS 4200000128, external\nlink\n  BGP version 4, remote router ID 1.1.1.1\n  BGP state = Established, up for 00:27:25\n  Last read 00:00:25, hold time is 90, keepalive interval is 30 seconds\n  Configured hold time is 90, keepalive interval is 30 seconds\n  Neighbor capabilities:\n    4 Byte AS: advertised and received\n    Route refresh: advertised and received(old &amp; new)\n    Address family IPv4 Unicast: advertised and received\n    Graceful Restart Capability: advertised and received\n      Remote Restart timer is 120 seconds\n      Address families by peer:\n        none\n        ...\n```"
      operationId: showSiteSsrAndSrxRoutes
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: All attributes are optional
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/utils_show_route'
              - description: All attributes are optional
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/show_service_path:
    post:
      tags:
      - Utilities WAN
      summary: showSiteSsrServicePath
      description: >-
        Get service path information of the Device.



        The output will be available through websocket. As there can be multiple command

        issued against the same device at the same time and the output all goes through

        the same websocket stream, session is introduced for demux.




        #### Subscribe to Device Command outputs


        `WS /api-ws/v1/stream`



        ```json

        { "subscribe": "/sites/{site_id}/devices/{device_id}/cmd" }

        ```


        #### Example output from ws stream


        ```json

        {
              "channel": "/sites/d6fb4f96-xxxx-xxxx-xxxx-xxxxxxxxxxxx/devices/00000000-0000-0000-1000-xxxxxxxxxxxx/cmd",
              "event": "data",
              "data": {
                      "session": "5cb8a6db-d11a-42cd-bed7-19e9f29e637",
                      "raw": "{\"status\":\"SUCCESS\",\"finished\":true,\"rows\":[{\"service\":\"management\",\"type\":\"service-agent\",\"network_interface\":\"ge-0/0/0\",\"destination\":\"\",\"gateway_ip\":\"192.168.1.1\",\"vector\":\"\",\"cost\":0,\"rate\":0,\"state\":\"Up\",\"capacity\":\"0/unlimited\",\"meetsSLA\":\"Yes\"},{\"service\":\"management\",\"type\":\"service-agent\",\"network_interface\":\"ge-0/0/1\",\"destination\":\"\",\"gateway_ip\":\"192.168.0.1\",\"vector\":\"\",\"cost\":0,\"rate\":0,\"state\":\"Up\",\"capacity\":\"0/unlimited\",\"meetsSLA\":\"Yes\"}]}"
              }
        }

        ```
      operationId: showSiteSsrServicePath
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/utils_show_service_path'
              - examples:
                - node: node0
                  service_name: any
              contentMediaType: application/json
            examples:
              Example:
                value:
                  node: node0
                  service_name: any
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/show_session:
    post:
      tags:
      - Utilities WAN
      summary: showSiteSsrAndSrxSessions
      description: "Get active sessions passing through the Device.\n\n\nThe output will be available through websocket. As there can be multiple command\nissued against the same device at the same time and the output all goes through\nthe same websocket stream, session is introduced for demux.\n\n\n\n#### Subscribe to Device Command outputs\n\n`WS /api-ws/v1/stream`\n\n\n```json \n{ \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\" }\n```\n\n\n#### Example output from ws stream\n\n```json \n{\n      \"channel\": \"/sites/d6fb4f96-xxxx-xxxx-xxxx-xxxxxxxxxxxx/devices/00000000-0000-0000-1000-xxxxxxxxxxxx/cmd\",\n      \"event\": \"data\",\n      \"data\": {\n              \"session\": \"f517bf29-1141-41ae-a084-17cacb0ccb57\",\n              \"raw\": \"{\\\"status\\\":\\\"SUCCESS\\\",\\\"finished\\\":true,\\\"rows\\\":[{\\\"session_id\\\":\\\"a04b1cc7-dcc1-40a6-a010-0fe46ca38551\\\",\\\"direction\\\":\\\"forward\\\",\\\"service\\\":\\\"internet\\\",\\\"tenant\\\":\\\"SRV.PRD-Core\\\",\\\"device_interface\\\":\\\"ge-0/0/3\\\",\\\"network_interface\\\":\\\"ge-0/0/3.100\\\",\\\"protocol\\\":\\\"TCP\\\",\\\"source_ip\\\":\\\"10.3.20.101\\\",\\\"source_port\\\":45733,\\\"destination_ip\\\":\\\"13.38.46.35\\\",\\\"destination_port\\\":443,\\\"nat_ip\\\":\\\"192.168.1.115\\\",\\\"nat_port\\\":45256,\\\"payload_encrypted\\\":false,\\\"timeout\\\":1581,\\\"uptime\\\":319},{\\\"session_id\\\":\\\"a04b1cc7-dcc1-40a6-a010-0fe46ca38551\\\",\\\"direction\\\":\\\"reverse\\\",\\\"service\\\":\\\"internet\\\",\\\"tenant\\\":\\\"SRV.PRD-Core\\\",\\\"device_interface\\\":\\\"ge-0/0/0\\\",\\\"network_interface\\\":\\\"ge-0/0/0\\\",\\\"protocol\\\":\\\"TCP\\\",\\\"source_ip\\\":\\\"13.38.46.35\\\",\\\"source_port\\\":443,\\\"destination_ip\\\":\\\"192.168.1.115\\\",\\\"destination_port\\\":45256,\\\"nat_ip\\\":\\\"0.0.0.0\\\",\\\"nat_port\\\":0,\\\"payload_encrypted\\\":false,\\\"timeout\\\":1581,\\\"uptime\\\":319}]}\\n\"\n      }\n}\n```"
      operationId: showSiteSsrAndSrxSessions
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/utils_show_session'
              - examples:
                - node: node0
                  service_name: any
              contentMediaType: application/json
            examples:
              Example:
                value:
                  node: node0
                  service_name: any
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/wired_clients/{client_mac}/coa:
    post:
      tags:
      - Utilities LAN
      summary: reauthOrgDot1xWiredClient
      description: Trigger a CoA (change of authorization) against a Wired client
      operationId: reauthOrgDot1xWiredClient
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: client_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      responses:
        '200':
          description: Reauth Wired Client
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_wired_coa'
                - description: Response returned after triggering wired client CoA reauthentication
                  examples:
                  - device_mac: 5c5b35000002
                    port_id: ge-0/0/0
                    session: 0a2a11b8-4b30-40d8-a6d1-e91ea540d86f
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    device_mac: 5c5b35000002
                    port_id: ge-0/0/0
                    session: 0a2a11b8-4b30-40d8-a6d1-e91ea540d86f
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_wired_coa'
                - description: Response returned after triggering wired client CoA reauthentication
                  examples:
                  - device_mac: 5c5b35000002
                    port_id: ge-0/0/0
                    session: 0a2a11b8-4b30-40d8-a6d1-e91ea540d86f
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    device_mac: 5c5b35000002
                    port_id: ge-0/0/0
                    session: 0a2a11b8-4b30-40d8-a6d1-e91ea540d86f
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/clear_pending_version:
    post:
      tags:
      - Utilities LAN
      summary: clearSiteMultipleDevicePendingVersion
      description: Clear device pending fw version (Available on Junos OS EX2300-, EX3400-, EX4000-, EX4100-, EX4400- devices)
      operationId: clearSiteMultipleDevicePendingVersion
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/devices_ids'
              - description: Request Body
                examples:
                - device_ids:
                  - 00000000-0000-0000-1000-5c5b35584a6f
                  - 00000000-0000-0000-1000-5c5b350ea3b3
              contentMediaType: application/json
            examples:
              Example:
                value:
                  device_ids:
                  - 00000000-0000-0000-1000-5c5b35584a6f
                  - 00000000-0000-0000-1000-5c5b350ea3b3
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                type: string
                examples:
                - cannot clear pending version on an offline device
                - clear-pending-fw-version not supported
                contentMediaType: application/json
              examples:
                cannot-clear-pending-version-on-an-offline-device:
                  value: cannot clear pending version on an offline device
                clear-pending-version-not-supported:
                  value: clear-pending-fw-version not supported
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/restore_backup_version:
    post:
      tags:
      - Utilities LAN
      summary: restoreSiteMultipleDeviceBackupVersion
      description: Restore device backup fw version (Available on Junos OS EX4000-, EX4100-, EX4400- devices)
      operationId: restoreSiteMultipleDeviceBackupVersion
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/devices_ids'
              - description: Request Body
                examples:
                - device_ids:
                  - 00000000-0000-0000-1000-5c5b35584a6f
                  - 00000000-0000-0000-1000-5c5b350ea3b3
              contentMediaType: application/json
            examples:
              Example:
                value:
                  device_ids:
                  - 00000000-0000-0000-1000-5c5b35584a6f
                  - 00000000-0000-0000-1000-5c5b350ea3b3
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                type: string
                examples:
                - snapshot not supported
                - cannot snapshot an offline device
                contentMediaType: application/json
              examples:
                cannot-restore-backup-version-on-an-offline-device:
                  value: snapshot not supported
                restore-backup-fw-version-not-supported:
                  value: cannot snapshot an offline device
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/upgrade_bios:
    post:
      tags:
      - Utilities LAN
      summary: upgradeSiteDevicesBios
      description: Upgrade Bios on Multiple Device
      operationId: upgradeSiteDevicesBios
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/upgrade_bios_multi'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/upgrade_fpga:
    post:
      tags:
      - Utilities LAN
      summary: upgradeSiteDevicesFpga
      description: Upgrade Bios on Multiple Device
      operationId: upgradeSiteDevicesFpga
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/upgrade_fpga_multi'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/cable_test:
    post:
      tags:
      - Utilities LAN
      summary: cableTestFromSwitch
      description: >-
        TDR can be performed from the Switch. The output will be available through websocket. As there can be multiple commands issued against the same Switch at the same time and the output all goes through the same websocket stream, session is introduced for demux.


        #### Subscribe to Device Command outputs

        `WS /api-ws/v1/stream`


        ```json

        {
            "subscribe": "/sites/{site_id}/devices/{device_id}/cmd"
        }

        ```

        ##### Example output from ws stream

        ```json

        {
            "event": "data",
            "channel": "/sites/4ac1dcf4-9d8b-7211-65c4-057819f0862b/devices/00000000-0000-0000-1000-5c5b350e0060/cmd",
            "data": {
                "session": "session_id",
                "raw": "Interface TDR detail:\nTest status : Test successfully executed  ge-0/0/0\n"
            }
        }

        ```
      operationId: cableTestFromSwitch
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/utils_cable_tests'
              - examples:
                - port: ge-0/0/0
              contentMediaType: application/json
            examples:
              Example:
                value:
                  port: ge-0/0/0
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/clear_bpdu_error:
    post:
      tags:
      - Utilities LAN
      summary: clearBpduErrorsFromPortsOnSwitch
      description: Clear bridge protocol data unit (BPDU) error condition caused by the detection of a possible bridging loop from Spanning Tree Protocol (STP) operation that renders the port unoperational.
      operationId: clearBpduErrorsFromPortsOnSwitch
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/utils_clear_bpdu'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Ports not specified
          headers: {}
          content: {}
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/clear_dot1x:
    post:
      tags:
      - Utilities LAN
      summary: clearSiteDeviceDot1xSession
      description: Clear Dot1x Session. The output will be available through websocket.
      operationId: clearSiteDeviceDot1xSession
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/clear_dot1x_session'
              - description: Request Body
                examples:
                - ports:
                  - ge-0/0/0
              contentMediaType: application/json
            examples:
              Example:
                value:
                  ports:
                  - ge-0/0/0
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/clear_macs:
    post:
      tags:
      - Utilities LAN
      summary: clearAllLearnedMacsFromPortOnSwitch
      description: Clear all learned MAC addresses, including persistent MAC addresses, on a port.
      operationId: clearAllLearnedMacsFromPortOnSwitch
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/utils_clear_macs'
              - examples:
                - ports:
                  - ge-0/0/0.0
              contentMediaType: application/json
            examples:
              Example:
                value:
                  ports:
                  - ge-0/0/0.0
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/clear_pending_version:
    post:
      tags:
      - Utilities LAN
      summary: clearSiteDevicePendingVersion
      description: Clear device pending fw version (Available on Junos OS EX2300-, EX3400-, EX4000-, EX4100-, EX4400- devices)
      operationId: clearSiteDevicePendingVersion
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                type: string
                examples:
                - cannot clear pending version on an offline device
                - clear-pending-fw-version not supported
                contentMediaType: application/json
              examples:
                cannot-clear-pending-version-on-an-offline-device:
                  value: cannot clear pending version on an offline device
                clear-pending-version-not-supported:
                  value: clear-pending-fw-version not supported
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/flow_records/search:
    get:
      tags:
      - Utilities LAN
      summary: searchSiteDeviceFlowRecords
      description: >-
        Search network flow records for a specific device within a site.

        Note: Only supported for switch devices. The device must be manageable. The `device_mac` is automatically scoped to the device in the URL path and cannot be overridden by query parameter.
      operationId: searchSiteDeviceFlowRecords
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: sort
        in: query
        description: On which field the list should be sorted, -prefix represents DESC order
        style: form
        explode: true
        schema:
          type: string
          default: timestamp
          examples:
          - -site_id
      - name: src_ip
        in: query
        description: Source IP address
        style: form
        explode: true
        schema:
          type: string
      - name: dst_ip
        in: query
        description: Destination IP address
        style: form
        explode: true
        schema:
          type: string
      - name: src_port
        in: query
        description: Source port
        style: form
        explode: true
        schema:
          type: string
      - name: dst_port
        in: query
        description: Destination port
        style: form
        explode: true
        schema:
          type: string
      - name: protocol
        in: query
        description: Protocol (e.g. `tcp`, `udp`, `icmp`)
        style: form
        explode: true
        schema:
          type: string
      - name: state
        in: query
        description: Flow state
        style: form
        explode: true
        schema:
          type: string
      - name: direction
        in: query
        description: Flow direction
        style: form
        explode: true
        schema:
          type: string
      - name: search_after
        in: query
        description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_device_flow_records_search'
                - description: Paginated response for device flow record search results
                  examples:
                  - end: 1775003600
                    limit: 1000
                    results:
                    - device_mac: 5c5b350e020a
                      direction: ingress
                      dst_ip: 8.8.8.8
                      dst_port: 443
                      duration: 60
                      end_time: 1775000060
                      flow_id: 12345
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      protocol: tcp
                      sampling_percentage: 0.1
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      src_ip: 10.0.0.1
                      src_port: 54321
                      start_time: 1775000000
                      state: aged-out
                      timestamp: 1775000060
                      total_bytes: 150000
                      total_pkts: 100
                    start: 1775000000
                    total: 1
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1775003600
                    limit: 1000
                    results:
                    - device_mac: 5c5b350e020a
                      direction: ingress
                      dst_ip: 8.8.8.8
                      dst_port: 443
                      duration: 60
                      end_time: 1775000060
                      flow_id: 12345
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      protocol: tcp
                      sampling_percentage: 0.1
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      src_ip: 10.0.0.1
                      src_port: 54321
                      start_time: 1775000000
                      state: aged-out
                      timestamp: 1775000060
                      total_bytes: 150000
                      total_pkts: 100
                    start: 1775000000
                    total: 1
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_device_flow_records_search'
                - description: Paginated response for device flow record search results
                  examples:
                  - end: 1775003600
                    limit: 1000
                    results:
                    - device_mac: 5c5b350e020a
                      direction: ingress
                      dst_ip: 8.8.8.8
                      dst_port: 443
                      duration: 60
                      end_time: 1775000060
                      flow_id: 12345
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      protocol: tcp
                      sampling_percentage: 0.1
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      src_ip: 10.0.0.1
                      src_port: 54321
                      start_time: 1775000000
                      state: aged-out
                      timestamp: 1775000060
                      total_bytes: 150000
                      total_pkts: 100
                    start: 1775000000
                    total: 1
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1775003600
                    limit: 1000
                    results:
                    - device_mac: 5c5b350e020a
                      direction: ingress
                      dst_ip: 8.8.8.8
                      dst_port: 443
                      duration: 60
                      end_time: 1775000060
                      flow_id: 12345
                      org_id: 2818e386-8dec-2562-9ede-5b8a0fbbdc71
                      protocol: tcp
                      sampling_percentage: 0.1
                      site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
                      src_ip: 10.0.0.1
                      src_port: 54321
                      start_time: 1775000000
                      state: aged-out
                      timestamp: 1775000060
                      total_bytes: 150000
                      total_pkts: 100
                    start: 1775000000
                    total: 1
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/poll_stats:
    post:
      tags:
      - Utilities LAN
      summary: pollSiteSwitchStats
      description: This API can be used to poll statistics from the Switch proactively once. After it is called, the statistics will be pushed back to the cloud within the statistics interval.
      operationId: pollSiteSwitchStats
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/restore_backup_version:
    post:
      tags:
      - Utilities LAN
      summary: restoreSiteDeviceBackupVersion
      description: Restore device backup fw version (Available on Junos OS EX4000-, EX4100-, EX4400- devices)
      operationId: restoreSiteDeviceBackupVersion
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                type: string
                examples:
                - cannot restore backup version on an offline device
                - restore-backup-fw-version not supported
                contentMediaType: application/json
              examples:
                cannot-restore-backup-version-on-an-offline-device:
                  value: cannot restore backup version on an offline device
                restore-backup-fw-version-not-supported:
                  value: restore-backup-fw-version not supported
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/show_arp:
    post:
      tags:
      - Utilities LAN
      summary: showSiteDeviceArpTable
      description: >
        Get ARP Table from the Device.


        The output will be available through websocket. As there can be multiple commands issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.


        #### Subscribe to Device Command outputs

        `WS /api-ws/v1/stream`


        ```json

        {
            "subscribe": "/sites/{site_id}/devices/{device_id}/cmd"
        }

        ```
      operationId: showSiteDeviceArpTable
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: All attributes are optional
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/utils_show_arp'
              - description: All attributes are optional
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/websocket_session'
                - description: Response containing the WebSocket session handle for asynchronous command output
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/snapshot:
    post:
      tags:
      - Utilities LAN
      summary: createSiteDeviceSnapshot
      description: Create recovery device snapshot (Available on Junos OS EX2300-, EX3400-, EX4400- devices)
      operationId: createSiteDeviceSnapshot
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                type: string
                examples:
                - cannot snapshot an offline device
                - snapshot not supported
                contentMediaType: application/json
              examples:
                cannot-snapshot-an-offline-device:
                  value: cannot snapshot an offline device
                snapshot-not-supported:
                  value: snapshot not supported
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/upgrade_bios:
    post:
      tags:
      - Utilities LAN
      summary: upgradeDeviceBios
      description: Upgrade device bios
      operationId: upgradeDeviceBios
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/upgrade_bios'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_device_bios_upgrade'
                - description: Device BIOS upgrade status response
                  examples:
                  - status: inprogress
                    timestamp: 1428949501
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    status: inprogress
                    timestamp: 1428949501
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_device_bios_upgrade'
                - description: Device BIOS upgrade status response
                  examples:
                  - status: inprogress
                    timestamp: 1428949501
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    status: inprogress
                    timestamp: 1428949501
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/upgrade_fpga:
    post:
      tags:
      - Utilities LAN
      summary: upgradeDeviceFPGA
      description: Upgrade device fpga
      operationId: upgradeDeviceFPGA
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/upgrade_fpga'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_device_bios_upgrade'
                - description: Device BIOS upgrade status response
                  examples:
                  - status: inprogress
                    timestamp: 1428949501
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    status: inprogress
                    timestamp: 1428949501
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_device_bios_upgrade'
                - description: Device BIOS upgrade status response
                  examples:
                  - status: inprogress
                    timestamp: 1428949501
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    status: inprogress
                    timestamp: 1428949501
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/vc/switch_master:
    post:
      tags:
      - Utilities LAN
      summary: toogleSiteDeviceVcRoutingEnginesRole
      description: In a pre-provisioned VC, mastership is system-determined. This command allows manual toggling between primary and backup Routing Engines.
      operationId: toogleSiteDeviceVcRoutingEnginesRole
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                type: string
                examples:
                - backup routing engine is not present
                - The device is not an OC device
                - Non-provisioned VC is not supported currently
                - VC is currently disconnected
                contentMediaType: application/json
              examples:
                backup-re-not-present:
                  value: backup routing engine is not present
                device-is-not-an-oc-device:
                  value: The device is not an OC device
                non-provisioned-vc-not-supported:
                  value: Non-provisioned VC is not supported currently
                vc-is-currently-disconnected:
                  value: VC is currently disconnected
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/wired_clients/{client_mac}/coa:
    post:
      tags:
      - Utilities LAN
      summary: reauthSiteDot1xWiredClient
      description: Trigger a CoA (change of authorization) against a Wired client
      operationId: reauthSiteDot1xWiredClient
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: client_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      responses:
        '200':
          description: Reauth Wired Client
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_wired_coa'
                - description: Response returned after triggering wired client CoA reauthentication
                  examples:
                  - device_mac: 5c5b35000002
                    port_id: ge-0/0/0
                    session: 0a2a11b8-4b30-40d8-a6d1-e91ea540d86f
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    device_mac: 5c5b35000002
                    port_id: ge-0/0/0
                    session: 0a2a11b8-4b30-40d8-a6d1-e91ea540d86f
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_wired_coa'
                - description: Response returned after triggering wired client CoA reauthentication
                  examples:
                  - device_mac: 5c5b35000002
                    port_id: ge-0/0/0
                    session: 0a2a11b8-4b30-40d8-a6d1-e91ea540d86f
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    device_mac: 5c5b35000002
                    port_id: ge-0/0/0
                    session: 0a2a11b8-4b30-40d8-a6d1-e91ea540d86f
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/clients/{client_mac}/coa:
    post:
      tags:
      - Utilities Wi-Fi
      summary: reauthOrgDot1xWirelessClient
      description: Trigger a CoA (change of authorization) against a client
      operationId: reauthOrgDot1xWirelessClient
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: client_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/clients/disconnect:
    post:
      tags:
      - Utilities Wi-Fi
      summary: disconnectSiteMultipleClients
      description: To unauthorize multiple clients
      operationId: disconnectSiteMultipleClients
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              uniqueItems: true
              type: array
              items:
                type: string
              description: Request Body
              examples:
              - - 5c5b350e0001
                - 5c5b350e0003
              contentMediaType: application/json
            examples:
              Example:
                value:
                - 5c5b350e0001
                - 5c5b350e0003
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/clients/unauthorize:
    post:
      tags:
      - Utilities Wi-Fi
      summary: unauthorizeSiteMultipleClients
      description: This unauthorize clients (if they are guest) and disconnect them. From the guest’s perspective, they will see the splash page again and go through the flow (e.g. Terms of Use) again.
      operationId: unauthorizeSiteMultipleClients
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/mac_addresses'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/clients/{client_mac}/coa:
    post:
      tags:
      - Utilities Wi-Fi
      summary: reauthSiteDot1xWirelessClient
      description: Trigger a CoA (change of authorization) against a Wireless client
      operationId: reauthSiteDot1xWirelessClient
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: client_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/clients/{client_mac}/disconnect:
    post:
      tags:
      - Utilities Wi-Fi
      summary: disconnectSiteWirelessClient
      description: This disconnect a client (and it’s likely to connect back)
      operationId: disconnectSiteWirelessClient
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: client_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/clients/{client_mac}/unauthorize:
    post:
      tags:
      - Utilities Wi-Fi
      summary: unauthorizeSiteWirelessClient
      description: This unauthorize a client (if it’s a guest) and disconnect it. From the guest’s perspective, s/he will see the splash page again and go through the flow (e.g. Terms of Use) again.
      operationId: unauthorizeSiteWirelessClient
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: client_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/reprovision:
    post:
      tags:
      - Utilities Wi-Fi
      summary: reprovisionSiteAllDevices
      description: To force all Devices to reprovision itself again.
      operationId: reprovisionSiteAllDevices
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/reset_radio_config:
    post:
      tags:
      - Utilities Wi-Fi
      summary: resetSiteAllApsToUseRrm
      description: Reset all APs in the Site to use RRM
      operationId: resetSiteAllApsToUseRrm
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/utils_reset_radio_config'
              - description: Request Body
                examples:
                - bands:
                  - '24'
                  - '5'
                  - '6'
                  force: false
              contentMediaType: application/json
            examples:
              Example:
                value:
                  bands:
                  - '24'
                  - '5'
                  - '6'
                  force: false
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/zeroize:
    post:
      tags:
      - Utilities Wi-Fi
      summary: zeroizeSiteFipsAllAps
      description: Zeroize all FIPS APs in the Site
      operationId: zeroizeSiteFipsAllAps
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/utils_zeroize_fips'
              - description: Request Body
                examples:
                - password: NUKETHESITE
              contentMediaType: application/json
            examples:
              Example:
                value:
                  password: NUKETHESITE
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/rogues/{rogue_bssid}/deauth_clients:
    post:
      tags:
      - Utilities Wi-Fi
      summary: deauthSiteWirelessClientsConnectedToARogue
      description: Send Deauth frame to clients connected to a Rogue AP
      operationId: deauthSiteWirelessClientsConnectedToARogue
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: rogue_bssid
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/rrm/optimize:
    post:
      tags:
      - Utilities Wi-Fi
      summary: optimizeSiteRrm
      description: Optimize Site RRM
      operationId: optimizeSiteRrm
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/utils_rrm_optimize'
              - description: Request Body
                examples:
                - bands:
                  - '24'
                  - '5'
                  - '6'
              contentMediaType: application/json
            examples:
              Example:
                value:
                  bands:
                  - '24'
                  - '5'
                  - '6'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/utils/test_smsglobal:
    post:
      tags:
      - Utilities Wi-Fi
      summary: testSiteWlanSmsGlobal
      description: >-
        Allows validation of Global sms gateway credentials.


        In case of success, a text message confirming successful setup should be received. In case of error, smsglobal error message are returned.
      operationId: testSiteWlanSmsGlobal
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/test_sms_global'
              - examples:
                - smsglobal_api_key: '123456'
                  smsglobal_api_secret: abcdef
                  smsglobal_sender: '61400000002'
                  to: '+911122334455'
              contentMediaType: application/json
            examples:
              Example:
                value:
                  smsglobal_api_key: '123456'
                  smsglobal_api_secret: abcdef
                  smsglobal_sender: '61400000002'
                  to: '+911122334455'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/utils/test_telstra:
    post:
      tags:
      - Utilities Wi-Fi
      summary: testSiteWlanTelstraSetup
      description: >-
        Allows validation of Telstra sms gateway credentials.


        In case of success, a text message confirming successful setup should be received. In case of error, telstra error message are returned.
      operationId: testSiteWlanTelstraSetup
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/test_telstra'
              - examples:
                - telstra_client_id: '123456'
                  telstra_client_secret: abcdef
                  to: '+911122334455'
              contentMediaType: application/json
            examples:
              Example:
                value:
                  telstra_client_id: '123456'
                  telstra_client_secret: abcdef
                  to: '+911122334455'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/utils/test_twilio:
    post:
      tags:
      - Utilities Wi-Fi
      summary: testSiteWlanTwilioSetup
      description: >-
        Allows validation of twilio setup

        In case of success, a text message confirming successful setup should be received. In case of error, twilio error code and message are returned.
      operationId: testSiteWlanTwilioSetup
      parameters: []
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/test_twilio'
              - description: Request Body
                examples:
                - from: '+185051234567'
                  to: '+19999999999'
                  twilio_auth_token: 2135be04736a1a0a314bce432d61721a
                  twilio_sid: REDACTED_TWILIO_ACCOUNT_SID
              contentMediaType: application/json
            examples:
              Example:
                value:
                  from: '+185051234567'
                  to: '+19999999999'
                  twilio_auth_token: 2135be04736a1a0a314bce432d61721a
                  twilio_sid: REDACTED_TWILIO_ACCOUNT_SID
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/pcaps:
    get:
      tags:
      - Utilities PCAPs
      summary: listOrgPacketCaptures
      description: List organization packet capture sessions and generated capture files for the selected time range.
      operationId: listOrgPacketCaptures
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_pcap_search'
                - description: Paginated response for packet capture search results
                  examples:
                  - end: 1461089816
                    limit: 100
                    next: /api/v1/sites/67970e46-4e12-11e6-9188-0242ac110007/pcaps?start=1461099816&search_after=%5B1694537121217%5D&limit=100&end=1461089816
                    results:
                    - ap_macs:
                      - 5c5b35000010
                      timestamp: 1461869041
                      type: new_assoc
                      url: https://...
                    - duration: 9999
                      format: stream
                      id: 80cec4c9-322c-4712-95ce-6ba47fb54fc0
                      last_seen: 1693482149.417
                      mxedges:
                      - 00000000-0000-0000-1000-001122334455
                      org_id: 78c11da8-f984-4425-bedb-a7ddd7d0f6da
                      pcap_url: https://...
                      site_id: null
                      termination_reason: default
                      timestamp: 1693525333.234066
                      type: mxedge
                      url: https://...
                    start: 1461099816
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1461089816
                    limit: 100
                    next: /api/v1/sites/67970e46-4e12-11e6-9188-0242ac110007/pcaps?start=1461099816&search_after=%5B1694537121217%5D&limit=100&end=1461089816
                    results:
                    - ap_macs:
                      - 5c5b35000010
                      timestamp: 1461869041
                      type: new_assoc
                      url: https://...
                    - duration: 9999
                      format: stream
                      id: 80cec4c9-322c-4712-95ce-6ba47fb54fc0
                      last_seen: 1693482149.417
                      mxedges:
                      - 00000000-0000-0000-1000-001122334455
                      org_id: 78c11da8-f984-4425-bedb-a7ddd7d0f6da
                      pcap_url: https://...
                      site_id: null
                      termination_reason: default
                      timestamp: 1693525333.234066
                      type: mxedge
                      url: https://...
                    start: 1461099816
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_pcap_search'
                - description: Paginated response for packet capture search results
                  examples:
                  - end: 1461089816
                    limit: 100
                    next: /api/v1/sites/67970e46-4e12-11e6-9188-0242ac110007/pcaps?start=1461099816&search_after=%5B1694537121217%5D&limit=100&end=1461089816
                    results:
                    - ap_macs:
                      - 5c5b35000010
                      timestamp: 1461869041
                      type: new_assoc
                      url: https://...
                    - duration: 9999
                      format: stream
                      id: 80cec4c9-322c-4712-95ce-6ba47fb54fc0
                      last_seen: 1693482149.417
                      mxedges:
                      - 00000000-0000-0000-1000-001122334455
                      org_id: 78c11da8-f984-4425-bedb-a7ddd7d0f6da
                      pcap_url: https://...
                      site_id: null
                      termination_reason: default
                      timestamp: 1693525333.234066
                      type: mxedge
                      url: https://...
                    start: 1461099816
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1461089816
                    limit: 100
                    next: /api/v1/sites/67970e46-4e12-11e6-9188-0242ac110007/pcaps?start=1461099816&search_after=%5B1694537121217%5D&limit=100&end=1461089816
                    results:
                    - ap_macs:
                      - 5c5b35000010
                      timestamp: 1461869041
                      type: new_assoc
                      url: https://...
                    - duration: 9999
                      format: stream
                      id: 80cec4c9-322c-4712-95ce-6ba47fb54fc0
                      last_seen: 1693482149.417
                      mxedges:
                      - 00000000-0000-0000-1000-001122334455
                      org_id: 78c11da8-f984-4425-bedb-a7ddd7d0f6da
                      pcap_url: https://...
                      site_id: null
                      termination_reason: default
                      timestamp: 1693525333.234066
                      type: mxedge
                      url: https://...
                    start: 1461099816
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/pcaps/capture:
    delete:
      tags:
      - Utilities PCAPs
      summary: stopOrgPacketCapture
      description: Stop the currently running organization packet capture and end its websocket output stream.
      operationId: stopOrgPacketCapture
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Utilities PCAPs
      summary: getOrgCapturingStatus
      description: Retrieve the current organization packet capture status, including active capture targets and progress.
      operationId: getOrgCapturingStatus
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_pcap_status'
                - description: Current status of a packet capture session
                  examples:
                  - aps:
                    - 5c5b350e001c
                    - 5c5b350e001b
                    client_mac: 60a10a773412
                    duration: 300
                    failed: []
                    id: a9a84e13-a714-b1eb-152f-a434416217d5
                    includes_mcast: false
                    max_pkt_len: 128
                    num_packets: 1000
                    ok:
                    - 5c5b350e001c
                    - 5c5b350e001b
                    started_time: 1435080709
                    type: client
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    aps:
                    - 5c5b350e001c
                    - 5c5b350e001b
                    client_mac: 60a10a773412
                    duration: 300
                    failed: []
                    id: a9a84e13-a714-b1eb-152f-a434416217d5
                    includes_mcast: false
                    max_pkt_len: 128
                    num_packets: 1000
                    ok:
                    - 5c5b350e001c
                    - 5c5b350e001b
                    started_time: 1435080709
                    type: client
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_pcap_status'
                - description: Current status of a packet capture session
                  examples:
                  - aps:
                    - 5c5b350e001c
                    - 5c5b350e001b
                    client_mac: 60a10a773412
                    duration: 300
                    failed: []
                    id: a9a84e13-a714-b1eb-152f-a434416217d5
                    includes_mcast: false
                    max_pkt_len: 128
                    num_packets: 1000
                    ok:
                    - 5c5b350e001c
                    - 5c5b350e001b
                    started_time: 1435080709
                    type: client
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    aps:
                    - 5c5b350e001c
                    - 5c5b350e001b
                    client_mac: 60a10a773412
                    duration: 300
                    failed: []
                    id: a9a84e13-a714-b1eb-152f-a434416217d5
                    includes_mcast: false
                    max_pkt_len: 128
                    num_packets: 1000
                    ok:
                    - 5c5b350e001c
                    - 5c5b350e001b
                    started_time: 1435080709
                    type: client
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Utilities PCAPs
      summary: startOrgPacketCapture
      description: "Start an organization-level packet capture for org-level Mist Edges\n\n**NOTE**: For packet captures of org level Mist Edges only. Use [Start Site Packet Capture]($e/Utilities%20PCAPs/startSitePacketCapture) for site level Mist Edges. \n\nThe output will be available through websocket. As there can be multiple commands issued against the same AP at the same time and the output all goes through the same websocket stream, session is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n    \"subscribe\": \"/orgs/:org_id/pcaps\"\n}\n```\n#### Response (MxEdge)\n```json\n{\n  \"event\": \"data\"\n  \"channel\": \"/orgs/67970e46-4e12-11e6-9188-0242ac110007/pcaps\"\n  \"data\": {\n      \"capture_id\": \"f039b1b4-a23e-48b2-906a-0da40524de73\", \n      \"pcap_dict\": {\n          \"dst_mac\": \"68:ec:c5:09:2e:87\",\n          \"src_mac\": \"8c:3b:ad:e0:47:40\", \n          \"vlan\": 1, \n          \"src_ip\": \"34.224.147.117\", \n          \"dst_ip\": \"192.168.1.55\",\n          \"dst_port\": 51635, \n          \"src_port\": 443,\n          \"protocol\": \"TCP\", \n          \"mxedge_id\": \"00000000-0000-0000-1000-001122334455\",\n          \"direction\": \"tx\", \n          \"timestamp\": 1652247615, \n          \"length\": 159.0, \n          \"lost_messages\": 0,\n          \"interface\": \"port0\",\n          \"info\": \"1652247616.007409 IP ec2-34-224-147-117.compute-1.amazonaws.com.https > ip-192-168-1-55.ec2.internal.51635: Flags [P.], seq \\n                    2192123968:2192124057, ack 4035166782, win 12, options [nop,nop,TS val 597467050 ecr 740580660], length 89\\\\n\",\n          }, \n      \"pcap_raw\": \"1MOyoQIABAAAAAAAAAAAAP//AAABAAAAQEx7YhMzAACfAAAAnwAAAGjsxQkuh4w7reBHQIEAAAEIAEUAAI1bLEAAKAZ/CiLgk3XAqAE3AbvJs4KpKEDwg8I+gBgADFf9AAABAQgKI5yfqiwkXTQXAwMAVKY5JopoKQrVEn0/3ld4YntctGEH/rTZuwtCvzSncFw71QJveJi9uxHs57KC8w9Apph3YvXJrmWg7M37+o+YV0KH/xmr626s5Bkhb3QhKOu+NoNEmA==\"\n    }\n}\n```\n#### Stop Response\n```json\n{\n  \"event\": \"data\"\n  \"channel\": \"/orgs/67970e46-4e12-11e6-9188-0242ac110007/pcaps\"\n  \"data\": {\n      \"capture_id\": \"a2f7374d-6a70-41fd-8a3f-71e42573baaf\",\n      \"pcap_dict\": null\n  }\n}\n```"
      operationId: startOrgPacketCapture
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/capture_org'
              - description: Request Body
                examples:
                - duration: 600
                  format: stream
                  max_pkt_len: 1500
                  mxedges:
                    00000000-0000-0000-1000-001122334455:
                      interfaces:
                        port1:
                          tcpdump_expression: udp port 67 or udp port 68
                  num_packets: 100
                  type: mxedge
              contentMediaType: application/json
            examples:
              MxEdge-Packet-Capture:
                value:
                  duration: 600
                  format: stream
                  max_pkt_len: 1500
                  mxedges:
                    00000000-0000-0000-1000-001122334455:
                      interfaces:
                        port1:
                          tcpdump_expression: udp port 67 or udp port 68
                  num_packets: 100
                  type: mxedge
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_pcap_start'
                - description: Packet capture session created by a start request
                  examples:
                  - ap_count: 3
                    aps: []
                    duration: 600
                    enabled: true
                    expiry: 1614886726.5411825
                    format: stream
                    id: a9a84e13-a714-b1eb-152f-a434416217d5
                    include_mcast: false
                    max_pkt_len: 68
                    num_packets: 100
                    org_id: a9346fba-f920-e99a-cc51-2e8dcc57fa3c
                    raw: true
                    site_id: 67970e46-4e12-11e6-9188-0242ac110007
                    ssid: ''
                    timestamp: 1614886126.5411825
                    type: radiotap
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    ap_count: 3
                    aps: []
                    duration: 600
                    enabled: true
                    expiry: 1614886726.5411825
                    format: stream
                    id: a9a84e13-a714-b1eb-152f-a434416217d5
                    include_mcast: false
                    max_pkt_len: 68
                    num_packets: 100
                    org_id: a9346fba-f920-e99a-cc51-2e8dcc57fa3c
                    raw: true
                    site_id: 67970e46-4e12-11e6-9188-0242ac110007
                    ssid: ''
                    timestamp: 1614886126.5411825
                    type: radiotap
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_pcap_start'
                - description: Packet capture session created by a start request
                  examples:
                  - ap_count: 3
                    aps: []
                    duration: 600
                    enabled: true
                    expiry: 1614886726.5411825
                    format: stream
                    id: a9a84e13-a714-b1eb-152f-a434416217d5
                    include_mcast: false
                    max_pkt_len: 68
                    num_packets: 100
                    org_id: a9346fba-f920-e99a-cc51-2e8dcc57fa3c
                    raw: true
                    site_id: 67970e46-4e12-11e6-9188-0242ac110007
                    ssid: ''
                    timestamp: 1614886126.5411825
                    type: radiotap
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    ap_count: 3
                    aps: []
                    duration: 600
                    enabled: true
                    expiry: 1614886726.5411825
                    format: stream
                    id: a9a84e13-a714-b1eb-152f-a434416217d5
                    include_mcast: false
                    max_pkt_len: 68
                    num_packets: 100
                    org_id: a9346fba-f920-e99a-cc51-2e8dcc57fa3c
                    raw: true
                    site_id: 67970e46-4e12-11e6-9188-0242ac110007
                    ssid: ''
                    timestamp: 1614886126.5411825
                    type: radiotap
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/pcaps:
    get:
      tags:
      - Utilities PCAPs
      summary: listSitePacketCaptures
      description: List packet captures for a site, optionally filtered by client MAC address and time range. Use [List Org Packet Captures]($e/Utilities%20PCAPs/listOrgPacketCaptures) to retrieve packet captures across the organization.
      operationId: listSitePacketCaptures
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: client_mac
        in: query
        description: Optional client mac filter
        style: form
        explode: true
        schema:
          type: string
      - name: start
        in: query
        description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
        style: form
        explode: true
        schema:
          type: string
      - name: duration
        in: query
        description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
        style: form
        explode: true
        schema:
          type: string
          default: 1d
          examples:
          - 10m
      - name: limit
        in: query
        description: Maximum number of results to return per page
        style: form
        explode: true
        schema:
          minimum: 0
          type: integer
          contentEncoding: int32
          default: 100
      - name: page
        in: query
        description: Select the page number to return when using page-based pagination; starts at `1`
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          contentEncoding: int32
          default: 1
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_pcap_search'
                - description: Paginated response for packet capture search results
                  examples:
                  - end: 1461089816
                    limit: 100
                    next: /api/v1/sites/67970e46-4e12-11e6-9188-0242ac110007/pcaps?start=1461099816&search_after=%5B1694537121217%5D&limit=100&end=1461089816
                    results:
                    - ap_macs:
                      - 5c5b35000010
                      timestamp: 1461869041
                      type: new_assoc
                      url: https://...
                    - duration: 9999
                      format: stream
                      id: 80cec4c9-322c-4712-95ce-6ba47fb54fc0
                      last_seen: 1693482149.417
                      mxedges:
                      - 00000000-0000-0000-1000-001122334455
                      org_id: 78c11da8-f984-4425-bedb-a7ddd7d0f6da
                      pcap_url: https://...
                      site_id: null
                      termination_reason: default
                      timestamp: 1693525333.234066
                      type: mxedge
                      url: https://...
                    start: 1461099816
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    end: 1461089816
                    limit: 100
                    next: /api/v1/sites/67970e46-4e12-11e6-9188-0242ac110007/pcaps?start=1461099816&search_after=%5B1694537121217%5D&limit=100&end=1461089816
                    results:
                    - ap_macs:
                      - 5c5b35000010
                      timestamp: 1461869041
                      type: new_assoc
                      url: https://...
                    - duration: 9999
                      format: stream
                      id: 80cec4c9-322c-4712-95ce-6ba47fb54fc0
                      last_seen: 1693482149.417
                      mxedges:
                      - 00000000-0000-0000-1000-001122334455
                      org_id: 78c11da8-f984-4425-bedb-a7ddd7d0f6da
                      pcap_url: https://...
                      site_id: null
                      termination_reason: default
                      timestamp: 1693525333.234066
                      type: mxedge
                      url: https://...
                    start: 1461099816
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_pcap_search'
                - description: Paginated response for packet capture search results
                  examples:
                  - end: 1461089816
                    limit: 100
                    next: /api/v1/sites/67970e46-4e12-11e6-9188-0242ac110007/pcaps?start=1461099816&search_after=%5B1694537121217%5D&limit=100&end=1461089816
                    results:
                    - ap_macs:
                      - 5c5b35000010
                      timestamp: 1461869041
                      type: new_assoc
                      url: https://...
                    - duration: 9999
                      format: stream
                      id: 80cec4c9-322c-4712-95ce-6ba47fb54fc0
                      last_seen: 1693482149.417
                      mxedges:
                      - 00000000-0000-0000-1000-001122334455
                      org_id: 78c11da8-f984-4425-bedb-a7ddd7d0f6da
                      pcap_url: https://...
                      site_id: null
                      termination_reason: default
                      timestamp: 1693525333.234066
                      type: mxedge
                      url: https://...
                    start: 1461099816
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    end: 1461089816
                    limit: 100
                    next: /api/v1/sites/67970e46-4e12-11e6-9188-0242ac110007/pcaps?start=1461099816&search_after=%5B1694537121217%5D&limit=100&end=1461089816
                    results:
                    - ap_macs:
                      - 5c5b35000010
                      timestamp: 1461869041
                      type: new_assoc
                      url: https://...
                    - duration: 9999
                      format: stream
                      id: 80cec4c9-322c-4712-95ce-6ba47fb54fc0
                      last_seen: 1693482149.417
                      mxedges:
                      - 00000000-0000-0000-1000-001122334455
                      org_id: 78c11da8-f984-4425-bedb-a7ddd7d0f6da
                      pcap_url: https://...
                      site_id: null
                      termination_reason: default
                      timestamp: 1693525333.234066
                      type: mxedge
                      url: https://...
                    start: 1461099816
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/pcaps/capture:
    delete:
      tags:
      - Utilities PCAPs
      summary: stopSitePacketCapture
      description: Stop current capture
      operationId: stopSitePacketCapture
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    get:
      tags:
      - Utilities PCAPs
      summary: getSiteCapturingStatus
      description: Get Capturing status
      operationId: getSiteCapturingStatus
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_pcap_status'
                - description: Current status of a packet capture session
                  examples:
                  - aps:
                    - 5c5b350e001c
                    - 5c5b350e001b
                    client_mac: 60a10a773412
                    duration: 300
                    failed: []
                    id: a9a84e13-a714-b1eb-152f-a434416217d5
                    includes_mcast: false
                    max_pkt_len: 128
                    num_packets: 1000
                    ok:
                    - 5c5b350e001c
                    - 5c5b350e001b
                    started_time: 1435080709
                    type: client
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    aps:
                    - 5c5b350e001c
                    - 5c5b350e001b
                    client_mac: 60a10a773412
                    duration: 300
                    failed: []
                    id: a9a84e13-a714-b1eb-152f-a434416217d5
                    includes_mcast: false
                    max_pkt_len: 128
                    num_packets: 1000
                    ok:
                    - 5c5b350e001c
                    - 5c5b350e001b
                    started_time: 1435080709
                    type: client
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_pcap_status'
                - description: Current status of a packet capture session
                  examples:
                  - aps:
                    - 5c5b350e001c
                    - 5c5b350e001b
                    client_mac: 60a10a773412
                    duration: 300
                    failed: []
                    id: a9a84e13-a714-b1eb-152f-a434416217d5
                    includes_mcast: false
                    max_pkt_len: 128
                    num_packets: 1000
                    ok:
                    - 5c5b350e001c
                    - 5c5b350e001b
                    started_time: 1435080709
                    type: client
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    aps:
                    - 5c5b350e001c
                    - 5c5b350e001b
                    client_mac: 60a10a773412
                    duration: 300
                    failed: []
                    id: a9a84e13-a714-b1eb-152f-a434416217d5
                    includes_mcast: false
                    max_pkt_len: 128
                    num_packets: 1000
                    ok:
                    - 5c5b350e001c
                    - 5c5b350e001b
                    started_time: 1435080709
                    type: client
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Utilities PCAPs
      summary: startSitePacketCapture
      description: "Initiate a Site Packet Capture\n\nThe output will be available through websocket. As there can be multiple commands issued against the same AP at the same time and the output all goes through the same websocket stream, session is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n    \"subscribe\": \"/sites/{site_id}/pcaps\"\n}\n```\n#### Response (MxEdge)\n```json\n{\n    \"event\": \"data\"\n    \"channel\": \"/sites/{site_id}/pcaps\"\n    \"data\": {\n         \"capture_id\": \"6b1be4fb-b239-44d9-9d3b-cb1ff3af1721\",\n     \"lost_messages\": 0\n         \"pcap_dict\": {\n             \"channel_frequency\": 2412,\n             \"channel\": \"1\",\n             \"datarate\": \"1.0 Mbps\",\n             \"rssi\": -75, \n             \"dst\": \"78:bd:bc:ca:0b:0a\",\n             \"src\": \"18:b8:1f:4c:91:c0\",\n             \"bssid\": \"18:b8:1f:4c:91:c0\",\n             \"frame_type\": \"Management\", \n             \"frame_subtype\": \"Probe Response\", \n         \"proto\": \"802.11\", \n             \"ap_mac\": \"d4:20:b0:81:99:2e\", \n             \"direction\": \"tx\", \n             \"timestamp\": 1652246543, \n             \"length\": 416.0,\n             \"interface\": \"radiotap\",\n             \"info\": \"1652246544.467733 1683216786us tsft 1.0 Mb/s 2412 MHz 11g -75dBm signal -82dBm noise antenna 0 Probe Response (ATTKmsWiVS) [1.0* 2.0* 5.5* 11.0* 18.0 24.0 36.0 54.0 Mbit] CH: 2, PRIVACY\\\\n\",\n         }, \n        \"pcap_raw\": \"1MOyoQIABAAAAAAAAAAAAP//AAABAAAAEEh7Yh5VBwCgAQAAoAEAAAAAKwBvCADAAQAAAIw7reCS2VNkAAAAABACbAmABLWuAAEAEBgAAwACAABQADoBeL28ygsKGLgfTJHAGLgfTJHAcIZ2WDlBJQAAAGQAERUACkFUVEttc1dpVlMBCIKEi5YkMEhsAwECBwZVUyABCx4gAQAjAhkAKgEEMgQMEhhgMBQBAAAPrAQBAAAPrAQBAAAPrAIMAAsFAQAbAABGBTIIAQAALRqtCR////8AAAAAAAAAAAAAAAAAAAAAAAAAAD0WAggVAAAAAAAAAAAAAAAAAAAAAAAAAH8IBAAIAAAAAEDdkwBQ8gQQSgABEBBEAAECEDsAAQMQRwAQn2481frn3KT+uGod2ERx+RAhAAtBcnJpcywgSW5jLhAjAApCR1cyMTAtNzAwECQACkJHVzIxMC03MDAQQgAKQkdXMjEwLTcwMBBUAAgABgBQ8gQAARARAA5BcnJpcyBXaXJlbGVzcxAIAAIgCBA8AAEBEEkABgA3KgABIN0JABAYAgEQHAAA3RgAUPICAQGEAAOkAAAnpAAAQkNeAGIyLwAzjakr\"\n}\n```\n\n#### Response (Wired)\n```json\n{\n    \"event\": \"data\"\n    \"channel\": \"/sites/67970e46-4e12-11e6-9188-0242ac110007/pcaps\"\n    \"data\": {\n        \"capture_id\": \"f039b1b4-a23e-48b2-906a-0da40524de73\", \n        \"pcap_dict\": {\n             \"dst_mac\": \"68:ec:c5:09:2e:87\",\n             \"src_mac\": \"8c:3b:ad:e0:47:40\", \n             \"vlan\": 1, \n             \"src_ip\": \"34.224.147.117\", \n             \"dst_ip\": \"192.168.1.55\",\n             \"dst_port\": 51635, \n             \"src_port\": 443,\n             \"proto\": \"TCP\", \n             \"ap_mac\": \"d4:20:b0:81:99:2e\",\n             \"direction\": \"tx\", \n             \"timestamp\": 1652247615, \n             \"length\": 159.0, \n             \"interface\": \"wired\",\n             \"info\": \"1652247616.007409 IP ec2-34-224-147-117.compute-1.amazonaws.com.https > ip-192-168-1-55.ec2.internal.51635: Flags [P.], seq 2192123968:2192124057, ack 4035166782, win 12, options [nop,nop,TS val 597467050 ecr 740580660], length 89\\\\n\",\n             }, \n        \"pcap_raw\": \"1MOyoQIABAAAAAAAAAAAAP//AAABAAAAQEx7YhMzAACfAAAAnwAAAGjsxQkuh4w7reBHQIEAAAEIAEUAAI1bLEAAKAZ/CiLgk3XAqAE3AbvJs4KpKEDwg8I+gBgADFf9AAABAQgKI5yfqiwkXTQXAwMAVKY5JopoKQrVEn0/3ld4YntctGEH/rTZuwtCvzSncFw71QJveJi9uxHs57KC8w9Apph3YvXJrmWg7M37+o+YV0KH/xmr626s5Bkhb3QhKOu+NoNEmA==\"\n\n    }\n}\n```\n\n#### Stop Response (Wired/Wireless)\n```json\n{\n    \"event\": \"data\"\n    \"channel\": \"/sites/67970e46-4e12-11e6-9188-0242ac110007/pcaps\"\n    \"data\": {\n      \"capture_id\": \"a2f7374d-6a70-41fd-8a3f-71e42573baaf\", \n      \"lost_messages\": 0,\n      \"pcap_dict\": null\n    }\n}\n```"
      operationId: startSitePacketCapture
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/capture_site'
              - description: Request Body
                examples:
                - '{"client_mac":"60a10a773412","duration":600,"includes_mcast":false,"max_pkt_len":128,"num_packets":100,"type":"new_assoc"}'
                - '{"duration":600,"max_pkt_len":68,"num_packets":100,"type":"radiotap"}'
                - '{"ap_mac":"string","client_mac":"38f9d3972ff1","duration":600,"max_pkt_len":128,"num_packets":1024,"ssid":"string","type":"radiotap,wired"}'
                - '{"ap_mac":null,"band":"24","bandwidth":20,"channel":1,"client_mac":"38f9d3972ff1","duration":600,"format":"stream","max_pkt_len":68,"num_packets":100,"tcpdump_expression":"tcp port 80","type":"scan"}'
                - '{"duration":600,"max_pkt_len":68,"num_packets":100,"tcpdump_expression":"tcp port 80","type":"wired"}'
                - '{"ap_mac":null,"band":"24","duration":600,"max_pkt_len":128,"num_packets":100,"type":"wireless"}'
                - '{"client_mac":"60a10a773412","duration":300,"includes_mcast":false,"max_pkt_len":128,"num_packets":1000,"type":"client"}'
                - '{"duration":600,"format":"stream","gateways":{"001122334455":{"ports":{"ge-0/0/0":{"tcpdump_expression":"tcp"},"ge-0/0/1":{"tcpdump_expression":"port 443"},"ge-1/0/0":{"tcpdump_expression":"tcp"},"ge-1/0/1":{"tcpdump_expression":"port 443"}}},"001122334466":{"ports":{"ge-0/0/0":{"tcpdump_expression":"udp"},"ge-0/0/1":{"tcpdump_expression":"port 32768"}}}},"max_pkt_len":1500,"num_packets":100,"type":"gateway"}'
                - '{"duration":600,"format":"stream","max_pkt_len":1500,"num_packets":100,"switches":{"001122334455":{"ports":{"ge-0/0/0":{"tcpdump_expression":"udp"},"ge-0/0/1":{},"ge-1/0/0":{},"ge-1/0/1":{}}},"001122334466":{"ports":{"ge-0/0/0":{},"ge-0/0/1":{}}}},"tcpdump_expression":"port 443","type":"switch"}'
              contentMediaType: application/json
            examples:
              AP-New-Wireless-Client-Associations-Packet-Capture:
                value:
                  client_mac: 60a10a773412
                  duration: 600
                  includes_mcast: false
                  max_pkt_len: 128
                  num_packets: 100
                  type: new_assoc
              AP-Radiotap-Packet-Capture:
                value:
                  duration: 600
                  max_pkt_len: 68
                  num_packets: 100
                  type: radiotap
              AP-Radiotap-Packet-Capture-and-Wired-Packet-Capture:
                value:
                  ap_mac: string
                  client_mac: 38f9d3972ff1
                  duration: 600
                  max_pkt_len: 128
                  num_packets: 1024
                  ssid: string
                  type: radiotap,wired
              AP-Scan-radio-Packet-Capture:
                value:
                  ap_mac: null
                  band: '24'
                  bandwidth: 20
                  channel: 1
                  client_mac: 38f9d3972ff1
                  duration: 600
                  format: stream
                  max_pkt_len: 68
                  num_packets: 100
                  tcpdump_expression: tcp port 80
                  type: scan
              AP-Wired-Packet-Capture:
                value:
                  duration: 600
                  max_pkt_len: 68
                  num_packets: 100
                  tcpdump_expression: tcp port 80
                  type: wired
              AP-Wireless-Packet-Capture:
                value:
                  ap_mac: null
                  band: '24'
                  duration: 600
                  max_pkt_len: 128
                  num_packets: 100
                  type: wireless
              Client-Packet-Capture:
                value:
                  client_mac: 60a10a773412
                  duration: 300
                  includes_mcast: false
                  max_pkt_len: 128
                  num_packets: 1000
                  type: client
              SSR-Packet-Capture:
                value:
                  duration: 600
                  format: stream
                  gateways:
                    '001122334455':
                      ports:
                        ge-0/0/0:
                          tcpdump_expression: tcp
                        ge-0/0/1:
                          tcpdump_expression: port 443
                        ge-1/0/0:
                          tcpdump_expression: tcp
                        ge-1/0/1:
                          tcpdump_expression: port 443
                    '001122334466':
                      ports:
                        ge-0/0/0:
                          tcpdump_expression: udp
                        ge-0/0/1:
                          tcpdump_expression: port 32768
                  max_pkt_len: 1500
                  num_packets: 100
                  type: gateway
              Switch-Packet-Capture:
                value:
                  duration: 600
                  format: stream
                  max_pkt_len: 1500
                  num_packets: 100
                  switches:
                    '001122334455':
                      ports:
                        ge-0/0/0:
                          tcpdump_expression: udp
                        ge-0/0/1: {}
                        ge-1/0/0: {}
                        ge-1/0/1: {}
                    '001122334466':
                      ports:
                        ge-0/0/0: {}
                        ge-0/0/1: {}
                  tcpdump_expression: port 443
                  type: switch
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_pcap_start'
                - description: Packet capture session created by a start request
                  examples:
                  - ap_count: 3
                    aps: []
                    duration: 600
                    enabled: true
                    expiry: 1614886726.5411825
                    format: stream
                    id: a9a84e13-a714-b1eb-152f-a434416217d5
                    include_mcast: false
                    max_pkt_len: 68
                    num_packets: 100
                    org_id: a9346fba-f920-e99a-cc51-2e8dcc57fa3c
                    raw: true
                    site_id: 67970e46-4e12-11e6-9188-0242ac110007
                    ssid: ''
                    timestamp: 1614886126.5411825
                    type: radiotap
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    ap_count: 3
                    aps: []
                    duration: 600
                    enabled: true
                    expiry: 1614886726.5411825
                    format: stream
                    id: a9a84e13-a714-b1eb-152f-a434416217d5
                    include_mcast: false
                    max_pkt_len: 68
                    num_packets: 100
                    org_id: a9346fba-f920-e99a-cc51-2e8dcc57fa3c
                    raw: true
                    site_id: 67970e46-4e12-11e6-9188-0242ac110007
                    ssid: ''
                    timestamp: 1614886126.5411825
                    type: radiotap
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_pcap_start'
                - description: Packet capture session created by a start request
                  examples:
                  - ap_count: 3
                    aps: []
                    duration: 600
                    enabled: true
                    expiry: 1614886726.5411825
                    format: stream
                    id: a9a84e13-a714-b1eb-152f-a434416217d5
                    include_mcast: false
                    max_pkt_len: 68
                    num_packets: 100
                    org_id: a9346fba-f920-e99a-cc51-2e8dcc57fa3c
                    raw: true
                    site_id: 67970e46-4e12-11e6-9188-0242ac110007
                    ssid: ''
                    timestamp: 1614886126.5411825
                    type: radiotap
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    ap_count: 3
                    aps: []
                    duration: 600
                    enabled: true
                    expiry: 1614886726.5411825
                    format: stream
                    id: a9a84e13-a714-b1eb-152f-a434416217d5
                    include_mcast: false
                    max_pkt_len: 68
                    num_packets: 100
                    org_id: a9346fba-f920-e99a-cc51-2e8dcc57fa3c
                    raw: true
                    site_id: 67970e46-4e12-11e6-9188-0242ac110007
                    ssid: ''
                    timestamp: 1614886126.5411825
                    type: radiotap
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/pcaps/{pcap_id}:
    put:
      tags:
      - Utilities PCAPs
      summary: updateSitePacketCapture
      description: Update or add notes to a completed packet capture
      operationId: updateSitePacketCapture
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: pcap_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/notes_string'
              - examples:
                - notes: wired pcap test
              contentMediaType: application/json
            examples:
              Example:
                value:
                  notes: wired pcap test
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/send_ble_beacon:
    post:
      tags:
      - Utilities Location
      summary: sendSiteDevicesArbitraryBleBeacon
      description: >-
        Send arbitrary BLE Beacon for a period of time


        Note that only the devices that are connected will be restarted.
      operationId: sendSiteDevicesArbitraryBleBeacon
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/utils_send_ble_beacon'
              - examples:
                - beacon_frame: 68b329da9893e34099c7d8ad5cb9c940
                  beacon_freq: 100
                  duration: 10
                  macs:
                  - 5c5b35584a6f
                  - 5c5b350ea3b3
                  map_ids:
                  - 845a23bf-bed9-e43c-4c86-6fa474be7ae5
              contentMediaType: application/json
            examples:
              Example:
                value:
                  beacon_frame: 68b329da9893e34099c7d8ad5cb9c940
                  beacon_freq: 100
                  duration: 10
                  macs:
                  - 5c5b35584a6f
                  - 5c5b350ea3b3
                  map_ids:
                  - 845a23bf-bed9-e43c-4c86-6fa474be7ae5
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/mxtunnels/{mxtunnel_id}/preempt_aps:
    post:
      tags:
      - Utilities MxEdge
      summary: preemptSitesMxTunnel
      description: To preempt AP’s which are not connected to preferred peer to the preferred peer
      operationId: preemptSitesMxTunnel
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: mxtunnel_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_mxtunnels_preempt_aps'
                - description: Result of preempting APs onto preferred MxTunnel peers
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_mxtunnels_preempt_aps'
                - description: Result of preempting APs onto preferred MxTunnel peers
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/devices/upgrade:
    get:
      tags:
      - Utilities Upgrade
      summary: listOrgDeviceUpgrades
      description: List organization-level device upgrade jobs, including the site-level upgrade jobs created under each organization upgrade.
      operationId: listOrgDeviceUpgrades
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/upgrade_org_devices_item'
                description: Organization device upgrade jobs returned by a list response
                examples:
                - - id: 466f6eca-6276-4993-bfeb-53cbbbba6f88
                    site_upgrades:
                    - site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                      upgrade_id: 174bda0-06a3-40ee-b918-d9cbde303690
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - id: 466f6eca-6276-4993-bfeb-53cbbbba6f88
                    site_upgrades:
                    - site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                      upgrade_id: 174bda0-06a3-40ee-b918-d9cbde303690
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/upgrade_org_devices_item'
                description: Organization device upgrade jobs returned by a list response
                examples:
                - - id: 466f6eca-6276-4993-bfeb-53cbbbba6f88
                    site_upgrades:
                    - site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                      upgrade_id: 174bda0-06a3-40ee-b918-d9cbde303690
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - id: 466f6eca-6276-4993-bfeb-53cbbbba6f88
                    site_upgrades:
                    - site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
                      upgrade_id: 174bda0-06a3-40ee-b918-d9cbde303690
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Utilities Upgrade
      summary: upgradeOrgDevices
      description: Start an organization-level device upgrade job across selected sites. The request selects device type, sites, models, firmware versions, and upgrade strategy; AP-specific and Junos-specific options apply only where supported.
      operationId: upgradeOrgDevices
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/upgrade_org_devices'
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_upgrade_org_devices'
                - description: Organization AP upgrade job details
                  examples:
                  - enable_p2p: true
                    force: true
                    id: 31223085-405d-4b64-8aea-9c5b98098b4b
                    strategy: big_bang
                    target_version: 0.14.29411
                    upgrades:
                    - site_id: 1bbe6e79-2583-403c-be1a-9881b4691ab6
                      upgrade:
                        id: 473f6eca-6276-4993-bfeb-53cbbbba6f18
                        start_time: 1717658765
                        status: upgrading
                        targets:
                          download_requested:
                          - 5c5b3550bd2e
                          downloaded:
                          - 003e7316ff9e
                          total: 4
                          upgraded:
                          - 5c5b3550bd2e
                          - 003e7316ff9e
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    enable_p2p: true
                    force: true
                    id: 31223085-405d-4b64-8aea-9c5b98098b4b
                    strategy: big_bang
                    target_version: 0.14.29411
                    upgrades:
                    - site_id: 1bbe6e79-2583-403c-be1a-9881b4691ab6
                      upgrade:
                        id: 473f6eca-6276-4993-bfeb-53cbbbba6f18
                        start_time: 1717658765
                        status: upgrading
                        targets:
                          download_requested:
                          - 5c5b3550bd2e
                          downloaded:
                          - 003e7316ff9e
                          total: 4
                          upgraded:
                          - 5c5b3550bd2e
                          - 003e7316ff9e
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_upgrade_org_devices'
                - description: Organization AP upgrade job details
                  examples:
                  - enable_p2p: true
                    force: true
                    id: 31223085-405d-4b64-8aea-9c5b98098b4b
                    strategy: big_bang
                    target_version: 0.14.29411
                    upgrades:
                    - site_id: 1bbe6e79-2583-403c-be1a-9881b4691ab6
                      upgrade:
                        id: 473f6eca-6276-4993-bfeb-53cbbbba6f18
                        start_time: 1717658765
                        status: upgrading
                        targets:
                          download_requested:
                          - 5c5b3550bd2e
                          downloaded:
                          - 003e7316ff9e
                          total: 4
                          upgraded:
                          - 5c5b3550bd2e
                          - 003e7316ff9e
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    enable_p2p: true
                    force: true
                    id: 31223085-405d-4b64-8aea-9c5b98098b4b
                    strategy: big_bang
                    target_version: 0.14.29411
                    upgrades:
                    - site_id: 1bbe6e79-2583-403c-be1a-9881b4691ab6
                      upgrade:
                        id: 473f6eca-6276-4993-bfeb-53cbbbba6f18
                        start_time: 1717658765
                        status: upgrading
                        targets:
                          download_requested:
                          - 5c5b3550bd2e
                          downloaded:
                          - 003e7316ff9e
                          total: 4
                          upgraded:
                          - 5c5b3550bd2e
                          - 003e7316ff9e
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/devices/upgrade/{upgrade_id}:
    get:
      tags:
      - Utilities Upgrade
      summary: getOrgDeviceUpgrade
      description: Retrieve details for an organization-level device upgrade job, including per-site upgrade status and device targets.
      operationId: getOrgDeviceUpgrade
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: upgrade_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_upgrade_org_devices'
                - description: Organization AP upgrade job details
                  examples:
                  - enable_p2p: true
                    force: true
                    id: 31223085-405d-4b64-8aea-9c5b98098b4b
                    strategy: big_bang
                    target_version: 0.14.29411
                    upgrades:
                    - site_id: 1bbe6e79-2583-403c-be1a-9881b4691ab6
                      upgrade:
                        id: 473f6eca-6276-4993-bfeb-53cbbbba6f18
                        start_time: 1717658765
                        status: upgrading
                        targets:
                          download_requested:
                          - 5c5b3550bd2e
                          downloaded:
                          - 003e7316ff9e
                          total: 4
                          upgraded:
                          - 5c5b3550bd2e
                          - 003e7316ff9e
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    enable_p2p: true
                    force: true
                    id: 31223085-405d-4b64-8aea-9c5b98098b4b
                    strategy: big_bang
                    target_version: 0.14.29411
                    upgrades:
                    - site_id: 1bbe6e79-2583-403c-be1a-9881b4691ab6
                      upgrade:
                        id: 473f6eca-6276-4993-bfeb-53cbbbba6f18
                        start_time: 1717658765
                        status: upgrading
                        targets:
                          download_requested:
                          - 5c5b3550bd2e
                          downloaded:
                          - 003e7316ff9e
                          total: 4
                          upgraded:
                          - 5c5b3550bd2e
                          - 003e7316ff9e
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_upgrade_org_devices'
                - description: Organization AP upgrade job details
                  examples:
                  - enable_p2p: true
                    force: true
                    id: 31223085-405d-4b64-8aea-9c5b98098b4b
                    strategy: big_bang
                    target_version: 0.14.29411
                    upgrades:
                    - site_id: 1bbe6e79-2583-403c-be1a-9881b4691ab6
                      upgrade:
                        id: 473f6eca-6276-4993-bfeb-53cbbbba6f18
                        start_time: 1717658765
                        status: upgrading
                        targets:
                          download_requested:
                          - 5c5b3550bd2e
                          downloaded:
                          - 003e7316ff9e
                          total: 4
                          upgraded:
                          - 5c5b3550bd2e
                          - 003e7316ff9e
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    enable_p2p: true
                    force: true
                    id: 31223085-405d-4b64-8aea-9c5b98098b4b
                    strategy: big_bang
                    target_version: 0.14.29411
                    upgrades:
                    - site_id: 1bbe6e79-2583-403c-be1a-9881b4691ab6
                      upgrade:
                        id: 473f6eca-6276-4993-bfeb-53cbbbba6f18
                        start_time: 1717658765
                        status: upgrading
                        targets:
                          download_requested:
                          - 5c5b3550bd2e
                          downloaded:
                          - 003e7316ff9e
                          total: 4
                          upgraded:
                          - 5c5b3550bd2e
                          - 003e7316ff9e
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/devices/upgrade/{upgrade_id}/cancel:
    post:
      tags:
      - Utilities Upgrade
      summary: cancelOrgDeviceUpgrade
      description: Cancel an organization-level device upgrade job on a best-effort basis. Devices that have already completed the upgrade are not changed.
      operationId: cancelOrgDeviceUpgrade
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: upgrade_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/devices/versions:
    get:
      tags:
      - Utilities Upgrade
      summary: listOrgAvailableDeviceVersions
      description: List available firmware versions for organization devices, optionally filtered by device type and model.
      operationId: listOrgAvailableDeviceVersions
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: type
        in: query
        description: 'Filter results by type. enum: `ap`, `gateway`, `switch`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/device_type_default_ap'
          - description: 'Filter results by type. enum: `ap`, `gateway`, `switch`'
      - name: model
        in: query
        description: Fetch version for device model, use/combine with `type` as needed (for switch and gateway devices). Accepts multiple comma-separated values.
        style: form
        explode: true
        schema:
          type: string
          examples:
          - AP27,AP27E
          - AP43
        examples:
          Untitled Example1:
            value: AP27,AP27E
          Untitled Example2:
            value: AP43
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                uniqueItems: true
                type: array
                items:
                  $ref: '#/components/schemas/device_version_item'
                description: Available firmware versions for device models
                examples:
                - - model: AP41
                    tag: suggested
                    version: v0.1.543
                  - model: AP21
                    version: v0.1.545
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - model: AP41
                    tag: suggested
                    version: v0.1.543
                  - model: AP21
                    version: v0.1.545
            application/vnd.api+json:
              schema:
                uniqueItems: true
                type: array
                items:
                  $ref: '#/components/schemas/device_version_item'
                description: Available firmware versions for device models
                examples:
                - - model: AP41
                    tag: suggested
                    version: v0.1.543
                  - model: AP21
                    version: v0.1.545
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - model: AP41
                    tag: suggested
                    version: v0.1.543
                  - model: AP21
                    version: v0.1.545
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/jsi/devices/{device_mac}/upgrade:
    post:
      tags:
      - Utilities Upgrade
      summary: upgradeOrgJsiDevice
      description: Start a software upgrade for a JSI-connected device identified by MAC address using the requested target version.
      operationId: upgradeOrgJsiDevice
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_mac
        in: path
        description: ''
        required: true
        schema:
          pattern: ^[0-9a-fA-F]{12}$
          type: string
          examples:
          - 0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/version_string'
              - examples:
                - version: 3.1.5
              contentMediaType: application/json
            examples:
              Example:
                value:
                  version: 3.1.5
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/mxedges/upgrade:
    get:
      tags:
      - Utilities Upgrade
      summary: listOrgMxEdgeUpgrades
      description: List Mist Edge upgrade requests for the organization, including status, rollout strategy, target versions, and per-status target counts.
      operationId: listOrgMxEdgeUpgrades
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/response_mxedge_upgrade'
                description: Mist Edge upgrade records returned by list upgrade operations
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/response_mxedge_upgrade'
                description: Mist Edge upgrade records returned by list upgrade operations
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Utilities Upgrade
      summary: upgradeOrgMxEdges
      description: Schedule a Mist Edge upgrade for selected Mist Edges, using service target versions or an optional Linux distro upgrade with rollout strategy and canary settings.
      operationId: upgradeOrgMxEdges
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/mxedge_upgrade_multi'
              - description: Request Body
                examples:
                - '{"allow_downgrades":{"mxagent":false,"tunterm":true},"canary_phases":[5,25,50,100],"channel":"stable","max_failure_percentage":5,"max_failures":[1,1,5,5],"mxedge_ids":["387804a7-3474-85ce-15a2-f9a9684c9c90"],"start_time":1624399840,"strategy":"serial","versions":{"mxagent":"latest","radsecproxy":"<version>","tunterm":"default"}}'
                - '{"canary_phases":[5,25,50,100],"distro":"buster","max_failure_percentage":5,"max_failures":[1,1,5,5],"mxedge_ids":["387804a7-3474-85ce-15a2-f9a9684c9c90"],"start_time":1624399840,"strategy":"serial"}'
              contentMediaType: application/json
            examples:
              Upgrade_MxEdge:
                value:
                  allow_downgrades:
                    mxagent: false
                    tunterm: true
                  canary_phases:
                  - 5
                  - 25
                  - 50
                  - 100
                  channel: stable
                  max_failure_percentage: 5
                  max_failures:
                  - 1
                  - 1
                  - 5
                  - 5
                  mxedge_ids:
                  - 387804a7-3474-85ce-15a2-f9a9684c9c90
                  start_time: 1624399840
                  strategy: serial
                  versions:
                    mxagent: latest
                    radsecproxy: <version>
                    tunterm: default
              Upgrade_MxEdge_Distro:
                value:
                  canary_phases:
                  - 5
                  - 25
                  - 50
                  - 100
                  distro: buster
                  max_failure_percentage: 5
                  max_failures:
                  - 1
                  - 1
                  - 5
                  - 5
                  mxedge_ids:
                  - 387804a7-3474-85ce-15a2-f9a9684c9c90
                  start_time: 1624399840
                  strategy: serial
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/mxedges/upgrade/{upgrade_id}:
    get:
      tags:
      - Utilities Upgrade
      summary: getOrgMxEdgeUpgrade
      description: Retrieve status, rollout strategy, target versions, and target counts for a specific Mist Edge upgrade request.
      operationId: getOrgMxEdgeUpgrade
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: upgrade_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_mxedge_upgrade'
                - description: Mist Edge upgrade details response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_mxedge_upgrade'
                - description: Mist Edge upgrade details response
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Utilities Upgrade
      summary: updateOrgMxEdgeUpgrade
      description: Update a queued Mist Edge upgrade request, such as target versions, rollout strategy, start time, or target Mist Edge IDs. Only upgrades in `queued` state can be updated.
      operationId: updateOrgMxEdgeUpgrade
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: upgrade_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/mxedge_upgrade_multi'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_mxedge_upgrade'
                - description: Mist Edge upgrade details response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_mxedge_upgrade'
                - description: Mist Edge upgrade details response
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/mxedges/upgrade/{upgrade_id}/cancel:
    post:
      tags:
      - Utilities Upgrade
      summary: cancelOrgMxEdgeUpgrade
      description: Cancel a Mist Edge upgrade request on a best-effort basis. Mist Edges that have already been upgraded are not changed.
      operationId: cancelOrgMxEdgeUpgrade
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: upgrade_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/ssr/upgrade:
    get:
      tags:
      - Utilities Upgrade
      summary: listOrgSsrUpgrades
      description: List SSR firmware upgrade jobs for the organization, including status, rollout strategy, target versions, release channel, and device counts.
      operationId: listOrgSsrUpgrades
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/response_ssr_upgrade'
                description: SSR firmware upgrade jobs returned by list operations
                examples:
                - - channel: stable
                    counts:
                      failed: 0
                      queued: 1
                      success: 0
                      upgrading: 1
                    device_type: gateway
                    id: ceef2c8a-e2e6-447a-8b27-cb4f3ec1adae
                    status: upgrading
                    strategy: serial
                    versions: {}
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - channel: stable
                    counts:
                      failed: 0
                      queued: 1
                      success: 0
                      upgrading: 1
                    device_type: gateway
                    id: ceef2c8a-e2e6-447a-8b27-cb4f3ec1adae
                    status: upgrading
                    strategy: serial
                    versions: {}
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/response_ssr_upgrade'
                description: SSR firmware upgrade jobs returned by list operations
                examples:
                - - channel: stable
                    counts:
                      failed: 0
                      queued: 1
                      success: 0
                      upgrading: 1
                    device_type: gateway
                    id: ceef2c8a-e2e6-447a-8b27-cb4f3ec1adae
                    status: upgrading
                    strategy: serial
                    versions: {}
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - channel: stable
                    counts:
                      failed: 0
                      queued: 1
                      success: 0
                      upgrading: 1
                    device_type: gateway
                    id: ceef2c8a-e2e6-447a-8b27-cb4f3ec1adae
                    status: upgrading
                    strategy: serial
                    versions: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Utilities Upgrade
      summary: upgradeOrgSsrs
      description: Create an SSR firmware upgrade job for selected devices, with firmware version or channel, rollout strategy, and optional download or reboot timing.
      operationId: upgradeOrgSsrs
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ssr_upgrade_multi'
              - examples:
                - channel: stable
                  device_ids:
                  - 00000000-0000-0000-1000-5c5b3500001f
                  - 00000000-0000-0000-1000-5c5b35000020
                  strategy: big_bang
                  version: 5.3.0-93
              contentMediaType: application/json
            examples:
              Example:
                value:
                  channel: stable
                  device_ids:
                  - 00000000-0000-0000-1000-5c5b3500001f
                  - 00000000-0000-0000-1000-5c5b35000020
                  strategy: big_bang
                  version: 5.3.0-93
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_ssr_upgrade'
                - description: SSR firmware upgrade job summary
                  examples:
                  - channel: stable
                    counts:
                      failed: 0
                      queued: 1
                      success: 0
                      upgrading: 1
                    device_type: gateway
                    id: ceef2c8a-e2e6-447a-8b27-cb4f3ec1adae
                    status: upgrading
                    strategy: serial
                    versions: {}
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    channel: stable
                    counts:
                      failed: 0
                      queued: 1
                      success: 0
                      upgrading: 1
                    device_type: gateway
                    id: ceef2c8a-e2e6-447a-8b27-cb4f3ec1adae
                    status: upgrading
                    strategy: serial
                    versions: {}
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_ssr_upgrade'
                - description: SSR firmware upgrade job summary
                  examples:
                  - channel: stable
                    counts:
                      failed: 0
                      queued: 1
                      success: 0
                      upgrading: 1
                    device_type: gateway
                    id: ceef2c8a-e2e6-447a-8b27-cb4f3ec1adae
                    status: upgrading
                    strategy: serial
                    versions: {}
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    channel: stable
                    counts:
                      failed: 0
                      queued: 1
                      success: 0
                      upgrading: 1
                    device_type: gateway
                    id: ceef2c8a-e2e6-447a-8b27-cb4f3ec1adae
                    status: upgrading
                    strategy: serial
                    versions: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/ssr/upgrade/{upgrade_id}/cancel:
    get:
      tags:
      - Utilities Upgrade
      summary: getOrgSsrUpgrade
      description: Return detailed status for an SSR firmware upgrade job, including target device IDs grouped by upgrade status.
      operationId: getOrgSsrUpgrade
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: upgrade_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_ssr_upgrade_status'
                - description: Detailed status for an SSR firmware upgrade job
                  examples:
                  - channel: stable
                    device_type: gateway
                    id: 5cbcee0a-c620-4bb4-a25e-15000934e9d8
                    status: upgrading
                    targets:
                      failed: []
                      queued: []
                      success: []
                      upgrading:
                      - 8e525f1d-4178-4ae1-a988-2b0176855e55
                    versions: {}
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    channel: stable
                    device_type: gateway
                    id: 5cbcee0a-c620-4bb4-a25e-15000934e9d8
                    status: upgrading
                    targets:
                      failed: []
                      queued: []
                      success: []
                      upgrading:
                      - 8e525f1d-4178-4ae1-a988-2b0176855e55
                    versions: {}
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_ssr_upgrade_status'
                - description: Detailed status for an SSR firmware upgrade job
                  examples:
                  - channel: stable
                    device_type: gateway
                    id: 5cbcee0a-c620-4bb4-a25e-15000934e9d8
                    status: upgrading
                    targets:
                      failed: []
                      queued: []
                      success: []
                      upgrading:
                      - 8e525f1d-4178-4ae1-a988-2b0176855e55
                    versions: {}
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    channel: stable
                    device_type: gateway
                    id: 5cbcee0a-c620-4bb4-a25e-15000934e9d8
                    status: upgrading
                    targets:
                      failed: []
                      queued: []
                      success: []
                      upgrading:
                      - 8e525f1d-4178-4ae1-a988-2b0176855e55
                    versions: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Utilities Upgrade
      summary: cancelOrgSsrUpgrade
      description: Cancel an SSR firmware upgrade job on a best-effort basis. Devices that have already upgraded are not changed.
      operationId: cancelOrgSsrUpgrade
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: upgrade_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/orgs/{org_id}/ssr/versions:
    get:
      tags:
      - Utilities Upgrade
      summary: listOrgAvailableSsrVersions
      description: List SSR firmware versions available for upgrade, optionally filtered by release channel and one or more SSR MAC addresses.
      operationId: listOrgAvailableSsrVersions
      parameters:
      - name: org_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: channel
        in: query
        description: 'SSR release channel used to filter available versions. enum: `alpha`, `beta`, `stable`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/ssr_version_channel'
          - description: 'SSR release channel used to filter available versions. enum: `alpha`, `beta`, `stable`'
      - name: mac
        in: query
        description: Optional. MAC address, or comma separated MAC address list.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                uniqueItems: true
                type: array
                items:
                  $ref: '#/components/schemas/ssr_version'
                description: SSR firmware versions available for upgrade
                examples:
                - - default: true
                    package: SSR
                    version: 5.3.1-17
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - default: true
                    package: SSR
                    version: 5.3.1-17
            application/vnd.api+json:
              schema:
                uniqueItems: true
                type: array
                items:
                  $ref: '#/components/schemas/ssr_version'
                description: SSR firmware versions available for upgrade
                examples:
                - - default: true
                    package: SSR
                    version: 5.3.1-17
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - default: true
                    package: SSR
                    version: 5.3.1-17
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/upgrade:
    get:
      tags:
      - Utilities Upgrade
      summary: listSiteDeviceUpgrades
      description: List device upgrade operations for a site, optionally filtered by upgrade status. Use [List Org Device Upgrades]($e/Utilities%20Upgrade/listOrgDeviceUpgrades) to retrieve device upgrade operations across the organization.
      operationId: listSiteDeviceUpgrades
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: status
        in: query
        description: 'Filter results by status. enum: `cancelled`, `completed`, `created`, `downloaded`, `downloading`, `failed`, `queued`, `upgrading`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/upgrade_device_status'
          - description: 'Filter results by status. enum: `cancelled`, `completed`, `created`, `downloaded`, `downloading`, `failed`, `queued`, `upgrading`'
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/response_site_device_upgrades_item'
                description: Site device upgrade jobs returned by list operations
                examples:
                - - counts:
                      download_requested: 0
                      downloaded: 0
                      failed: 0
                      reboot_in_progress: 0
                      rebooted: 0
                      skipped: 0
                      total: 0
                    enable_p2p: true
                    force: true
                    id: 472f6eca-6276-4993-bfeb-53cbbbba6f28
                    start_time: 0
                    status: created
                    strategy: big_bang
                    target_version: string
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - counts:
                      download_requested: 0
                      downloaded: 0
                      failed: 0
                      reboot_in_progress: 0
                      rebooted: 0
                      skipped: 0
                      total: 0
                    enable_p2p: true
                    force: true
                    id: 472f6eca-6276-4993-bfeb-53cbbbba6f28
                    start_time: 0
                    status: created
                    strategy: big_bang
                    target_version: string
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/response_site_device_upgrades_item'
                description: Site device upgrade jobs returned by list operations
                examples:
                - - counts:
                      download_requested: 0
                      downloaded: 0
                      failed: 0
                      reboot_in_progress: 0
                      rebooted: 0
                      skipped: 0
                      total: 0
                    enable_p2p: true
                    force: true
                    id: 472f6eca-6276-4993-bfeb-53cbbbba6f28
                    start_time: 0
                    status: created
                    strategy: big_bang
                    target_version: string
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - counts:
                      download_requested: 0
                      downloaded: 0
                      failed: 0
                      reboot_in_progress: 0
                      rebooted: 0
                      skipped: 0
                      total: 0
                    enable_p2p: true
                    force: true
                    id: 472f6eca-6276-4993-bfeb-53cbbbba6f28
                    start_time: 0
                    status: created
                    strategy: big_bang
                    target_version: string
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Utilities Upgrade
      summary: upgradeSiteDevices
      description: >-
        Upgrade Site Device


        **Note**: this call doesn’t guarantee the devices to be upgraded right away (they may be offline)
      operationId: upgradeSiteDevices
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/upgrade_site_devices'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_upgrade_id'
                - description: Response containing an upgrade job identifier
                  examples:
                  - upgrade_id: 4316c116-0acb-4c43-8f06-6723154e741e
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    upgrade_id: 4316c116-0acb-4c43-8f06-6723154e741e
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_upgrade_id'
                - description: Response containing an upgrade job identifier
                  examples:
                  - upgrade_id: 4316c116-0acb-4c43-8f06-6723154e741e
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    upgrade_id: 4316c116-0acb-4c43-8f06-6723154e741e
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/upgrade/{upgrade_id}:
    get:
      tags:
      - Utilities Upgrade
      summary: getSiteDeviceUpgrade
      description: Get Site Device Upgrade
      operationId: getSiteDeviceUpgrade
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: upgrade_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_site_device_upgrade'
                - description: Site device upgrade job details
                  examples:
                  - canary_phases:
                    - 1
                    - 10
                    - 50
                    - 100
                    current_phase: 0
                    enable_p2p: true
                    force: false
                    id: b910de88-0e0e-43a0-b20e-a43aa8788917
                    max_failure_percentage: 5
                    max_failures:
                    - 5
                    - 5
                    - 5
                    - 5
                    p2p_cluster_size: 10
                    p2p_parallelism: 2
                    reboot_at: 1738233315
                    start_time: 1738232698
                    status: created
                    strategy: canary
                    target_version: 0.14.29633
                    targets:
                      downloaded:
                      - 30783a619182
                      total: 2
                      upgraded:
                      - a8378280da5e
                    upgrade_plan:
                      '1':
                      - 30783a619182
                      '2':
                      - a8378280da5e
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    canary_phases:
                    - 1
                    - 10
                    - 50
                    - 100
                    current_phase: 0
                    enable_p2p: true
                    force: false
                    id: b910de88-0e0e-43a0-b20e-a43aa8788917
                    max_failure_percentage: 5
                    max_failures:
                    - 5
                    - 5
                    - 5
                    - 5
                    p2p_cluster_size: 10
                    p2p_parallelism: 2
                    reboot_at: 1738233315
                    start_time: 1738232698
                    status: created
                    strategy: canary
                    target_version: 0.14.29633
                    targets:
                      downloaded:
                      - 30783a619182
                      total: 2
                      upgraded:
                      - a8378280da5e
                    upgrade_plan:
                      '1':
                      - 30783a619182
                      '2':
                      - a8378280da5e
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_site_device_upgrade'
                - description: Site device upgrade job details
                  examples:
                  - canary_phases:
                    - 1
                    - 10
                    - 50
                    - 100
                    current_phase: 0
                    enable_p2p: true
                    force: false
                    id: b910de88-0e0e-43a0-b20e-a43aa8788917
                    max_failure_percentage: 5
                    max_failures:
                    - 5
                    - 5
                    - 5
                    - 5
                    p2p_cluster_size: 10
                    p2p_parallelism: 2
                    reboot_at: 1738233315
                    start_time: 1738232698
                    status: created
                    strategy: canary
                    target_version: 0.14.29633
                    targets:
                      downloaded:
                      - 30783a619182
                      total: 2
                      upgraded:
                      - a8378280da5e
                    upgrade_plan:
                      '1':
                      - 30783a619182
                      '2':
                      - a8378280da5e
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    canary_phases:
                    - 1
                    - 10
                    - 50
                    - 100
                    current_phase: 0
                    enable_p2p: true
                    force: false
                    id: b910de88-0e0e-43a0-b20e-a43aa8788917
                    max_failure_percentage: 5
                    max_failures:
                    - 5
                    - 5
                    - 5
                    - 5
                    p2p_cluster_size: 10
                    p2p_parallelism: 2
                    reboot_at: 1738233315
                    start_time: 1738232698
                    status: created
                    strategy: canary
                    target_version: 0.14.29633
                    targets:
                      downloaded:
                      - 30783a619182
                      total: 2
                      upgraded:
                      - a8378280da5e
                    upgrade_plan:
                      '1':
                      - 30783a619182
                      '2':
                      - a8378280da5e
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/upgrade/{upgrade_id}/cancel:
    post:
      tags:
      - Utilities Upgrade
      summary: cancelSiteDeviceUpgrade
      description: Best effort to cancel an upgrade. Devices which are already upgraded wont be touched
      operationId: cancelSiteDeviceUpgrade
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: upgrade_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/versions:
    get:
      tags:
      - Utilities Upgrade
      summary: listSiteAvailableDeviceVersions
      description: List firmware versions available for devices in a site, optionally filtered by device type and model. Use [List Org Available Device Versions]($e/Utilities%20Upgrade/listOrgAvailableDeviceVersions) to retrieve available device versions across the organization.
      operationId: listSiteAvailableDeviceVersions
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: type
        in: query
        description: 'Filter results by type. enum: `ap`, `gateway`, `switch`'
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/device_type_default_ap'
          - description: 'Filter results by type. enum: `ap`, `gateway`, `switch`'
      - name: model
        in: query
        description: Fetch version for device model, use/combine with `type` as needed (for switch and gateway devices)
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                uniqueItems: true
                type: array
                items:
                  $ref: '#/components/schemas/device_version_item'
                description: Available firmware versions for device models
                examples:
                - - model: AP41
                    tag: suggested
                    version: v0.1.543
                  - model: AP21
                    version: v0.1.545
                contentMediaType: application/json
              examples:
                Example:
                  value:
                  - model: AP41
                    tag: suggested
                    version: v0.1.543
                  - model: AP21
                    version: v0.1.545
            application/vnd.api+json:
              schema:
                uniqueItems: true
                type: array
                items:
                  $ref: '#/components/schemas/device_version_item'
                description: Available firmware versions for device models
                examples:
                - - model: AP41
                    tag: suggested
                    version: v0.1.543
                  - model: AP21
                    version: v0.1.545
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                  - model: AP41
                    tag: suggested
                    version: v0.1.543
                  - model: AP21
                    version: v0.1.545
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/devices/{device_id}/upgrade:
    post:
      tags:
      - Utilities Upgrade
      summary: upgradeDevice
      description: Device Upgrade
      operationId: upgradeDevice
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/device_upgrade'
              - examples:
                - version: 3.1.5
              contentMediaType: application/json
            examples:
              Example:
                value:
                  version: 3.1.5
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_device_upgrade'
                - description: Single-device upgrade status response
                  examples:
                  - status: inprogress
                    timestamp: 1428949501
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    status: inprogress
                    timestamp: 1428949501
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_device_upgrade'
                - description: Single-device upgrade status response
                  examples:
                  - status: inprogress
                    timestamp: 1428949501
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    status: inprogress
                    timestamp: 1428949501
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/mxedges/upgrade:
    get:
      tags:
      - Utilities Upgrade
      summary: listSiteMxEdgeUpgrades
      description: List Mist Edge upgrade operations for a site. Use [List Org Mist Edge Upgrades]($e/Utilities%20Upgrade/listOrgMxEdgeUpgrades) to retrieve Mist Edge upgrade operations across the organization.
      operationId: listSiteMxEdgeUpgrades
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/response_mxedge_upgrade'
                description: Mist Edge upgrade records returned by list upgrade operations
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/response_mxedge_upgrade'
                description: Mist Edge upgrade records returned by list upgrade operations
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    post:
      tags:
      - Utilities Upgrade
      summary: upgradeSiteMxEdges
      description: >-
        Upgrade Mist Edges in a Site.


        See [Org Mist Edges](/#tag/Utilities-Upgrade/operation/upgradeOrgMxEdges) for package upgrades


        See [Org Mist Edges Distro](/#tag/Utilities-Upgrade/operation/upgradeOrgMxEdges) for distro upgrades
      operationId: upgradeSiteMxEdges
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/mxedge_upgrade_multi'
              - description: Request Body
                examples:
                - '{"allow_downgrades":{"mxagent":false,"tunterm":true},"canary_phases":[5,25,50,100],"channel":"stable","max_failure_percentage":5,"max_failures":[1,1,5,5],"mxedge_ids":["387804a7-3474-85ce-15a2-f9a9684c9c90"],"start_time":1624399840,"strategy":"serial","versions":{"mxagent":"latest","radsecproxy":"<version>","tunterm":"default"}}'
                - '{"canary_phases":[5,25,50,100],"distro":"buster","max_failure_percentage":5,"max_failures":[1,1,5,5],"mxedge_ids":["387804a7-3474-85ce-15a2-f9a9684c9c90"],"start_time":1624399840,"strategy":"serial"}'
              contentMediaType: application/json
            examples:
              Upgrade_MxEdge:
                value:
                  allow_downgrades:
                    mxagent: false
                    tunterm: true
                  canary_phases:
                  - 5
                  - 25
                  - 50
                  - 100
                  channel: stable
                  max_failure_percentage: 5
                  max_failures:
                  - 1
                  - 1
                  - 5
                  - 5
                  mxedge_ids:
                  - 387804a7-3474-85ce-15a2-f9a9684c9c90
                  start_time: 1624399840
                  strategy: serial
                  versions:
                    mxagent: latest
                    radsecproxy: <version>
                    tunterm: default
              Upgrade_MxEdge_Distro:
                value:
                  canary_phases:
                  - 5
                  - 25
                  - 50
                  - 100
                  distro: buster
                  max_failure_percentage: 5
                  max_failures:
                  - 1
                  - 1
                  - 5
                  - 5
                  mxedge_ids:
                  - 387804a7-3474-85ce-15a2-f9a9684c9c90
                  start_time: 1624399840
                  strategy: serial
        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/mxedges/upgrade/{upgrade_id}:
    get:
      tags:
      - Utilities Upgrade
      summary: getSiteMxEdgeUpgrade
      description: Get Mist Edge Upgrade
      operationId: getSiteMxEdgeUpgrade
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: upgrade_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_mxedge_upgrade'
                - description: Mist Edge upgrade details response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_mxedge_upgrade'
                - description: Mist Edge upgrade details response
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    put:
      tags:
      - Utilities Upgrade
      summary: updateSiteMxEdgeUpgrade
      description: Update Mist Edge Upgrade. Only upgrades in `queued` state can be updated.
      operationId: updateSiteMxEdgeUpgrade
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: upgrade_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: Request Body
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/mxedge_upgrade_multi'
              - description: Request Body
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_mxedge_upgrade'
                - description: Mist Edge upgrade details response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_mxedge_upgrade'
                - description: Mist Edge upgrade details response
                contentMediaType: application/vnd.api+json
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/mxedges/upgrade/{upgrade_id}/cancel:
    post:
      tags:
      - Utilities Upgrade
      summary: cancelSiteMxEdgeUpgrade
      description: Cancel Mist Edge Upgrade. Best effort to cancel an upgrade. MxEdges which are already upgraded won't be touched.
      operationId: cancelSiteMxEdgeUpgrade
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: upgrade_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/ssr/upgrade/{upgrade_id}:
    get:
      tags:
      - Utilities Upgrade
      summary: getSiteSsrUpgrade
      description: Get Specific Site SSR Upgrade
      operationId: getSiteSsrUpgrade
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: upgrade_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_ssr_upgrade_status'
                - description: Detailed status for an SSR firmware upgrade job
                  examples:
                  - channel: stable
                    device_type: gateway
                    id: 5cbcee0a-c620-4bb4-a25e-15000934e9d8
                    status: upgrading
                    targets:
                      failed: []
                      queued: []
                      success: []
                      upgrading:
                      - 8e525f1d-4178-4ae1-a988-2b0176855e55
                    versions: {}
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    channel: stable
                    device_type: gateway
                    id: 5cbcee0a-c620-4bb4-a25e-15000934e9d8
                    status: upgrading
                    targets:
                      failed: []
                      queued: []
                      success: []
                      upgrading:
                      - 8e525f1d-4178-4ae1-a988-2b0176855e55
                    versions: {}
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_ssr_upgrade_status'
                - description: Detailed status for an SSR firmware upgrade job
                  examples:
                  - channel: stable
                    device_type: gateway
                    id: 5cbcee0a-c620-4bb4-a25e-15000934e9d8
                    status: upgrading
                    targets:
                      failed: []
                      queued: []
                      success: []
                      upgrading:
                      - 8e525f1d-4178-4ae1-a988-2b0176855e55
                    versions: {}
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    channel: stable
                    device_type: gateway
                    id: 5cbcee0a-c620-4bb4-a25e-15000934e9d8
                    status: upgrading
                    targets:
                      failed: []
                      queued: []
                      success: []
                      upgrading:
                      - 8e525f1d-4178-4ae1-a988-2b0176855e55
                    versions: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
  /api/v1/sites/{site_id}/ssr/{device_id}/upgrade:
    post:
      tags:
      - Utilities Upgrade
      summary: upgradeSsr
      description: Upgrade Site SSR device
      operationId: upgradeSsr
      parameters:
      - name: site_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      - name: device_id
        in: path
        description: ''
        required: true
        schema:
          type: string
          contentEncoding: uuid
          examples:
          - 000000ab-00ab-00ab-00ab-0000000000ab
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ssr_upgrade'
              - examples:
                - channel: stable
                  version: 5.3.1-170-93
              contentMediaType: application/json
            examples:
              Example:
                value:
                  channel: stable
                  version: 5.3.1-170-93
        required: false
      responses:
        '200':
          description: Example response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_ssr_upgrade'
                - description: SSR firmware upgrade job summary
                  examples:
                  - channel: stable
                    counts:
                      failed: 0
                      queued: 1
                      success: 0
                      upgrading: 1
                    device_type: gateway
                    id: ceef2c8a-e2e6-447a-8b27-cb4f3ec1adae
                    status: upgrading
                    strategy: serial
                    versions: {}
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    channel: stable
                    counts:
                      failed: 0
                      queued: 1
                      success: 0
                      upgrading: 1
                    device_type: gateway
                    id: ceef2c8a-e2e6-447a-8b27-cb4f3ec1adae
                    status: upgrading
                    strategy: serial
                    versions: {}
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_ssr_upgrade'
                - description: SSR firmware upgrade job summary
                  examples:
                  - channel: stable
                    counts:
                      failed: 0
                      queued: 1
                      success: 0
                      upgrading: 1
                    device_type: gateway
                    id: ceef2c8a-e2e6-447a-8b27-cb4f3ec1adae
                    status: upgrading
                    strategy: serial
                    versions: {}
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    channel: stable
                    counts:
                      failed: 0
                      queued: 1
                      success: 0
                      upgrading: 1
                    device_type: gateway
                    id: ceef2c8a-e2e6-447a-8b27-cb4f3ec1adae
                    status: upgrading
                    strategy: serial
                    versions: {}
        '400':
          description: Bad Syntax
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http400'
                - description: Standard HTTP 400 bad request error response
                  examples:
                  - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http401'
                - description: Standard HTTP 401 authentication error response
                  examples:
                  - detail: Authentication credentials were not provided.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: Permission Denied
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http403'
                - description: Standard HTTP 403 permission error response
                  examples:
                  - detail: You do not have permission to perform this action.
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/json
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http404'
                - description: Standard HTTP 404 not found error response
                contentMediaType: application/vnd.api+json
        '429':
          description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
            application/vnd.api+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_http429'
                - description: Standard HTTP 429 rate limit error response
                  examples:
                  - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
                contentMediaType: application/vnd.api+json
              examples:
                Example:
                  value:
                    detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
      deprecated: false
    parameters: []
components:
  schemas:
    aamw_profile:
      title: aamw_profile
      type: object
      properties:
        categories:
          type: array
          items:
            $ref: '#/components/schemas/aamw_profile_category'
          description: File categories evaluated by this Advanced Anti Malware profile
        created_time:
          type: number
          description: Timestamp when the Advanced Anti Malware profile was created
          readOnly: true
        fallback_action:
          allOf:
          - $ref: '#/components/schemas/aamw_profile_action3'
          - description: 'Action to take when Sky ATP cannot obtain a malware verdict. enum: `block`, `permit`.'
        file_action:
          allOf:
          - $ref: '#/components/schemas/aamw_profile_action1'
          - description: 'Action to take for files that meet or exceed the malware verdict threshold. enum: `block`, `permit`.'
        id:
          type: string
          description: Unique identifier of the Advanced Anti Malware profile
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        modified_time:
          type: number
          description: Timestamp when the Advanced Anti Malware profile was last modified
          readOnly: true
        name:
          type: string
          description: Display name of the Advanced Anti Malware profile
          examples:
          - aamw-custom
        org_id:
          type: string
          description: Organization that owns this Advanced Anti Malware profile
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        site_id:
          type: string
          description: Site associated with this derived Advanced Anti Malware profile
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        verdict_threshold:
          maximum: 10
          minimum: 1
          type: integer
          description: Minimum Sky ATP verdict score that triggers the configured file action
          contentEncoding: int32
          default: 8
      description: Advanced Anti Malware profile that controls Sky ATP file verdict handling
    aamw_profile_action:
      title: aamw_profile_action
      enum:
      - block
      - permit
      type: string
      description: 'Action applied to files by an Advanced Anti Malware profile. enum: `block`, `permit`'
    aamw_profile_category:
      title: aamw_profile_category
      type: object
      properties:
        category:
          allOf:
          - $ref: '#/components/schemas/aamw_profile_category_category2'
          - description: 'File category covered by this Advanced Anti Malware profile. enum: `archive`, `document`, `pdf`, `executable`, `rich_application`, `library`, `os_package`, `mobile`, `java`, `configuration`, `script`.'
        hash_lookup_only:
          type: boolean
          description: Whether files in this category use hash lookup without full file analysis
          default: false
      description: File category rule for Advanced Anti Malware inspection
    aamw_profile_category_category:
      title: aamw_profile_category_category
      enum:
      - archive
      - document
      - pdf
      - executable
      - rich_application
      - library
      - os_package
      - mobile
      - java
      - configuration
      - script
      type: string
      description: 'enum: `archive`, `document`, `pdf`, `executable`, `rich_application`, `library`, `os_package`, `mobile`, `java`, `configuration`, `script`'
    account_cradlepoint_config:
      title: account_cradlepoint_config
      type: object
      properties:
        cp_api_id:
          type: string
          description: Cradlepoint API ID used by Mist for the integration
          examples:
          - 84446d61-2206-4ea5-855a-0043f980be54
        cp_api_key:
          type: string
          description: Cradlepoint API key paired with the Cradlepoint API ID
          examples:
          - 79c329da9893e34099c7d8ad5cb9c941
        ecm_api_id:
          type: string
          description: Cradlepoint ECM API ID used by Mist for the integration
          examples:
          - 73446d61-2206-4ea5-855a-0043f980be62
        ecm_api_key:
          type: string
          description: Cradlepoint ECM API key paired with the ECM API ID
          examples:
          - 68b329da9893e34099c7d8ad5cb9c9405
        enable_lldp:
          type: boolean
          description: Whether Mist uses Cradlepoint LLDP data to link routers to Mist sites and devices
      description: Cradlepoint account credentials and LLDP integration settings
    account_crowdstrike_config:
      title: account_crowdstrike_config
      required:
      - client_id
      - client_secret
      - customer_id
      type: object
      properties:
        client_id:
          type: string
          description: Customer account api client ID
        client_secret:
          type: string
          description: Customer account api client Secret
        customer_id:
          type: string
          description: Customer id of an admin
      description: OAuth linked CrowdStrike apps account details
    account_jamf_config:
      title: account_jamf_config
      required:
      - client_id
      - client_secret
      - instance_url
      - smartgroup_name
      type: object
      properties:
        client_id:
          type: string
          description: Customer account api client id. Required if `app_name`==`crowdstrike`
        client_secret:
          type: string
          description: Customer account api client secret
        instance_url:
          type: string
          description: Customer account Jamf instance URL
          examples:
          - junipertest.jamfcloud.com
        smartgroup_name:
          type: string
          description: Smart group membership for determining compliance status
          examples:
          - CompliantGroup1
      description: OAuth linked Jamf apps account details
    account_jse_config:
      title: account_jse_config
      required:
      - password
      - username
      type: object
      properties:
        cloud_name:
          type: string
          description: JSE cloud hostname used for the integration
          examples:
          - devcentral.juniperclouds.net
        password:
          type: string
          description: Credential password for the JSE integration user
          contentEncoding: password
          examples:
          - foryoureyesonly
        username:
          type: string
          description: JSE integration username with access to service location, site, and IPsec profile APIs
          examples:
          - john@abc.com
      description: Juniper Security Exchange account credentials used for integration
    account_jse_info:
      title: account_jse_info
      type: object
      properties:
        cloud_name:
          type: string
          description: JSE cloud hostname configured for the integration
          examples:
          - devcentral.juniperclouds.net
        org_names:
          uniqueItems: true
          type: array
          items:
            type: string
          description: JSE organization names associated with the linked account
        username:
          type: string
          description: JSE integration username configured for the linked account
          examples:
          - john@abc.com
      description: Linked Juniper Security Exchange account information
    account_juniper_config:
      title: account_juniper_config
      required:
      - password
      - username
      type: object
      properties:
        password:
          type: string
          description: Authentication password for the Juniper account
          contentEncoding: password
          examples:
          - password
        username:
          type: string
          description: Customer account user name
          examples:
          - john@nmo.com
      description: Juniper account credentials used to link the integration
    account_juniper_info:
      title: account_juniper_info
      type: object
      properties:
        accounts:
          type: array
          items:
            $ref: '#/components/schemas/juniper_account'
          description: List of linked Juniper account records
      description: Linked Juniper account information returned by the integration
    account_mobicontrol_config:
      title: account_mobicontrol_config
      required:
      - client_id
      - client_secret
      - instance_url
      - password
      - username
      type: object
      properties:
        client_id:
          type: string
          description: Customer account Client ID
        client_secret:
          type: string
          description: Customer account Client Secret
        instance_url:
          type: string
          description: Customer account MobiControl instance URL
        password:
          type: string
          description: Customer account password instance URL
          contentEncoding: password
        username:
          type: string
          description: Login username used to authenticate to the MobiControl account
      description: MobiControl account credentials used for OAuth application linking
    account_oauth_config:
      title: account_oauth_config
      required:
      - account_id
      type: object
      properties:
        account_id:
          type: string
          description: Linked app(zoom/teams/intune) account id
          examples:
          - iojzXIJWEuiD73ZvydOfg
        discard_guest_info:
          type: boolean
          description: Optional, for Zoom/Teams. Whether to redact identifying information for call participants that are not part of the Zoom/Teams account identified by `account_id`
        max_daily_api_requests:
          type: integer
          description: Zoom daily api request quota, https://developers.zoom.us/docs/api/rest/rate-limits/
          contentEncoding: int32
          examples:
          - 5000
      description: OAuth linked apps (zoom/teams/intune) account details
    account_oauth_info:
      title: account_oauth_info
      required:
      - accounts
      - linked
      type: object
      properties:
        accounts:
          type: array
          items:
            $ref: '#/components/schemas/account_oauth_info_account'
          description: Linked third-party application accounts for this OAuth application
        authorization_url:
          type: string
          description: OAuth authorization URL to open when linking an account
          readOnly: true
        linked:
          type: boolean
          description: Whether at least one account is linked for this OAuth application
          readOnly: true
      description: OAuth-linked application account status and authorization details
    account_oauth_info_account:
      title: account_oauth_info_account
      type: object
      properties:
        account_id:
          type: string
          description: Linked app account id
          readOnly: true
          examples:
          - iojzXIJWEuiD73ZvydOfg
        auto_probe_subnet:
          type: string
          description: For Prisma accounts only, tunnel auto probe subnet
          readOnly: true
          examples:
          - 11.0.0.0/8
        client_id:
          type: string
          description: Customer account Client ID
          readOnly: true
        cloud_name:
          type: string
          description: Name of the company whose account mist has subscribed to
          readOnly: true
          examples:
          - Tapi.sase.paloaltonetworks.com
        company:
          type: string
          description: Name of the company whose account mist has subscribed to
          readOnly: true
          examples:
          - Test Company1 Ltd
        enable_probe:
          type: boolean
          description: For Prisma accounts only, tunnel probe enable/disable
          readOnly: true
          examples:
          - false
        error:
          type: string
          description: This error is provided when the account fails to fetch token/data
          readOnly: true
          examples:
          - OAuth token refresh failed, please re-link your account
        errors:
          type: array
          items:
            type: string
          description: Problems reported during OAuth token refresh or account data sync
          readOnly: true
          examples:
          - - OAuth token refresh failed, please re-link your account
            - API daily rate limit reached for your account
        instance_url:
          type: string
          description: Customer account instance URL
          readOnly: true
        key_id:
          type: string
          description: For ZDX Account only, Customer account API key ID
          examples:
          - L72frZcK3JvrZc
        last_status:
          type: string
          description: Is the last data pull for account is successful or not
          readOnly: true
          examples:
          - failed
        last_sync:
          type: integer
          description: Last data pull timestamp, background jobs that pull account data
          contentEncoding: int64
          readOnly: true
          examples:
          - 1665465339000
        linked_by:
          type: string
          description: First name of the user who linked the account
          readOnly: true
          examples:
          - Testname1
        linked_timestamp:
          type: number
          description: Timestamp when this third-party account was linked
          readOnly: true
          examples:
          - 1665465339000
        max_daily_api_requests:
          type: integer
          description: Zoom daily api request quota, https://developers.zoom.us/docs/api/rest/rate-limits/
          contentEncoding: int32
          readOnly: true
          examples:
          - 5000
        name:
          type: string
          description: Display name of the linked third-party account or company
          readOnly: true
          examples:
          - Test Compay1 Ltd
        password:
          type: string
          description: Customer account password instance URL
          contentEncoding: password
          readOnly: true
        region:
          type: string
          description: For Prisma accounts only
          readOnly: true
          examples:
          - americas
        regions:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/account_oauth_info_account_region'
          description: Prisma Access regions with allocated bandwidth for this linked account
        service_account_name:
          type: string
          description: For Prisma accounts only
          readOnly: true
          examples:
          - Corp SA
        service_connections:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/account_oauth_info_account_service_connection'
          description: Prisma Access service connections configured for this linked account
        smartgroup_name:
          type: string
          description: Smart group membership for determining compliance status
          readOnly: true
          examples:
          - CompliantGroup1
        tsg_id:
          type: string
          description: For Prisma accounts only, Prisma Tenant Service Group id
          readOnly: true
          examples:
          - '189953456'
        username:
          type: string
          description: Login name configured for the linked third-party account
          readOnly: true
        webhook_auth_type:
          type: string
          description: For Crowdstrike, JAMF, SentinelOne and VMWare accounts only
          examples:
          - Basic
          - Bearer
        webhook_enabled:
          type: boolean
          description: For Crowdstrike, JAMF, SentinelOne and VMWare accounts only
        webhook_password:
          type: string
          description: For VMWare accounts only
          contentEncoding: password
          examples:
          - password_1234
        webhook_secret:
          type: string
          description: For Crowdstrike accounts only
          contentEncoding: password
          examples:
          - secret-value
        webhook_token:
          type: string
          description: For JAMF and SentinelOne accounts only
          examples:
          - token-value
        webhook_url:
          type: string
          description: For Crowdstrike, JAMF, SentinelOne and VMWare accounts only
          examples:
          - https://websync.nac-staging.mistsys.com/v1/S_org-8dcbe9005/ae9dee49-69e7-4710-a114-5b827a777738/crowdstrike/edr
          - https://websync.nac-staging.mistsys.com/v1/S_org-8dcbe9005/ae9dee49-69e7-4710-a114-5b827a777738/jamf/mdm
          - https://websync.nac-staging.mistsys.com/v1/S_org-8dcbe9005/00fd8b39-cf92-4b43-a2ff-a461b48e7059/sentinelone/edr
          - https://websync.nac-staging.mistsys.com/v1/S_41b2525af1d8dcbe9005/f43ea4c48f22/vmware/mdm
        webhook_username:
          type: string
          description: For VMWare accounts only
          examples:
          - username_1234
        zdx_org_id:
          type: string
          description: For ZDX Account only, ZDX organization id
          examples:
          - '123456'
      description: OAuth linked apps account info
    account_oauth_info_account_region:
      title: account_oauth_info_account_region
      type: object
      properties:
        aggregate_region:
          type: string
          description: Bandwidth Aggregate region for this region
          examples:
          - us-southwest
        allocated_bandwidth:
          type: integer
          description: Allocated bandwidth for the region, in Mbps
          contentEncoding: int32
          readOnly: true
          examples:
          - 1000
        name:
          type: string
          description: Display name for this region
          examples:
          - US West
      description: Prisma Access region bandwidth allocation for a linked OAuth account
    account_oauth_info_account_service_connection:
      title: account_oauth_info_account_service_connection
      type: object
      properties:
        region:
          type: string
          description: Prisma Access region where this service connection is provisioned
          examples:
          - us-southwest
      description: Prisma Access service connection region for a linked OAuth account
    account_prisma_config:
      title: account_prisma_config
      required:
      - client_id
      - client_secret
      - tsg_id
      type: object
      properties:
        auto_probe_subnet:
          type: string
          description: Required If `enable_probe`==`true`. This field will accept an IPv4 cidr and an IP address will be picked from this range to be used as tunnel probe source IP address and as well as BGP neighbour IP address. The subnet should be big enough for num_devices * num_tunnel * 2
          examples:
          - 11.0.0.0/8
        client_id:
          type: string
          description: Customer account api client ID
        client_secret:
          type: string
          description: Customer account api client Secret
        enable_probe:
          type: boolean
          description: To enable/disable tunnel probe
          default: false
        tsg_id:
          type: string
          description: Prisma Tenant Service Group id
      description: OAuth linked CrowdStrike apps account details
    account_sentinelone_config:
      title: account_sentinelone_config
      required:
      - api_token
      - instance_url
      type: object
      properties:
        api_token:
          type: string
          description: Access token used to authenticate to the SentinelOne account
        instance_url:
          type: string
          description: Customer account SentinelOne instance URL
      description: OAuth linked CrowdStrike apps account details
    account_skyatp_cloud_name:
      title: account_skyatp_cloud_name
      enum:
      - www.amerskyatp.com
      - www.apacskyatp.com
      - www.euroskyatp.com
      - www.canadaskyatp.com
      type: string
      description: 'Sky ATP cloud name. enum: `www.amerskyatp.com`, `www.apacskyatp.com`, `www.euroskyatp.com`, `www.canadaskyatp.com`'
      examples:
      - www.amerskyatp.com
    account_skyatp_config:
      title: account_skyatp_config
      required:
      - password
      - realm
      - username
      type: object
      properties:
        cloud_name:
          allOf:
          - $ref: '#/components/schemas/account_skyatp_cloud_name1'
          - description: 'Sky ATP cloud endpoint used for the integration. enum: `www.amerskyatp.com`, `www.apacskyatp.com`, `www.euroskyatp.com`, `www.canadaskyatp.com`.'
            examples:
            - www.amerskyatp.com
        password:
          type: string
          description: Credential password for the Sky ATP realm user
          contentEncoding: password
          examples:
          - foryoureyesonly
        realm:
          type: string
          description: Sky ATP realm to create or link with this Mist organization
          examples:
          - mist-team
        username:
          type: string
          description: Sky ATP username used to create or access the realm
          examples:
          - john@abc.com
      description: Sky ATP account credentials and realm settings used for integration
    account_skyatp_data:
      title: account_skyatp_data
      type: object
      properties:
        secintel:
          allOf:
          - $ref: '#/components/schemas/account_skyatp_data_secintel2'
          - description: Juniper SecIntel threat feed configuration provided by Sky ATP
        secintel_allowlist_url:
          type: string
          description: URL for the Sky ATP SecIntel allowlist
          readOnly: true
          examples:
          - https://papi.s3.amazonaws.com/secintel_allowlist/xxx...
        secintel_blocklist_url:
          type: string
          description: URL for the Sky ATP SecIntel blocklist
          readOnly: true
          examples:
          - https://papi.s3.amazonaws.com/secintel_blocklist/xxx...
      description: Sky ATP SecIntel feed data and generated list URLs
    account_skyatp_data_secintel:
      title: account_skyatp_data_secintel
      type: object
      properties:
        third_party_threat_feeds:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Third-party threat feed names enabled for SecIntel
      description: >-
        juniper secintel_feeds are enabled depending on your license tier: infected_host, geo_ip, attacker_ip, command_and_control.

        third party:
          * ip-based: block_list, threatfox_ip, feodo_tracker, dshield, tor
          * url-based: threatfox_url, urlhaus, open_phish
          * domain-based: threatfox_domains
    account_skyatp_info:
      title: account_skyatp_info
      type: object
      properties:
        cloud_name:
          allOf:
          - $ref: '#/components/schemas/account_skyatp_cloud_name2'
          - description: 'Sky ATP cloud endpoint configured for the integration. enum: `www.amerskyatp.com`, `www.apacskyatp.com`, `www.euroskyatp.com`, `www.canadaskyatp.com`.'
            examples:
            - www.amerskyatp.com
        realm:
          type: string
          description: Sky ATP realm linked with this Mist organization
          examples:
          - mist-team
        username:
          type: string
          description: Sky ATP username configured for the linked realm
          examples:
          - john@abc.com
      description: Linked Sky ATP account and realm information
    account_vmware_config:
      title: account_vmware_config
      required:
      - client_id
      - client_secret
      - instance_url
      - webhook_enabled
      type: object
      properties:
        client_id:
          type: string
          description: Customer account Client ID
        client_secret:
          type: string
          description: Customer account Client Secret
        instance_url:
          type: string
          description: Customer account VMware instance URL
        webhook_enabled:
          type: boolean
          description: Enables or disables the webhook integration
      description: VMware account credentials and webhook settings for OAuth application linking
    account_zdx_config:
      title: account_zdx_config
      required:
      - key_id
      - key_secret
      - zdx_org_id
      type: object
      properties:
        cloud_name:
          type: string
          description: ZDX cloud name. Refer https://help.zscaler.com/zdx/getting-started-zdx-api for ZDX cloud name
          default: zdxcloud.net
        key_id:
          type: string
          description: Customer account API key ID
          examples:
          - K35vrZcK3JvrZc
        key_secret:
          type: string
          description: Customer account API key Secret
          examples:
          - K35vrZcK3JvrZcjjswpp2eii1oo100
        zdx_org_id:
          type: string
          description: Organization identifier assigned to the ZDX account
          examples:
          - '123456'
      description: OAuth linked ZDX apps account details
    account_zscaler_config:
      title: account_zscaler_config
      required:
      - cloud_name
      - partner_key
      - password
      - username
      type: object
      properties:
        cloud_name:
          type: string
          description: Zscaler Internet Access cloud name used for the integration
          examples:
          - zscalerbeta.net
        partner_key:
          type: string
          description: Zscaler partner key generated for the Mist integration
          examples:
          - K35vrZcK3JvrZc
        password:
          type: string
          description: Credential password for the Zscaler partner administrator
          contentEncoding: password
          examples:
          - password
        username:
          type: string
          description: Zscaler partner administrator username used by Mist
          examples:
          - john@nmo.com
      description: OAuth linked Zscaler apps account details
    account_zscaler_info:
      title: account_zscaler_info
      type: object
      properties:
        cloud_name:
          type: string
          description: Zscaler Internet Access cloud name configured for the integration
          examples:
          - zscalerbeta.net
        partner_key:
          type: string
          description: Zscaler partner key configured for the Mist integration
          examples:
          - K35vrZcK3JvrZc
        username:
          type: string
          description: Zscaler partner administrator username configured for Mist
          examples:
          - john@nmo.com
      description: OAuth linked Zscaler apps account details
    acl_policy:
      title: acl_policy
      type: object
      properties:
        actions:
          type: array
          items:
            $ref: '#/components/schemas/acl_policy_action'
          description: Destination tag actions evaluated for sources matching this ACL policy
        disabled:
          type: boolean
          description: Whether this ACL policy is disabled
          default: false
        name:
          type: string
          description: Display name of the ACL policy
          examples:
          - guest access
        src_tags:
          type: array
          items:
            type: string
          description: Source ACL tags that select traffic for this ACL policy
      description: >-
        ACL Policy:
          - for GBP-based policy, all src_tags and dst_tags have to be gbp-based
          - for ACL-based policy, `network` is required in either the source or destination so that we know where to attach the policy to
    acl_policy_action:
      title: acl_policy_action
      required:
      - dst_tag
      type: object
      properties:
        action:
          allOf:
          - $ref: '#/components/schemas/allow_deny4'
          - description: Allow or deny decision applied to traffic matching the destination tag
        dst_tag:
          type: string
          description: Destination ACL tag matched by this policy action
          examples:
          - corp
      description: Action applied to traffic that matches a destination ACL tag
    acl_tag:
      title: acl_tag
      required:
      - type
      type: object
      properties:
        ether_types:
          type: array
          items:
            type: string
          description: Layer 2 EtherTypes matched by this ACL tag; defaults to `any`
          default:
          - any
        gbp_tag:
          type: integer
          description: >-
            Required if
              - `type`==`dynamic_gbp` (gbp_tag received from RADIUS)
              - `type`==`gbp_resource`
              - `type`==`static_gbp` (applying gbp tag against matching conditions)
          contentEncoding: int32
        macs:
          type: array
          items:
            type: string
          description: Client or resource MAC addresses matched by this ACL tag
        network:
          type: string
          description: >-
            If:
              * `type`==`mac` (optional. default is `any`)
              * `type`==`subnet` (optional. default is `any`)
              * `type`==`network`
              * `type`==`resource` (optional. default is `any`)
              * `type`==`static_gbp` if from matching network (vlan)
        port_usage:
          type: string
          description: Required if `type`==`port_usage`. Switch port usage name matched by this ACL tag
        radius_group:
          type: string
          description: >-
            Required if:
              * `type`==`radius_group`
              * `type`==`aruba_user_role`
              * `type`==`static_gbp`
            if from matching radius_group
        specs:
          type: array
          items:
            $ref: '#/components/schemas/acl_tag_spec'
          description: Layer 4 protocol and destination-port constraints for this ACL tag
        subnets:
          type: array
          items:
            type: string
          description: IP subnets matched by this ACL tag
        type:
          allOf:
          - $ref: '#/components/schemas/acl_tag_type2'
          - description: 'Classifier type that determines which ACL tag fields are evaluated. enum: `any`, `aruba_user_role`, `dynamic_gbp`, `gbp_resource`, `mac`, `network`, `port_usage`, `radius_group`, `resource`, `static_gbp`, `subnet`.'
      description: Resource tags (`type`==`resource` or `type`==`gbp_resource`) can only be used in `dst_tags`
    acl_tag_spec:
      title: acl_tag_spec
      type: object
      properties:
        port_range:
          type: string
          description: Matched dst port, "0" means any
          default: '0'
        protocol:
          type: string
          description: '`tcp` / `udp` / `icmp` / `icmp6` / `gre` / `any` / `:protocol_number`, `protocol_number` is between 1-254, default is `any` `protocol_number` is between 1-254'
          default: any
      description: Layer 4 protocol and destination-port match constraint for an ACL tag
    acl_tag_type:
      title: acl_tag_type
      enum:
      - any
      - aruba_user_role
      - dynamic_gbp
      - gbp_resource
      - mac
      - network
      - port_usage
      - radius_group
      - resource
      - static_gbp
      - subnet
      type: string
      description: "enum: \n  * `any`: matching anything not identified\n  * `aruba_user_role`: Aruba user role matched via `radius_group`\n  * `dynamic_gbp`: from the gbp_tag received from RADIUS\n  * `gbp_resource`: can only be used in `dst_tags`\n  * `mac`\n  * `network`\n  * `port_usage`\n  * `radius_group`\n  * `resource`: can only be used in `dst_tags`\n  * `static_gbp`: applying gbp tag against matching conditions\n  * `subnet`'"
    admin:
      title: admin
      type: object
      properties:
        admin_id:
          type: string
          description: Unique identifier of the administrator
          contentEncoding: uuid
          readOnly: true
          examples:
          - 456b7016-a916-a4b1-78dd-72b947c152b7
        compliance_status:
          allOf:
          - $ref: '#/components/schemas/admin_compliance_status2'
          - description: 'Trade compliance status for this administrator. enum: `blocked`, `restricted`.'
        email:
          type: string
          description: If admin account is not an Org API Token
          contentEncoding: email
          examples:
          - jsnow@abc.com
        enable_two_factor:
          type: boolean
          description: If admin account is not an Org API Token
          readOnly: true
        expire_time:
          type: integer
          description: Expiration time for the admin invitation, in epoch seconds
          contentEncoding: int32
        first_name:
          type: string
          description: If admin account is not an Org API Token. For an invite, this is the original first name used
          examples:
          - John
        hours:
          maximum: 168
          minimum: 1
          type: integer
          description: If admin account is not an Org API Token, how long the invite should be valid
          contentEncoding: int32
          default: 24
        last_name:
          type: string
          description: If admin account is not an Org API Token. For an invite, this is the original last name used
          examples:
          - Sno
        name:
          type: string
          description: For Org API Token Only
        no_tracking:
          type:
          - boolean
          - 'null'
          description: Optional, whether to store privacy-consent information. When it doesn’t exist, it’s assumed true on EU (i.e. no tracking, the user has to opt-in); otherwise, the user would have to opt-out
        oauth_google:
          type: boolean
          description: If admin account is not an Org API Token
          readOnly: true
        password_modified_time:
          type: number
          description: Password last modified time, in epoch
        phone:
          type: string
          description: If admin account is not an Org API Token. Phone number (numbers only, including country code)
        phone2:
          type: string
          description: If admin account is not an Org API Token. Secondary phone number (numbers only, including country code)
        privileges:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/admin_privilege'
          description: Privilege assignments that define the admin's MSP, organization, site, or site group access
        session_expiry:
          maximum: 20160
          minimum: 10
          type: integer
          description: Session lifetime for the admin, in minutes
          contentEncoding: int64
          readOnly: true
          examples:
          - 1440
        tags:
          type: array
          items:
            type: string
          description: Read-only tags associated with the admin account
          readOnly: true
        two_factor_verified:
          type: boolean
          description: If admin account is not an Org API Token. Two factor status
          readOnly: true
        via_sso:
          type: boolean
          description: If admin account is not an Org API Token, an admin login via_sso is more restircted. (password and email cannot be changed)
          readOnly: true
      description: Mist administrator account or organization API token details
    admin_compliance_status:
      title: admin_compliance_status
      enum:
      - blocked
      - restricted
      type: string
      description: 'trade compliance status. enum: `blocked`, `restricted`'
    admin_invite:
      title: admin_invite
      required:
      - email
      - first_name
      - last_name
      - org_name
      - password
      - recaptcha
      type: object
      properties:
        account_only:
          type: boolean
          description: Skip creating initial setup if true
          default: false
        allow_mist:
          type: boolean
          description: Whether to allow Mist to look at this org
          default: false
        city:
          type: string
          description: Registration city for the admin user
          examples:
          - Cupertino
        country:
          type: string
          description: Registration country or region for the admin user, as a name or ISO code
          examples:
          - United States
        email:
          maxLength: 64
          type: string
          description: Registration email address for the admin user
          examples:
          - test@mistsys.com
        first_name:
          type: string
          description: Given name for the registering admin user
          examples:
          - John
        invite_code:
          type: string
          description: Invite code used to authorize new admin registration
          examples:
          - MISTROCKS
        last_name:
          type: string
          description: Family name for the registering admin user
          examples:
          - Smith
        org_name:
          type: string
          description: Organization name supplied during initial admin registration
          examples:
          - Smith LLC
        password:
          type: string
          description: Credential password for the registering admin account
          contentEncoding: password
          examples:
          - foryoureyesonly
        recaptcha:
          type: string
          description: CAPTCHA verification token submitted during admin registration
        recaptcha_flavor:
          allOf:
          - $ref: '#/components/schemas/recaptcha_flavor4'
          - description: 'CAPTCHA provider flavor used for registration verification. enum: `google`, `hcaptcha`.'
            examples:
            - hcaptcha
        referer_invite_token:
          type: string
          description: Invite token to apply after account creation
          examples:
          - Dm2gtT8dwMeM4Bc2E8FLIaA96VHOjPat
        return_to:
          type: string
          description: URL the user should be redirected back to
          examples:
          - https://mist.zendesk.com/hc/quickstart.pdf
        state:
          type: string
          description: Registration state or province for the admin user, optional depending on country or region
          examples:
          - CA
        street_address:
          type: string
          description: Street address of registering user
          examples:
          - 1601 S De Anza Blvd Ste 248
        street_address 2:
          type: string
          description: Street address 2 of registering user
          examples:
          - 1601 S De Anza Blvd Ste 248
        zipcode:
          type: string
          description: Postal code for the registering admin user
          examples:
          - '95014'
      description: Administrator invitation and initial registration payload
    admin_privilege:
      title: admin_privilege
      required:
      - role
      - scope
      type: object
      properties:
        msp_id:
          type: string
          description: Required if `scope`==`msp`. MSP granted by this privilege
          contentEncoding: uuid
          examples:
          - b9d42c2e-88ee-41f8-b798-f009ce7fe909
        msp_logo_url:
          type: string
          description: Logo of the MSP (if the MSP belongs to an Advanced tier)
          readOnly: true
        msp_name:
          type:
          - string
          - 'null'
          description: Name of the MSP (if the org belongs to an MSP)
          readOnly: true
        msp_url:
          type: string
          description: Custom url of the MSP (if the MSP belongs to an Advanced tier)
          readOnly: true
        name:
          type: string
          description: Display name of the object for this privilege scope
          readOnly: true
        org_id:
          type: string
          description: Required if `scope`==`org`. Organization granted by this privilege
          contentEncoding: uuid
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        org_name:
          type: string
          description: Name of the org (for a site belonging to org)
          readOnly: true
        orggroup_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: If `scope`==`orggroup`. Organization groups granted by this privilege
        role:
          allOf:
          - $ref: '#/components/schemas/admin_privilege_role2'
          - description: 'Access role granted by this privilege. enum: `admin`, `helpdesk`, `installer`, `read`, `write`.'
        scope:
          allOf:
          - $ref: '#/components/schemas/admin_privilege_scope2'
          - description: 'Object scope where this privilege applies. enum: `msp`, `org`, `orggroup`, `site`, `sitegroup`.'
        site_id:
          type: string
          description: Required if `scope`==`site`. Site granted by this privilege
          contentEncoding: uuid
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        sitegroup_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: If `scope`==`sitegroup`. Site groups granted by this privilege
        views:
          type: array
          items:
            $ref: '#/components/schemas/admin_privilege_view'
          description: UI view restrictions applied when custom roles limit this privilege
      description: Admin privilege scope, role, and UI access settings
    admin_privilege_role:
      title: admin_privilege_role
      enum:
      - admin
      - helpdesk
      - installer
      - read
      - write
      type: string
      description: 'access permissions. enum: `admin`, `helpdesk`, `installer`, `read`, `write`'
    admin_privilege_scope:
      title: admin_privilege_scope
      enum:
      - msp
      - org
      - orggroup
      - site
      - sitegroup
      type: string
      description: 'enum: `msp`, `org`, `orggroup`, `site`, `sitegroup`'
    admin_privilege_view:
      title: admin_privilege_view
      enum:
      - lobby_admin
      - location
      - marketing
      - mxedge_admin
      - reporting
      - security
      - super_observer
      - switch_admin
      type: string
      description: 'UI view name allowed by a custom admin role. enum: `lobby_admin`, `location`, `marketing`, `mxedge_admin`, `reporting`, `security`, `super_observer`, `switch_admin`'
    aggregate_route:
      title: aggregate_route
      type: object
      properties:
        discard:
          type: boolean
          description: Whether to install the aggregate route as a discard route
          default: false
        metric:
          maximum: 4294967295
          minimum: 0
          type:
          - integer
          - 'null'
          description: Routing metric assigned to the aggregate route
          contentEncoding: int32
        preference:
          maximum: 4294967295
          minimum: 0
          type:
          - integer
          - 'null'
          description: Route preference assigned to the aggregate route
          contentEncoding: int32
      description: Aggregate route configuration for a network or routing instance
    alarm:
      title: alarm
      required:
      - count
      - group
      - id
      - last_seen
      - severity
      - timestamp
      - type
      type: object
      properties:
        ack_admin_id:
          type: string
          description: UUID of the admin who acked the alarm
          contentEncoding: uuid
          readOnly: true
          examples:
          - 456b7016-a916-a4b1-78dd-72b947c152b7
        ack_admin_name:
          type: string
          description: Name & Email ID of the admin who acked the alarm
          examples:
          - Joe
        acked:
          type: boolean
          description: Whether the alarm is acked or not
          examples:
          - true
        acked_time:
          type: integer
          description: Epoch (seconds) when the alarm was acked
          contentEncoding: int32
          readOnly: true
          examples:
          - 1711031352
        aps:
          type: array
          items:
            type: string
          description: Access point MAC addresses related to this alarm
          examples:
          - - ffeeddccbbaa
            - ffeeddccbbab
        bssids:
          type: array
          items:
            type: string
          description: Wireless BSSIDs related to this alarm
        count:
          type: integer
          description: Number of incident within an alarm window
          contentEncoding: int32
          readOnly: true
          examples:
          - 2
        gateways:
          type: array
          items:
            type: string
          description: Gateway MAC addresses related to this alarm
          examples:
          - - ffeeddccbbaa
            - ffeeddccbbab
        group:
          type: string
          description: Category group for this alarm, such as certificate_expiry, infrastructure, marvis, or security
          examples:
          - security
        hostnames:
          type: array
          items:
            type: string
          description: Device hostnames related to this alarm
          examples:
          - - MC_DavidL
            - MCM_AP_33_Nishant
        id:
          type: string
          description: Unique identifier of the alarm
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        last_seen:
          type: number
          description: Epoch (seconds) of the last incident/alarm within an alarm window
          readOnly: true
          examples:
          - 1711031774
        note:
          type: string
          description: Text describing the alarm
        org_id:
          type: string
          description: Organization associated with this alarm
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        resolved_time:
          type: integer
          description: Epoch (seconds) of the resolved_time for the alarm
          contentEncoding: int32
        severity:
          type: string
          description: Impact level assigned to this alarm, such as critical, warn, or info
          examples:
          - critical
        site_id:
          type: string
          description: Site associated with this alarm
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        ssids:
          type: array
          items:
            type: string
          description: Wireless SSIDs related to this alarm
        status:
          allOf:
          - $ref: '#/components/schemas/alarm_status2'
          - description: 'Current lifecycle status of this alarm. enum: `open`, `resolved`.'
        switches:
          type: array
          items:
            type: string
          description: Switch MAC addresses related to this alarm
          examples:
          - - ffeeddccbbaa
            - ffeeddccbbab
        timestamp:
          type: number
          description: Time when the alarm was raised, in epoch seconds
          readOnly: true
        type:
          type: string
          description: Key-name of the alarm type
          readOnly: true
          examples:
          - rogue_client
      description: Additional information per alarm type
    alarm_ack:
      title: alarm_ack
      required:
      - alarm_ids
      type: object
      properties:
        alarm_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Alarm identifiers to acknowledge or unacknowledge
          examples:
          - - ccb8c94d-ca56-4075-932f-1f2ab444ff2c
            - 98ff4a3d-ec9b-4138-a42e-54fc3335179d
        note:
          type: string
          description: Some text note describing the intent
          examples:
          - maintenance window
      description: Request body for acknowledging or unacknowledging alarms
    alarm_count_distinct:
      title: alarm_count_distinct
      enum:
      - acked
      - group
      - severity
      - type
      type: string
      description: 'enum: `acked`, `group`, `severity`, `type`'
    alarm_group:
      title: alarm_group
      enum:
      - certificate_expiry
      - infrastructure
      - marvis
      - security
      type: string
      description: 'Alarm group. enum: `certificate_expiry`, `infrastructure`, `marvis`, `security`'
    alarm_search_result:
      title: alarm_search_result
      required:
      - end
      - limit
      - results
      - start
      - total
      type: object
      properties:
        component:
          type: string
          description: Alarm component matched by the search result
        end:
          type: integer
          description: Upper bound of the alarm search window, in epoch seconds
          contentEncoding: int32
          examples:
          - 1711035686
        limit:
          type: integer
          description: Maximum number of alarm results returned
          contentEncoding: int32
          examples:
          - 10
        next:
          type: string
          description: URL for the next page of alarm search results
          examples:
          - /api/v1/orgs/b3b9f5e6-67b1-4112-9b4c-6824c565eaeb/alarms/search?end=1711035686&limit=10&search_after=%5B1711031354000%2C+%2256bfa7af-b2db-43ee-a4c8-9b820bbba0e1%22%5D&start=1710949286
        page:
          type: integer
          description: Current page number for paginated alarm search results
          contentEncoding: int32
          examples:
          - 1
        results:
          type: array
          items:
            $ref: '#/components/schemas/alarm'
          description: Alarm records returned for this search
        start:
          type: integer
          description: Lower bound of the alarm search window, in epoch seconds
          contentEncoding: int32
          examples:
          - 1710949286
        total:
          type: integer
          description: Number of alarm records matching the search
          contentEncoding: int32
          examples:
          - 232
      description: Paginated response returned by an alarm search
    alarm_severity:
      title: alarm_severity
      enum:
      - critical
      - info
      - warn
      type: string
      description: 'Severity of the alarm. enum: `critical`, `info`, `warn`'
    alarm_status:
      title: alarm_status
      enum:
      - open
      - resolved
      type: string
      description: 'Current lifecycle status of this alarm. enum: `open`, `resolved`'
    alarm_template:
      title: alarm_template
      required:
      - delivery
      - rules
      type: object
      properties:
        created_time:
          type: number
          description: Timestamp when the alarm template was created
          readOnly: true
        delivery:
          allOf:
          - $ref: '#/components/schemas/delivery3'
          - description: Default alarm delivery settings for rules in this template
        id:
          type: string
          description: Unique identifier of the alarm template
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        modified_time:
          type: number
          description: Timestamp when the alarm template was last modified
          readOnly: true
        name:
          type: string
          description: Some string to name the alarm template
          examples:
          - default
        org_id:
          type: string
          description: Organization that owns this alarm template
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        rules:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/alarm_template_rule'
          description: Alarm Rules object to configure the individual alarm keys/types. Property key is the alarm name.
          examples:
          - ap_offline:
              delivery:
                additional_emails:
                - string
                enabled: true
                to_org_admins: true
                to_site_admins: true
              enabled: true
            bad_cable:
              delivery:
                additional_emails:
                - string
                enabled: true
                to_org_admins: true
                to_site_admins: true
              enabled: true
      description: Alarm template defining default delivery and per-alarm rules
    alarm_template_rule:
      title: alarm_template_rule
      type: object
      properties:
        delivery:
          allOf:
          - $ref: '#/components/schemas/delivery1'
          - description: Overrides for the alarm template delivery defaults for this alarm rule
        enabled:
          type: boolean
          description: Whether this alarm rule is enabled in the template
      description: Per-alarm enablement and delivery override in an alarm template
    alarms:
      title: alarms
      required:
      - alarm_ids
      type: object
      properties:
        alarm_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Alarm identifiers to acknowledge or unacknowledge
        note:
          type: string
          description: Some text note describing the intent
      description: Alarm identifiers and optional note used for bulk alarm state changes
    allow_deny:
      title: allow_deny
      enum:
      - allow
      - deny
      type: string
      description: 'Policy action value that either allows or denies matching traffic. enum: `allow`, `deny`'
    anomaly:
      title: anomaly
      required:
      - events
      - sle_baseline
      - sle_deviation
      - timestamp
      type: object
      properties:
        events:
          type: array
          items:
            type: string
          description: Event names contributing to this anomaly
          readOnly: true
        since:
          type: number
          description: Timestamp when the anomalous period began
          readOnly: true
        sle_baseline:
          type: number
          description: Expected SLE value used as the anomaly baseline
          readOnly: true
        sle_deviation:
          type: number
          description: Difference between the observed SLE value and the baseline
          readOnly: true
        timestamp:
          type: number
          description: Time when this anomaly data point was recorded, in epoch seconds
          readOnly: true
      description: SLE anomaly data point with baseline, deviation, and contributing events
    antenna_select:
      title: antenna_select
      enum:
      - external
      - internal
      type: string
      description: 'Antenna Mode for AP which supports selectable antennas. enum: `""` (default), `external`, `internal`'
      examples:
      - external
    aos_register_cmd:
      title: aos_register_cmd
      type: object
      properties:
        cli_commands:
          type: string
          description: AOS-specific CLI commands that can be copied and pasted directly into an AOS device to register it with Mist. Includes registration code and configuration commands.
      description: AOS Brownfield Registration Commands
    aoscx_register_cmd:
      title: aoscx_register_cmd
      type: object
      properties:
        cli_commands:
          type: string
          description: AOSCX-specific CLI commands that can be copied and pasted directly into an AOSCX device to register it with Mist
      description: AOSCX Brownfield Registration Commands
    ap_aeroscout:
      title: ap_aeroscout
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether to enable aeroscout config
          default: false
        host:
          type:
          - string
          - 'null'
          description: Required if enabled, aeroscout server host
          examples:
          - aero.pvt.net
        locate_connected:
          type: boolean
          description: Whether to enable the feature to allow wireless clients data received and sent to AES server for location calculation
          default: false
        port:
          type:
          - integer
          - 'null'
          description: Optional if enabled, Aeroscout server port. Defaults to 1144
          contentEncoding: int32
          default: 1144
      description: AeroScout location integration settings applied to an AP or AP profile
    ap_airista:
      title: ap_airista
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether to enable Airista config
          default: false
        host:
          type:
          - string
          - 'null'
          description: Required if enabled, Airista server host
          examples:
          - airista.pvt.net
        port:
          type:
          - integer
          - 'null'
          description: Optional if enabled, Airista server port. Defaults to 1144
          contentEncoding: int32
          default: 1144
      description: Airista RTLS integration settings for an AP
    ap_centrak:
      title: ap_centrak
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether to enable Centrak config
          default: false
      description: CenTrak integration settings for an AP
    ap_client_bridge:
      title: ap_client_bridge
      type: object
      properties:
        auth:
          allOf:
          - $ref: '#/components/schemas/ap_client_bridge_auth2'
          - description: Credentials and security mode used when the AP connects as a wireless client bridge
        enabled:
          type: boolean
          description: >-
            When acted as client bridge:
              * only 5G radio can be used
              * will not serve as AP on any radios
          default: false
        ssid:
          minLength: 1
          type: string
          description: Uplink SSID used by the AP when client bridge mode is enabled
          examples:
          - Uplink-SSID
      description: AP client bridge mode configuration
    ap_client_bridge_auth:
      title: ap_client_bridge_auth
      type: object
      properties:
        psk:
          maxLength: 63
          minLength: 8
          type: string
          description: Pre-shared key used when `type`==`psk` for client bridge authentication
          examples:
          - foryoureyesonly
        type:
          allOf:
          - $ref: '#/components/schemas/ap_client_bridge_auth_type2'
          - minLength: 1
            description: 'Authentication mode for the client bridge connection. enum: `open`, `psk`.'
            examples:
            - psk
      description: Authentication settings for the AP client bridge uplink
    ap_client_bridge_auth_type:
      title: ap_client_bridge_auth_type
      enum:
      - open
      - psk
      type: string
      description: 'wpa2-AES/CCMPp is assumed when `type`==`psk`. enum: `open`, `psk`'
      examples:
      - psk
    ap_esl_config:
      title: ap_esl_config
      type: object
      properties:
        cacert:
          type: string
          description: Only if `type`==`imagotag` or `type`==`native`
          examples:
          - >
            --BEGIN CERTIFICATE--

            MIIDXTCCAkWgAwIBAgIJAL5b1z4f3k2TMA0GCSqGSIb3DQEBCwUAMIGVMQsw
        channel:
          type: integer
          description: Only if `type`==`imagotag` or `type`==`native`
          contentEncoding: int32
          examples:
          - 3
        enabled:
          type: boolean
          description: usb_config is ignored if esl_config enabled
          default: false
        host:
          type: string
          description: Only if `type`==`imagotag` or `type`==`native`
          examples:
          - 1.1.1.1
        port:
          type: integer
          description: Only if `type`==`imagotag` or `type`==`native`
          contentEncoding: int32
          examples:
          - 0
        type:
          allOf:
          - $ref: '#/components/schemas/ap_esl_type2'
          - description: 'ESL integration type to enable on the AP. enum: `hanshow`, `imagotag`, `native`, `solum`.'
            examples:
            - imagotag
        verify_cert:
          type: boolean
          description: Only if `type`==`imagotag` or `type`==`native`
          examples:
          - true
        vlan_id:
          type: integer
          description: Only if `type`==`solum` or `type`==`hanshow`
          contentEncoding: int32
          default: 1
      description: Electronic shelf label integration settings for an AP
    ap_esl_type:
      title: ap_esl_type
      enum:
      - hanshow
      - imagotag
      - native
      - solum
      type: string
      description: 'note: ble_config will be ignored if esl_config is enabled and with native mode. enum: `hanshow`, `imagotag`, `native`, `solum`'
      examples:
      - imagotag
    device_ap:
      title: device_ap
      required:
      - type
      type: object
      properties:
        aeroscout:
          allOf:
          - $ref: '#/components/schemas/ap_aeroscout1'
          - description: Location integration settings for AeroScout on this access point
        airista:
          allOf:
          - $ref: '#/components/schemas/ap_airista1'
          - description: Location integration settings for Airista on this access point
        ble_config:
          allOf:
          - $ref: '#/components/schemas/ble_config4'
          - description: Bluetooth Low Energy beacon and asset settings for this access point
        centrak:
          allOf:
          - $ref: '#/components/schemas/ap_centrak1'
          - description: Location integration settings for Centrak on this access point
        client_bridge:
          allOf:
          - $ref: '#/components/schemas/ap_client_bridge1'
          - description: Wireless client bridge settings for this access point
        created_time:
          type: number
          description: Timestamp when the access point object was created
          readOnly: true
        deviceprofile_id:
          type:
          - string
          - 'null'
          description: Device profile assigned to this access point
          contentEncoding: uuid
          examples:
          - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
        disable_eth1:
          type: boolean
          description: Whether to disable eth1 port
          default: false
        disable_eth2:
          type: boolean
          description: Whether to disable eth2 port
          default: false
        disable_eth3:
          type: boolean
          description: Whether to disable eth3 port
          default: false
        disable_module:
          type: boolean
          description: Whether to disable module port
          default: false
        enable_unii_4:
          type: boolean
          description: Whether U-NII-4 channels (169, 173, 177) are enabled on this access point
          default: false
        esl_config:
          allOf:
          - $ref: '#/components/schemas/ap_esl_config1'
          - description: Electronic shelf label integration settings for this access point
        flow_control:
          type: boolean
          description: For some AP models, flow_control can be enabled to address some switch compatibility issue
          default: false
        for_site:
          type: boolean
          description: Whether the access point configuration is scoped directly to a site
          readOnly: true
        height:
          type: number
          description: Installation height of the AP, in meters
          examples:
          - 2.75
        id:
          type: string
          description: Unique identifier of the access point object
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        image1_url:
          type:
          - string
          - 'null'
          description: First custom image URL associated with the access point
        image2_url:
          type:
          - string
          - 'null'
          description: Second custom image URL associated with the access point
        image3_url:
          type:
          - string
          - 'null'
          description: Third custom image URL associated with the access point
        iot_config:
          allOf:
          - $ref: '#/components/schemas/ap_iot3'
          - description: Digital and analog IoT pin settings for this access point
        ip_config:
          allOf:
          - $ref: '#/components/schemas/ap_ip_config4'
          - description: Management IP addressing settings for this access point
        lacp_config:
          allOf:
          - $ref: '#/components/schemas/device_ap_lacp_config3'
          - description: Link aggregation settings for supported AP Ethernet uplinks
        led:
          allOf:
          - $ref: '#/components/schemas/ap_led5'
          - description: Indicator light behavior settings for this access point
        locked:
          type: boolean
          description: Whether this map is considered locked down
        mac:
          type: string
          description: Access point MAC address used to identify the device
          readOnly: true
        map_id:
          type: string
          description: Map where the device belongs to
          contentEncoding: uuid
          examples:
          - 63eda950-c6da-11e4-a628-60f81dd250cc
        mesh:
          allOf:
          - $ref: '#/components/schemas/ap_mesh3'
          - description: Wireless mesh role and band settings for this access point
        model:
          type: string
          description: Hardware model reported for the access point
          readOnly: true
        modified_time:
          type: number
          description: Timestamp when the access point object was last modified
          readOnly: true
        mqtt_config:
          allOf:
          - $ref: '#/components/schemas/ap_mqtt3'
          - description: MQTT broker publishing settings for this access point
        name:
          type: string
          description: Configured hostname assigned to the access point
          examples:
          - conference room
        notes:
          type: string
          description: Any notes about this AP
          examples:
          - slightly off center
        ntp_servers:
          uniqueItems: true
          type: array
          items:
            type: string
          description: NTP servers used by this access point
        org_id:
          type: string
          description: Organization that owns this access point
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        orientation:
          maximum: 359
          minimum: 0
          type: integer
          description: AP orientation in degrees from 0 to 359, where 0 is up and 90 is right
          contentEncoding: int32
          examples:
          - 45
        poe_passthrough:
          type: boolean
          description: Whether to enable power out through module port (for APH) or eth1 (for APL/BT11)
          default: false
        port_config:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ap_port_config'
          description: eth0 is not allowed here. Property key is the interface(s) name (e.g. `eth1` or `eth1,eth2`). If spcified, this takes predecence over switch_config (switch_config requires user to configure all vlans manually, which is error-prone. thus deprecated)
        pwr_config:
          allOf:
          - $ref: '#/components/schemas/ap_pwr_config3'
          - description: Power negotiation and peripheral power settings for this access point
        radio_config:
          allOf:
          - $ref: '#/components/schemas/ap_radio4'
          - description: Radio configuration overrides for this access point
        serial:
          type: string
          description: Manufacturer serial number for the access point
          readOnly: true
        site_id:
          type: string
          description: Site where this access point is assigned
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        type:
          const: ap
          type: string
          description: 'Device type discriminator for access point records. enum: `ap`.'
          readOnly: true
        uplink_port_config:
          allOf:
          - $ref: '#/components/schemas/ap_uplink_port_config4'
          - description: Authentication and failover behavior for AP uplink ports
        usb_config:
          allOf:
          - $ref: '#/components/schemas/ap_usb3'
          - description: Legacy USB integration settings for this access point
        uwb_config:
          allOf:
          - $ref: '#/components/schemas/ap_uwb_config4'
          - description: UWB RTLS / OMLOX asset-visibility settings; overrides the device profile and site-level `uwb_config`
        vars:
          type: object
          additionalProperties:
            type: string
          description: Variable values that override site variables for this access point
          examples:
          - RADIUS_IP1: 172.31.2.5
            RADIUS_SECRET: 11s64632d
        x:
          type: number
          description: Horizontal map position of the AP, in pixels
          examples:
          - 53.5
        y:
          type: number
          description: Vertical map position of the AP, in pixels
          examples:
          - 173.1
        zigbee_config:
          allOf:
          - $ref: '#/components/schemas/ap_zigbee3'
          - description: Zigbee radio and network settings for this access point
      description: Access point configuration and placement data
    ap_iot:
      title: ap_iot
      type: object
      properties:
        A1:
          allOf:
          - $ref: '#/components/schemas/ap_iot_output6'
          - description: Analog-capable IoT pin A1 output settings
        A2:
          allOf:
          - $ref: '#/components/schemas/ap_iot_output1'
          - description: Analog-capable IoT pin A2 output settings
        A3:
          allOf:
          - $ref: '#/components/schemas/ap_iot_output2'
          - description: Analog-capable IoT pin A3 output settings
        A4:
          allOf:
          - $ref: '#/components/schemas/ap_iot_output3'
          - description: Analog-capable IoT pin A4 output settings
        DI1:
          allOf:
          - $ref: '#/components/schemas/ap_iot_input3'
          - description: Digital input pin DI1 settings
        DI2:
          allOf:
          - $ref: '#/components/schemas/ap_iot_input1'
          - description: Digital input pin DI2 settings
        DO:
          allOf:
          - $ref: '#/components/schemas/ap_iot_output4'
          - description: Digital output pin DO settings
      description: Digital and analog IoT port settings applied to an AP or AP profile
    ap_iot_input:
      title: ap_iot_input
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether to enable a pin
          default: false
        name:
          type: string
          description: Optional; descriptive pin name
          examples:
          - motion
        pullup:
          allOf:
          - $ref: '#/components/schemas/ap_iot_pullup1'
          - description: 'Selects the pull-up resistor mode applied to the input pin. enum: `external`, `internal`, `none`.'
      description: IoT Input AP settings
    ap_iot_output:
      title: ap_iot_output
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether to enable a pin
          default: false
        name:
          type: string
          description: Optional; descriptive pin name
          examples:
          - motion
        output:
          type: boolean
          description: Whether the pin is configured as an output. DO and A1-A4 can be repurposed by changing
          examples:
          - true
        pullup:
          allOf:
          - $ref: '#/components/schemas/ap_iot_pullup3'
          - description: 'Selects the pull-up resistor mode applied to the output pin. enum: `external`, `internal`, `none`.'
        value:
          type: integer
          description: Output pin signal level, default 0
          contentEncoding: int32
          examples:
          - 0
      description: IoT output AP settings
    ap_iot_pullup:
      title: ap_iot_pullup
      enum:
      - external
      - internal
      - none
      type: string
      description: 'the type of pull-up the pin uses. enum: `external`, `internal`, `none`'
    ap_ip_config:
      title: ap_ip_config
      type: object
      properties:
        dns:
          type: array
          items:
            type: string
          description: If `type`==`static`. DNS server IP addresses for AP management traffic
          examples:
          - - 8.8.8.8
            - 4.4.4.4
        dns_suffix:
          type: array
          items:
            type: string
          description: If `type`==`static`. DNS search suffixes applied to AP management lookups
          examples:
          - - .mist.local
            - .mist.com
        gateway:
          type: string
          description: Required if `type`==`static`. IPv4 default gateway for AP management traffic
          contentEncoding: ipv4
          examples:
          - 10.2.1.254
        gateway6:
          type: string
          description: Required if `type6`==`static`. IPv6 default gateway for AP management traffic when static IPv6 addressing is used
          contentEncoding: ipv6
          examples:
          - 2607:f8b0:4005:808::1
        ip:
          type: string
          description: Required if `type`==`static`. Static IPv4 address for the AP management interface
          contentEncoding: ipv4
          examples:
          - 10.2.1.1
        ip6:
          type: string
          description: Required if `type6`==`static`. Static IPv6 address for the AP management interface
          contentEncoding: ipv6
          examples:
          - 2607:f8b0:4005:808::2004
        mtu:
          type: integer
          description: Maximum transmission unit for AP management traffic
          contentEncoding: int32
          examples:
          - 0
        netmask:
          type: string
          description: Required if `type`==`static`. IPv4 netmask for the AP management interface
          examples:
          - 255.255.255.0
        netmask6:
          type: string
          description: Required if `type6`==`static`. IPv6 prefix length for the AP management interface
          examples:
          - /32
        type:
          allOf:
          - $ref: '#/components/schemas/ip_type13'
          - description: 'IPv4 address assignment mode for AP management traffic. enum: `dhcp`, `static`.'
            examples:
            - static
        type6:
          allOf:
          - $ref: '#/components/schemas/ip_type64'
          - description: 'IPv6 address assignment mode for AP management traffic. enum: `autoconf`, `dhcp`, `disabled`, `static`.'
            examples:
            - static
        vlan_id:
          type: integer
          description: Management VLAN ID, default is 1 (untagged)
          contentEncoding: int32
          default: 1
          examples:
          - 1
      description: Management IP addressing settings for an access point
    ap_led:
      title: ap_led
      type: object
      properties:
        brightness:
          maximum: 255
          minimum: 0
          type: integer
          description: Indicator LED brightness level from 0 to 255
          contentEncoding: int32
          default: 255
          examples:
          - 255
        enabled:
          type: boolean
          description: Whether the AP indicator LED is enabled
          default: true
      description: Indicator light settings for an access point
    ap_mesh:
      title: ap_mesh
      type: object
      properties:
        bands:
          type: array
          items:
            $ref: '#/components/schemas/dot11_band'
          description: Radio bands allowed for AP mesh links
        enabled:
          type: boolean
          description: Whether mesh is enabled on this AP
          default: false
        group:
          maximum: 9
          minimum: 1
          type:
          - integer
          - 'null'
          description: Mesh group, base AP(s) will only allow remote AP(s) in the same mesh group to join, 1-9, optional
          contentEncoding: int32
          examples:
          - 1
        role:
          allOf:
          - $ref: '#/components/schemas/ap_mesh_role2'
          - description: Mesh role for this AP, either base or remote
            examples:
            - base
        use_wpa3_on_5:
          type: boolean
          description: Whether to use WPA3 on the 5 GHz band for mesh links
          default: false
      description: Wireless mesh settings for an access point
    dot11_band:
      title: dot11_band
      enum:
      - '24'
      - '5'
      - 5-dedicated
      - 5-selectable
      - '6'
      - 6-dedicated
      - 6-selectable
      type: string
      description: 'enum: `24`, `5`, `5-dedicated`, `5-selectable`, `6`, `6-dedicated`, `6-selectable`'
    ap_mesh_role:
      title: ap_mesh_role
      enum:
      - base
      - remote
      type: string
      description: 'Mesh role for this AP, either base or remote. enum: `base`, `remote`'
      examples:
      - base
    ap_mqtt:
      title: ap_mqtt
      type: object
      properties:
        broker_host:
          type: string
          description: MQTT broker hostname or IP address; required when `enabled` is `true`
        broker_port:
          type: integer
          description: MQTT broker port; defaults to `1883` for `tcp` and `8883` for `ssl`
          contentEncoding: int32
        broker_proto:
          allOf:
          - $ref: '#/components/schemas/ap_mqtt_broker_proto2'
          - description: 'MQTT broker transport protocol. enum: `ssl`, `tcp`.'
        default_topic:
          type: string
          description: Optional catch-all MQTT topic; BLE advertisements matching no AssetFilter are published here
          examples:
          - mist/asset/raw
        enabled:
          type: boolean
          description: Whether to enable MQTT publishing
          default: false
        format:
          allOf:
          - $ref: '#/components/schemas/ap_mqtt_format2'
          - description: 'Payload format for published messages. enum: `json`, `raw`.'
        password:
          type: string
          description: Optional MQTT password; masked in GET responses
          contentEncoding: password
        username:
          type: string
          description: Optional MQTT username
      description: MQTT publishing configuration for an AP. Use `mqtt_topic` on individual AssetFilter entries to specify which MQTT topic each matching BLE advertisement is forwarded to. Only AssetFilters with `mqtt_topic` set are used; disabled filters and filters without `mqtt_topic` are skipped. Set `default_topic` to publish advertisements that match no AssetFilter to a catch-all topic, allowing MQTT to be used without configuring any AssetFilter.
    ap_mqtt_broker_proto:
      title: ap_mqtt_broker_proto
      enum:
      - ssl
      - tcp
      type: string
      description: 'MQTT broker transport protocol. enum: `ssl`, `tcp`'
    ap_mqtt_format:
      title: ap_mqtt_format
      enum:
      - json
      - raw
      type: string
      description: 'Payload format for MQTT published messages. enum: `json`, `raw`'
    ap_port_config:
      title: ap_port_config
      type: object
      properties:
        disabled:
          type: boolean
          description: Whether this AP Ethernet port is disabled
          default: false
        dynamic_vlan:
          allOf:
          - $ref: '#/components/schemas/ap_port_config_dynamic_vlan2'
          - description: RADIUS-assigned VLAN settings for AP port authentication
        enable_mac_auth:
          type: boolean
          description: Whether MAC authentication is enabled on this AP port
          default: false
        forwarding:
          allOf:
          - $ref: '#/components/schemas/ap_port_config_forwarding2'
          - description: 'Traffic forwarding mode for this AP Ethernet port. enum: `all`, `limited`, `mxtunnel`, `site_mxedge`, `wxtunnel`.'
            examples:
            - all
        mac_auth_preferred:
          type: boolean
          description: When `true`, we'll do dot1x then mac_auth. enable this to prefer mac_auth
          default: false
        mac_auth_protocol:
          allOf:
          - $ref: '#/components/schemas/ap_port_config_mac_auth_protocol2'
          - description: 'Protocol used for MAC authentication when `enable_mac_auth` is `true`. enum: `eap-md5`, `eap-peap`, `pap`.'
        mist_nac:
          allOf:
          - $ref: '#/components/schemas/wlan_mist_nac3'
          - description: Juniper Mist NAC settings used by AP port authentication
        mx_tunnel_id:
          type: string
          description: If `forwarding`==`mxtunnel`, vlan_ids comes from mxtunnel
          contentEncoding: uuid
          examples:
          - 08cd7499-5841-51c8-e663-fb16b6f3b45e
        mxtunnel_name:
          type: string
          description: If `forwarding`==`site_mxedge`, vlan_ids comes from site_mxedge (`mxtunnel` under site setting)
        port_auth:
          allOf:
          - $ref: '#/components/schemas/ap_port_config_port_auth2'
          - description: 'Authentication mode for this AP Ethernet port. enum: `dot1x`, `none`.'
            examples:
            - none
        port_vlan_id:
          maximum: 4094
          minimum: 1
          type: integer
          description: If `forwarding`==`limited`. VLAN ID allowed on this AP Ethernet port
          contentEncoding: int32
          examples:
          - 1
        radius_config:
          allOf:
          - $ref: '#/components/schemas/radius_config2'
          - description: RADIUS authentication and accounting settings for this AP port
        radsec:
          allOf:
          - $ref: '#/components/schemas/radsec3'
          - description: TLS-secured RADIUS settings for this AP port
        vlan_id:
          maximum: 4094
          minimum: 1
          type: integer
          description: >-
            Optional to specify the VLAN ID for a tunnel if forwarding is for `wxtunnel`, `mxtunnel` or `site_mxedge`.
              * if vlan_id is not specified then it will use first one in vlan_ids[] of the mxtunnel.
              * if forwarding == site_mxedge, vlan_ids comes from site_mxedge (`mxtunnel` under site setting)
          contentEncoding: int32
          examples:
          - 9
        vlan_ids:
          type: string
          description: If `forwarding`==`limited`, comma separated list of additional VLAN IDs allowed on this port
          examples:
          - 10,20,30
        wxtunnel_id:
          type: string
          description: If `forwarding`==`wxtunnel`, the port is bridged to the vlan of the session
          contentEncoding: uuid
          examples:
          - 7dae216d-7c98-a51b-e068-dd7d477b7216
        wxtunnel_remote_id:
          type: string
          description: If `forwarding`==`wxtunnel`, the port is bridged to the vlan of the session
          examples:
          - wifiguest
      description: Ethernet port behavior settings for an access point
    ap_port_config_dynamic_vlan:
      title: ap_port_config_dynamic_vlan
      type: object
      properties:
        default_vlan_id:
          maximum: 4094
          minimum: 1
          type: integer
          description: Fallback VLAN ID used when RADIUS does not return a dynamic VLAN match
          contentEncoding: int32
          examples:
          - 999
        enabled:
          type: boolean
          description: Whether dynamic VLAN assignment is enabled for this AP port
        type:
          allOf:
          - $ref: '#/components/schemas/ap_port_config_dynamic_vlan_type2'
          - description: 'Mapping mode for interpreting dynamic VLAN attributes returned by RADIUS. enum: `airespace-interface-name`, `standard`.'
        vlans:
          type: object
          additionalProperties:
            type: string
            nullable: true
          description: Mapping entries for RADIUS-assigned VLAN values on this AP port. For `type`==`airespace-interface-name`, the property key is the Airespace interface name returned by RADIUS (e.g. "guest"), and the value is the corresponding VLAN ID (e.g. 100). For `type`==`standard`, the property key is the VLAN ID number returned by RADIUS, and the value is ignored.
          examples:
          - 1-10: null
            user: 10
      description: Dynamic VLAN assignment settings for AP port authentication
    ap_port_config_dynamic_vlan_type:
      title: ap_port_config_dynamic_vlan_type
      enum:
      - airespace-interface-name
      - standard
      type: string
      description: 'Mapping mode for interpreting dynamic VLAN attributes returned by RADIUS.\ \ enum: `airespace-interface-name`, where the VLAN is determined by parsing\ \ the RADIUS attribute as an Airespace interface name (e.g. "guest"\ \ would map to VLAN 100), or `standard`, where the VLAN is determined by parsing\ \ the RADIUS attribute as a standard VLAN ID number'
    ap_port_config_forwarding:
      title: ap_port_config_forwarding
      enum:
      - all
      - limited
      - mxtunnel
      - site_mxedge
      - wxtunnel
      type: string
      description: "enum: \n  * `all`: local breakout, All VLANs\n  * `limited`: local breakout, only the VLANs configured in `port_vlan_id` and `vlan_ids`\n  * `mxtunnel`: central breakout to an Org Mist Edge (requires `mxtunnel_id`)\n  * `site_mxedge`: central breakout to a Site Mist Edge (requires `mxtunnel_name`)\n  * `wxtunnel`': central breakout to an Org WxTunnel (requires `wxtunnel_id`)"
      examples:
      - all
    ap_port_config_mac_auth_protocol:
      title: ap_port_config_mac_auth_protocol
      enum:
      - eap-md5
      - eap-peap
      - pap
      type: string
      description: 'if `enable_mac_auth`==`true`, allows user to select an authentication protocol. enum: `eap-md5`, `eap-peap`, `pap`'
    ap_port_config_port_auth:
      title: ap_port_config_port_auth
      enum:
      - dot1x
      - none
      type: string
      description: 'When doing port auth. enum: `dot1x`, `none`'
      examples:
      - none
    ap_pwr_config:
      title: ap_pwr_config
      type: object
      properties:
        base:
          type: integer
          description: Additional power to request during negotiating with PSE over PoE, in mW
          contentEncoding: int32
          default: 0
          examples:
          - 2000
        prefer_usb_over_wifi:
          type: boolean
          description: Whether to enable power out to peripheral, meanwhile will reduce power to Wi-Fi (only for AP45 at power mode)
          default: false
      description: Power negotiation and peripheral power settings for an AP or AP profile
    ap_radio:
      title: ap_radio
      type: object
      properties:
        allow_rrm_disable:
          type: boolean
          description: Whether RRM can be disabled for individual radio-band settings
          default: false
        ant_gain_24:
          minimum: 0
          type: integer
          description: Antenna gain for 2.4G - for models with external antenna only
          contentEncoding: int32
          examples:
          - 4
        ant_gain_5:
          minimum: 0
          type: integer
          description: Antenna gain for 5G - for models with external antenna only
          contentEncoding: int32
          examples:
          - 5
        ant_gain_6:
          minimum: 0
          type: integer
          description: Antenna gain for 6G - for models with external antenna only
          contentEncoding: int32
          examples:
          - 5
        antenna_mode:
          allOf:
          - $ref: '#/components/schemas/ap_radio_antenna_mode2'
          - description: 'Selected radio chain mode for AP models that support antenna mode control. enum: `1x1`, `2x2`, `3x3`, `4x4`, `default`.'
        antenna_select:
          allOf:
          - $ref: '#/components/schemas/antenna_select1'
          - description: 'Internal or external antenna selection for AP models with selectable antennas. enum: ``, `external`, `internal`.'
            examples:
            - external
        band_24:
          allOf:
          - $ref: '#/components/schemas/ap_radio_band242'
          - description: 2.4 GHz radio settings for this access point
        band_24_usage:
          allOf:
          - $ref: '#/components/schemas/radio_band_24_usage4'
          - description: 'Radio usage mode for the 2.4 GHz-capable radio. enum: `24`, `5`, `6`, `auto`.'
        band_5:
          allOf:
          - $ref: '#/components/schemas/ap_radio_band53'
          - description: 5 GHz radio settings for this access point
        band_5_on_24_radio:
          allOf:
          - $ref: '#/components/schemas/ap_radio_band51'
          - description: 5 GHz settings used when the 2.4 GHz radio operates in 5 GHz mode
        band_6:
          allOf:
          - $ref: '#/components/schemas/ap_radio_band62'
          - description: 6 GHz radio settings for this access point
        full_automatic_rrm:
          type: boolean
          description: Let RRM control everything, only the `channels` and `ant_gain` will be honored (i.e. disabled/bandwidth/power/band_24_usage are all controlled by RRM)
          default: false
        indoor_use:
          type: boolean
          description: To make an outdoor operate indoor. For an outdoor-ap, some channels are disallowed by default, this allows the user to use it as an indoor-ap
          default: false
        rrm_managed:
          type: boolean
          description: Enable RRM to manage all radio settings (ignores all band_xxx configs)
        scanning_enabled:
          type: boolean
          description: Whether scanning radio is enabled
          examples:
          - true
      description: Radio configuration settings for an access point
    ap_radio_antenna_mode:
      title: ap_radio_antenna_mode
      enum:
      - 1x1
      - 2x2
      - 3x3
      - 4x4
      - default
      type: string
      description: 'enum: `1x1`, `2x2`, `3x3`, `4x4`, `default`'
    ap_radio_band24:
      title: ap_radio_band24
      type: object
      properties:
        allow_rrm_disable:
          type: boolean
          description: Whether RRM may disable the 2.4 GHz radio when optimizing RF settings
          default: false
        ant_gain:
          maximum: 10
          minimum: 0
          type:
          - integer
          - 'null'
          description: External antenna gain for the 2.4 GHz radio
          contentEncoding: int32
          default: 0
        antenna_mode:
          allOf:
          - $ref: '#/components/schemas/radio_band_antenna_mode4'
          - description: 'Radio chain mode for the 2.4 GHz radio. enum: `1x1`, `2x2`, `3x3`, `4x4`, `default`.'
            examples:
            - default
        bandwidth:
          allOf:
          - $ref: '#/components/schemas/dot11_bandwidth242'
          - description: 'Channel width configured for the 2.4 GHz radio. enum: `0`, `20`, `40`.'
            examples:
            - 20
        channel:
          maximum: 13
          minimum: 1
          type:
          - integer
          - 'null'
          description: For Device. (primary) channel for the band, 0 means using the Site Setting
          contentEncoding: int32
          examples:
          - 6
        channels:
          type:
          - array
          - 'null'
          items:
            type: integer
            contentEncoding: int32
          description: Allowed channel list for the 2.4 GHz radio; null or an empty array uses automatic selection
          default: []
        disabled:
          type: boolean
          description: Whether to disable the radio
          default: false
        power:
          maximum: 25
          minimum: 0
          type:
          - integer
          - 'null'
          description: Radio Tx power, in dBm. Can be an integer 0-25 for static power configuration, or `null` or unset for auto power mode
          contentEncoding: int32
          examples:
          - 3
        power_max:
          maximum: 18
          minimum: 3
          type:
          - integer
          - 'null'
          description: When power=null/unset, max tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        power_min:
          maximum: 18
          minimum: 3
          type:
          - integer
          - 'null'
          description: When power=null/unset, min tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        preamble:
          allOf:
          - $ref: '#/components/schemas/radio_band_preamble4'
          - description: '802.11 preamble mode used by the 2.4 GHz radio. enum: `auto`, `long`, `short`.'
      description: 2.4 GHz radio settings for an access point
    ap_radio_band5:
      title: ap_radio_band5
      type: object
      properties:
        allow_rrm_disable:
          type: boolean
          description: Whether RRM may disable the 5 GHz radio when optimizing RF settings
          default: false
        ant_gain:
          maximum: 10
          minimum: 0
          type:
          - integer
          - 'null'
          description: External antenna gain for the 5 GHz radio
          contentEncoding: int32
          default: 0
        antenna_beam_pattern:
          allOf:
          - $ref: '#/components/schemas/radio_band_antenna_beam_pattern3'
          - description: 'Beam pattern used by the 5 GHz radio antenna. enum: `narrow`, `medium`, `wide`.'
        antenna_mode:
          allOf:
          - $ref: '#/components/schemas/radio_band_antenna_mode1'
          - description: 'Radio chain mode for the 5 GHz radio. enum: `1x1`, `2x2`, `3x3`, `4x4`, `default`.'
            examples:
            - default
        bandwidth:
          allOf:
          - $ref: '#/components/schemas/dot11_bandwidth52'
          - description: 'Channel width configured for the 5 GHz radio. enum: `0`, `20`, `40`, `80`.'
            examples:
            - 40
        channel:
          type:
          - integer
          - 'null'
          description: For Device. (primary) channel for the band, 0 means using the Site Setting
          contentEncoding: int32
          examples:
          - 100
        channels:
          type:
          - array
          - 'null'
          items:
            type: integer
            contentEncoding: int32
          description: Allowed channel list for the 5 GHz radio; null or an empty array uses automatic selection
          default: []
        disabled:
          type: boolean
          description: Whether to disable the radio
          default: false
        power:
          maximum: 25
          minimum: 0
          type:
          - integer
          - 'null'
          description: Radio Tx power, in dBm. Can be an integer 0-25 for static power configuration, or `null` or unset for auto power mode
          contentEncoding: int32
          examples:
          - 6
        power_max:
          maximum: 17
          minimum: 5
          type:
          - integer
          - 'null'
          description: When power=null/unset, max tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        power_min:
          maximum: 17
          minimum: 5
          type:
          - integer
          - 'null'
          description: When power=null/unset, min tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        preamble:
          allOf:
          - $ref: '#/components/schemas/radio_band_preamble1'
          - description: '802.11 preamble mode used by the 5 GHz radio. enum: `auto`, `long`, `short`.'
      description: 5 GHz radio settings for an access point
    ap_radio_band6:
      title: ap_radio_band6
      type: object
      properties:
        allow_rrm_disable:
          type: boolean
          description: Whether RRM may disable the 6 GHz radio when optimizing RF settings
          default: false
        ant_gain:
          maximum: 10
          minimum: 0
          type:
          - integer
          - 'null'
          description: External antenna gain for the 6 GHz radio
          contentEncoding: int32
          default: 0
        antenna_beam_pattern:
          allOf:
          - $ref: '#/components/schemas/radio_band_antenna_beam_pattern1'
          - description: 'Beam pattern used by the 6 GHz radio antenna. enum: `narrow`, `medium`, `wide`.'
        antenna_mode:
          allOf:
          - $ref: '#/components/schemas/radio_band_antenna_mode2'
          - description: 'Radio chain mode for the 6 GHz radio. enum: `1x1`, `2x2`, `3x3`, `4x4`, `default`.'
            examples:
            - default
        bandwidth:
          allOf:
          - $ref: '#/components/schemas/dot11_bandwidth62'
          - description: 'Channel width configured for the 6 GHz radio. enum: `0`, `20`, `40`, `80`, `160`.'
            examples:
            - 80
        channel:
          type:
          - integer
          - 'null'
          description: For Device. (primary) channel for the band, 0 means using the Site Setting
          contentEncoding: int32
          examples:
          - 0
        channels:
          type:
          - array
          - 'null'
          items:
            type: integer
            contentEncoding: int32
          description: Allowed channel list for the 6 GHz radio; null or an empty array uses automatic selection
          default: []
        disabled:
          type: boolean
          description: Whether to disable the radio
          default: false
        power:
          maximum: 25
          minimum: 0
          type:
          - integer
          - 'null'
          description: Radio Tx power, in dBm. Can be an integer 0-25 for static power configuration, or `null` or unset for auto power mode
          contentEncoding: int32
          examples:
          - 7
        power_max:
          maximum: 18
          minimum: 5
          type:
          - integer
          - 'null'
          description: When power=null/unset, max tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        power_min:
          maximum: 18
          minimum: 5
          type:
          - integer
          - 'null'
          description: When power=null/unset, min tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        preamble:
          allOf:
          - $ref: '#/components/schemas/radio_band_preamble2'
          - description: '802.11 preamble mode used by the 6 GHz radio. enum: `auto`, `long`, `short`.'
        standard_power:
          type: boolean
          description: For 6GHz Only, standard-power operation, AFC (Automatic Frequency Coordination) will be performed, and we'll fall back to Low Power Indoor if AFC failed
          default: false
      description: 6 GHz radio settings for an access point
    ap_radio_mac:
      title: ap_radio_mac
      required:
      - mac
      - radio_macs
      type: object
      properties:
        mac:
          minLength: 1
          type: string
          description: Access point MAC address for this radio MAC mapping
          examples:
          - 5c5b350001a0
        radio_macs:
          type: array
          items:
            type: string
          description: List of radio MAC addresses associated with this access point
          examples:
          - - 5c5b350001a0
            - 5c5b350001a1
      description: Access point MAC address and its related radio MAC addresses
      examples:
      - mac: 5c5b350001a0
        radio_macs:
        - 5c5b350001a0
        - 5c5b350001a1
    ap_radio_stat:
      title: ap_radio_stat
      type: object
      properties:
        bandwidth:
          allOf:
          - $ref: '#/components/schemas/dot11_bandwidth8'
          - description: 'Current channel width reported for this radio. enum: `0`, `20`, `40`, `80`, `160`.'
            examples:
            - 20
        channel:
          type:
          - integer
          - 'null'
          description: Current channel the radio is running on
          contentEncoding: int32
          readOnly: true
        dynamic_chaining_enabled:
          type:
          - boolean
          - 'null'
          description: Use dynamic chaining for downlink
          readOnly: true
        mac:
          type:
          - string
          - 'null'
          description: Radio base MAC address; a base radio MAC can represent up to 16 BSSIDs (e.g. 5c5b350001a0-5c5b350001af)
          readOnly: true
        noise_floor:
          type:
          - integer
          - 'null'
          description: Measured noise floor for this radio, in dBm
          contentEncoding: int32
          readOnly: true
          examples:
          - -90
        num_clients:
          type:
          - integer
          - 'null'
          description: Number of clients currently connected on this radio
          contentEncoding: int32
          readOnly: true
        num_wlans:
          type: integer
          description: How many WLANs are applied to the radio
          contentEncoding: int32
        power:
          type:
          - integer
          - 'null'
          description: Transmit power (in dBm)
          contentEncoding: int32
          readOnly: true
        rx_bytes:
          type:
          - integer
          - 'null'
          description: Received byte count reported for this radio
          contentEncoding: int64
          readOnly: true
          examples:
          - 8515104416
        rx_pkts:
          type:
          - integer
          - 'null'
          description: Received packet count reported for this radio
          contentEncoding: int64
          readOnly: true
          examples:
          - 57770567
        tx_bytes:
          type:
          - integer
          - 'null'
          description: Transmitted byte count reported for this radio
          contentEncoding: int64
          readOnly: true
          examples:
          - 211217389682
        tx_pkts:
          type:
          - integer
          - 'null'
          description: Transmitted packet count reported for this radio
          contentEncoding: int64
          readOnly: true
          examples:
          - 812204062
        usage:
          type:
          - string
          - 'null'
          description: Operating band reported for this radio, such as 24, 5, or 6
          readOnly: true
          examples:
          - '24'
        util_all:
          type:
          - integer
          - 'null'
          description: All utilization in percentage
          contentEncoding: int32
          readOnly: true
        util_non_wifi:
          type:
          - integer
          - 'null'
          description: Reception of "No Packets" utilization in percentage, received frames with invalid PLCPs and CRS glitches as noise
          contentEncoding: int32
          readOnly: true
        util_rx_in_bss:
          type:
          - integer
          - 'null'
          description: Reception of "In BSS" utilization in percentage, only frames that are received from AP/STAs within the BSS
          contentEncoding: int32
          readOnly: true
        util_rx_other_bss:
          type:
          - integer
          - 'null'
          description: Reception of "Other BSS" utilization in percentage, all frames received from AP/STAs that are outside the BSS
          contentEncoding: int32
          readOnly: true
        util_tx:
          type:
          - integer
          - 'null'
          description: Transmission utilization in percentage
          contentEncoding: int32
          readOnly: true
        util_undecodable_wifi:
          type:
          - integer
          - 'null'
          description: Reception of "UnDecodable Wifi" utilization in percentage, only Preamble, PLCP header is decoded, Rest is undecodable in this radio
          contentEncoding: int32
          readOnly: true
        util_unknown_wifi:
          type:
          - integer
          - 'null'
          description: Reception of "No Category" utilization in percentage, all 802.11 frames that are corrupted at the receiver
          contentEncoding: int32
          readOnly: true
      description: Runtime radio statistics for an access point radio
    ap_redundancy:
      title: ap_redundancy
      type: object
      properties:
        modules:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ap_redundancy_module'
          description: Per-module AP redundancy counts keyed by switch node ID
        num_aps:
          type: integer
          description: Total number of APs considered for switch redundancy
          contentEncoding: int32
          examples:
          - 15
        num_aps_with_switch_redundancy:
          type: integer
          description: Number of APs that have switch redundancy coverage
          contentEncoding: int32
          examples:
          - 8
      description: AP switch redundancy coverage summary
    ap_redundancy_module:
      title: ap_redundancy_module
      type: object
      properties:
        num_aps:
          type: integer
          description: Total number of APs connected through this VC member
          contentEncoding: int32
          examples:
          - 15
        num_aps_with_switch_redundancy:
          type: integer
          description: Number of APs on this VC member with switch redundancy coverage
          contentEncoding: int32
          examples:
          - 8
      description: AP switch redundancy counts for one VC member
    ap_search:
      title: ap_search
      required:
      - mxtunnel_status
      - power_constrained
      - power_opmode
      - wlans
      type: object
      properties:
        band_24_bandwidth:
          type: string
          description: Current channel bandwidth on the AP 2.4 GHz radio
        band_24_channel:
          type: integer
          description: Current channel on the AP 2.4 GHz radio
          contentEncoding: int32
        band_24_power:
          type: integer
          description: Current transmit power on the AP 2.4 GHz radio
          contentEncoding: int32
        band_5_bandwidth:
          type: string
          description: Current channel bandwidth on the AP 5 GHz radio
        band_5_channel:
          type: integer
          description: Current channel on the AP 5 GHz radio
          contentEncoding: int32
        band_5_power:
          type: integer
          description: Current transmit power on the AP 5 GHz radio
          contentEncoding: int32
        band_6_bandwidth:
          type: string
          description: Current channel bandwidth on the AP 6 GHz radio
        band_6_channel:
          type: integer
          description: Current channel on the AP 6 GHz radio
          contentEncoding: int32
        band_6_power:
          type: integer
          description: Current transmit power on the AP 6 GHz radio
          contentEncoding: int32
        eth0_port_speed:
          type: integer
          description: Port speed of eth0
          contentEncoding: int32
        ext_ip:
          type: string
          description: External IP address observed for AP management traffic
        hostname:
          type: array
          items:
            type: string
          description: Observed hostnames detected for the AP in search results
        inactive_wired_vlans:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: Inactive wired VLAN IDs reported for this AP
        ip:
          type: string
          description: Management IP address currently assigned to the AP
        last_hostname:
          type: string
          description: Most recent hostname detected for the AP
        lldp_mgmt_addr:
          type: string
          description: LLDP management IP address advertised by the upstream neighbor
        lldp_port_desc:
          type: string
          description: LLDP port description advertised by the upstream neighbor
        lldp_port_id:
          type: string
          description: LLDP port identifier advertised by the upstream neighbor
        lldp_power_allocated:
          type: integer
          description: Power allocated to the AP by LLDP, in mW
          contentEncoding: int32
        lldp_power_draw:
          type: integer
          description: Power drawn by the AP as reported through LLDP, in mW
          contentEncoding: int32
        lldp_system_desc:
          type: string
          description: LLDP system description advertised by the upstream neighbor
        lldp_system_name:
          type: string
          description: LLDP system name advertised by the upstream neighbor
        mac:
          type: string
          description: Access point MAC address used to identify the AP in search results
        model:
          type: string
          description: AP hardware model for this search result
        mxedge_id:
          type: string
          description: Mist Edge id, if AP is connecting to a Mist Edge
        mxedge_ids:
          type: string
          description: Comma separated list of Mist Edge ids, if AP is connecting to a Mist Edge
        mxtunnel_status:
          type: string
          description: Current MxTunnel connection status of the AP
        org_id:
          type: string
          description: Organization that owns this AP search result
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        power_constrained:
          type: boolean
          description: Whether the AP is operating with insufficient power
        power_opmode:
          type: string
          description: Operating mode reported when AP power is constrained
        site_id:
          type: string
          description: Site that contains this AP search result
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        sku:
          type: string
          description: Hardware SKU for the AP model
        timestamp:
          type: number
          description: Time associated with this AP search result
          readOnly: true
        uptime:
          type: integer
          description: Device uptime for the AP, in seconds
          contentEncoding: int32
        version:
          type: string
          description: Software version currently running on the AP
        wlans:
          type: array
          items:
            $ref: '#/components/schemas/ap_search_wlan'
          description: Wireless LAN summaries applied to the AP in this search result
      description: Access point record returned by device search endpoints
    ap_search_wlan:
      title: ap_search_wlan
      type: object
      properties:
        id:
          type: string
          description: WLAN identifier included in the AP search result
          contentEncoding: uuid
        ssid:
          type: string
          description: Wireless network SSID shown for this WLAN
      description: WLAN summary included in an AP search result
    ap_stat_mesh_downlink:
      title: ap_stat_mesh_downlink
      type: object
      properties:
        band:
          type: string
          description: Radio band used by this mesh downlink
          examples:
          - '5'
        channel:
          type: integer
          description: Radio channel used by this mesh downlink
          contentEncoding: int32
          examples:
          - 36
        idle_time:
          type: integer
          description: Seconds since traffic was last observed on this mesh downlink
          contentEncoding: int32
          examples:
          - 3
        last_seen:
          type:
          - number
          - 'null'
          description: Timestamp when this mesh downlink was last observed
          readOnly: true
          examples:
          - 1470417522
        proto:
          type: string
          description: 802.11 protocol reported for this mesh downlink
          examples:
          - n
        rssi:
          type: integer
          description: Received signal strength for this mesh downlink, in dBm
          contentEncoding: int32
          examples:
          - -65
        rx_bps:
          type:
          - integer
          - 'null'
          description: Inbound throughput on this mesh downlink, in bits per second
          contentEncoding: int64
          readOnly: true
          examples:
          - 60003
        rx_bytes:
          type:
          - integer
          - 'null'
          description: Inbound byte count for this mesh downlink
          contentEncoding: int64
          readOnly: true
          examples:
          - 8515104416
        rx_packets:
          type:
          - integer
          - 'null'
          description: Inbound packet count for this mesh downlink
          contentEncoding: int64
          readOnly: true
          examples:
          - 57770567
        rx_rate:
          type:
          - number
          - 'null'
          description: Inbound data rate reported for this mesh downlink
          readOnly: true
        rx_retries:
          type:
          - integer
          - 'null'
          description: Inbound retry count reported for this mesh downlink
          contentEncoding: int32
          readOnly: true
        site_id:
          type: string
          description: Site associated with this mesh downlink statistic
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        snr:
          type: integer
          description: Signal-to-noise ratio for this mesh downlink, in dB
          contentEncoding: int32
          examples:
          - 31
        tx_bps:
          type:
          - integer
          - 'null'
          description: Outbound throughput on this mesh downlink, in bits per second
          contentEncoding: int64
          readOnly: true
          examples:
          - 634301
        tx_bytes:
          type:
          - integer
          - 'null'
          description: Outbound byte count for this mesh downlink
          contentEncoding: int64
          readOnly: true
          examples:
          - 211217389682
        tx_packets:
          type:
          - integer
          - 'null'
          description: Outbound packet count for this mesh downlink
          contentEncoding: int64
          readOnly: true
          examples:
          - 812204062
        tx_rate:
          type:
          - number
          - 'null'
          description: Outbound data rate reported for this mesh downlink
          readOnly: true
        tx_retries:
          type:
          - integer
          - 'null'
          description: Outbound retry count reported for this mesh downlink
          contentEncoding: int32
          readOnly: true
      description: Runtime statistics for a mesh downlink from this AP
    ap_stat_mesh_uplink:
      title: ap_stat_mesh_uplink
      type: object
      properties:
        band:
          type: string
          description: Radio band used by this mesh uplink
          examples:
          - '5'
        channel:
          type: integer
          description: Radio channel used by this mesh uplink
          contentEncoding: int32
          examples:
          - 36
        idle_time:
          type: integer
          description: Seconds since traffic was last observed on this mesh uplink
          contentEncoding: int32
          examples:
          - 3
        last_seen:
          type:
          - number
          - 'null'
          description: Timestamp when this mesh uplink was last observed
          readOnly: true
          examples:
          - 1470417522
        proto:
          type: string
          description: 802.11 protocol reported for this mesh uplink
          examples:
          - n
        rssi:
          type: integer
          description: Received signal strength for this mesh uplink, in dBm
          contentEncoding: int32
          examples:
          - -65
        rx_bps:
          type:
          - integer
          - 'null'
          description: Inbound throughput on this mesh uplink, in bits per second
          contentEncoding: int64
          readOnly: true
          examples:
          - 60003
        rx_bytes:
          type:
          - integer
          - 'null'
          description: Inbound byte count for this mesh uplink
          contentEncoding: int64
          readOnly: true
          examples:
          - 8515104416
        rx_packets:
          type:
          - integer
          - 'null'
          description: Inbound packet count for this mesh uplink
          contentEncoding: int64
          readOnly: true
          examples:
          - 57770567
        rx_rate:
          type:
          - number
          - 'null'
          description: Inbound data rate reported for this mesh uplink
          readOnly: true
        rx_retries:
          type:
          - integer
          - 'null'
          description: Inbound retry count reported for this mesh uplink
          contentEncoding: int32
          readOnly: true
        site_id:
          type: string
          description: Site associated with this mesh uplink statistic
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        snr:
          type: integer
          description: Signal-to-noise ratio for this mesh uplink, in dB
          contentEncoding: int32
          examples:
          - 31
        tx_bps:
          type:
          - integer
          - 'null'
          description: Outbound throughput on this mesh uplink, in bits per second
          contentEncoding: int64
          readOnly: true
          examples:
          - 634301
        tx_bytes:
          type:
          - integer
          - 'null'
          description: Outbound byte count for this mesh uplink
          contentEncoding: int64
          readOnly: true
          examples:
          - 211217389682
        tx_packets:
          type:
          - integer
          - 'null'
          description: Outbound packet count for this mesh uplink
          contentEncoding: int64
          readOnly: true
          examples:
          - 812204062
        tx_rate:
          type:
          - number
          - 'null'
          description: Outbound data rate reported for this mesh uplink
          readOnly: true
        tx_retries:
          type:
          - integer
          - 'null'
          description: Outbound retry count reported for this mesh uplink
          contentEncoding: int32
          readOnly: true
        uplink_ap_id:
          type: string
          description: Identifier of the upstream AP for this mesh uplink
          contentEncoding: uuid
          examples:
          - 00000000-0000-0000-1000-5c5b35000010
      description: Runtime statistics for this AP's mesh uplink
    ap_switch:
      title: ap_switch
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether deprecated AP switch VLAN control is enabled
          default: false
        eth0:
          allOf:
          - $ref: '#/components/schemas/ap_switch_setting7'
          - description: VLAN settings for AP eth0
        eth1:
          allOf:
          - $ref: '#/components/schemas/ap_switch_setting1'
          - description: VLAN settings for AP eth1
        eth2:
          allOf:
          - $ref: '#/components/schemas/ap_switch_setting2'
          - description: VLAN settings for AP eth2
        eth3:
          allOf:
          - $ref: '#/components/schemas/ap_switch_setting3'
          - description: VLAN settings for AP eth3
        module:
          allOf:
          - $ref: '#/components/schemas/ap_switch_setting4'
          - description: VLAN settings for the AP module port
        wds:
          allOf:
          - $ref: '#/components/schemas/ap_switch_setting5'
          - description: VLAN settings for WDS traffic on the AP
      description: Deprecated AP switch VLAN control settings for advanced per-port configuration
      deprecated: true
    ap_switch_setting:
      title: ap_switch_setting
      type: object
      properties:
        enable_vlan:
          type: boolean
          description: Whether VLAN tagging is enabled for this AP switch-config port
        port_vlan_id:
          anyOf:
          - maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
          - type: string
          description: Native VLAN ID for this AP switch-config port
        vlan_ids:
          type: array
          items:
            maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
          description: Allowed VLAN IDs for this AP switch-config port
      description: VLAN settings for one deprecated AP switch-config port
    ap_template:
      title: ap_template
      required:
      - ap_matching
      type: object
      properties:
        ap_matching:
          allOf:
          - $ref: '#/components/schemas/ap_template_matching2'
          - description: Rules used to select access points for this AP template
        created_time:
          type: number
          description: Timestamp when the AP template was created
          readOnly: true
        for_site:
          type: boolean
          description: Whether the AP template is scoped to a site rather than the organization
          readOnly: true
        id:
          type: string
          description: Unique identifier of the AP template
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        modified_time:
          type: number
          description: Timestamp when the AP template was last modified
          readOnly: true
        org_id:
          type: string
          description: Organization that owns this AP template
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        site_id:
          type: string
          description: Site that owns this site-level AP template
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        wifi:
          allOf:
          - $ref: '#/components/schemas/ap_template_wifi2'
          - description: Wi-Fi and mesh settings applied by this AP template
      description: Access point template configuration
    ap_template_matching:
      title: ap_template_matching
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether AP matching is enabled for this AP template
        rules:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/ap_template_matching_rule'
          description: AP matching entries that select access points and apply AP port configuration
      description: Rules that select which AP template port configuration applies
    ap_template_matching_rule:
      title: ap_template_matching_rule
      type: object
      properties:
        match_model:
          minLength: 1
          type: string
          description: Access point model matched by this AP template rule
        name:
          minLength: 1
          type: string
          description: Display label for this AP template matching rule
        port_config:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ap_port_config'
          description: Property key is the interface(s) name (e.g. "eth1,eth2")
      description: Model and name match criteria for an AP template port configuration
    ap_template_wifi:
      title: ap_template_wifi
      type: object
      properties:
        cisco_enabled:
          type: boolean
          description: Whether Cisco-specific Wi-Fi compatibility behavior is enabled
        disable_11k:
          type: boolean
          description: Whether 802.11k neighbor reports are disabled
          default: false
        disable_radios_when_power_constrained:
          type: boolean
          description: Whether AP radios are disabled when power is constrained
        enable_arp_spoof:
          type: boolean
          description: Whether ARP spoofing checks are enabled when proxy ARP is used
        enable_shared_radio_scanning:
          type: boolean
          description: Whether shared radio scanning is enabled for AP radio scanning
          default: false
        enabled:
          type: boolean
          description: Whether Wi-Fi settings in this AP template are enabled
          default: true
        locate_connected:
          type: boolean
          description: Whether location tracking is enabled for connected clients
          default: false
        locate_unconnected:
          type: boolean
          description: Whether location tracking is enabled for unconnected clients
          default: false
        mesh_allow_dfs:
          type: boolean
          description: Whether mesh links may use DFS channels, which can add CAC delays during scanning
          default: false
        mesh_enable_crm:
          type: boolean
          description: Whether CRM is enabled for mesh networking in this AP template
        mesh_enabled:
          type: boolean
          description: Whether mesh networking is enabled by this AP template
        proxy_arp:
          type: boolean
          description: Whether proxy ARP is enabled for Wi-Fi clients
          default: false
      description: Wi-Fi behavior settings applied by an AP template
    ap_uplink_port_config:
      title: ap_uplink_port_config
      type: object
      properties:
        dot1x:
          type: boolean
          description: Whether to do 802.1x against uplink switch. When enabled, AP cert will be used to do EAP-TLS and the Org's CA Cert has to be provisioned at the switch
          default: false
        keep_wlans_up_if_down:
          type: boolean
          description: By default, WLANs are disabled when uplink is down. In some scenario, like SiteSurvey, one would want the AP to keep sending beacons.
          default: false
      description: AP Uplink port configuration
    ap_usb:
      title: ap_usb
      type: object
      properties:
        cacert:
          type:
          - string
          - 'null'
          description: Only if `type`==`imagotag`. CA certificate used to validate the Imagotag service certificate
        channel:
          type: integer
          description: Only if `type`==`imagotag`, channel selection, not needed by default, required for manual channel override only
          contentEncoding: int32
          examples:
          - 3
        enabled:
          type: boolean
          description: Whether to enable any usb config
        host:
          type: string
          description: Only if `type`==`imagotag`. Imagotag service host or IP address contacted by the AP
          examples:
          - 1.1.1.1
        port:
          type: integer
          description: Only if `type`==`imagotag`. TCP port used to reach the Imagotag service
          contentEncoding: int32
          default: 0
          examples:
          - 0
        type:
          allOf:
          - $ref: '#/components/schemas/ap_usb_type2'
          - description: 'USB integration type for this legacy AP USB configuration. enum: `hanshow`, `imagotag`, `solum`.'
            examples:
            - imagotag
        verify_cert:
          type: boolean
          description: Only if `type`==`imagotag`, whether to turn on SSL verification
        vlan_id:
          type: integer
          description: Only if `type`==`solum` or `type`==`hanshow`
          contentEncoding: int32
          default: 1
      description: >-
        Legacy USB integration settings for an access point
          - Note: if native imagotag is enabled, BLE will be disabled automatically
          - Note: legacy, new config moved to ESL Config.
    ap_usb_type:
      title: ap_usb_type
      enum:
      - hanshow
      - imagotag
      - solum
      type: string
      description: 'usb config type. enum: `hanshow`, `imagotag`, `solum`'
      examples:
      - imagotag
    ap_uwb_config:
      title: ap_uwb_config
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether UWB RTLS integration is enabled
          default: false
        host:
          type: string
          description: RTLS server hostname or IP address
          examples:
          - coriva.example.com
        port:
          maximum: 65535
          minimum: 1
          type: integer
          description: RTLS server port number
          contentEncoding: int32
          examples:
          - 9000
        slot:
          maximum: 15
          minimum: 0
          type: integer
          description: UWB time slot assigned to this AP, 0–15
          contentEncoding: int32
          default: 0
          examples:
          - 0
        type:
          allOf:
          - $ref: '#/components/schemas/ap_uwb_config_type'
          - description: 'UWB integration type. enum: `zigpos`'
      description: Ultra-wideband (UWB) RTLS / OMLOX asset-visibility integration settings for an access point. The device-level value overrides the device profile value, which in turn overrides the site-level setting.
    ap_uwb_config_type:
      title: ap_uwb_config_type
      const: zigpos
      type: string
      description: 'UWB integration type. enum: `zigpos`'
    ap_zigbee:
      title: ap_zigbee
      type: object
      properties:
        allow_join:
          allOf:
          - $ref: '#/components/schemas/ap_zigbee_allow_join2'
          - description: 'Join policy for new Zigbee devices on this AP. enum: `always`, `manual`.'
            examples:
            - manual
        channel:
          maximum: 26
          minimum: 0
          type: integer
          description: Zigbee channel (2.4 GHz). `0` means auto; valid fixed values are 11–26
          contentEncoding: int32
          default: 0
          examples:
          - 0
        enabled:
          type: boolean
          description: Whether to enable Zigbee on this AP
          default: false
        extended_pan_id:
          type:
          - string
          - 'null'
          description: Extended PAN ID in hex string format; only applicable when `pan_id` is also specified
          examples:
          - '1311768467294899695'
        pan_id:
          type:
          - string
          - 'null'
          description: PAN ID in hex string format; if not specified, assigned automatically
          examples:
          - 0x1234
      description: Zigbee radio and network settings applied to an AP or AP profile
    ap_zigbee_allow_join:
      title: ap_zigbee_allow_join
      enum:
      - always
      - manual
      type: string
      description: 'Controls whether new Zigbee devices are allowed to join the network. enum: `always`, `manual`'
      examples:
      - manual
    api_usage:
      title: api_usage
      required:
      - request_limit
      - requests
      type: object
      properties:
        request_limit:
          type: integer
          description: Maximum API requests allowed in the current hourly rate-limit window
          contentEncoding: int32
          readOnly: true
        requests:
          type: integer
          description: Number of API requests made in the current hourly rate-limit window
          contentEncoding: int32
          readOnly: true
        seconds:
          type: number
          description: Time remaining, in seconds, before the current hourly rate-limit window resets
      description: API rate-limit usage status for the current user or API token
    app_probing:
      title: app_probing
      type: object
      properties:
        apps:
          type: array
          items:
            type: string
          description: Predefined application keys to probe
          examples:
          - - facebook
        custom_apps:
          type: array
          items:
            $ref: '#/components/schemas/app_probing_custom_app'
          description: User-defined application probe definitions
        enabled:
          type: boolean
          description: Whether gateway application probing is enabled
      description: Application reachability probing settings for gateway management
    app_probing_custom_app:
      title: app_probing_custom_app
      type: object
      properties:
        address:
          type: string
          description: Required if `protocol`==`icmp`. IP address probed by the ICMP custom app
          examples:
          - 192.168.1.1
        app_type:
          type: string
          description: Category label used for this custom application probe
        hostnames:
          type: array
          items:
            type: string
          description: If `protocol`==`http`. Hostnames or URLs probed by this custom app
          examples:
          - - https://www.abc.com
        key:
          type: string
          description: Stable key used to identify this custom application probe
        name:
          type: string
          description: Display name for this custom application probe
          examples:
          - pos_app
        network:
          type: string
          description: Gateway network used as the source context for this probe
          examples:
          - lan
        packetSize:
          maximum: 65400
          minimum: 0
          type: integer
          description: If `protocol`==`icmp`. ICMP packet size used by this custom app probe
          contentEncoding: int32
        protocol:
          allOf:
          - $ref: '#/components/schemas/app_probing_custom_app_protocol2'
          - description: 'Probe protocol used by this custom application definition. enum: `http`, `icmp`.'
        url:
          type: string
          description: If `protocol`==`http`. HTTP URL or hostname probed by this custom app
          examples:
          - www.abc.com
        vrf:
          type: string
          description: Gateway VRF used as the source context for this probe
          examples:
          - lan
      description: User-defined application probe definition
    app_probing_custom_app_protocol:
      title: app_probing_custom_app_protocol
      enum:
      - http
      - icmp
      type: string
      description: 'Probe protocol for a custom application. enum: `http`, `icmp`'
    arp_table_stats:
      title: arp_table_stats
      type: object
      properties:
        arp_table_count:
          type: integer
          description: Number of ARP table entries currently present on the device
          contentEncoding: int32
        max_entries_supported:
          type: integer
          description: Supported ARP table capacity for the device
          contentEncoding: int32
      description: ARP table usage and capacity statistics
    asset:
      title: asset
      required:
      - mac
      - name
      type: object
      properties:
        created_time:
          type: number
          description: Timestamp when this asset record was created
          readOnly: true
        for_site:
          type: boolean
          description: Whether this asset is scoped directly to a site
          readOnly: true
        id:
          type: string
          description: Unique identifier of the asset record
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        mac:
          type: string
          description: Bluetooth MAC address used to identify the BLE asset
        map_id:
          type: string
          description: Identifier of the map associated with this asset, when specified
          contentEncoding: uuid
        modified_time:
          type: number
          description: Timestamp when this asset record was last modified
          readOnly: true
        name:
          type: string
          description: Display name or label for the BLE asset
        org_id:
          type: string
          description: Owning organization identifier for this asset
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        site_id:
          type: string
          description: Identifier of the site associated with this asset
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        tag_id:
          type: string
          description: BLE tag identifier associated with this asset
          contentEncoding: uuid
      description: Named Bluetooth Low Energy asset record
    asset_filter:
      title: asset_filter
      required:
      - name
      type: object
      properties:
        ap_mac:
          type: string
          description: Access point MAC address that must observe the BLE asset
        beam:
          type: integer
          description: BLE beam number used to filter asset observations
          contentEncoding: int32
        created_time:
          type: number
          description: Timestamp when this asset filter was created
          readOnly: true
        disabled:
          type: boolean
          description: Whether the asset filter is disabled
          default: false
        eddystone_uid_namespace:
          type: string
          description: Eddystone uid namespace used to filter assets
          examples:
          - 2818e3868dec25629ede
        eddystone_url:
          type: string
          description: Eddystone url used to filter assets
          examples:
          - https://www.abc.com
        for_site:
          type: boolean
          description: Whether this asset filter is scoped directly to a site
          readOnly: true
        ibeacon_major:
          maximum: 65535
          minimum: 1
          type:
          - integer
          - 'null'
          description: Major value from the iBeacon advertisement that assets must match
          contentEncoding: int32
          examples:
          - 1234
        ibeacon_uuid:
          type:
          - string
          - 'null'
          description: UUID from the iBeacon advertisement that assets must match
          contentEncoding: uuid
          examples:
          - f3f17139-704a-f03a-2786-0400279e37c3
        id:
          type: string
          description: Unique identifier of the asset filter
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        mfg_company_id:
          type: integer
          description: BLE manufacturing-specific company-id used to filter assets
          contentEncoding: int32
          examples:
          - 935
        modified_time:
          type: number
          description: Timestamp when this asset filter was last modified
          readOnly: true
        mqtt_topic:
          type: string
          description: If set, matching BLE advertisements are forwarded to this MQTT topic when MQTT publishing is enabled
        name:
          type: string
          description: Display name for this BLE asset filter
          examples:
          - Visitor Tags
        org_id:
          type: string
          description: Owning organization identifier for this asset filter
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        rssi:
          type: integer
          description: Signal strength threshold used to filter BLE asset observations
          contentEncoding: int32
        service_uuid:
          type: string
          description: BLE service data uuid used to filter assets
          contentEncoding: uuid
          examples:
          - 0000fe6a-0000-1000-8000-0030459b3cfb
        site_id:
          type: string
          description: Containing site identifier for this asset filter, when site-scoped
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
      description: BLE asset filter definition; all specified criteria must match
    asset_import:
      title: asset_import
      required:
      - mac
      - name
      type: object
      properties:
        mac:
          minLength: 1
          type: string
          description: Bluetooth MAC address used to identify the imported BLE asset
        name:
          minLength: 1
          type: string
          description: Display name for the imported BLE asset
      description: Asset record supplied in a JSON import payload
    asset_of_interest:
      title: asset_of_interest
      type: object
      properties:
        ap_mac:
          minLength: 1
          type: string
          description: Access point MAC address that heard this BLE beacon
        beam:
          type: number
          description: BLE beam number that detected this beacon
        by:
          minLength: 1
          type: string
          description: Match source for this BLE beacon, such as asset or asset filter
        curr_site:
          minLength: 1
          type: string
          description: Site currently associated with this BLE beacon
        device_name:
          type: string
          description: AP name reported for the device that heard this BLE beacon
        id:
          type: string
          description: Unique identifier of the matched asset or filter entry
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        last_seen:
          type:
          - number
          - 'null'
          description: Timestamp when this BLE beacon was last observed
          readOnly: true
          examples:
          - 1470417522
        mac:
          minLength: 1
          type: string
          description: Bluetooth MAC address of this BLE beacon
        manufacture:
          minLength: 1
          type: string
          description: BLE manufacturer name resolved for this beacon
        map_id:
          minLength: 1
          type: string
          description: Identifier of the map associated with this BLE beacon observation
        name:
          minLength: 1
          type: string
          description: Display name of the matched asset or filter
        rssi:
          type: number
          description: Signal strength of this BLE beacon, in dBm
      description: BLE beacon that matched a named asset or asset filter
    asset_rssi_zone:
      title: asset_rssi_zone
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the RSSI zone
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        since:
          type: number
          description: Timestamp when the asset entered this RSSI zone
      description: RSSI zone membership for an individual asset statistic
    asset_zone:
      title: asset_zone
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the zone
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        since:
          type: number
          description: Timestamp when the asset entered this zone
      description: Map zone membership for an individual asset statistic
    assets_import_file:
      title: assets_import_file
      type: object
      properties:
        file:
          type: string
          description: CSV file containing asset records to import
          contentEncoding: base64
      description: CSV file upload payload for importing BLE assets
    audit_log:
      title: audit_log
      required:
      - admin_id
      - admin_name
      - id
      - message
      - org_id
      - site_id
      - timestamp
      type: object
      properties:
        admin_id:
          type: string
          description: Identifier of the administrator associated with the audited action
          contentEncoding: uuid
          readOnly: true
          examples:
          - 456b7016-a916-a4b1-78dd-72b947c152b7
        admin_name:
          type: string
          description: Name or email of the administrator associated with the audited action
        after:
          type: object
          description: Field values after the audited change
        before:
          type: object
          description: Field values before the audited change
        for_site:
          type: boolean
          description: Whether this audit log entry is scoped to a site
          readOnly: true
        id:
          type: string
          description: Unique identifier of the audit log entry
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        message:
          type: string
          description: Human-readable audit message describing the action
        org_id:
          type: string
          description: Owning organization identifier for this audit log entry
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        site_id:
          type: string
          description: Associated site identifier for this audit log entry
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        timestamp:
          type: number
          description: Time when the audited action occurred
          readOnly: true
      description: Administrative audit log entry
    auto_map_assignment:
      title: auto_map_assignment
      type: object
      properties:
        dryrun:
          type: boolean
          description: If `true`, validates the site's APs without starting the map assignment process. Returns device validity and estimated runtime.
          default: false
        force_collection:
          type: boolean
          description: If `true`, forces data collection via orchestration. If `false`, attempts to use existing BLE data first.
          default: false
      description: Request options for validating or starting automatic AP map assignment
    auto_map_assignment_request:
      title: auto_map_assignment_request
      type: object
      properties:
        map_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Optional list of specific map IDs to apply/clear. If not provided or empty, all pending map assignments are accepted/rejected.
      description: Request body for accepting or clearing pending map assignments
    auto_orient:
      title: auto_orient
      type: object
      properties:
        dryrun:
          type: boolean
          description: Set to `true` to perform an invalid AP check and provide an estimated run time without enqueuing the run into the auto orient service.
        force_collection:
          type: boolean
          description: "If `force_collection`==`false`, the API attempts to start auto orientation with existing BLE data. \nIf `force_collection`==`true`, the API attempts to start BLE orchestration."
          default: false
        macs:
          type: array
          items:
            type: string
          description: AP MAC addresses to include in the auto-orient run
        override:
          type: boolean
          description: Set to `true` to run auto orient even if there are invalid APs in the selected APs.
      description: Request options for validating or starting AP auto-orientation
    auto_placement:
      title: auto_placement
      type: object
      properties:
        dryrun:
          type: boolean
          description: Set to `true` to perform an invalid AP check and provide an estimated run time without enqueuing the run into the auto placement service.
          default: false
        force_collection:
          type: boolean
          description: "* If `force_collection`==`false`: the API attempts to start localization with existing data. \n* If `force_collection`==`true`: maintenance the API attempts to start orchestration."
          default: false
        macs:
          type: array
          items:
            type: string
          description: AP MAC addresses to include in the auto-placement run
        override:
          type: boolean
          description: Set to `true` to run auto placement even if there are invalid APs in the selected APs.
          default: false
      description: Request options for validating or starting AP auto-placement
    auto_placement_info_status:
      title: auto_placement_info_status
      enum:
      - done
      - error
      - inprogress
      - pending
      type: string
      description: 'the status of autoplacement for a given map. enum: `done`, `error`, `inprogress`, `pending`'
    auto_preemption:
      title: auto_preemption
      type: object
      properties:
        day_of_week:
          allOf:
          - $ref: '#/components/schemas/day_of_week7'
          - description: 'Scheduled weekday for auto preemption. enum: `any`, `fri`, `mon`, `sat`, `sun`, `thu`, `tue`, `wed`.'
        enabled:
          type: boolean
          description: Whether auto preemption is enabled
          default: false
        time_of_day:
          type: string
          description: Scheduled time of day for auto preemption
          default: any
          examples:
          - 12:00
      description: Schedule to preempt AP tunnels that are not connected to their preferred peer
    autoplacement_localization_selector:
      title: autoplacement_localization_selector
      type: object
      properties:
        for:
          allOf:
          - $ref: '#/components/schemas/autoplacement_localization_selector_for'
          - description: 'The selector to choose auto placement or auto orientation. enum: `orientation`, `placement`'
        macs:
          type: array
          items:
            type: string
          description: List of AP MAC addresses to apply the action to. If omitted, the action applies to all APs on the map
      description: Request body to apply or clear cached autoplacement or auto-orientation values for a map or subset of APs
    autoplacement_localization_selector_for:
      title: autoplacement_localization_selector_for
      enum:
      - orientation
      - placement
      type: string
      description: 'The selector to choose auto placement or auto orientation. enum: `orientation`, `placement`'
    avprofile:
      title: avprofile
      required:
      - name
      type: object
      properties:
        created_time:
          type: number
          description: Timestamp when this antivirus profile was created
          readOnly: true
        fallback_action:
          allOf:
          - $ref: '#/components/schemas/avprofile_fallback_action2'
          - description: 'Action to take when antivirus scanning cannot complete. enum: `block`, `log-and-permit`, `permit`.'
        id:
          type: string
          description: Unique identifier of the antivirus profile
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        max_filesize:
          maximum: 40000
          minimum: 20
          type: integer
          description: Maximum file size scanned by this antivirus profile, in KB
          contentEncoding: int32
          default: 10000
        mime_whitelist:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Content MIME types exempted from antivirus scanning
        modified_time:
          type: number
          description: Timestamp when this antivirus profile was last modified
          readOnly: true
        name:
          type: string
          description: Display name of the antivirus profile
        org_id:
          type: string
          description: Owning organization identifier for this antivirus profile
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        protocols:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/avprofile_protocol'
          description: Network protocols inspected by this antivirus profile
        site_id:
          type: string
          description: Associated site identifier for this antivirus profile, when site-scoped
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        url_whitelist:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Allowed URL entries exempted from antivirus scanning
      description: Antivirus scanning profile with protocols, limits, and whitelist settings
    avprofile_fallback_action:
      title: avprofile_fallback_action
      enum:
      - block
      - log-and-permit
      - permit
      type: string
      description: 'Action applied when antivirus scanning cannot complete. enum: `block`, `log-and-permit`, `permit`'
    avprofile_protocol:
      title: avprofile_protocol
      enum:
      - ftp
      - http
      - imap
      - pop3
      - smtp
      type: string
      description: 'Protocol that can be inspected by an antivirus profile. enum: `ftp`, `http`, `imap`, `pop3`, `smtp`'
    beacon:
      title: beacon
      type: object
      properties:
        created_time:
          type: number
          description: Timestamp when this beacon configuration was created
          readOnly: true
        eddystone_instance:
          type: string
          description: Eddystone-UID instance (6 bytes) in hexstring format
        eddystone_namespace:
          type: string
          description: Eddystone-UID namespace (10 bytes) in hexstring format
        eddystone_url:
          type: string
          description: Eddystone-URL value broadcast by the beacon
        for_site:
          type: boolean
          description: Whether this beacon is scoped directly to a site
          readOnly: true
        ibeacon_major:
          maximum: 65535
          minimum: 1
          type:
          - integer
          - 'null'
          description: iBeacon major value advertised by this beacon
          contentEncoding: int32
          examples:
          - 1234
        ibeacon_minor:
          maximum: 65535
          minimum: 1
          type:
          - integer
          - 'null'
          description: iBeacon minor value advertised by this beacon
          contentEncoding: int32
          examples:
          - 1234
        ibeacon_uuid:
          type:
          - string
          - 'null'
          description: iBeacon UUID advertised by this beacon
          contentEncoding: uuid
          examples:
          - f3f17139-704a-f03a-2786-0400279e37c3
        id:
          type: string
          description: Unique identifier of the beacon configuration
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        mac:
          type: string
          description: Optional beacon MAC address, currently used only to identify battery voltage
        map_id:
          type: string
          description: Map where the beacon is placed
          contentEncoding: uuid
        modified_time:
          type: number
          description: Timestamp when this beacon configuration was last modified
          readOnly: true
        name:
          type: string
          description: Display name of the beacon
        org_id:
          type: string
          description: Owning organization identifier for this beacon
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        power:
          maximum: 100
          minimum: -12
          type: integer
          description: Beacon transmit power, in dBm
          contentEncoding: int32
          default: -12
        site_id:
          type: string
          description: Site identifier associated with this beacon
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        type:
          allOf:
          - $ref: '#/components/schemas/beacon_type2'
          - description: 'Beacon advertisement format used by this beacon. enum: `eddystone-uid`, `eddystone-url`, `ibeacon`.'
        x:
          type: number
          description: Horizontal map position of the beacon, in pixels
        y:
          type: number
          description: Vertical map position of the beacon, in pixels
      description: Beacon configuration and placement data
    beacon_type:
      title: beacon_type
      enum:
      - eddystone-uid
      - eddystone-url
      - ibeacon
      type: string
      description: 'enum: `eddystone-uid`, `eddystone-url`, `ibeacon`'
    bgp_config:
      title: bgp_config
      required:
      - via
      type: object
      properties:
        auth_key:
          type: string
          description: Optional if `via`==`lan`, `via`==`tunnel` or `via`==`wan`
        bfd_minimum_interval:
          maximum: 255000
          minimum: 1
          type:
          - integer
          - 'null'
          description: >-
            Optional if `via`==`lan`, `via`==`tunnel` or `via`==`wan`, when bfd_multiplier is configured alone. Default:
              * 1000 if `type`==`external`
              * 350 `type`==`internal`
          contentEncoding: int32
          default: 350
        bfd_multiplier:
          maximum: 255
          minimum: 1
          type:
          - integer
          - 'null'
          description: Optional if `via`==`lan`, `via`==`tunnel` or `via`==`wan`, when bfd_minimum_interval_is_configured alone
          contentEncoding: int32
          default: 3
        disable_bfd:
          type: boolean
          description: Optional if `via`==`lan`, `via`==`tunnel` or `via`==`wan`. BFD provides faster path failure detection and is enabled by default
          default: false
        export:
          type: string
          description: Routing policy applied to routes exported by this BGP session
        export_policy:
          type: string
          description: Default export policies if no per-neighbor policies defined
        extended_v4_nexthop:
          type: boolean
          description: Optional if `via`==`lan`, `via`==`tunnel` or `via`==`wan`. By default, either inet/net6 unicast depending on neighbor IP family (v4 or v6). For v6 neighbors, to exchange v4 nexthop, which allows dual-stack support, enable this
        graceful_restart_time:
          maximum: 4095
          minimum: 0
          type: integer
          description: Optional if `via`==`lan`, `via`==`tunnel` or `via`==`wan`. `0` means disable
          contentEncoding: int32
          default: 0
        hold_time:
          maximum: 65535
          minimum: 0
          type: integer
          description: Optional if `via`==`lan`, `via`==`tunnel` or `via`==`wan`. Default is 90.
          contentEncoding: int32
          default: 90
        import:
          type: string
          description: Routing policy applied to routes imported by this BGP session
        import_policy:
          type: string
          description: Optional if `via`==`lan`, `via`==`tunnel` or `via`==`wan`. Default import policies if no per-neighbor policies defined
        local_as:
          anyOf:
          - type: string
          - maximum: 4294967295
            minimum: 1
            type: integer
            contentEncoding: int32
          description: Required if `via`==`lan`, `via`==`tunnel` or `via`==`wan`; local BGP Autonomous System (AS) number
          examples:
          - '65000'
        neighbor_as:
          anyOf:
          - type: string
          - maximum: 4294967294
            minimum: 1
            type: integer
            contentEncoding: int32
          description: Default BGP neighbor Autonomous System (AS) number for this session
          examples:
          - '65000'
        neighbors:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/bgp_config_neighbors'
          description: Required if `via`==`lan`, `via`==`tunnel` or `via`==`wan`. If per-neighbor as is desired. Property key is the neighbor address
        networks:
          type: array
          items:
            type: string
          description: Optional if `via`==`lan`; networks where BGP neighbors can connect to or from
        no_private_as:
          type: boolean
          description: Optional if `via`==`lan`, `via`==`tunnel` or `via`==`wan`. If true, we will not advertise private ASNs (AS 64512-65534) to this neighbor
          default: false
        no_readvertise_to_overlay:
          type: boolean
          description: Optional if `via`==`lan`, `via`==`tunnel` or `via`==`wan`. By default, we'll re-advertise all learned BGP routers toward overlay
          default: false
        tunnel_name:
          type: string
          description: Optional if `via`==`tunnel`; tunnel name used for this BGP session
        type:
          allOf:
          - $ref: '#/components/schemas/bgp_config_type2'
          - minLength: 1
            description: Required if `via`==`lan`, `via`==`tunnel` or `via`==`wan`; BGP session type, internal or external
        via:
          allOf:
          - $ref: '#/components/schemas/bgp_config_via2'
          - description: Transport used for this BGP session, such as LAN, tunnel, VPN, or WAN
        vpn_name:
          type: string
          description: Optional if `via`==`vpn`; VPN name used for this BGP session
        wan_name:
          type: string
          description: Optional if `via`==`wan`; WAN interface name used for this BGP session
      description: BGP session configuration. BFD is enabled when either bfd_minimum_interval or bfd_multiplier is configured
    bgp_config_neighbors:
      title: bgp_config_neighbors
      required:
      - neighbor_as
      type: object
      properties:
        disabled:
          type: boolean
          description: If true, the BGP session to this neighbor will be administratively disabled/shutdown
          default: false
        export_policy:
          type: string
          description: Export policy applied only to this BGP neighbor
        hold_time:
          maximum: 65535
          minimum: 0
          type: integer
          description: BGP hold time for this neighbor, in seconds
          contentEncoding: int32
          default: 90
        import_policy:
          type: string
          description: Import policy applied only to this BGP neighbor
        multihop_ttl:
          maximum: 255
          minimum: 0
          type: integer
          description: Assuming BGP neighbor is directly connected
          contentEncoding: int32
        neighbor_as:
          anyOf:
          - type: string
          - maximum: 4294967294
            minimum: 1
            type: integer
            contentEncoding: int32
          description: Autonomous System (AS) number of this BGP neighbor
          examples:
          - '65000'
        tunnel_via:
          allOf:
          - $ref: '#/components/schemas/tunnel_via2'
          - description: If `via`==`tunnel`, primary or secondary tunnel associated with this BGP neighbor
      description: Per-neighbor BGP session settings
    bgp_config_type:
      title: bgp_config_type
      enum:
      - external
      - internal
      type: string
      description: 'Required if `via`==`lan`, `via`==`tunnel` or `via`==`wan`. enum: `external`, `internal`'
    bgp_config_via:
      title: bgp_config_via
      enum:
      - lan
      - tunnel
      - vpn
      - wan
      type: string
      description: 'enum: `lan`, `tunnel`, `vpn`, `wan`'
    bgp_peer:
      title: bgp_peer
      type: object
      properties:
        evpn_overlay:
          type: boolean
          description: If this is created for evpn overlay
        for_overlay:
          type: boolean
          description: If this is created for overlay
        local_as:
          anyOf:
          - type: string
          - maximum: 4294967294
            minimum: 1
            type: integer
            contentEncoding: int32
          description: Local Autonomous System (AS) number used by this BGP session
          examples:
          - '65000'
        neighbor:
          type: string
          description: IP address of the BGP neighbor
          examples:
          - 15.8.3.5
        neighbor_as:
          anyOf:
          - type: string
          - maximum: 4294967294
            minimum: 1
            type: integer
            contentEncoding: int32
          description: Autonomous System (AS) number of the BGP neighbor
          examples:
          - '65000'
        neighbor_mac:
          type: string
          description: MAC address of the BGP neighbor when it is another device in the same organization
          examples:
          - 020001c04600
        node:
          type: string
          description: HA node reporting this BGP peer, such as node0 or node1
          examples:
          - node0
        rx_pkts:
          type:
          - integer
          - 'null'
          description: Packets received from this BGP neighbor
          contentEncoding: int64
          readOnly: true
          examples:
          - 57770567
        rx_routes:
          type: integer
          description: Number of received routes
          contentEncoding: int32
          examples:
          - 60
        state:
          allOf:
          - $ref: '#/components/schemas/bgp_stats_state1'
          - description: 'Current state of the BGP session. enum: `active`, `connect`, `established`, `idle`, `open_config`, `open_sent`.'
            examples:
            - established
        timestamp:
          type: number
          description: Time when these BGP peer stats were sampled
          readOnly: true
        tx_pkts:
          type:
          - integer
          - 'null'
          description: Packets sent to this BGP neighbor
          contentEncoding: int64
          readOnly: true
          examples:
          - 812204062
        tx_routes:
          type: integer
          description: Number of routes advertised to this BGP neighbor
          contentEncoding: int32
          examples:
          - 60
        up:
          type: boolean
          description: Whether the BGP session is currently up
        uptime:
          type: integer
          description: Number of seconds the BGP session has been up
          contentEncoding: int32
          examples:
          - 31355
        vrf_name:
          type: string
          description: VRF name associated with this BGP session
          examples:
          - default
      description: Only present when `bgp_peers` in `fields` query parameter
    bgp_stats:
      title: bgp_stats
      type: object
      properties:
        evpn_overlay:
          type: boolean
          description: If this is created for evpn overlay
        for_overlay:
          type: boolean
          description: If this is created for overlay
        local_as:
          anyOf:
          - type: string
          - maximum: 4294967294
            minimum: 1
            type: integer
            contentEncoding: int32
          description: Local Autonomous System (AS) number used by this BGP session
          examples:
          - '65000'
        mac:
          type: string
          description: Router MAC address for the device reporting this BGP peer
          examples:
          - 020001c04668
        model:
          type: string
          description: Device model reporting this BGP peer statistic
        neighbor:
          type: string
          description: IP address of the BGP neighbor
          examples:
          - 15.8.3.5
        neighbor_as:
          anyOf:
          - type: string
          - maximum: 4294967294
            minimum: 1
            type: integer
            contentEncoding: int32
          description: Autonomous System (AS) number of the BGP neighbor
          examples:
          - '65000'
        neighbor_mac:
          type: string
          description: MAC address of the BGP neighbor when it is another device in the same organization
          examples:
          - 020001c04600
        node:
          type: string
          description: HA node reporting this BGP peer, such as node0 or node1
          examples:
          - node0
        org_id:
          type: string
          description: Owning organization identifier for this BGP peer statistic
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        rx_pkts:
          type:
          - integer
          - 'null'
          description: Packets received from this BGP neighbor
          contentEncoding: int64
          readOnly: true
          examples:
          - 57770567
        rx_routes:
          type: integer
          description: Number of received routes
          contentEncoding: int32
          examples:
          - 60
        site_id:
          type: string
          description: Site identifier associated with this BGP peer statistic
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        state:
          allOf:
          - $ref: '#/components/schemas/bgp_stats_state1'
          - description: 'Current state of the BGP session. enum: `active`, `connect`, `established`, `idle`, `open_config`, `open_sent`.'
            examples:
            - established
        timestamp:
          type: number
          description: Time when these BGP peer stats were sampled
          readOnly: true
        tx_pkts:
          type:
          - integer
          - 'null'
          description: Packets sent to this BGP neighbor
          contentEncoding: int64
          readOnly: true
          examples:
          - 812204062
        tx_routes:
          type: integer
          description: Number of routes advertised to this BGP neighbor
          contentEncoding: int32
          examples:
          - 60
        up:
          type: boolean
          description: Whether the BGP session is currently up
        uptime:
          type: integer
          description: Number of seconds the BGP session has been up
          contentEncoding: int32
          examples:
          - 31355
        vrf_name:
          type: string
          description: VRF name associated with this BGP session
          examples:
          - default
      description: BGP peer statistics reported by a network device
    bgp_stats_state:
      title: bgp_stats_state
      enum:
      - active
      - connect
      - established
      - idle
      - open_config
      - open_sent
      type: string
      description: 'enum: `active`, `connect`, `established`, `idle`, `open_config`, `open_sent`'
      examples:
      - established
    binary_stream:
      title: binary_stream
      required:
      - file
      type: object
      properties:
        file:
          type: string
          description: Binary file payload to upload with this request
          contentEncoding: base64
      description: Binary file upload payload
    ble_config:
      title: ble_config
      type: object
      properties:
        beacon_enabled:
          type: boolean
          description: Whether Mist beacons is enabled
          default: true
        beacon_rate:
          type: integer
          description: Required if `beacon_rate_mode`==`custom`, 1-10, in number-beacons-per-second
          contentEncoding: int32
          examples:
          - 3
        beacon_rate_mode:
          allOf:
          - $ref: '#/components/schemas/ble_config_beacon_rate_mode2'
          - description: 'Beacon rate mode for Mist BLE beacons; use custom to set beacon_rate. enum: `custom`, `default`.'
            examples:
            - custom
        beam_disabled:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: AP BLE beam numbers disabled for location advertisements
          examples:
          - - 1
            - 3
            - 6
        custom_ble_packet_enabled:
          type: boolean
          description: Can be enabled if `beacon_enabled`==`true`, whether to send custom packet
          default: false
        custom_ble_packet_frame:
          type: string
          description: The custom frame to be sent out in this beacon. The frame must be a hexstring
          examples:
          - 0x........
        custom_ble_packet_freq_msec:
          minimum: 0
          type: integer
          description: Frequency (msec) of data emitted by custom ble beacon
          contentEncoding: int32
          default: 0
          examples:
          - 300
        eddystone_uid_adv_power:
          maximum: 20
          minimum: -100
          type: integer
          description: Advertised TX Power, -100 to 20 (dBm), omit this attribute to use default
          contentEncoding: int32
          default: 0
          examples:
          - -65
        eddystone_uid_beams:
          type: string
          description: BLE beams used to transmit Eddystone-UID advertisements, expressed as ranges such as `2-4,7`
          examples:
          - 2-4,7
        eddystone_uid_enabled:
          type: boolean
          description: Only if `beacon_enabled`==`false`, Whether Eddystone-UID beacon is enabled
          default: false
        eddystone_uid_freq_msec:
          type: integer
          description: Frequency (msec) of data emit by Eddystone-UID beacon
          contentEncoding: int32
          default: 0
          examples:
          - 200
        eddystone_uid_instance:
          type: string
          description: Eddystone-UID instance for the device
          examples:
          - 5c5b35000001
        eddystone_uid_namespace:
          type: string
          description: Eddystone-UID namespace broadcast by the AP, as a 10-byte hex string
          examples:
          - 2818e3868dec25629ede
        eddystone_url_adv_power:
          maximum: 20
          minimum: -100
          type: integer
          description: Advertised TX Power, -100 to 20 (dBm), omit this attribute to use default
          contentEncoding: int32
          default: 0
          examples:
          - -65
        eddystone_url_beams:
          type: string
          description: BLE beams used to transmit Eddystone-URL advertisements, expressed as ranges such as `2-4,7`
          examples:
          - 2-4,7
        eddystone_url_enabled:
          type: boolean
          description: Only if `beacon_enabled`==`false`, Whether Eddystone-URL beacon is enabled
          default: false
        eddystone_url_freq_msec:
          type: integer
          description: Frequency (msec) of data emitted by Eddystone-URL beacon
          contentEncoding: int32
          default: 0
          examples:
          - 1000
        eddystone_url_url:
          type: string
          description: URL pointed by Eddystone-URL beacon
          examples:
          - https://www.abc.com
        ibeacon_adv_power:
          maximum: 20
          minimum: -100
          type: integer
          description: Advertised TX Power, -100 to 20 (dBm), omit this attribute to use default
          contentEncoding: int32
          default: 0
          examples:
          - -65
        ibeacon_beams:
          type: string
          description: BLE beams used to transmit iBeacon advertisements, expressed as ranges such as `2-4,7`
          examples:
          - 2-4,7
        ibeacon_enabled:
          type: boolean
          description: Can be enabled if `beacon_enabled`==`true`, whether to send iBeacon
          default: false
        ibeacon_freq_msec:
          type: integer
          description: Frequency (msec) of data emit for iBeacon
          contentEncoding: int32
          default: 0
        ibeacon_major:
          maximum: 65535
          minimum: 1
          type:
          - integer
          - 'null'
          description: iBeacon major value broadcast by the AP
          contentEncoding: int32
          examples:
          - 1234
        ibeacon_minor:
          maximum: 65535
          minimum: 1
          type:
          - integer
          - 'null'
          description: iBeacon minor value broadcast by the AP
          contentEncoding: int32
          examples:
          - 1234
        ibeacon_uuid:
          type: string
          description: Optional, if not specified, the same UUID as the beacon will be used
          contentEncoding: uuid
          examples:
          - f3f17139-704a-f03a-2786-0400279e37c3
        power:
          maximum: 10
          minimum: 1
          type: integer
          description: Required if `power_mode`==`custom`; else use `power_mode` as default
          contentEncoding: int32
          default: 9
          examples:
          - 6
        power_mode:
          allOf:
          - $ref: '#/components/schemas/ble_config_power_mode3'
          - description: 'Transmit power mode for BLE beacons; use custom to set `power`. enum: `custom`, `default`.'
            examples:
            - custom
      description: Bluetooth Low Energy beacon and asset advertising settings for an AP
    ble_config_beacon_rate_mode:
      title: ble_config_beacon_rate_mode
      enum:
      - custom
      - default
      type: string
      description: 'Beacon rate mode for Mist BLE beacons; use custom to set beacon_rate. enum: `custom`, `default`'
      examples:
      - custom
    ble_config_power_mode:
      title: ble_config_power_mode
      enum:
      - custom
      - default
      type: string
      description: 'Transmit power mode for BLE beacons; use `custom` to set explicit power. enum: `custom`, `default`'
      examples:
      - custom
    call_troubleshoot:
      title: call_troubleshoot
      type: object
      properties:
        mac:
          type: string
          description: Client MAC address for the troubleshot call
          examples:
          - 983a78ea4a44
        meeting_id:
          type: string
          description: Meeting identifier for the troubleshot call
          contentEncoding: uuid
          examples:
          - b784d744-9a7c-4fad-9af0-f78858a319b1
        results:
          type: array
          items:
            $ref: '#/components/schemas/troubleshoot_call_item'
          description: Per-sample troubleshooting results for the call
      description: Detailed call troubleshooting response
    call_troubleshoot_data:
      title: call_troubleshoot_data
      type: object
      properties:
        ap_num_clients:
          type: number
          description: Troubleshooting metric value for AP client count
          examples:
          - -0.6565111
        ap_rtt:
          type: number
          description: Troubleshooting metric value for AP round-trip time
          examples:
          - 0.16559607
        client_cpu:
          type: number
          description: Troubleshooting metric value for client CPU load
          examples:
          - 3.7028809
        client_n_streams:
          type: number
          description: Troubleshooting metric value for the number of client spatial streams
          examples:
          - 0.15803306
        client_radio_band:
          type: number
          description: Troubleshooting metric value for the client radio band
          examples:
          - 0.5576923
        client_rssi:
          type: number
          description: Troubleshooting metric value for client RSSI
          examples:
          - -1.0839354
        client_rx_bytes:
          type: number
          description: Troubleshooting metric value for bytes received by the client
          examples:
          - 2.2622051
        client_rx_rates:
          type: number
          description: Troubleshooting metric value for client receive data rates
          examples:
          - 0.62357205
        client_rx_retries:
          type: number
          description: Troubleshooting metric value for client receive retries
          examples:
          - 0.26726437
        client_tx_bytes:
          type: number
          description: Troubleshooting metric value for bytes transmitted by the client
          examples:
          - 0.15803306
        client_tx_rates:
          type: number
          description: Troubleshooting metric value for client transmit data rates
          examples:
          - 0.62357205
        client_tx_retries:
          type: number
          description: Troubleshooting metric value for client transmit retries
          examples:
          - 0.77553505
        client_vpn_distance:
          type: number
          description: Troubleshooting metric value for client VPN distance
          examples:
          - 1.6474955
        client_wifi_version:
          type: number
          description: Troubleshooting metric value for the client Wi-Fi version
          examples:
          - 0.18267937
        expected:
          type: number
          description: Model baseline value expected for this media direction
          examples:
          - 30.941595
        radio_bandwidth:
          type: number
          description: Troubleshooting metric value for radio channel bandwidth
          examples:
          - -0.06538621
        radio_channel:
          type: number
          description: Troubleshooting metric value for the radio channel
          examples:
          - -0.73391086
        radio_tx_power:
          type: number
          description: Troubleshooting metric value for radio transmit power
          examples:
          - 0.10027129
        radio_util:
          type: number
          description: Troubleshooting metric value for radio utilization
          examples:
          - 12.770318
        radio_util_interference:
          type: number
          description: Troubleshooting metric value for radio interference utilization
          examples:
          - -3.079999
        site_num_clients:
          type: number
          description: Troubleshooting metric value for the number of clients at the site
          examples:
          - 0.017364305
        wan_avg_download_mbps:
          type: number
          description: Troubleshooting metric value for average WAN download throughput
          examples:
          - 1.4803165
        wan_avg_upload_mbps:
          type: number
          description: Troubleshooting metric value for average WAN upload throughput
          examples:
          - -0.038184267
        wan_jitter:
          type: number
          description: Troubleshooting metric value for WAN jitter
          examples:
          - 5.9680853
        wan_max_download_mbps:
          type: number
          description: Troubleshooting metric value for maximum WAN download throughput
          examples:
          - 1.4803165
        wan_max_upload_mbps:
          type: number
          description: Troubleshooting metric value for maximum WAN upload throughput
          examples:
          - -0.038184267
        wan_rtt:
          type: number
          description: Troubleshooting metric value for WAN round-trip time
          examples:
          - 46.77899
      description: Per-media call troubleshooting metric values
    call_troubleshoot_summary:
      title: call_troubleshoot_summary
      type: object
      properties:
        ap_num_clients:
          type: number
          description: Summary troubleshooting metric value for AP client count
          examples:
          - -0.08802365511655807
        ap_rtt:
          type: number
          description: Summary troubleshooting metric value for AP round-trip time
          examples:
          - 0.09924473613500595
        audio_in:
          allOf:
          - $ref: '#/components/schemas/call_troubleshoot_summary_data5'
          - description: Troubleshooting metrics for the inbound audio stream
        audio_out:
          allOf:
          - $ref: '#/components/schemas/call_troubleshoot_summary_data1'
          - description: Troubleshooting metrics for the outbound audio stream
        client_cpu:
          type: number
          description: Summary troubleshooting metric value for client CPU load
          examples:
          - 0.00834270566701889
        client_n_streams:
          type: number
          description: Summary troubleshooting metric value for the number of client spatial streams
          examples:
          - 0.00734270566701889
        client_radio_band:
          type: number
          description: Summary troubleshooting metric value for the client radio band
          examples:
          - 0.5841414928436279
        client_rssi:
          type: number
          description: Summary troubleshooting metric value for client RSSI
          examples:
          - 0.7594696879386902
        client_rx_bytes:
          type: number
          description: Summary troubleshooting metric value for bytes received by the client
          examples:
          - 2.365511655807E-05
        client_rx_rates:
          type: number
          description: Summary troubleshooting metric value for client receive data rates
          examples:
          - 0.02441493794322014
        client_rx_retries:
          type: number
          description: Summary troubleshooting metric value for client receive retries
          examples:
          - -0.14325742423534393
        client_tx_bytes:
          type: number
          description: Summary troubleshooting metric value for bytes transmitted by the client
          examples:
          - 0.00102365511655807
        client_tx_rates:
          type: number
          description: Summary troubleshooting metric value for client transmit data rates
          examples:
          - 0.22236637771129608
        client_tx_retries:
          type: number
          description: Summary troubleshooting metric value for client transmit retries
          examples:
          - 0.3308201730251312
        client_vpn_distance:
          type: number
          description: Summary troubleshooting metric value for client VPN distance
          examples:
          - -0.0001660545531194657
        client_wifi_version:
          type: number
          description: Summary troubleshooting metric value for the client Wi-Fi version
          examples:
          - 7.0566701889E-07
        expected:
          type: number
          description: Model baseline value expected for this call sample
          examples:
          - -2.8630001056670187
        radio_ap_change:
          type: number
          description: Summary troubleshooting metric value for AP changes on the radio path
          examples:
          - 0.01850946433842182
        radio_bandwidth:
          type: number
          description: Summary troubleshooting metric value for radio channel bandwidth
          examples:
          - -0.021175479516386986
        radio_channel:
          type: number
          description: Summary troubleshooting metric value for the radio channel
          examples:
          - 0.11686426401138306
        radio_rx_failed:
          type: number
          description: Summary troubleshooting metric value for failed radio receive attempts
          examples:
          - 1.1782013177871704
        radio_tx_power:
          type: number
          description: Summary troubleshooting metric value for radio transmit power
          examples:
          - 0.121039018034935
        radio_util:
          type: number
          description: Summary troubleshooting metric value for radio utilization
          examples:
          - 0.2452986091375351
        radio_util_interference:
          type: number
          description: Summary troubleshooting metric value for radio interference utilization
          examples:
          - 3.4367904663085938
        site_num_clients:
          type: number
          description: Summary troubleshooting metric value for the number of clients at the site
          examples:
          - 0.055026158690452576
        site_wan_avg_download_mbps:
          type: number
          description: Summary troubleshooting metric value for site WAN average download throughput
          examples:
          - 3.0566701889E-07
        site_wan_avg_upload_mbps:
          type: number
          description: Summary troubleshooting metric value for site WAN average upload throughput
          examples:
          - 5.566701889E-08
        site_wan_download_mbps:
          type: number
          description: Summary troubleshooting metric value for site WAN download throughput
          examples:
          - 8.0566701889E-07
        site_wan_jitter:
          type: number
          description: Summary troubleshooting metric value for site WAN jitter
          examples:
          - 0.7875519659784105
        site_wan_rtt:
          type: number
          description: Summary troubleshooting metric value for site WAN round-trip time
          examples:
          - 15.094849904378256
        site_wan_upload_mbps:
          type: number
          description: Summary troubleshooting metric value for site WAN upload throughput
          examples:
          - 2.0566701889E-07
        timestamp:
          type: number
          description: Time when this call troubleshooting sample was recorded
          readOnly: true
        video_in:
          allOf:
          - $ref: '#/components/schemas/call_troubleshoot_summary_data2'
          - description: Troubleshooting metrics for the inbound video stream
        video_out:
          allOf:
          - $ref: '#/components/schemas/call_troubleshoot_summary_data3'
          - description: Troubleshooting metrics for the outbound video stream
      description: Summary row for call troubleshooting metrics
    call_troubleshoot_summary_data:
      title: call_troubleshoot_summary_data
      type: object
      properties:
        ap_num_clients:
          type: number
          description: Media-direction metric value for AP client count
          examples:
          - -0.6565111
        ap_rtt:
          type: number
          description: Media-direction metric value for AP round-trip time
          examples:
          - 0.16559607
        client_cpu:
          type: number
          description: Media-direction metric value for client CPU load
          examples:
          - 3.7028809
        client_n_streams:
          type: number
          description: Media-direction metric value for the number of client spatial streams
          examples:
          - 0.15803306
        client_radio_band:
          type: number
          description: Media-direction metric value for the client radio band
          examples:
          - 0.5576923
        client_rssi:
          type: number
          description: Media-direction metric value for client RSSI
          examples:
          - -1.0839354
        client_rx_bytes:
          type: number
          description: Media-direction metric value for bytes received by the client
          examples:
          - 2.2622051
        client_rx_rates:
          type: number
          description: Media-direction metric value for client receive data rates
          examples:
          - 0.26726437
        client_tx_bytes:
          type: number
          description: Media-direction metric value for bytes transmitted by the client
          examples:
          - 6.6164713
        client_tx_rates:
          type: number
          description: Media-direction metric value for client transmit data rates
          examples:
          - 0.62357205
        client_tx_retries:
          type: number
          description: Media-direction metric value for client transmit retries
          examples:
          - 1.702031
        client_vpn_distance:
          type: number
          description: Media-direction metric value for client VPN distance
          examples:
          - 1.6474955
        client_wifi_version:
          type: number
          description: Media-direction metric value for the client Wi-Fi version
          examples:
          - 0.18267937
        expected:
          type: number
          description: Model baseline value expected for this media direction
          examples:
          - 30.941595
        radio_bandwidth:
          type: number
          description: Media-direction metric value for radio channel bandwidth
          examples:
          - -0.06538621
        radio_channel:
          type: number
          description: Media-direction metric value for the radio channel
          examples:
          - -0.73391086
        radio_tx_power:
          type: number
          description: Media-direction metric value for radio transmit power
          examples:
          - 0.10027129
        radio_util:
          type: number
          description: Media-direction metric value for radio utilization
          examples:
          - 12.770318
        radio_util_interference:
          type: number
          description: Media-direction metric value for radio interference utilization
          examples:
          - -3.079999
        site_num_clients:
          type: number
          description: Media-direction metric value for the number of clients at the site
          examples:
          - 0.017364305
        site_wan_avg_download_mbps:
          type: number
          description: Media-direction metric value for site WAN average download throughput
          examples:
          - 3.0566701889E-07
        site_wan_avg_upload_mbps:
          type: number
          description: Media-direction metric value for site WAN average upload throughput
          examples:
          - 5.566701889E-08
        site_wan_download_mbps:
          type: number
          description: Media-direction metric value for site WAN download throughput
          examples:
          - 8.0566701889E-07
        site_wan_jitter:
          type: number
          description: Media-direction metric value for site WAN jitter
          examples:
          - 0.7875519659784105
        site_wan_rtt:
          type: number
          description: Media-direction metric value for site WAN round-trip time
          examples:
          - 15.094849904378256
        site_wan_upload_mbps:
          type: number
          description: Media-direction metric value for site WAN upload throughput
          examples:
          - 2.0566701889E-07
        wan_avg_download_mbps:
          type: number
          description: Media-direction metric value for average WAN download throughput
          examples:
          - 1.4803165
        wan_avg_upload_mbps:
          type: number
          description: Media-direction metric value for average WAN upload throughput
          examples:
          - -0.038184267
        wan_jitter:
          type: number
          description: Media-direction metric value for WAN jitter
          examples:
          - 5.9680853
        wan_max_download_mbps:
          type: number
          description: Media-direction metric value for maximum WAN download throughput
          examples:
          - 1.4803165
        wan_max_upload_mbps:
          type: number
          description: Media-direction metric value for maximum WAN upload throughput
          examples:
          - -0.038184267
        wan_rtt:
          type: number
          description: Media-direction metric value for WAN round-trip time
          examples:
          - 46.77899
      description: Media-direction call troubleshooting metrics in a summary response
    troubleshoot_call_item:
      title: troubleshoot_call_item
      type: object
      properties:
        ap_num_clients:
          type: number
          description: Troubleshooting metric value for AP client count
          examples:
          - -0.08802365511655807
        ap_rtt:
          type: number
          description: Troubleshooting metric value for AP round-trip time
          examples:
          - 0.09924473613500595
        audio_in:
          allOf:
          - $ref: '#/components/schemas/call_troubleshoot_data5'
          - description: Troubleshooting metrics for the inbound audio stream
        audio_out:
          allOf:
          - $ref: '#/components/schemas/call_troubleshoot_data1'
          - description: Troubleshooting metrics for the outbound audio stream
        client_cpu:
          type: number
          description: Troubleshooting metric value for client CPU load
          examples:
          - 0.00834270566701889
        client_n_streams:
          type: number
          description: Troubleshooting metric value for the number of client spatial streams
          examples:
          - 0.00734270566701889
        client_radio_band:
          type: number
          description: Troubleshooting metric value for the client radio band
          examples:
          - 0.5841414928436279
        client_rssi:
          type: number
          description: Troubleshooting metric value for client RSSI
          examples:
          - 0.7594696879386902
        client_rx_bytes:
          type: number
          description: Troubleshooting metric value for bytes received by the client
          examples:
          - 2.365511655807E-05
        client_rx_rates:
          type: number
          description: Troubleshooting metric value for client receive data rates
          examples:
          - 0.02441493794322014
        client_rx_retries:
          type: number
          description: Troubleshooting metric value for client receive retries
          examples:
          - -0.14325742423534393
        client_tx_bytes:
          type: number
          description: Troubleshooting metric value for bytes transmitted by the client
          examples:
          - 0.00102365511655807
        client_tx_rates:
          type: number
          description: Troubleshooting metric value for client transmit data rates
          examples:
          - 0.22236637771129608
        client_tx_retries:
          type: number
          description: Troubleshooting metric value for client transmit retries
          examples:
          - 0.3308201730251312
        client_vpn_distance:
          type: number
          description: Troubleshooting metric value for client VPN distance
          examples:
          - -0.0001660545531194657
        client_wifi_version:
          type: number
          description: Troubleshooting metric value for the client Wi-Fi version
          examples:
          - 7.0566701889E-07
        expected:
          type: number
          description: Model baseline value expected for this call sample
          examples:
          - -2.8630001056670187
        radio_ap_change:
          type: number
          description: Troubleshooting metric value for AP changes on the radio path
          examples:
          - 0.01850946433842182
        radio_bandwidth:
          type: number
          description: Troubleshooting metric value for radio channel bandwidth
          examples:
          - -0.021175479516386986
        radio_channel:
          type: number
          description: Troubleshooting metric value for the radio channel
          examples:
          - 0.11686426401138306
        radio_rx_failed:
          type: number
          description: Troubleshooting metric value for failed radio receive attempts
          examples:
          - 1.1782013177871704
        radio_tx_power:
          type: number
          description: Troubleshooting metric value for radio transmit power
          examples:
          - 0.121039018034935
        radio_util:
          type: number
          description: Troubleshooting metric value for radio utilization
          examples:
          - 0.2452986091375351
        radio_util_interference:
          type: number
          description: Troubleshooting metric value for radio interference utilization
          examples:
          - 3.4367904663085938
        site_num_clients:
          type: number
          description: Troubleshooting metric value for the number of clients at the site
          examples:
          - 0.055026158690452576
        site_wan_avg_download_mbps:
          type: number
          description: Troubleshooting metric value for site WAN average download throughput
          examples:
          - 3.0566701889E-07
        site_wan_avg_upload_mbps:
          type: number
          description: Troubleshooting metric value for site WAN average upload throughput
          examples:
          - 5.566701889E-08
        site_wan_download_mbps:
          type: number
          description: Troubleshooting metric value for site WAN download throughput
          examples:
          - 8.0566701889E-07
        site_wan_jitter:
          type: number
          description: Troubleshooting metric value for site WAN jitter
          examples:
          - 1.00566701889E-06
        site_wan_rtt:
          type: number
          description: Troubleshooting metric value for site WAN round-trip time
          examples:
          - 4.0566701889E-07
        site_wan_upload_mbps:
          type: number
          description: Troubleshooting metric value for site WAN upload throughput
          examples:
          - 2.0566701889E-07
        timestamp:
          type: number
          description: Time when this call troubleshooting sample was recorded
          readOnly: true
        video_in:
          allOf:
          - $ref: '#/components/schemas/call_troubleshoot_data2'
          - description: Troubleshooting metrics for the inbound video stream
        video_out:
          allOf:
          - $ref: '#/components/schemas/call_troubleshoot_data3'
          - description: Troubleshooting metrics for the outbound video stream
      description: Per-sample call troubleshooting metrics
    capture_client:
      title: capture_client
      required:
      - type
      type: object
      properties:
        ap_mac:
          type:
          - string
          - 'null'
          description: AP MAC address used to target the client packet capture
        client_mac:
          type:
          - string
          - 'null'
          description: Client MAC address, required if `type`==`client`; optional otherwise
          examples:
          - 60a10a773412
        duration:
          maximum: 86400
          minimum: 60
          type:
          - integer
          - 'null'
          description: Packet capture duration, in seconds
          contentEncoding: int32
          default: 600
          examples:
          - 300
        includes_mcast:
          type: boolean
          description: Whether to include multicast traffic in the packet capture
          default: false
        max_pkt_len:
          maximum: 2048
          minimum: 64
          type:
          - integer
          - 'null'
          description: Maximum number of bytes captured from each packet
          contentEncoding: int32
          default: 512
          examples:
          - 128
        num_packets:
          maximum: 10000
          minimum: 0
          type:
          - integer
          - 'null'
          description: Maximum number of packets to capture; use 0 for unlimited
          contentEncoding: int32
          default: 1024
          examples:
          - 1000
        ssid:
          type:
          - string
          - 'null'
          description: Optional SSID filter for the packet capture
        type:
          const: client
          type: string
          description: Packet capture type discriminator for client captures
          examples:
          - client
      description: Initiate a Client Packet Capture
    capture_client_type:
      title: capture_client_type
      const: client
      type: string
      description: 'Packet capture type discriminator for client captures. enum: `client`'
      examples:
      - client
    capture_gateway:
      title: capture_gateway
      required:
      - gateways
      - type
      type: object
      properties:
        duration:
          maximum: 86400
          minimum: 60
          type:
          - integer
          - 'null'
          description: Packet capture duration, in seconds
          contentEncoding: int32
          default: 600
          examples:
          - 300
        format:
          allOf:
          - $ref: '#/components/schemas/capture_gateway_format2'
          - description: 'Output format for the gateway packet capture. enum: `stream`.'
            examples:
            - stream
        gateways:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/capture_gateway_gateways'
          description: List of SSRs. Property key is the SSR MAC
        max_pkt_len:
          maximum: 1520
          minimum: 64
          type:
          - integer
          - 'null'
          description: minimum is 64 (SSR) / 68 (SRX) maximum is 10240 (SSR) / 1520 (SRX)
          contentEncoding: int32
          default: 512
          examples:
          - 128
        num_packets:
          maximum: 10000
          minimum: 0
          type:
          - integer
          - 'null'
          description: Maximum number of packets to capture; use 0 for unlimited
          contentEncoding: int32
          default: 1024
          examples:
          - 1000
        ports:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/capture_gateway_gateways_port'
          description: Gateway ports to include in the packet capture
        type:
          const: gateway
          type: string
          description: Packet capture type discriminator for gateway captures
          examples:
          - gateway
      description: Initiate a Gateway (SSR/SRX) Packet Capture
    capture_gateway_format:
      title: capture_gateway_format
      const: stream
      type: string
      description: 'Output format for the gateway packet capture. enum: `stream`'
      examples:
      - stream
    capture_gateway_gateways:
      title: capture_gateway_gateways
      type: object
      properties:
        ports:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/capture_gateway_gateways_port'
          description: Gateway ports to include in the capture, keyed by port ID
      description: Gateway-specific packet capture settings keyed under a gateway MAC address
    capture_gateway_gateways_port:
      title: capture_gateway_gateways_port
      type: object
      properties:
        tcpdump_expression:
          type: string
          description: tcpdump expression per port
      description: Per-port tcpdump filter for a gateway packet capture
    capture_gateway_type:
      title: capture_gateway_type
      const: gateway
      type: string
      description: 'Packet capture type discriminator for gateway captures. enum: `gateway`'
      examples:
      - gateway
    capture_mxedge:
      title: capture_mxedge
      required:
      - type
      type: object
      properties:
        duration:
          maximum: 10800
          minimum: 60
          type: integer
          description: Packet capture duration, in seconds. Default is 600, minimum is 60 and maximum is 10800 (3h)
          contentEncoding: int32
          default: 600
          examples:
          - 600
        format:
          allOf:
          - $ref: '#/components/schemas/capture_mxedge_format3'
          - description: 'Output format for the Mist Edge packet capture. enum: `stream`, `tzsp`.'
        max_pkt_len:
          maximum: 2048
          minimum: 64
          type: integer
          description: Max_len of each packet to capture. Default is 512, minimum is 64 and maximum is 2048
          contentEncoding: int32
          default: 512
          examples:
          - 512
        mxedges:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/capture_mxedge_mxedges'
          description: Dict of Mist Edges to capture on, property key is the Mist Edge ID. Property value is a dict of interfaces to capture for the given Mist Edge (e.g. port1, kni0, lacp0, ipsec, drop, oobm)
        num_packets:
          maximum: 10000
          minimum: 0
          type: integer
          description: Number of packets to capture. Default is 1024, maximum is 10000, minimum 1, or 0 for unlimited (local/remote streaming only)
          contentEncoding: int32
          default: 1024
          examples:
          - 100
        tcpdump_expression:
          type: string
          description: tcpdump expression, applicable across all interfaces if specified at top level. An interface-specific value (under the `interfaces` dict) overrides this top-level value.
        type:
          const: mxedge
          type: string
          description: 'Packet capture type discriminator for Mist Edge captures. enum: `mxedge`.'
          examples:
          - mxedge
        tzsp_host:
          type: string
          description: Required if `format`==`tzsp`. Remote host accessible to mxedges over the network for receiving the captured packets
          examples:
          - 192.168.1.2
        tzsp_port:
          maximum: 65535
          minimum: 1
          type: integer
          description: Optional port on remote host for receiving the captured packets. Default is 37008 (TZSP)
          contentEncoding: int32
          default: 37008
      description: Initiate a Mist Edge Packet Capture
    capture_mxedge_format:
      title: capture_mxedge_format
      enum:
      - stream
      - tzsp
      type: string
      description: "PCAP format. enum: \n    * `stream`: to Mist cloud\n    * `tzsp`: stream packets (over UDP as TZSP packets) to a remote host (typically running Wireshark)"
    capture_mxedge_mxedges:
      title: capture_mxedge_mxedges
      type: object
      properties:
        interfaces:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/capture_mxedge_mxedges_interfaces'
          description: Mx Edge interfaces to include in the capture, keyed by interface name
      description: Property key is the Mx Edge ID, currently limited to one mxedge per org capture session
    capture_mxedge_mxedges_interfaces:
      title: capture_mxedge_mxedges_interfaces
      type: object
      properties:
        tcpdump_expression:
          type: string
          description: tcpdump expression common for wired,radiotap
      description: Property key is the Port name (e.g. "port1", "kni0", "lacp0", "ipsec", "drop", "oobm"), currently limited to specifying one interface per mxedge
    capture_mxedge_type:
      title: capture_mxedge_type
      const: mxedge
      type: string
      description: 'Packet capture type discriminator for Mist Edge captures. enum: `mxedge`'
      examples:
      - mxedge
    capture_new_assoc:
      title: capture_new_assoc
      required:
      - type
      type: object
      properties:
        ap_mac:
          type: string
          description: AP MAC address used to target new association capture
          examples:
          - a83a79a947ee
        client_mac:
          type: string
          description: Client MAC address, required if `type`==`client`; optional otherwise
          examples:
          - 60a10a773412
        duration:
          maximum: 86400
          minimum: 60
          type:
          - integer
          - 'null'
          description: Packet capture duration, in seconds
          contentEncoding: int32
          default: 600
          examples:
          - 300
        includes_mcast:
          type: boolean
          description: Whether to include multicast traffic in the packet capture
          default: false
        max_pkt_len:
          maximum: 2048
          minimum: 64
          type:
          - integer
          - 'null'
          description: Maximum number of bytes captured from each packet
          contentEncoding: int32
          default: 512
          examples:
          - 128
        num_packets:
          maximum: 10000
          minimum: 0
          type:
          - integer
          - 'null'
          description: Maximum number of packets to capture; use 0 for unlimited
          contentEncoding: int32
          default: 1024
          examples:
          - 1000
        ssid:
          type: string
          description: Optional SSID filter for new association capture
        type:
          const: new_assoc
          type: string
          description: 'Packet capture type discriminator for new association captures. enum: `new_assoc`.'
          examples:
          - new_assoc
      description: Initiate a packet Capture for New Wireless Client Associations
    capture_new_assoc_type:
      title: capture_new_assoc_type
      const: new_assoc
      type: string
      description: 'Packet capture type discriminator for new association captures. enum: `new_assoc`'
      examples:
      - new_assoc
    capture_radiotap:
      title: capture_radiotap
      required:
      - type
      type: object
      properties:
        ap_mac:
          type: string
          description: AP MAC address used to target the radiotap packet capture
          examples:
          - a83a79a947ee
        band:
          allOf:
          - $ref: '#/components/schemas/capture_radiotap_band2'
          - description: 'Radio band to capture for radiotap packets. enum: `24`, `24,5,6`, `5`, `6`.'
            examples:
            - '24'
        client_mac:
          type: string
          description: Client MAC address used to filter the radiotap packet capture
          examples:
          - 38f9d3972ff1
        duration:
          maximum: 86400
          minimum: 60
          type:
          - integer
          - 'null'
          description: Packet capture duration, in seconds
          contentEncoding: int32
          default: 600
          examples:
          - 300
        format:
          allOf:
          - $ref: '#/components/schemas/capture_radiotap_format2'
          - description: 'Output format for the radiotap packet capture. enum: `pcap`, `stream`.'
            examples:
            - stream
        max_pkt_len:
          maximum: 2048
          minimum: 64
          type:
          - integer
          - 'null'
          description: Maximum number of bytes captured from each packet
          contentEncoding: int32
          default: 512
          examples:
          - 128
        num_packets:
          maximum: 10000
          minimum: 0
          type:
          - integer
          - 'null'
          description: Maximum number of packets to capture; use 0 for unlimited
          contentEncoding: int32
          default: 1024
          examples:
          - 1000
        ssid:
          type: string
          description: Wireless network SSID used to filter the radiotap packet capture
          examples:
          - test
        tcpdump_expression:
          type:
          - string
          - 'null'
          description: Filter expression applied to the radiotap packet capture
          examples:
          - tcp port 80
        type:
          const: radiotap
          type: string
          description: Packet capture type discriminator for radiotap captures
          examples:
          - radiotap
        wlan_id:
          type: string
          description: WLAN id associated with the respective ssid.
          contentEncoding: uuid
          examples:
          - fac8e973-feb9-421a-b381-aabbc4b61f5a
      description: Initiate a Radiotap Packet Capture
    capture_radiotap_band:
      title: capture_radiotap_band
      enum:
      - '24'
      - 24,5,6
      - '5'
      - '6'
      type: string
      description: 'enum: `24`, `24,5,6`, `5`, `6`'
      examples:
      - '24'
    capture_radiotap_format:
      title: capture_radiotap_format
      enum:
      - pcap
      - stream
      type: string
      description: 'Output format for the radiotap packet capture. enum: `pcap`, `stream`'
      examples:
      - stream
    capture_radiotap_type:
      title: capture_radiotap_type
      const: radiotap
      type: string
      description: 'Packet capture type discriminator for radiotap captures. enum: `radiotap`'
      examples:
      - radiotap
    capture_radiotapwired:
      title: capture_radiotapwired
      required:
      - type
      type: object
      properties:
        ap_mac:
          type:
          - string
          - 'null'
          description: AP MAC address used to target the combined radiotap and wired packet capture
        band:
          allOf:
          - $ref: '#/components/schemas/capture_radiotapwired_band2'
          - description: 'Radio band to capture for the radiotap portion. enum: `24`, `24,5,6`, `5`, `6`.'
            examples:
            - '24'
        client_mac:
          type:
          - string
          - 'null'
          description: Client MAC address used to filter the combined packet capture
          examples:
          - 38f9d3972ff1
        duration:
          maximum: 86400
          minimum: 60
          type:
          - integer
          - 'null'
          description: Packet capture duration, in seconds
          contentEncoding: int32
          default: 600
          examples:
          - 300
        format:
          allOf:
          - $ref: '#/components/schemas/capture_radiotapwired_format2'
          - description: 'Output format for the combined packet capture. enum: `pcap`, `stream`.'
            examples:
            - stream
        max_pkt_len:
          maximum: 2048
          minimum: 64
          type:
          - integer
          - 'null'
          description: Maximum number of bytes captured from each packet
          contentEncoding: int32
          default: 512
          examples:
          - 128
        num_packets:
          maximum: 10000
          minimum: 0
          type:
          - integer
          - 'null'
          description: Maximum number of packets to capture; use 0 for unlimited
          contentEncoding: int32
          default: 1024
          examples:
          - 1000
        radiotap_tcpdump_expression:
          type: string
          description: tcpdump expression for radiotap interface (802.11 + radio headers)
          examples:
          - type
        ssid:
          type:
          - string
          - 'null'
          description: Wireless network SSID used to filter the radiotap portion
          examples:
          - test
        tcpdump_expression:
          type:
          - string
          - 'null'
          description: Filter expression applied across the combined packet capture
          examples:
          - tcp port 80
        type:
          const: radiotap,wired
          type: string
          description: 'Packet capture type discriminator for combined radiotap and wired captures. enum: `radiotap,wired`.'
          examples:
          - radiotap,wired
        wired_tcpdump_expression:
          type:
          - string
          - 'null'
          description: Filter expression applied to the wired portion of the capture
          examples:
          - tcp port 80
        wireless_tcpdump_expression:
          type: string
          description: tcpdump expression for radiotap interface (802.11)
        wlan_id:
          type:
          - string
          - 'null'
          description: WLAN id associated with the respective ssid.
          examples:
          - fac8e973-feb9-421a-b381-aabbc4b61f5a
      description: Initiate a Radiotap Packet Capture and Wired Packet Capture
    capture_radiotapwired_band:
      title: capture_radiotapwired_band
      enum:
      - '24'
      - 24,5,6
      - '5'
      - '6'
      type: string
      description: 'only used for radiotap. enum: `24`, `24,5,6`, `5`, `6`'
      examples:
      - '24'
    capture_radiotapwired_format:
      title: capture_radiotapwired_format
      enum:
      - pcap
      - stream
      type: string
      description: 'Output format for the combined packet capture. enum: `pcap`, `stream`'
      examples:
      - stream
    capture_radiotapwired_type:
      title: capture_radiotapwired_type
      const: radiotap,wired
      type: string
      description: 'Packet capture type discriminator for combined radiotap and wired captures. enum: `radiotap,wired`'
      examples:
      - radiotap,wired
    capture_scan:
      title: capture_scan
      required:
      - type
      type: object
      properties:
        ap_mac:
          type:
          - string
          - 'null'
          description: AP MAC address used to filter the scan radio packet capture
        aps:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/capture_scan_aps'
          description: Dictionary key is AP mac and value is a dictionary which contains key "band", "bandwidth", "channel" and "tcpdump_expression". In case keys are missed we will take parent value if parent values are not set we will use default value
        band:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/capture_scan_band2'
          - description: 'Radio band to capture for scan radio packets. enum: `24`, `5`, `6`.'
            examples:
            - '24'
        bandwidth:
          allOf:
          - $ref: '#/components/schemas/dot11_bandwidth1'
          - description: 'Channel bandwidth to use for the scan radio packet capture. enum: `0`, `20`, `40`, `80`, `160`.'
            examples:
            - 20
        channel:
          type: integer
          description: Specify the channel value where scan PCAP has to be started, default value gets applied when user provides wrong values
          contentEncoding: int32
          default: 1
          examples:
          - 1
        client_mac:
          type:
          - string
          - 'null'
          description: Client MAC address used to filter the scan radio packet capture
          examples:
          - 38f9d3972ff1
        duration:
          maximum: 86400
          minimum: 60
          type:
          - integer
          - 'null'
          description: Packet capture duration, in seconds
          contentEncoding: int32
          default: 600
          examples:
          - 300
        format:
          allOf:
          - $ref: '#/components/schemas/capture_scan_format2'
          - description: 'Output format for the scan radio packet capture. enum: `pcap`, `stream`.'
            examples:
            - stream
        max_pkt_len:
          maximum: 2048
          minimum: 64
          type:
          - integer
          - 'null'
          description: Maximum number of bytes captured from each packet
          contentEncoding: int32
          default: 512
          examples:
          - 128
        num_packets:
          maximum: 10000
          minimum: 0
          type:
          - integer
          - 'null'
          description: Maximum number of packets to capture; use 0 for unlimited
          contentEncoding: int32
          default: 1024
          examples:
          - 1000
        tcpdump_expression:
          type: string
          description: tcpdump expression, port specific if specified under ports dict, otherwise applicable across ports if specified at top level of payload. Port specific value overrides top level value when both exist.
          examples:
          - tcp port 80
        type:
          const: scan
          type: string
          description: Packet capture type discriminator for scan radio captures
          examples:
          - scan
        width:
          type: string
          description: Specify the bandwidth value with respect to the channel.
      description: Initiate a Scan Radio Packet Capture
    capture_scan_aps:
      title: capture_scan_aps
      type: object
      properties:
        band:
          allOf:
          - $ref: '#/components/schemas/capture_scan_aps_band2'
          - description: 'Radio band on which to start the scan capture. enum: `24`, `5`, `6`.'
        channel:
          type: string
          description: Specify the channel value where scan PCAP has to be started
        tcpdump_expression:
          type: string
          description: tcpdump expression, port specific if specified under ports dict, otherwise applicable across ports if specified at top level of payload. Port specific value overrides top level value when both exist.
        width:
          type: string
          description: Specify the bandwidth value with respect to the channel.
      description: Property key is the AP MAC address (e.g. "5c5b35000001"). All optionals, parent parameters will be used if not defined
    capture_scan_aps_band:
      title: capture_scan_aps_band
      enum:
      - '24'
      - '5'
      - '6'
      type: string
      description: 'Only Single value allowed. enum: `24`, `5`, `6`'
    capture_scan_band:
      title: capture_scan_band
      enum:
      - '24'
      - '5'
      - '6'
      type: string
      description: 'Only Single value allowed, default value gets applied when user provides wrong values. enum: `24`, `5`, `6`'
      examples:
      - '24'
    capture_scan_format:
      title: capture_scan_format
      enum:
      - pcap
      - stream
      type: string
      description: 'Output format for the scan radio packet capture. enum: `pcap`, `stream`'
      examples:
      - stream
    capture_scan_type:
      title: capture_scan_type
      const: scan
      type: string
      description: 'Packet capture type discriminator for scan radio captures. enum: `scan`'
      examples:
      - scan
    capture_switch:
      title: capture_switch
      required:
      - switches
      - type
      type: object
      properties:
        duration:
          maximum: 86400
          minimum: 60
          type:
          - integer
          - 'null'
          description: Packet capture duration, in seconds
          contentEncoding: int32
          default: 600
          examples:
          - 300
        format:
          allOf:
          - $ref: '#/components/schemas/capture_switch_format2'
          - description: 'Output format for the switch packet capture. enum: `stream`.'
        max_pkt_len:
          maximum: 2048
          minimum: 64
          type:
          - integer
          - 'null'
          description: Maximum number of bytes captured from each packet
          contentEncoding: int32
          default: 512
          examples:
          - 128
        num_packets:
          maximum: 10000
          minimum: 0
          type:
          - integer
          - 'null'
          description: Maximum number of packets to capture; use 0 for unlimited
          contentEncoding: int32
          default: 1024
          examples:
          - 1000
        ports:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/capture_switch_ports_tcpdump_expression'
          description: Switch ports to include in the packet capture
        switches:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/capture_switch_switches'
          description: Property key is the switch MAC address
        tcpdump_expression:
          type: string
          description: tcpdump expression, port specific if specified under ports dict, otherwise applicable across ports if specified at top level of payload. Port specific value overrides top level value when both exist.
          examples:
          - port 443
        type:
          const: switch
          type: string
          description: Packet capture type discriminator for switch captures
          examples:
          - switch
      description: Initiate a Switch (Junos) Packet Capture
    capture_switch_format:
      title: capture_switch_format
      const: stream
      type: string
      description: 'Output format for the switch packet capture. enum: `stream`'
    capture_switch_ports_tcpdump_expression:
      title: capture_switch_ports_tcpdump_expression
      type: object
      properties:
        tcpdump_expression:
          type: string
          description: tcpdump expression, port specific if specified under ports dict, otherwise applicable across ports if specified at top level of payload. Port specific value overrides top level value when both exist.
          examples:
          - port 443
      description: Per-port tcpdump filter for a switch packet capture
    capture_switch_switches:
      title: capture_switch_switches
      type: object
      properties:
        ports:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/capture_switch_ports_tcpdump_expression'
          description: Switch ports to include in the capture, keyed by port ID
      description: Switch-specific packet capture settings keyed under a switch MAC address
    capture_switch_type:
      title: capture_switch_type
      const: switch
      type: string
      description: 'Packet capture type discriminator for switch captures. enum: `switch`'
      examples:
      - switch
    capture_wired:
      title: capture_wired
      required:
      - type
      type: object
      properties:
        ap_mac:
          type:
          - string
          - 'null'
          description: AP MAC address used to target the wired packet capture
        duration:
          maximum: 86400
          minimum: 60
          type:
          - integer
          - 'null'
          description: Packet capture duration, in seconds
          contentEncoding: int32
          default: 600
          examples:
          - 300
        format:
          allOf:
          - $ref: '#/components/schemas/capture_wired_format2'
          - description: 'Output format for the wired packet capture. enum: `pcap`, `stream`.'
        max_pkt_len:
          maximum: 2048
          minimum: 64
          type:
          - integer
          - 'null'
          description: Maximum number of bytes captured from each packet
          contentEncoding: int32
          default: 512
          examples:
          - 128
        num_packets:
          maximum: 10000
          minimum: 0
          type:
          - integer
          - 'null'
          description: Maximum number of packets to capture; use 0 for unlimited
          contentEncoding: int32
          default: 1024
          examples:
          - 1000
        tcpdump_expression:
          type:
          - string
          - 'null'
          description: Filter expression applied to the wired packet capture
          examples:
          - tcp port 80
        type:
          const: wired
          type: string
          description: Packet capture type discriminator for wired captures
          examples:
          - wired
      description: Initiate a Wired Packet Capture
    capture_wired_format:
      title: capture_wired_format
      enum:
      - pcap
      - stream
      type: string
      description: 'pcap format. enum: `pcap`, `stream`'
    capture_wired_type:
      title: capture_wired_type
      const: wired
      type: string
      description: 'Packet capture type discriminator for wired captures. enum: `wired`'
      examples:
      - wired
    capture_wireless:
      title: capture_wireless
      required:
      - type
      type: object
      properties:
        ap_mac:
          type:
          - string
          - 'null'
          description: AP MAC address used to target the wireless packet capture
        band:
          allOf:
          - $ref: '#/components/schemas/capture_wireless_band2'
          - description: 'Radio band to capture for wireless packets. enum: `24`, `5`, `6`.'
        duration:
          maximum: 86400
          minimum: 60
          type:
          - integer
          - 'null'
          description: Packet capture duration, in seconds
          contentEncoding: int32
          default: 600
          examples:
          - 300
        format:
          allOf:
          - $ref: '#/components/schemas/capture_wireless_format2'
          - description: 'Output format for the wireless packet capture. enum: `pcap`, `stream`.'
        max_pkt_len:
          maximum: 2048
          minimum: 64
          type:
          - integer
          - 'null'
          description: Maximum number of bytes captured from each packet
          contentEncoding: int32
          default: 512
          examples:
          - 128
        num_packets:
          maximum: 10000
          minimum: 0
          type:
          - integer
          - 'null'
          description: Maximum number of packets to capture; use 0 for unlimited
          contentEncoding: int32
          default: 1024
          examples:
          - 1000
        ssid:
          type: string
          description: Wireless network SSID used to filter the packet capture
        type:
          const: wireless
          type: string
          description: Packet capture type discriminator for wireless captures
          examples:
          - wireless
        wlan_id:
          type: string
          description: WLAN identifier used to filter the wireless packet capture
          contentEncoding: uuid
      description: Initiate a Wireless Packet Capture
    capture_wireless_band:
      title: capture_wireless_band
      enum:
      - '24'
      - '5'
      - '6'
      type: string
      description: 'enum: `24`, `5`, `6`'
    capture_wireless_format:
      title: capture_wireless_format
      enum:
      - pcap
      - stream
      type: string
      description: 'pcap format. enum: `pcap`, `stream`'
    capture_wireless_type:
      title: capture_wireless_type
      const: wireless
      type: string
      description: 'Packet capture type discriminator for wireless captures. enum: `wireless`'
      examples:
      - wireless
    claim_activation:
      title: claim_activation
      required:
      - code
      - type
      type: object
      properties:
        code:
          type: string
          description: Activation or license claim code to redeem
        device_type:
          allOf:
          - $ref: '#/components/schemas/device_type_default_ap1'
          - description: 'If only intended to claim a certain device type, specify it here. enum: `ap`, `gateway`, `switch`.'
        type:
          allOf:
          - $ref: '#/components/schemas/claim_type2'
          - description: Claim scope, such as all, inventory, or license
      description: Request to claim organization licenses or activation codes
    claim_activation_async:
      title: claim_activation_async
      required:
      - code
      - type
      type: object
      properties:
        code:
          type: string
          description: Activation code to claim
        device_type:
          allOf:
          - $ref: '#/components/schemas/device_type_default_ap1'
          - description: 'If only intended to claim a certain device type, specify it here. enum: `ap`, `gateway`, `switch`.'
        type:
          allOf:
          - $ref: '#/components/schemas/claim_type_async2'
          - description: Claim scope; `all` claims licenses synchronously and queues inventory, `inventory` queues inventory only
      description: Request to schedule an asynchronous inventory claim
    claim_type:
      title: claim_type
      enum:
      - all
      - inventory
      - license
      type: string
      description: 'what to claim. enum: `all`, `inventory`, `license`'
    claim_type_async:
      title: claim_type_async
      enum:
      - all
      - inventory
      type: string
      description: 'Claim scope for async inventory claiming. enum: `all`, `inventory`'
    clear_dot1x_session:
      title: clear_dot1x_session
      type: object
      properties:
        ports:
          type: array
          items:
            type: string
          description: Port IDs whose dot1x sessions should be cleared
          examples:
          - - ge-0/0/0
            - ge-0/0/1
      description: Request body for clearing dot1x sessions on switch ports
    clear_policy_hit_count:
      title: clear_policy_hit_count
      required:
      - policy_name
      type: object
      properties:
        policy_name:
          type: string
          description: Application policy name whose hit counters should be cleared
      description: Request body for clearing hit counters on an application policy
    client_cert_serial_numbers:
      title: client_cert_serial_numbers
      type: object
      properties:
        serial_numbers:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Certificate serial numbers to revoke
      description: Client certificate serial numbers targeted by a certificate operation
      examples:
      - serial_numbers:
        - 13 00 13 03 23 EE D5 84 01
    client_info_source:
      title: client_info_source
      enum:
      - lldp
      - mac
      type: string
      description: 'source from where the client was learned (lldp, mac). enum: `lldp`, `mac`'
    client_key_mgmt:
      title: client_key_mgmt
      enum:
      - WPA2-PSK
      - WPA2-PSK/CCMP
      - WPA2-PSK-FT
      - WPA2-PSK-SHA256
      - WPA3-EAP-SHA256
      - WPA3-EAP-SHA256/CCMP
      - WPA3-EAP-FT/GCMP256
      - WPA3-SAE-FT
      - WPA3-SAE-PSK
      type: string
      description: 'Key management protocol used for the latest authentication. enum: `WPA2-PSK`, `WPA2-PSK/CCMP`, `WPA2-PSK-FT`, `WPA2-PSK-SHA256`, `WPA3-EAP-SHA256`, `WPA3-EAP-SHA256/CCMP`, `WPA3-EAP-FT/GCMP256`, `WPA3-SAE-FT`, `WPA3-SAE-PSK`'
      examples:
      - WPA2-PSK
    client_nac:
      title: client_nac
      type: object
      properties:
        ap:
          type: array
          items:
            type: string
          description: Observed AP MAC addresses for the NAC client during the query duration
          readOnly: true
          examples:
          - - 5c5b35bf16bb
            - d4dc090041b4
        auth_type:
          allOf:
          - $ref: '#/components/schemas/nac_auth_type5'
          - description: 'Authentication method used by the NAC client. enum: `cert`, `device-auth`, `eap-teap`, `eap-tls`, `eap-ttls`, `idp`, `mab`, `eap-peap`.'
            examples:
            - eap-tls
        cert_cn:
          type: array
          items:
            type: string
          description: Certificate common names observed for the client during the query duration
          readOnly: true
          examples:
          - - john@mycorp.net
        cert_issuer:
          type: array
          items:
            type: string
          description: Certificate issuers observed for the client during the query duration
          readOnly: true
          examples:
          - - /C=US/ST=CA/CN=MyCorp
        cert_serial:
          type: array
          items:
            type: string
          description: Certificate serial numbers observed for the client during the query duration
          readOnly: true
          examples:
          - - 2c63510123456789
        cert_subject:
          type: array
          items:
            type: string
          description: Certificate subjects observed for the client during the query duration
          readOnly: true
          examples:
          - - /C=US/O=MyCorp/CN=john@mycorp.net/emailAddress=john@mycorp.net
        client_ip:
          type: array
          items:
            type: string
          description: Client IP addresses observed during the query duration
          readOnly: true
          examples:
          - - 10.100.0.157
        device_mac:
          type: string
          description: MAC address of the AP or switch handling the NAC client session
          readOnly: true
          examples:
          - 60c78d8c7f6f
        edr_managed:
          type: boolean
          description: Whether the NAC client is managed by an EDR provider
        edr_providers:
          type: array
          items:
            $ref: '#/components/schemas/edr_provider'
          description: EDR providers associated with the NAC client
        edr_status:
          type: array
          items:
            $ref: '#/components/schemas/edr_status'
          description: EDR health statuses reported for the NAC client
        group:
          type: string
          description: User group associated with the NAC client
        idp_id:
          type: string
          description: Identity Provider identifier used during NAC authentication
        idp_role:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Identity Provider roles or groups returned for the NAC client
        last_ap:
          type: string
          description: Most recent AP MAC address used by the NAC client
          examples:
          - a83a79a947ee
        last_cert_cn:
          type: string
          description: Most recent certificate common name used by the NAC client
          examples:
          - john@mycorp.net
        last_cert_expiry:
          type: number
          description: Most recent certificate expiration timestamp for the NAC client
          examples:
          - 1746711240
        last_cert_issuer:
          type: string
          description: Most recent certificate issuer used by the NAC client
          examples:
          - /C=US/ST=CA/CN=MyCorp
        last_cert_serial:
          type: string
          description: Most recent certificate serial number used by the NAC client
          examples:
          - 2c63510123456789
        last_cert_subject:
          type: string
          description: Most recent certificate subject used by the NAC client
          examples:
          - /C=US/O=MyCorp/CN=john@mycorp.net/emailAddress=john@mycorp.net
        last_client_ip:
          type: string
          description: Most recent client IP address observed for the NAC client
          examples:
          - 10.100.0.157
        last_nacrule_id:
          type: string
          description: Most recent NAC policy rule identifier used for authentication
          examples:
          - 603b62db-d839-4152-9f7f-f2578443de8d
        last_nacrule_name:
          type: string
          description: Most recent NAC policy rule name used for authentication
          examples:
          - Wireless Cert Auth
        last_nas_vendor:
          type: string
          description: Most recent NAS vendor reported for the NAC client
          examples:
          - juniper-mist
        last_port_id:
          type: string
          description: Most recent port identifier used by the NAC client
          examples:
          - ge-0/0/17.0
        last_ssid:
          type: string
          description: Most recent SSID used by the NAC client
          examples:
          - MyCorp-NAC
        last_status:
          allOf:
          - $ref: '#/components/schemas/nac_client_last_status2'
          - description: 'Most recent NAC authentication status for the client. enum: `permitted`, `session_started`, `session_stopped`, `denied`.'
            examples:
            - permitted
        last_username:
          type: string
          description: Most recent username presented by the NAC client
          examples:
          - john@mycorp.net
        last_vlan:
          type: integer
          description: Most recent VLAN associated with the NAC client
          contentEncoding: int32
          examples:
          - 10
        mac:
          type: string
          description: Client MAC address for the NAC record
          readOnly: true
          examples:
          - ac3eb179e535
        nacrule_id:
          type: array
          items:
            type: string
          description: NAC policy rule identifiers used during the query duration
          readOnly: true
          examples:
          - - 603b62db-d839-4152-9f7f-f2578443de8d
        nacrule_matched:
          type: boolean
          description: Whether a NAC policy rule matched the client
        nacrule_name:
          type: array
          items:
            type: string
          description: NAC policy rule names used during the query duration
          readOnly: true
          examples:
          - - Wireless Cert Auth
        nas_ip:
          type: string
          description: IP address of the NAS device used for authentication
        nas_vendor:
          type: array
          items:
            type: string
          description: NAS vendors observed for the client during the query duration
          readOnly: true
          examples:
          - - juniper-mist
        org_id:
          type: string
          description: Owning organization identifier for the NAC client
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        port_id:
          type: array
          items:
            type: string
          description: Port identifiers used by the NAC client during the query duration
          readOnly: true
          examples:
          - - ge-0/0/17.0
        random_mac:
          allOf:
          - $ref: '#/components/schemas/random_mac3'
          - description: 'Whether the NAC client used a randomized MAC address. enum: `true`, `false`.'
        resp_attrs:
          uniqueItems: true
          type: array
          items:
            type: string
          description: RADIUS response attributes returned for the NAC client
          examples:
          - - Tunnel-Type=VLAN
            - Tunnel-Medium-Type=IEEE-802
            - Tunnel-Private-Group-Id=750
            - User-Name=anonymous
        site_id:
          type: string
          description: Site identifier associated with the NAC client
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        ssid:
          type: array
          items:
            type: string
          description: Wireless SSIDs used by the NAC client during the query duration
          examples:
          - - MyCorp-NAC
        timestamp:
          type: number
          description: Time when the NAC client record was observed
          readOnly: true
        type:
          allOf:
          - $ref: '#/components/schemas/nac_access_type4'
          - description: 'Network access type for the NAC client. enum: `wireless`, `wired`, `vty`.'
            examples:
            - wireless
        usermac_label:
          uniqueItems: true
          type: array
          items:
            type: string
          description: User MAC labels associated with the NAC client
        username:
          type: array
          items:
            type: string
          description: User identities associated with the NAC client authentication
          readOnly: true
        vlan:
          type: array
          items:
            type: string
          description: Network VLANs associated with the NAC client during authentication
          readOnly: true
      description: NAC client authentication and access state
    client_wireless:
      title: client_wireless
      type: object
      properties:
        ap:
          type: array
          items:
            type: string
          description: Observed AP MAC addresses for the wireless client during the query duration
          examples:
          - - a83a79a947ee
            - 003e73170b4c
        app_version:
          type: array
          items:
            type: string
          description: Marvis Client application versions reported by the wireless client during the query duration
          examples:
          - - 0.100.3
        band:
          type: string
          description: Wi-Fi radio band used by the wireless client
          examples:
          - '5'
        device:
          type: array
          items:
            type: string
          description: Detected device types for the wireless client during the query duration
          examples:
          - - Mac
        ftc:
          type: boolean
          description: Whether fast transition information is reported for the wireless client
        hardware:
          type: string
          description: Only when client has the Marvis Client app running. Type of Wi-Fi adapter
          examples:
          - Apple Wi-Fi adapter
        hostname:
          type: array
          items:
            type: string
          description: Detected hostnames for the wireless client during the query duration
          examples:
          - - hostname-a
            - hostname-b
        ip:
          type: array
          items:
            type: string
          description: Detected IP addresses for the wireless client during the query duration
          examples:
          - - 10.5.23.43
            - 192.168.0.2
        last_ap:
          type: string
          description: Most recent AP MAC address used by the wireless client
          examples:
          - a83a79a947ee
        last_device:
          type: string
          description: Most recent device type detected for the wireless client
          examples:
          - Zebra
        last_firmware:
          type: string
          description: Only when client has the Marvis Client app running. Same as "firmware"
          examples:
          - 'wl0: Jan 20 2024 04:08:41 version 20.103.12.0.8.7.171 FWID 01-e09d2675'
        last_hostname:
          type: string
          description: Latest hostname we detected for the client
          examples:
          - hostname-a
        last_ip:
          type: string
          description: Most recent IP address detected for the wireless client
          examples:
          - 10.100.0.157
        last_model:
          type: string
          description: Only when client has the Marvis Client app running. latest client hardware model we detected for the client
          examples:
          - MBP 16\" M1 2021
        last_os:
          type: string
          description: Only when client has the Marvis Client app running. Latest version of OS Type we detected for the client
          examples:
          - Sonoma
        last_os_version:
          type: string
          description: Only when client has the Marvis Client app running. Latest version of OS Version we detected for the client
          examples:
          - 14.4.1 (Build 23E224)
        last_psk_id:
          type: string
          description: Only for PPSK authentication. Latest PPSK ID used by the client
          contentEncoding: uuid
          examples:
          - abf7dc5c-bb51-4bb7-93b6-5547400ffe11
        last_psk_name:
          type: string
          description: Only for PPSK authentication. Latest PPSK Name used by the client
          examples:
          - iot
        last_ssid:
          type: string
          description: Most recent SSID used by the wireless client
          examples:
          - john@mycorp.net
        last_username:
          type: string
          description: Most recent username associated with the wireless client
        last_vlan:
          type: integer
          description: Most recent VLAN associated with the wireless client
          contentEncoding: int32
          examples:
          - 10
        last_wlan_id:
          type: string
          description: ID of the latest SSID (WLAN) the client is/was connected to
          contentEncoding: uuid
          examples:
          - e5d67b07-aae8-494b-8584-cbc20c8110aa
        mac:
          type: string
          description: Client MAC address for the wireless client
          examples:
          - bcd074000000
        mfg:
          type: string
          description: Manufacturer of the client hardware (MAC OUI based)
          examples:
          - Apple
        model:
          type: string
          description: Only when client has the Marvis Client app running. Client hardware model
          examples:
          - MBP 16\" M1 2021
        org_id:
          type: string
          description: Owning organization identifier for the wireless client
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        os:
          type: array
          items:
            type: string
          description: Operating systems detected for the wireless client during the query duration
          examples:
          - - Sonoma
        os_version:
          type: array
          items:
            type: string
          description: Operating system versions detected for the wireless client during the query duration
          examples:
          - - 14.4.1 (Build 23E224)
        protocol:
          type: string
          description: 802.11 protocol amendment used by the wireless client
          examples:
          - ax
        psk_id:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: PPSK identifiers used by the wireless client during the query duration
          examples:
          - - abf7dc5c-bb51-4bb7-93b6-5547400ffe11
        psk_name:
          type: array
          items:
            type: string
          description: PPSK names used by the wireless client during the query duration
          examples:
          - - iot
        random_mac:
          type: boolean
          description: Whether the wireless client uses a randomized MAC address
        sdk_version:
          type: array
          items:
            type: string
          description: Marvis Client SDK versions reported by the wireless client during the query duration
          examples:
          - - 0.100.3
        site_id:
          type: string
          description: Mist Site ID where the client is connected
          contentEncoding: uuid
          examples:
          - 25ff5219-9be7-4db9-907d-0c9b60445147
        site_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Site identifiers where the wireless client was observed during the query duration
          examples:
          - - 25ff5219-9be7-4db9-907d-0c9b60445147
        ssid:
          type: array
          items:
            type: string
          description: Wireless network SSIDs used by the client during the query duration
          examples:
          - - IoT SSID
        timestamp:
          type: number
          description: Time when the wireless client record was observed
          readOnly: true
        username:
          type: array
          items:
            type: string
          description: User identities associated with the wireless client during the query duration
          examples:
          - - user@corp.com
        vlan:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: Network VLANs associated with the wireless client during the query duration
          examples:
          - - 10
        wlan_id:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: WLAN identifiers used by the wireless client during the query duration
          examples:
          - - e5d67b07-aae8-494b-8584-cbc20c8110aa
      description: Wireless client record observed during a client search or stats query
    coa_server:
      title: coa_server
      required:
      - ip
      - secret
      type: object
      properties:
        disable_event_timestamp_check:
          type: boolean
          description: Whether to disable Event-Timestamp Check
          default: false
        enabled:
          type: boolean
          description: Whether this RADIUS CoA server is enabled
          default: false
        ip:
          type: string
          description: Server IPv4 address for RADIUS CoA messages
          contentEncoding: ipv4
          examples:
          - 1.2.3.4
        port:
          anyOf:
          - maximum: 65545
            minimum: 1
            type: integer
            contentEncoding: int32
          - type: string
          description: UDP port used to send RADIUS CoA messages to the server
        secret:
          type: string
          description: Shared secret used to authenticate RADIUS CoA messages
          examples:
          - testing456
      description: RADIUS Change of Authorization (CoA) server settings
    code_string:
      title: code_string
      required:
      - code
      type: object
      properties:
        code:
          type: string
          description: Request-supplied authorization or claim code value
      description: Request body containing a single authorization or claim code
    config_switch_local_accounts_user:
      title: config_switch_local_accounts_user
      type: object
      properties:
        password:
          type: string
          description: Local password for the switch user account
          contentEncoding: password
          examples:
          - Juniper123
        role:
          allOf:
          - $ref: '#/components/schemas/config_switch_local_accounts_user_role2'
          - description: 'Access role granted to the local switch user account. enum: `admin`, `helpdesk`, `none`, `read`.'
      description: Local switch user account credentials and access role
    config_switch_local_accounts_user_role:
      title: config_switch_local_accounts_user_role
      enum:
      - admin
      - helpdesk
      - none
      - read
      type: string
      description: 'enum: `admin`, `helpdesk`, `none`, `read`'
    config_vc_port_member:
      title: config_vc_port_member
      required:
      - member
      type: object
      properties:
        member:
          type: number
          description: Virtual Chassis member ID whose VC ports are being configured
        vc_ports:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Port names to configure as Virtual Chassis ports on the member
      description: Virtual Chassis member and port list for a VC port operation
    const_alarm_definition:
      title: const_alarm_definition
      required:
      - display
      - fields
      - group
      - key
      - severity
      type: object
      properties:
        display:
          type: string
          description: Description of the alarm type
          examples:
          - Device offline
        example:
          type: object
          description: Sample alarm payload returned for this alarm type
          examples:
          - aps:
            - d420b02000fa
            count: 1
            group: infrastructure
            hostnames:
            - Vendor_AP2
            id: f70c308f-7007-4866-9ecd-0d01842979ea
            last_seen: 1629753888
            org_id: 09dac91f-6e73-4100-89f7-698e0fafbb1b
            severity: warn
            site_id: dcfb31a1-d615-4361-8c95-b9dde05aa704
            timestamp: 1629753888
            type: device_down
        fields:
          type: array
          items:
            type: string
          description: Alarm payload fields available for this alarm type
          examples:
          - - aps
            - hostnames
        group:
          type: string
          description: Alarm group to which this definition belongs
          examples:
          - infrastructure
        key:
          type: string
          description: Alarm type key used in event and alarm payloads
          examples:
          - device_down
        marvis_suggestion_category:
          type: string
          description: Marvis defined category to which the alarm belongs
        severity:
          type: string
          description: Alarm severity level for this definition
          examples:
          - warn
      description: Alarm type definition returned by the constants API
    const_ap_channel:
      title: const_ap_channel
      type: object
      properties:
        band24_40mhz_allowed:
          type: boolean
          description: Whether 40 MHz channels are allowed on the 2.4 GHz band
          examples:
          - true
        band24_channels:
          type: object
          additionalProperties:
            type: array
            items:
              type: integer
              format: int32
            description: Allowed 2.4 GHz channels for this country or regulatory domain
            example:
              '20':
              - 1
              - 2
              - 3
              - 4
              - 5
              - 6
              - 7
              - 8
              - 9
              - 10
              - 11
              '40':
              - 1
              - 2
              - 3
              - 4
              - 5
              - 6
              - 7
              - 8
              - 9
              - 10
              - 11
          description: Allowed 2.4 GHz channels for this country or regulatory domain
          examples:
          - '20':
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - 7
            - 8
            - 9
            - 10
            - 11
            '40':
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - 7
            - 8
            - 9
            - 10
            - 11
        band24_enabled:
          type: boolean
          description: Whether the 2.4 GHz band is enabled for this country or regulatory domain
          examples:
          - true
        band5_channels:
          type: object
          additionalProperties:
            type: array
            items:
              type: integer
              format: int32
            description: Allowed 5 GHz channels for this country or regulatory domain
            example:
              '20':
              - 36
              - 40
              - 44
              - 48
              - 52
              - 56
              - 60
              - 64
              - 100
              - 104
              - 108
              - 112
              - 116
              - 120
              - 124
              - 128
              - 132
              - 136
              - 140
              - 144
              - 149
              - 153
              - 157
              - 161
              - 165
              '40':
              - 36
              - 40
              - 44
              - 48
              - 52
              - 56
              - 60
              - 64
              - 100
              - 104
              - 108
              - 112
              - 116
              - 120
              - 124
              - 128
              - 132
              - 136
              - 140
              - 144
              - 149
              - 153
              - 157
              - 161
              '80':
              - 36
              - 40
              - 44
              - 48
              - 52
              - 56
              - 60
              - 64
              - 100
              - 104
              - 108
              - 112
              - 116
              - 120
              - 124
              - 128
              - 132
              - 136
              - 140
              - 144
              - 149
              - 153
              - 157
              - 161
              dfs:
              - 52
              - 56
              - 60
              - 64
              - 100
              - 104
              - 108
              - 112
              - 116
              - 120
              - 124
              - 128
              - 132
              - 136
              - 140
              - 144
              outdoor:
              - 36
              - 40
              - 44
              - 48
              - 52
              - 56
              - 60
              - 64
              - 100
              - 104
              - 108
              - 112
              - 116
              - 120
              - 124
              - 128
              - 132
              - 136
              - 140
              - 144
              - 149
              - 153
              - 157
              - 161
              - 165
          description: Allowed 5 GHz channels for this country or regulatory domain
          examples:
          - '20':
            - 36
            - 40
            - 44
            - 48
            - 52
            - 56
            - 60
            - 64
            - 100
            - 104
            - 108
            - 112
            - 116
            - 120
            - 124
            - 128
            - 132
            - 136
            - 140
            - 144
            - 149
            - 153
            - 157
            - 161
            - 165
            '40':
            - 36
            - 40
            - 44
            - 48
            - 52
            - 56
            - 60
            - 64
            - 100
            - 104
            - 108
            - 112
            - 116
            - 120
            - 124
            - 128
            - 132
            - 136
            - 140
            - 144
            - 149
            - 153
            - 157
            - 161
            '80':
            - 36
            - 40
            - 44
            - 48
            - 52
            - 56
            - 60
            - 64
            - 100
            - 104
            - 108
            - 112
            - 116
            - 120
            - 124
            - 128
            - 132
            - 136
            - 140
            - 144
            - 149
            - 153
            - 157
            - 161
            dfs:
            - 52
            - 56
            - 60
            - 64
            - 100
            - 104
            - 108
            - 112
            - 116
            - 120
            - 124
            - 128
            - 132
            - 136
            - 140
            - 144
            outdoor:
            - 36
            - 40
            - 44
            - 48
            - 52
            - 56
            - 60
            - 64
            - 100
            - 104
            - 108
            - 112
            - 116
            - 120
            - 124
            - 128
            - 132
            - 136
            - 140
            - 144
            - 149
            - 153
            - 157
            - 161
            - 165
        band5_enabled:
          type: boolean
          description: Whether the 5 GHz band is enabled for this country or regulatory domain
          examples:
          - true
        band6_channels:
          type: object
          additionalProperties:
            type: array
            items:
              type: integer
              format: int32
            description: Allowed 6 GHz channels for this country or regulatory domain
            example:
              '160':
              - 1
              - 5
              - 9
              - 13
              - 17
              - 21
              - 25
              - 29
              - 33
              - 37
              - 41
              - 45
              - 49
              - 53
              - 57
              - 61
              - 65
              - 69
              - 73
              - 77
              - 81
              - 85
              - 89
              - 93
              - 97
              - 101
              - 105
              - 109
              - 113
              - 117
              - 121
              - 125
              - 129
              - 133
              - 137
              - 141
              - 145
              - 149
              - 153
              - 157
              - 161
              - 165
              - 169
              - 173
              - 177
              - 181
              - 185
              - 189
              - 193
              - 197
              - 201
              - 205
              - 209
              - 213
              - 217
              - 221
              '20':
              - 1
              - 5
              - 9
              - 13
              - 17
              - 21
              - 25
              - 29
              - 33
              - 37
              - 41
              - 45
              - 49
              - 53
              - 57
              - 61
              - 65
              - 69
              - 73
              - 77
              - 81
              - 85
              - 89
              - 93
              - 97
              - 101
              - 105
              - 109
              - 113
              - 117
              - 121
              - 125
              - 129
              - 133
              - 137
              - 141
              - 145
              - 149
              - 153
              - 157
              - 161
              - 165
              - 169
              - 173
              - 177
              - 181
              - 185
              - 189
              - 193
              - 197
              - 201
              - 205
              - 209
              - 213
              - 217
              - 221
              - 225
              - 229
              - 233
              '40':
              - 1
              - 5
              - 9
              - 13
              - 17
              - 21
              - 25
              - 29
              - 33
              - 37
              - 41
              - 45
              - 49
              - 53
              - 57
              - 61
              - 65
              - 69
              - 73
              - 77
              - 81
              - 85
              - 89
              - 93
              - 97
              - 101
              - 105
              - 109
              - 113
              - 117
              - 121
              - 125
              - 129
              - 133
              - 137
              - 141
              - 145
              - 149
              - 153
              - 157
              - 161
              - 165
              - 169
              - 173
              - 177
              - 181
              - 185
              - 189
              - 193
              - 197
              - 201
              - 205
              - 209
              - 213
              - 217
              - 221
              - 225
              - 229
              '80':
              - 1
              - 5
              - 9
              - 13
              - 17
              - 21
              - 25
              - 29
              - 33
              - 37
              - 41
              - 45
              - 49
              - 53
              - 57
              - 61
              - 65
              - 69
              - 73
              - 77
              - 81
              - 85
              - 89
              - 93
              - 97
              - 101
              - 105
              - 109
              - 113
              - 117
              - 121
              - 125
              - 129
              - 133
              - 137
              - 141
              - 145
              - 149
              - 153
              - 157
              - 161
              - 165
              - 169
              - 173
              - 177
              - 181
              - 185
              - 189
              - 193
              - 197
              - 201
              - 205
              - 209
              - 213
              - 217
              - 221
              psc:
              - 5
              - 21
              - 37
              - 53
              - 69
              - 85
              - 101
              - 117
              - 133
              - 149
              - 165
              - 181
              - 197
              - 213
              - 229
          description: Allowed 6 GHz channels for this country or regulatory domain
          examples:
          - '160':
            - 1
            - 5
            - 9
            - 13
            - 17
            - 21
            - 25
            - 29
            - 33
            - 37
            - 41
            - 45
            - 49
            - 53
            - 57
            - 61
            - 65
            - 69
            - 73
            - 77
            - 81
            - 85
            - 89
            - 93
            - 97
            - 101
            - 105
            - 109
            - 113
            - 117
            - 121
            - 125
            - 129
            - 133
            - 137
            - 141
            - 145
            - 149
            - 153
            - 157
            - 161
            - 165
            - 169
            - 173
            - 177
            - 181
            - 185
            - 189
            - 193
            - 197
            - 201
            - 205
            - 209
            - 213
            - 217
            - 221
            '20':
            - 1
            - 5
            - 9
            - 13
            - 17
            - 21
            - 25
            - 29
            - 33
            - 37
            - 41
            - 45
            - 49
            - 53
            - 57
            - 61
            - 65
            - 69
            - 73
            - 77
            - 81
            - 85
            - 89
            - 93
            - 97
            - 101
            - 105
            - 109
            - 113
            - 117
            - 121
            - 125
            - 129
            - 133
            - 137
            - 141
            - 145
            - 149
            - 153
            - 157
            - 161
            - 165
            - 169
            - 173
            - 177
            - 181
            - 185
            - 189
            - 193
            - 197
            - 201
            - 205
            - 209
            - 213
            - 217
            - 221
            - 225
            - 229
            - 233
            '40':
            - 1
            - 5
            - 9
            - 13
            - 17
            - 21
            - 25
            - 29
            - 33
            - 37
            - 41
            - 45
            - 49
            - 53
            - 57
            - 61
            - 65
            - 69
            - 73
            - 77
            - 81
            - 85
            - 89
            - 93
            - 97
            - 101
            - 105
            - 109
            - 113
            - 117
            - 121
            - 125
            - 129
            - 133
            - 137
            - 141
            - 145
            - 149
            - 153
            - 157
            - 161
            - 165
            - 169
            - 173
            - 177
            - 181
            - 185
            - 189
            - 193
            - 197
            - 201
            - 205
            - 209
            - 213
            - 217
            - 221
            - 225
            - 229
            '80':
            - 1
            - 5
            - 9
            - 13
            - 17
            - 21
            - 25
            - 29
            - 33
            - 37
            - 41
            - 45
            - 49
            - 53
            - 57
            - 61
            - 65
            - 69
            - 73
            - 77
            - 81
            - 85
            - 89
            - 93
            - 97
            - 101
            - 105
            - 109
            - 113
            - 117
            - 121
            - 125
            - 129
            - 133
            - 137
            - 141
            - 145
            - 149
            - 153
            - 157
            - 161
            - 165
            - 169
            - 173
            - 177
            - 181
            - 185
            - 189
            - 193
            - 197
            - 201
            - 205
            - 209
            - 213
            - 217
            - 221
            psc:
            - 5
            - 21
            - 37
            - 53
            - 69
            - 85
            - 101
            - 117
            - 133
            - 149
            - 165
            - 181
            - 197
            - 213
            - 229
        band6_enabled:
          type: boolean
          description: Whether the 6 GHz band is enabled for this country or regulatory domain
          examples:
          - true
        certified:
          type: boolean
          description: Whether AP operation is certified for this country or regulatory domain
          examples:
          - true
        code:
          type: integer
          description: Country code, ISO 3166-1 numeric
          contentEncoding: int32
          examples:
          - 840
        dfs_ok:
          type: boolean
          description: Whether DFS channels are allowed in this country or regulatory domain
          examples:
          - true
        key:
          type: string
          description: Country code, in two-character
          examples:
          - US
        name:
          type: string
          description: Country or regulatory-domain display name
          examples:
          - United States
        uses:
          type: string
          description: Regulatory ruleset used for AP channel validation
          examples:
          - US_FCC
      description: Country and regulatory-domain channel capabilities for AP radios
    const_ap_esl_version:
      title: const_ap_esl_version
      type: object
      properties:
        esl_version:
          type: string
          description: Electronic Shelf Label (ESL) package version supported by the AP model
          readOnly: true
          examples:
          - 2.5.1
        model:
          type: string
          description: AP model that supports the listed ESL version
          readOnly: true
          examples:
          - AP34
      description: Supported Electronic Shelf Label (ESL) version for an AP model
    const_ap_led:
      title: const_ap_led
      required:
      - code
      - description
      - key
      - name
      type: object
      properties:
        code:
          type: string
          description: Numeric LED status and `last_trouble` code reported by the AP
          examples:
          - '01'
        description:
          type: string
          description: Human-readable explanation of the AP status
          examples:
          - LED not working
        key:
          type: string
          description: Machine-readable AP status key
          examples:
          - LED_FAILURE
        name:
          type: string
          description: Display name for the AP status
          examples:
          - LED Failure
      description: AP LED status and `last_trouble` code definition returned by the constants API
    const_app_category_definition:
      title: const_app_category_definition
      required:
      - display
      - key
      type: object
      properties:
        display:
          type: string
          description: Description of the app category
          examples:
          - Images
        filters:
          allOf:
          - $ref: '#/components/schemas/const_app_category_definition_filters2'
          - description: Platform-specific application signatures included in this category
            examples:
            - srx:
              - Enhanced_Images_Media
              - Enhanced_Web_Images
              - Enhanced_Image_Servers
        includes:
          type: array
          items:
            type: string
          description: Application categories included by this aggregate category
        key:
          type: string
          description: Machine-readable application category key
          examples:
          - Images
      description: Application category definition returned by the constants API
    const_app_category_definition_filters:
      title: const_app_category_definition_filters
      type: object
      properties:
        srx:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Application signature names for SRX platforms included in this category
        ssr:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Application identifiers for SSR platforms included in this category
      description: Platform-specific application category filters
      examples:
      - srx:
        - Enhanced_Images_Media
        - Enhanced_Web_Images
        - Enhanced_Image_Servers
    const_app_subcategory_definition:
      title: const_app_subcategory_definition
      required:
      - display
      - key
      - traffic_type
      type: object
      properties:
        display:
          type: string
          description: Description of the app subcategory
          examples:
          - Office Document
        key:
          type: string
          description: Machine-readable application subcategory key
          examples:
          - Office_Documents
        traffic_type:
          type: string
          description: Type of traffic (QoS) of the app subcategory
          examples:
          - Images
      description: Application subcategory definition returned by the constants API
    const_application_definition:
      title: const_application_definition
      type: object
      properties:
        app_id:
          type: boolean
          description: Whether an AppID is defined for this application
        app_image_url:
          type: string
          description: URL of the application icon image, when one is available
          examples:
          - '""'
        app_probe:
          type: boolean
          description: Whether an application probe is available for this application
        category:
          type: string
          description: Application category key associated with this application
          examples:
          - FileSharing
        group:
          type: string
          description: Application group display name for this application
          examples:
          - File Sharing
        key:
          type: string
          description: Machine-readable key that identifies the application
          examples:
          - dropbox
        name:
          type: string
          description: Display name of the application
          examples:
          - Dropbox
        signature_based:
          type: boolean
          description: Whether this application is detected using signatures
        ssr_app_id:
          type: boolean
          description: Whether an SSR AppID is defined for this application
      description: Application definition recognized by Juniper Devices
    const_country:
      title: const_country
      required:
      - alpha2
      - certified
      - name
      - numeric
      type: object
      properties:
        alpha2:
          type: string
          description: Country code, in two-character
          examples:
          - FR
        certified:
          type: boolean
          description: Whether this country is certified for use in Mist APs
          examples:
          - true
        name:
          type: string
          description: Human-readable country name for display
          examples:
          - France
        numeric:
          type: number
          description: Country code, ISO 3166-1 numeric
          examples:
          - 250
      description: Country definition returned by the constants API
    const_device_ap:
      title: const_device_ap
      required:
      - ap_type
      - type
      type: object
      properties:
        ap_type:
          type: string
          description: Internal AP platform type identifier
          examples:
          - jewel
        band24:
          allOf:
          - $ref: '#/components/schemas/const_device_ap_band242'
          - description: 2.4 GHz radio capability limits for this AP model
        band5:
          allOf:
          - $ref: '#/components/schemas/const_device_ap_band52'
          - description: 5 GHz radio capability limits for this AP model
        band6:
          allOf:
          - $ref: '#/components/schemas/const_device_ap_band62'
          - description: 6 GHz radio capability limits for this AP model
        band_24_usages:
          type: array
          items:
            $ref: '#/components/schemas/const_device_ap_band_24_usage'
          description: Supported RF band usages for the 2.4 GHz radio on this AP model
        ce_dfs_ok:
          type: boolean
          description: Whether DFS operation is allowed for this AP model under CE rules
          examples:
          - true
        cisco_pace:
          type: boolean
          description: Whether the AP model supports Cisco PACE interoperability
        description:
          type: string
          description: Product description for the AP model
          examples:
          - AP-45
        disallowed_channels:
          type: object
          additionalProperties:
            type: array
            items:
              type: integer
              format: int32
            description: Property key is a list of country codes (e.g. "GB, DE")
          description: Property key is a list of country codes (e.g. "GB, DE")
        display:
          type: string
          description: User-facing model name shown for the AP
          examples:
          - AP45
        extio:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/const_device_ap_extios'
          description: Property key is the GPIO port name (e.g. "D0", "A1")
        fcc_dfs_ok:
          type: boolean
          description: Whether DFS operation is allowed for this AP model under FCC rules
          examples:
          - true
        has_11ax:
          type: boolean
          description: Whether the AP model supports 802.11ax
        has_compass:
          type: boolean
          description: Whether the AP model includes a compass sensor
          examples:
          - false
        has_ext_ant:
          type: boolean
          description: Whether the AP model supports external antennas
        has_extio:
          type: boolean
          description: Whether the AP model exposes external I/O ports
          examples:
          - false
        has_height:
          type: boolean
          description: Whether mounting height can be configured for this AP model
          examples:
          - false
        has_module_port:
          type: boolean
          description: Whether the AP model includes a module port
        has_poe_out:
          type: boolean
          description: Whether the AP model supports PoE output
          examples:
          - true
        has_scanning_radio:
          type: boolean
          description: Whether the AP model has scanning-radio capability
          examples:
          - true
        has_selectable_radio:
          type: boolean
          description: Whether the AP model has selectable radio modes
          examples:
          - true
        has_usb:
          type: boolean
          description: Whether the AP model includes a USB port
        has_vble:
          type: boolean
          description: Whether the AP model supports virtual BLE (vBLE)
          examples:
          - true
        has_wifi_band24:
          type: boolean
          description: Whether the AP model supports 2.4 GHz Wi-Fi
          examples:
          - true
        has_wifi_band5:
          type: boolean
          description: Whether the AP model supports 5 GHz Wi-Fi
          examples:
          - true
        has_wifi_band6:
          type: boolean
          description: Whether the AP model supports 6 GHz Wi-Fi
          examples:
          - true
        max_poe_out:
          type: integer
          description: Maximum PoE-out power budget supported by the AP model, in milliwatts
          contentEncoding: int32
          examples:
          - 15400
        max_wlans:
          type: integer
          description: Maximum number of WLANs supported by this AP model
          contentEncoding: int32
        model:
          type: string
          description: AP model identifier for this capability definition
          examples:
          - AP45
        other_dfs_ok:
          type: boolean
          description: Whether DFS operation is allowed for this AP model in other regulatory domains
          examples:
          - true
        outdoor:
          type: boolean
          description: Whether the AP model is rated for outdoor deployment
        radios:
          type: object
          additionalProperties:
            type: string
          description: Property key is the radio number (e.g. r0, r1, ...). Property value is the RF band (e.g. "24", "5", ...)
          examples:
          - r0: '6'
            r1: '5'
            r2: '24'
        shared_scanning_radio:
          type: boolean
          description: Whether scanning-radio capability shares a radio with client service
        type:
          const: ap
          type: string
          description: Device type for this AP model definition
          readOnly: true
        unmanaged:
          type: boolean
          description: Whether this AP model is listed as unmanaged in the constants catalog
        vble:
          allOf:
          - $ref: '#/components/schemas/const_device_ap_vble2'
          - description: Virtual BLE (vBLE) capability settings for this AP model
      description: AP model capability definition returned by the constants API
    const_device_ap_band24:
      title: const_device_ap_band24
      type: object
      properties:
        band5_channels_op:
          type: string
          description: 5 GHz channel set used when this radio operates on 5 GHz
          examples:
          - low
        max_clients:
          type: integer
          description: Maximum client count supported on the 2.4 GHz radio
          contentEncoding: int32
          examples:
          - 128
        max_power:
          type: integer
          description: Maximum transmit power for the 2.4 GHz radio, in dBm
          contentEncoding: int32
          examples:
          - 19
        min_power:
          type: integer
          description: Minimum transmit power for the 2.4 GHz radio, in dBm
          contentEncoding: int32
          examples:
          - 8
      description: 2.4 GHz radio capability limits for an AP model
    const_device_ap_band5:
      title: const_device_ap_band5
      type: object
      properties:
        max_clients:
          type: integer
          description: Maximum client count supported on the 5 GHz radio
          contentEncoding: int32
          examples:
          - 128
        max_power:
          type: integer
          description: Maximum transmit power for the 5 GHz radio, in dBm
          contentEncoding: int32
          examples:
          - 17
        min_power:
          type: integer
          description: Minimum transmit power for the 5 GHz radio, in dBm
          contentEncoding: int32
          examples:
          - 8
      description: 5 GHz radio capability limits for an AP model
    const_device_ap_band6:
      title: const_device_ap_band6
      type: object
      properties:
        max_clients:
          type: integer
          description: Maximum client count supported on the 6 GHz radio
          contentEncoding: int32
          examples:
          - 128
        max_power:
          type: integer
          description: Maximum transmit power for the 6 GHz radio, in dBm
          contentEncoding: int32
          examples:
          - 17
        min_power:
          type: integer
          description: Minimum transmit power for the 6 GHz radio, in dBm
          contentEncoding: int32
          examples:
          - 8
      description: 6 GHz radio capability limits for an AP model
    const_device_ap_band_24_usage:
      title: const_device_ap_band_24_usage
      enum:
      - '24'
      - '5'
      - '6'
      type: string
      description: 'enum: `24`, `5`, `6`'
    const_device_ap_extios:
      title: const_device_ap_extios
      type: object
      properties:
        default_dir:
          allOf:
          - $ref: '#/components/schemas/const_device_ap_extios_default_dir2'
          - description: 'Default direction for this external I/O port. enum: `IN`, `OUT`.'
        input:
          type: boolean
          description: Whether this external I/O port supports input mode
        output:
          type: boolean
          description: Whether this external I/O port supports output mode
      description: External I/O port capabilities for an AP model
    const_device_ap_extios_default_dir:
      title: const_device_ap_extios_default_dir
      enum:
      - IN
      - OUT
      type: string
      description: 'Default direction for this external I/O port. enum: `IN`, `OUT`'
    const_device_ap_vble:
      title: const_device_ap_vble
      type: object
      properties:
        beacon_rate:
          type: integer
          description: Advertisement rate for the virtual BLE beacon
          contentEncoding: int32
          examples:
          - 4
        beams:
          type: integer
          description: Number of virtual BLE beams supported by the AP model
          contentEncoding: int32
          examples:
          - 9
        power:
          type: integer
          description: Transmit power for virtual BLE beacons, in dBm
          contentEncoding: int32
          examples:
          - 8
      description: Virtual BLE (vBLE) capability settings for an AP model
    const_device_gateway:
      title: const_device_gateway
      required:
      - type
      type: object
      properties:
        defaults:
          type: object
          additionalProperties:
            type: string
          description: Default interface group mappings for this gateway model
        description:
          type: string
          description: Product description for the gateway model
        experimental:
          type: boolean
          description: Whether this gateway model is marked experimental in the constants catalog
          default: false
        fans_pluggable:
          type: boolean
          description: Whether the gateway model has field-replaceable fans
          default: true
        ha_node0_fpc:
          type: integer
          description: FPC number used for node0 in HA deployments
          contentEncoding: int32
        ha_node1_fpc:
          type: integer
          description: FPC number used for node1 in HA deployments
          contentEncoding: int32
        has_bgp:
          type: boolean
          description: Whether the gateway model supports BGP
          default: false
        has_fxp0:
          type: boolean
          description: Whether the gateway model includes an fxp0 management interface
          default: true
        has_ha_control:
          type: boolean
          description: Whether the gateway model has a dedicated HA control port
          default: false
        has_ha_data:
          type: boolean
          description: Whether the gateway model has dedicated HA data ports
          default: false
        has_irb:
          type: boolean
          description: Whether the gateway model supports IRB interfaces
          default: false
        has_poe_out:
          type: boolean
          description: Whether the gateway model supports PoE output
          default: true
        has_snapshot:
          type: boolean
          description: Whether the gateway model supports configuration snapshots
          default: true
        irb_disabled_by_default:
          type: boolean
          description: Whether IRB interfaces are disabled by default on this gateway model
          default: false
        model:
          type: string
          description: Gateway model identifier for this capability definition
        number_fans:
          type: integer
          description: Number of fans in the gateway model
          contentEncoding: int32
        oc_device:
          type: boolean
          description: Whether this gateway model is identified as an OpenConfig-managed device
          default: false
        pic:
          type: object
          additionalProperties:
            type: string
          description: Physical Interface Card port layout for this gateway model
        ports:
          allOf:
          - $ref: '#/components/schemas/const_device_gateway_ports2'
          - description: Per-interface metadata for this gateway model
        sub_required:
          type: string
          description: Subscription type required for this gateway model
        t128_device:
          type: boolean
          description: Whether this gateway model is a 128 Technology or SSR device
          default: false
        type:
          const: gateway
          type: string
          description: Device type for this gateway model definition
          readOnly: true
      description: Gateway model capability definition returned by the constants API
    const_device_gateway_ports:
      title: const_device_gateway_ports
      type: object
      properties:
        display:
          type: string
          description: User-facing interface name for the gateway port
        pci_address:
          type: string
          description: PCI address for the gateway port
        speed:
          type: integer
          description: Port speed for the gateway interface, in Mbps
          contentEncoding: int32
      description: Object Key is the interface name (e.g. "ge-0/0/1", ...)
    const_device_switch:
      title: const_device_switch
      required:
      - type
      type: object
      properties:
        alias:
          type: string
          description: Alternate model identifier for chassis-based switch definitions
          examples:
          - EX4100-48P-CHAS
        defaults:
          allOf:
          - $ref: '#/components/schemas/const_device_switch_default2'
          - description: Default port mappings for this switch model
        description:
          type: string
          description: Product description for the switch model
          examples:
          - Juniper EX4100 Series
        display:
          type: string
          description: User-facing model name shown for the switch
          examples:
          - EX4100-48P
        evolved_os:
          type: boolean
          description: Whether the switch model runs Junos Evolved
          default: false
        evpn_ri_type:
          type: string
          description: EVPN routing-instance type used by this switch model
          examples:
          - mac-vrf
        experimental:
          type: boolean
          description: Whether this switch model is marked experimental in the constants catalog
          default: false
        fans_pluggable:
          type: boolean
          description: Whether the switch model has field-replaceable fans
          default: false
          examples:
          - true
        has_bgp:
          type: boolean
          description: Whether the switch model supports BGP
          default: false
          examples:
          - true
        has_ets:
          type: boolean
          description: Whether the switch model supports Enhanced Transmission Selection (ETS)
          default: false
        has_evpn:
          type: boolean
          description: Whether the switch model supports EVPN
          default: false
          examples:
          - true
        has_irb:
          type: boolean
          description: Whether the switch model supports IRB interfaces
          default: false
          examples:
          - true
        has_poe_out:
          type: boolean
          description: Whether the switch model supports PoE output
          default: false
          examples:
          - true
        has_snapshot:
          type: boolean
          description: Whether the switch model supports configuration snapshots
          default: true
        has_vc:
          type: boolean
          description: Whether the switch model supports Virtual Chassis
          default: true
          examples:
          - true
        model:
          type: string
          description: Switch model identifier for this capability definition
          examples:
          - EX4100-48P
        modular:
          type: boolean
          description: Whether the switch model has modular hardware
          default: false
        no_shaping_rate:
          type: boolean
          description: Whether the switch model omits shaping-rate support
          default: false
        number_fans:
          type: integer
          description: Number of fans in the switch model
          contentEncoding: int32
          examples:
          - 2
        oc_device:
          type: boolean
          description: Whether this switch model is identified as an OpenConfig-managed device
          default: false
          examples:
          - true
        oob_interface:
          type: string
          description: Out-of-band management interface names for this switch model
          examples:
          - re0:mgmt-0, re1:mgmt-0
        packet_action_drop_only:
          type: boolean
          description: Whether packet action support is limited to drop-only behavior
          default: false
        pic:
          type: object
          additionalProperties:
            type: string
          description: Object Key is the PIC number
          examples:
          - '0': ge*48
            '1': qsfp+*4
            '2': sfp+*4 (uplink)
        sub_required:
          type: string
          description: Subscription type required for this switch model
        type:
          const: switch
          type: string
          description: Device type for this switch model definition
          readOnly: true
      description: Switch model capability definition returned by the constants API
    const_device_switch_default:
      title: const_device_switch_default
      type: object
      properties:
        _ports:
          type: string
          description: Default switch port range list for this model
          examples:
          - ge-0/0/0-47, et-0/1/0-3, xe-0/2/0-3, ge-0/2/0-3
      description: Default switch port ranges for a model
    const_device_type_ap:
      title: const_device_type_ap
      const: ap
      type: string
      description: 'Device Type. enum: `ap`'
    const_device_type_gateway:
      title: const_device_type_gateway
      const: gateway
      type: string
      description: 'Device Type. enum: `gateway`'
    const_device_type_switch:
      title: const_device_type_switch
      const: switch
      type: string
      description: 'Device Type. enum: `switch`'
    const_event:
      title: const_event
      required:
      - display
      - key
      type: object
      properties:
        description:
          type: string
          description: Narrative description of the device event type
        display:
          type: string
          description: Human-readable label for the device event type
        example:
          type: object
          description: Sample device event payload for this event type
        group:
          type: string
          description: Device event group for this definition
        key:
          type: string
          description: Machine-readable device event key
      description: Device event definition returned by the constants API
    const_fingerprint_types:
      title: const_fingerprint_types
      type: object
      properties:
        family:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Device family values available for client fingerprint matching
        mfg:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Manufacturer values available for client fingerprint matching
        model:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Device model values available for client fingerprint matching
        os:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Operating system values available for client fingerprint matching
      description: Supported client fingerprint values for NAC matching
    const_gateway_applications_definition:
      title: const_gateway_applications_definition
      type: object
      properties:
        app_id:
          type: boolean
          description: Whether an AppID is defined for this gateway application
          examples:
          - true
        key:
          type: string
          description: Machine-readable key that identifies the gateway application
          examples:
          - 4shared
        name:
          type: string
          description: Display name of the gateway application
          examples:
          - 4shared
        ssr_app_id:
          type: boolean
          description: Whether an SSR AppID is defined for this gateway application
          examples:
          - true
      description: Gateway application definition returned by the constants API
    const_insight_metrics_property:
      title: const_insight_metrics_property
      type: object
      properties:
        ctype:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Metric classification type labels for this insight metric
        description:
          type: string
          description: Human-readable description of the insight metric
        example:
          anyOf:
          - type: array
            items:
              $ref: '#/components/schemas/const_insight_metrics_property_example'
          - type: object
            additionalProperties:
              type: array
              items:
                $ref: '#/components/schemas/const_insight_metrics_property_example'
          description: Sample values returned for this insight metric
        intervals:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/const_insight_metrics_property_interval'
          description: Supported time intervals and retention windows for this metric
        keys:
          type: object
          description: Additional key metadata for this insight metric
        params:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/const_insight_metrics_property_param'
          description: Parameters supported when querying this insight metric
        report_durations:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/const_insight_metrics_property_report_duration'
          description: Supported reporting durations for this insight metric
        report_scopes:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Entity scopes supported when reporting this insight metric
        scopes:
          type: array
          items:
            $ref: '#/components/schemas/const_insight_metrics_property_scope'
          description: Entity scopes that can be queried for this insight metric
        sle_baselined:
          type: boolean
          description: Whether the insight metric uses an SLE baseline
        sle_classifiers:
          uniqueItems: true
          type: array
          items:
            type: string
          description: SLE classifiers associated with this insight metric
        type:
          type: string
          description: Metric data type, such as timeseries
        unit:
          type: string
          description: Measurement unit for values returned by this metric
        values:
          type: object
          description: Enumerated or structured value metadata for this insight metric
      description: Definition of an insight metric returned by the constants API
    const_insight_metrics_property_example_any_of:
      title: const_insight_metrics_property_example_any_of
      type: object
      description: Example values for an insight metric property, as an array or keyed object
    const_insight_metrics_property_interval:
      title: const_insight_metrics_property_interval
      type: object
      properties:
        interval:
          type: integer
          description: Sampling interval length, in seconds
          contentEncoding: int32
        max_age:
          type: integer
          description: Maximum lookback age for this interval, in seconds
          contentEncoding: int32
      description: Interval definition for an insight metric
    const_insight_metrics_property_param:
      title: const_insight_metrics_property_param
      type: object
      properties:
        required:
          type: boolean
          description: Whether this query parameter is required
      description: Query parameter definition for an insight metric
    const_insight_metrics_property_report_duration:
      title: const_insight_metrics_property_report_duration
      type: object
      properties:
        duration:
          type: integer
          description: Report duration length, in seconds
          contentEncoding: int32
        interval:
          type: integer
          description: Sampling interval used for this report duration, in seconds
          contentEncoding: int32
      description: Report duration definition for an insight metric
    const_insight_metrics_property_scope:
      title: const_insight_metrics_property_scope
      enum:
      - ap
      - client
      - device
      - gateway
      - map
      - msp
      - mxcluster
      - mxedge
      - org
      - otherdevice
      - rssizone
      - sdkclient
      - site
      - switch
      - wlan
      - zone
      type: string
      description: 'enum: `ap`, `client`, `device`, `gateway`, `map`, `msp`, `mxcluster`, `mxedge`, `org`, `otherdevice`, `rssizone`, `sdkclient`, `site`, `switch`, `wlan`, `zone`'
    const_language:
      title: const_language
      required:
      - display
      - display_native
      - key
      type: object
      properties:
        display:
          type: string
          description: Localized language display name in the API default locale
          examples:
          - English (US)
        display_native:
          type: string
          description: Language display name in its native locale
          examples:
          - English (US)
        key:
          type: string
          description: Locale key used to select this language
          examples:
          - en-US
      description: Language option returned by the constants API
    const_license_type:
      title: const_license_type
      type: object
      properties:
        description:
          type: string
          description: Human-readable description of the license type
          examples:
          - Wired Assurance 12
        enforcement_level:
          allOf:
          - $ref: '#/components/schemas/const_license_type_enforcement_level'
          - description: 'Level at which the license is enforced. enum: `org`, `site`.'
        entitled_licenses:
          type: array
          items:
            type: string
          description: License type keys this license type entitles
          examples:
          - - sub_ex12
            - sub_sadv1
        group:
          type: string
          description: License group this license type belongs to
          examples:
          - SUB-WIRED
        includes:
          type: array
          items:
            type: string
          description: License SKU components included by this license type
          examples:
          - - sub_ex12a
            - sub_ex12p
        key:
          type: string
          description: Machine-readable license type key
          examples:
          - sub_ex12
        name:
          type: string
          description: Display name of the license type
          examples:
          - SUB-EX12
        type:
          type: string
          description: License type identifier (SKU)
          examples:
          - SUB-EX12
      description: License type definition returned by the constants API
    const_license_type_enforcement_level:
      title: const_license_type_enforcement_level
      enum:
      - org
      - site
      type: string
      description: 'Level at which the license is enforced. enum: `org`, `site`.'
    const_marvis_client_version:
      title: const_marvis_client_version
      type: object
      properties:
        label:
          type: string
          description: Release label for this Marvis Client version
          examples:
          - default
        notes:
          type: string
          description: Release notes or extra text for this Marvis Client version
        os:
          type: string
          description: Operating system supported by this Marvis Client installer
          examples:
          - windows
        url:
          type: string
          description: Download URL for this Marvis Client installer
          examples:
          - https://mobile.mist.com/installers/marvisclient/...
        version:
          type: string
          description: Marvis Client software version for this installer
          examples:
          - 0.100.29
      description: Marvis Client version download entry
    const_marvisclient_event:
      title: const_marvisclient_event
      type: object
      properties:
        display:
          type: string
          description: Human-readable name for this Marvis Client event type
          examples:
          - Marvis Client Roamed
        key:
          type: string
          description: Event type key used in Marvis Client event search and count APIs
          examples:
          - MARVISCLIENT_ROAMED
      description: A Marvis Client event type definition
    const_mxedge_model:
      title: const_mxedge_model
      type: object
      properties:
        custom_ports:
          type: boolean
          description: Whether this Mist Edge model supports custom port definitions
        display:
          type: string
          description: User-facing model name shown for the Mist Edge
          examples:
          - X10
        model:
          type: string
          description: Mist Edge model identifier
          examples:
          - ME-X10
        ports:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/const_mxedge_model_port'
          description: Port metadata keyed by interface number for this Mist Edge model
      description: Mist Edge model definition returned by the constants API
    const_mxedge_model_port:
      title: const_mxedge_model_port
      type: object
      properties:
        display:
          type: string
          description: User-facing interface name for this Mist Edge port
          examples:
          - xe0
        speed:
          type: integer
          description: Port speed for the Mist Edge interface, in Mbps
          contentEncoding: int32
          examples:
          - 10000
      description: Mist Edge model port metadata
    const_nac_event:
      title: const_nac_event
      type: object
      properties:
        ap:
          type: string
          description: Access point MAC address associated with the NAC event
          examples:
          - 5c5b355008c0
        bssid:
          type: string
          description: Wireless BSSID associated with the NAC event
          examples:
          - 5c5b35548892
        cert_cn:
          type: string
          description: Certificate common name presented during NAC authentication
          examples:
          - suriyas
        cert_expiry:
          type: integer
          description: Certificate expiration timestamp presented during NAC authentication
          contentEncoding: int32
          examples:
          - 1711557441
        cert_issuer:
          type: string
          description: Certificate issuer presented during NAC authentication
          examples:
          - /DC=net/DC=jnpr/CN=Juniper Networks Issuing AWS1 CA
        cert_san_upn:
          type: array
          items:
            type: string
          description: Certificate SAN UPN values presented during NAC authentication
          examples:
          - - suriyas@juniper.net
        cert_serial:
          type: string
          description: Certificate serial number presented during NAC authentication
          examples:
          - 1300103d29e56ef083797bedc2000100103d29
        cert_subject:
          type: string
          description: Certificate subject presented during NAC authentication
          examples:
          - /CN=suriyas/emailAddress=suriyas@juniper.net
        eap_type:
          type: string
          description: EAP method used for the NAC authentication
          examples:
          - EAP-TLS
        nas_vendor:
          type: string
          description: Network access server vendor reported for the NAC event
          examples:
          - Mist
        org_id:
          type: string
          description: Organization identifier associated with the NAC event
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        random_mac:
          type: boolean
          description: Whether the client used a randomized MAC address in the NAC event
          examples:
          - true
        site_id:
          type: string
          description: Site identifier associated with the NAC event
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        ssid:
          type: string
          description: Wireless SSID associated with the NAC event
          examples:
          - Test_Suriya-SSID
        timestamp:
          type: number
          description: Time when the NAC event occurred
          readOnly: true
        type:
          type: string
          description: NAC event type key
          examples:
          - NAC_CLIENT_CERT_CHECK_SUCCESS
        username:
          type: string
          description: User identity associated with the NAC event
          examples:
          - suriyas@juniper.net
        wcid:
          type: string
          description: Wireless client identifier associated with the NAC event
          contentEncoding: uuid
          examples:
          - b43637b0-f0d9-0a1d-1ec2-73c394a9f679
      description: NAC event example payload returned by the constants API
    const_other_device_model:
      title: const_other_device_model
      type: object
      properties:
        _vendor_model_id:
          type: string
          description: Vendor-specific model identifier for this other-device model
        display:
          type: string
          description: User-facing model name shown for the other-device model
        model:
          type: string
          description: Device model identifier for this other-device definition
        type:
          type: string
          description: Device category for this other-device model
        vendor:
          type: string
          description: Manufacturer name for this other-device model
      description: Other-device model definition returned by the constants API
    const_state:
      title: const_state
      type: object
      properties:
        iso_code:
          type: string
          description: ISO subdivision code for the state or territory
          examples:
          - AK
        name:
          type: string
          description: State or territory display name
          examples:
          - Alaska
      description: State or territory definition returned by the constants API
    const_traffic_type:
      title: const_traffic_type
      type: object
      properties:
        display:
          type: string
          description: Human-readable traffic type label
          examples:
          - VoIP Video
        dscp:
          type: integer
          description: Differentiated Services Code Point value used for this traffic type
          contentEncoding: int32
          examples:
          - 32
        failover_policy:
          type: string
          description: Failover behavior associated with this traffic type
          examples:
          - non_revertible
        max_jitter:
          type: integer
          description: Maximum jitter threshold for this traffic type, in milliseconds
          contentEncoding: int32
          examples:
          - 250
        max_latency:
          type: integer
          description: Maximum latency threshold for this traffic type, in milliseconds
          contentEncoding: int32
          examples:
          - 1500
        max_loss:
          type: integer
          description: Maximum packet loss threshold for this traffic type, in percent
          contentEncoding: int32
          examples:
          - 35
        name:
          type: string
          description: Machine-readable traffic type name
          examples:
          - voip_video
        traffic_class:
          type: string
          description: Traffic class associated with this traffic type
          examples:
          - medium
      description: Traffic type definition returned by the constants API
    const_webhook_topic:
      title: const_webhook_topic
      type: object
      properties:
        allows_single_event_per_message:
          type: boolean
          description: Whether this topic can be configured to enforce one event per webhook message
        for_org:
          type: boolean
          description: Whether this topic can be used in organization-level webhooks
        has_delivery_results:
          type: boolean
          description: Whether delivery-result search is available for this webhook topic
        internal:
          type: boolean
          description: Whether this topic is internal and not selectable in site or organization webhooks
        key:
          type: string
          description: Machine-readable key that identifies the webhook topic
          examples:
          - alarms
      description: Webhook topic definition returned by the constants API
    count_org_devices_mxtunnel_status:
      title: count_org_devices_mxtunnel_status
      enum:
      - down
      - up
      type: string
      description: 'Mist Tunnel status value used when counting organization devices. enum: `down`, `up`'
    count_pbn_distinct:
      title: count_pbn_distinct
      enum:
      - versions
      - models
      - customer_risk
      - bug_type
      type: string
      description: 'Fields that can be used to group PBN advisory count results. enum: `versions`, `models`, `customer_risk`, `bug_type`'
      examples:
      - versions
    count_result:
      title: count_result
      required:
      - count
      type: object
      properties:
        count:
          type: integer
          description: Number of matching items for the distinct value or values in this result
          contentEncoding: int32
      additionalProperties:
        type: string
      description: Count result row with the matching distinct field values
    count_sirt_distinct:
      title: count_sirt_distinct
      enum:
      - versions
      - models
      - severity
      - jsa_updated_date
      type: string
      description: 'Fields that can be used to group SIRT advisory count results. enum: `versions`, `models`, `severity`, `jsa_updated_date`'
      examples:
      - versions
    count_site_calls_distinct:
      title: count_site_calls_distinct
      const: mac
      type: string
      description: 'Distinct field used when counting site call statistics. enum: `mac`'
    count_usermac_distinct:
      title: count_usermac_distinct
      enum:
      - mac
      - name
      - labels
      - org_id
      type: string
      description: 'Fields that can be used to group user MAC count results. enum: `mac`, `name`, `labels`, `org_id`'
      examples:
      - org_id
    cpu_stat:
      title: cpu_stat
      type: object
      properties:
        idle:
          type:
          - number
          - 'null'
          description: Percentage of CPU time that is idle
          readOnly: true
        interrupt:
          type:
          - number
          - 'null'
          description: Percentage of CPU time being used by interrupts
          readOnly: true
        load_avg:
          type: array
          items:
            type: number
          description: Load averages for the last 1, 5, and 15 minutes
        system:
          type:
          - number
          - 'null'
          description: Percentage of CPU time being used by system processes
          readOnly: true
        usage:
          type:
          - number
          - 'null'
          description: Overall CPU usage percentage
          readOnly: true
        user:
          type:
          - number
          - 'null'
          description: Percentage of CPU time being used by user processes
          readOnly: true
      description: CPU utilization breakdown for a device
    day_of_week:
      title: day_of_week
      enum:
      - any
      - fri
      - mon
      - sat
      - sun
      - thu
      - tue
      - wed
      type: string
      description: 'enum: `any`, `fri`, `mon`, `sat`, `sun`, `thu`, `tue`, `wed`'
    days_number:
      title: days_number
      type: object
      properties:
        days:
          type: integer
          description: Number of most recent days of CRL entries to retain after truncation
          contentEncoding: int32
          default: 30
      description: Request body specifying CRL truncation retention in days
    delivery:
      title: delivery
      required:
      - enabled
      type: object
      properties:
        additional_emails:
          type: array
          items:
            type: string
          description: Additional email recipients for alarm delivery
        enabled:
          type: boolean
          description: Whether to enable the alarm delivery via emails or not
          examples:
          - true
        to_org_admins:
          type: boolean
          description: Whether to deliver the alarms via emails to Org admins or not
          examples:
          - true
        to_site_admins:
          type: boolean
          description: Whether to deliver the alarms via emails to Site admins or not
          examples:
          - false
      description: Delivery object to configure the alarm delivery
    device_ap_lacp_config:
      title: device_ap_lacp_config
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether to enable LACP on supported AP Ethernet uplinks
          default: false
      description: LACP settings for supported AP Ethernet uplinks
    device_enum_with_all:
      title: device_enum_with_all
      enum:
      - all
      - ap
      - switch
      - gateway
      type: string
      description: 'device type. enum: `all`, `ap`, `gateway`, `switch`. Default is `ap`'
    device_event:
      title: device_event
      required:
      - org_id
      - timestamp
      - type
      type: object
      properties:
        ap:
          type: string
          description: Deprecated AP MAC address field; use `mac` instead
          deprecated: true
        ap_name:
          type: string
          description: Deprecated AP name field; use `device_name` instead
          deprecated: true
        apfw:
          type: string
          description: AP firmware version associated with the device event
        audit_id:
          type: string
          description: Audit log identifier associated with the device event
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        bandwidth:
          type: integer
          description: Channel bandwidth associated with a radio event, in MHz
          contentEncoding: int32
        channel:
          type: integer
          description: RF channel associated with the device event
          contentEncoding: int32
        chassis_mac:
          type: string
          description: Chassis MAC address associated with the device event
        count:
          type: integer
          description: Event count reported in the device event payload
          contentEncoding: int32
        device_name:
          type: string
          description: Name of the device associated with the event
        device_type:
          allOf:
          - $ref: '#/components/schemas/device_type6'
          - description: 'Device type associated with the event. enum: `ap`, `gateway`, `switch`.'
        ev_type:
          allOf:
          - $ref: '#/components/schemas/webhook_device_events_event_ev_type2'
          - description: 'Advisory severity for the device event. enum: `notice`, `warn`.'
        ext_ip:
          type: string
          description: External IP address reported for the device event
        job_id:
          type: string
          description: Job identifier associated with a tunnel provisioning event (present when `includes`==`ext_tunnel`)
          contentEncoding: uuid
        mac:
          type: string
          description: Device MAC address associated with the event
        model:
          type: string
          description: Device model associated with the event
        node:
          type: string
          description: Cluster node identifier associated with the device event
        org_id:
          type: string
          description: Organization identifier associated with the device event
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        port_id:
          type: string
          description: Port identifier associated with the device event
        power:
          type: integer
          description: Transmit power associated with a radio event
          contentEncoding: int32
        pre_bandwidth:
          type: integer
          description: Previous channel bandwidth before an RRM change, in MHz
          contentEncoding: int32
        pre_channel:
          type: integer
          description: Previous RF channel before an RRM change
          contentEncoding: int32
        pre_power:
          type: integer
          description: Previous transmit power before an RRM change
          contentEncoding: int32
        pre_usage:
          type: integer
          description: Previous radio usage band before an RRM change
          contentEncoding: int32
        reason:
          type: string
          description: Optional reason text reported for the device event
        site_id:
          type: string
          description: Site identifier associated with the device event
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        site_name:
          type: string
          description: Name of the site associated with the event
        status:
          type: string
          description: Tunnel provisioning status for ext_tunnel events (e.g. `PROVISION_IN_PROGRESS`)
        template_id:
          type: string
          description: Gateway template identifier associated with a tunnel provisioning event (present when `includes`==`ext_tunnel`)
          contentEncoding: uuid
        text:
          type: string
          description: Optional human-readable text for the device event
        timestamp:
          type: number
          description: Time when the device event occurred
          readOnly: true
        tunnel_name:
          type: string
          description: Tunnel name associated with a tunnel provisioning event (present when `includes`==`ext_tunnel`)
        type:
          type: string
          description: Device event type key
        usage:
          type: integer
          description: Current radio usage band for an RRM event
          contentEncoding: int32
        version:
          type: string
          description: Firmware or software version associated with the device event
      description: Device event payload returned by search and webhook APIs
    device_gateway:
      title: device_gateway
      required:
      - type
      type: object
      properties:
        additional_config_cmds:
          type: array
          items:
            type: string
          description: Additional CLI configuration commands to apply to this gateway
        bgp_config:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/bgp_config'
          description: BGP routing configuration for this gateway. Property key is the BGP session name
        created_time:
          type: number
          description: Timestamp when the gateway object was created
          readOnly: true
        deviceprofile_id:
          type: string
          description: Device profile associated with this gateway
          contentEncoding: uuid
          readOnly: true
        dhcpd_config:
          allOf:
          - $ref: '#/components/schemas/dhcpd_config4'
          - description: DHCP server configuration served by this gateway
        dns_servers:
          type: array
          items:
            type: string
          description: DNS servers configured for this gateway
        dns_suffix:
          type: array
          items:
            type: string
          description: DNS search suffixes configured for this gateway
        extra_routes:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/gateway_extra_route'
          description: Additional IPv4 routes configured on this gateway
        extra_routes6:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/gateway_extra_route6'
          description: Additional IPv6 routes configured on this gateway
          examples:
          - 2a02:1234:420a:10c9::/64:
              via: 2a02:1234:200a::100
        for_site:
          type: boolean
          description: Whether the gateway configuration is scoped directly to a site
          readOnly: true
        gateway_mgmt:
          allOf:
          - $ref: '#/components/schemas/gateway_mgmt4'
          - description: Management-plane settings for this gateway
        id:
          type: string
          description: Unique identifier of the gateway object
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        idp_profiles:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/idp_profile'
          description: Intrusion detection and prevention profiles configured for this gateway
        image1_url:
          type:
          - string
          - 'null'
          description: First custom image URL associated with the gateway
        image2_url:
          type:
          - string
          - 'null'
          description: Second custom image URL associated with the gateway
        image3_url:
          type:
          - string
          - 'null'
          description: Third custom image URL associated with the gateway
        ip_configs:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/gateway_ip_config_property'
          description: Gateway interface IP configurations by network name
        mac:
          type: string
          description: Gateway MAC address used to identify the device
          readOnly: true
        managed:
          type: boolean
          description: Whether the device is managed by Mist. Deprecated in favour of mist_configured.
          deprecated: true
        map_id:
          type: string
          description: Map where the device belongs to
          contentEncoding: uuid
          examples:
          - 63eda950-c6da-11e4-a628-60f81dd250cc
        mist_configured:
          type: boolean
          description: whether the device can be configured by Mist or not. This deprecates `managed` for adopted devices.
        model:
          type: string
          description: Gateway model reported for the device
          readOnly: true
        modified_time:
          type: number
          description: Timestamp when the gateway object was last modified
          readOnly: true
        msp_id:
          type: string
          description: MSP that manages this gateway, when applicable
          contentEncoding: uuid
          readOnly: true
          examples:
          - b9d42c2e-88ee-41f8-b798-f009ce7fe909
        name:
          type: string
          description: Friendly display name assigned to the gateway
        networks:
          type: array
          items:
            $ref: '#/components/schemas/network'
          description: Layer 3 networks configured for use by this gateway
        notes:
          type: string
          description: Free-form administrative notes for this gateway
        ntp_servers:
          uniqueItems: true
          type: array
          items:
            type: string
          description: NTP servers used by this gateway
        oob_ip_config:
          allOf:
          - $ref: '#/components/schemas/gateway_oob_ip_config4'
          - description: Out-of-band management IP configuration for this gateway
        org_id:
          type: string
          description: Organization that owns this gateway
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        path_preferences:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/gateway_path_preferences'
          description: Property key is the path name
        port_config:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/gateway_port_config'
          description: Property key is the port name or range (e.g. "ge-0/0/0-10")
        port_mirroring:
          allOf:
          - $ref: '#/components/schemas/gateway_port_mirroring2'
          - description: Port mirroring configuration for this gateway
        router_id:
          type: string
          description: Auto assigned if not set
          examples:
          - 10.2.1.10
        routing_policies:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/gw_routing_policy'
          description: Routing policies applied by this gateway
        serial:
          type: string
          description: Manufacturer serial number for the gateway
          readOnly: true
        service_policies:
          type: array
          items:
            $ref: '#/components/schemas/service_policy'
          description: Traffic service policies enforced by this gateway
        site_id:
          type: string
          description: Site where this gateway is assigned
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        tunnel_configs:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/tunnel_config'
          description: Property key is the tunnel name
        tunnel_provider_options:
          allOf:
          - $ref: '#/components/schemas/tunnel_provider_options4'
          - description: Provider-specific options for tunnels terminated by this gateway
        type:
          const: gateway
          type: string
          description: Device type discriminator for gateway records
          readOnly: true
        url_filtering_deny_msg:
          type: string
          description: When a service policy denies a app_category, what message to show in user's browser
          default: Access to this URL Category has been blocked
          examples:
          - Access to this URL Category has been blocked
        vars:
          type: object
          additionalProperties:
            type: string
          description: Variable values that override site variables for this gateway
          examples:
          - RADIUS_IP1: 172.31.2.5
            RADIUS_SECRET: 11s64632d
        vrf_config:
          allOf:
          - $ref: '#/components/schemas/vrf_config1'
          - description: VRF configuration applied to this gateway
        vrf_instances:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/gateway_vrf_instance'
          description: VRF instances configured on this gateway
          examples:
          - CORP_VRF:
              networks:
              - CORP_NET
              - MGMT_NET
        x:
          type: number
          description: Horizontal map position of the gateway, in pixels
          examples:
          - 53.5
        y:
          type: number
          description: Vertical map position of the gateway, in pixels
          examples:
          - 173.1
      description: Gateway configuration and placement data
    device_id_string:
      title: device_id_string
      required:
      - device_id
      type: object
      properties:
        device_id:
          type: string
          description: Device identifier supplied by the request
          contentEncoding: uuid
      description: Request body containing a device identifier
    device_other:
      title: device_other
      type: object
      properties:
        created_time:
          type: number
          description: Timestamp when the third-party device record was created
          readOnly: true
        device_mac:
          type: string
          description: MAC address of the Mist device this third-party device is attached to
        id:
          type: string
          description: Unique identifier of the third-party device record
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        mac:
          type: string
          description: Third-party device MAC address
        model:
          type: string
          description: Third-party device model reported by the vendor integration
        modified_time:
          type: number
          description: Timestamp when the third-party device record was last modified
          readOnly: true
        name:
          type: string
          description: Display name reported or configured for the third-party device
        org_id:
          type: string
          description: Organization that owns this third-party device record
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        serial:
          type: string
          description: Manufacturer serial number reported for the third-party device
        site_id:
          type: string
          description: Site where the third-party device is assigned
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        state:
          type: string
          description: Operational state reported for the third-party device
        vendor:
          type: string
          description: External vendor integration that reported the third-party device
        vendor_api_id:
          type: string
          description: Identifier assigned by the vendor API for this third-party device
      description: Third-party device discovered or managed through an external vendor integration
    device_search_radius_filter_status:
      title: device_search_radius_filter_status
      enum:
      - up
      - down
      - unreachable
      type: string
      description: 'Status of the device search RADIUS filter. enum: `up`, `down`, `unreachable`'
    device_search_radius_stat:
      title: device_search_radius_stat
      type: object
      properties:
        auth_accepts:
          type: integer
          description: Number of accepted authentication requests
          contentEncoding: int32
        auth_rejects:
          type: integer
          description: Number of rejected authentication requests
          contentEncoding: int32
        auth_server_status:
          allOf:
          - $ref: '#/components/schemas/device_search_radius_filter_status1'
          - description: 'RADIUS authentication server status for this server in device search results. enum: `up`, `down`, `unreachable`.'
        auth_timeouts:
          type: integer
          description: Number of authentication timeouts
          contentEncoding: int32
      description: RADIUS authentication counters and server status for a device search result
    device_status:
      title: device_status
      enum:
      - all
      - connected
      - disconnected
      type: string
      description: 'enum: `all`, `connected`, `disconnected`'
    device_status_filter:
      title: device_status_filter
      enum:
      - connected
      - disconnected
      type: string
      description: 'Filter devices based on their status. enum: `connected`, `disconnected`'
    device_switch:
      title: device_switch
      required:
      - type
      type: object
      properties:
        acl_policies:
          type: array
          items:
            $ref: '#/components/schemas/acl_policy'
          description: ACL policies applied to traffic handled by this switch
        acl_tags:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/acl_tag'
          description: ACL tags used by switch access policies
        additional_config_cmds:
          type: array
          items:
            type: string
          description: Additional CLI configuration commands to apply to this switch
        aggregate_routes:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/aggregate_route'
          description: Additional IPv4 aggregate routes configured on this switch
          examples:
          - 172.16.3.0/24:
              discard: false
              metric: null
              preference: 30
        aggregate_routes6:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/aggregate_route'
          description: Additional IPv6 aggregate routes configured on this switch
          examples:
          - 2a02:1234:420a:10c9::/64:
              discard: false
              metric: null
              preference: 30
        bgp_config:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_bgp_config'
          description: BGP routing configuration for this switch. Property key is the BGP session name
        created_time:
          type: number
          description: Timestamp when the switch object was created
          readOnly: true
        default_port_usage:
          type: string
          description: 'Port usage to assign to switch ports without any port usage assigned. Default: `default` to preserve default behavior'
          default: default
        deviceprofile_id:
          type: string
          description: Device profile associated with this switch
          contentEncoding: uuid
          readOnly: true
        dhcp_snooping:
          allOf:
          - $ref: '#/components/schemas/dhcp_snooping5'
          - description: DHCP snooping configuration for this switch
        dhcpd_config:
          allOf:
          - $ref: '#/components/schemas/switch_dhcpd_config3'
          - description: DHCP server configuration served by this switch
        disable_auto_config:
          type: boolean
          description: This disables the default behavior of a cloud-ready switch/gateway being managed/configured by Mist. Setting this to `true` means you want to disable the default behavior and do not want the device to be Mist-managed.
          default: false
        dns_servers:
          type: array
          items:
            type: string
          description: DNS servers configured for this switch
        dns_suffix:
          type: array
          items:
            type: string
          description: DNS search suffixes configured for this switch
        evpn_config:
          allOf:
          - $ref: '#/components/schemas/evpn_config3'
          - description: EVPN configuration applied to this switch
          readOnly: true
        extra_routes:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/extra_route'
          description: Additional IPv4 routes configured on this switch
          examples:
          - 0.0.0.0/0:
              via: 192.168.1.10
        extra_routes6:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/extra_route6'
          description: Additional IPv6 routes configured on this switch
          examples:
          - 2a02:1234:420a:10c9::/64:
              via: 2a02:1234:200a::100
        id:
          type: string
          description: Unique identifier of the switch object
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        image1_url:
          type:
          - string
          - 'null'
          description: First custom image URL associated with the switch
        image2_url:
          type:
          - string
          - 'null'
          description: Second custom image URL associated with the switch
        image3_url:
          type:
          - string
          - 'null'
          description: Third custom image URL associated with the switch
        iot_config:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_iot_port'
          description: IoT port settings for this switch
        ip_config:
          allOf:
          - $ref: '#/components/schemas/junos_ip_config3'
          - description: Management IP addressing settings for this switch
        local_port_config:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/junos_local_port_config'
          description: Local port configuration settings for this switch
        mac:
          type: string
          description: Switch MAC address used to identify the device
          readOnly: true
        managed:
          type: boolean
          description: An adopted switch/gateway will not be managed/configured by Mist by default. Setting this parameter to `true` enables the adopted switch/gateway to be managed/configured by Mist. Deprecated in favour of mist_configured, which is more intuitive and can be used for both adopted and claimed devices.
          default: false
          deprecated: true
        map_id:
          type: string
          description: Map where the device belongs to
          contentEncoding: uuid
          examples:
          - 63eda950-c6da-11e4-a628-60f81dd250cc
        mist_configured:
          type: boolean
          description: whether the device can be configured by Mist or not. This deprecates `managed` (for adopted device) and `disable_auto_config` for claimed device)
        mist_nac:
          allOf:
          - $ref: '#/components/schemas/switch_mist_nac5'
          - description: Mist NAC settings applied to this switch
        model:
          type: string
          description: Switch model reported for the device
          readOnly: true
        modified_time:
          type: number
          description: Timestamp when the switch object was last modified
          readOnly: true
        name:
          type: string
          description: Friendly display name assigned to the switch
        networks:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_network'
          description: Layer 3 networks configured for use by this switch
        notes:
          type: string
          description: Free-form administrative notes for this switch
        ntp_servers:
          type: array
          items:
            type: string
          description: NTP servers used by this switch
        oob_ip_config:
          allOf:
          - $ref: '#/components/schemas/switch_oob_ip_config3'
          - description: Out-of-band management IP configuration for this switch
        org_id:
          type: string
          description: Organization that owns this switch
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        ospf_areas:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ospf_area'
          description: OSPF area configuration for this switch
        ospf_config:
          allOf:
          - $ref: '#/components/schemas/switch_ospf_config2'
          - description: OSPF routing configuration for this switch
        other_ip_configs:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/junos_other_ip_config'
          description: Property key is the network name. Defines the additional IP Addresses configured on the device.
        port_config:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/junos_port_config'
          description: Per-port wired configuration for this switch
        port_config_overwrite:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_port_config_overwrite'
          description: Per-port overrides for switch port usage attributes
        port_mirroring:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_port_mirroring_property'
          description: Port mirroring configuration for this switch
        port_usages:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_port_usage'
          description: Reusable switch port usage profiles available on this switch
        radius_config:
          allOf:
          - $ref: '#/components/schemas/switch_radius_config6'
          - description: RADIUS authentication and accounting settings for this switch
        remote_syslog:
          allOf:
          - $ref: '#/components/schemas/remote_syslog5'
          - description: Remote syslog settings for this switch
        role:
          type: string
          description: Deployment role label for this switch
        router_id:
          type: string
          description: Used for OSPF / BGP / EVPN
          examples:
          - 10.2.1.10
        routing_policies:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/sw_routing_policy'
          description: Routing policies applied by this switch
        serial:
          type: string
          description: Manufacturer serial number for the switch
          readOnly: true
        site_id:
          type: string
          description: Site where this switch is assigned
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        snmp_config:
          allOf:
          - $ref: '#/components/schemas/snmp_config5'
          - description: SNMP configuration for this switch
        stp_config:
          allOf:
          - $ref: '#/components/schemas/switch_stp_config4'
          - description: Spanning Tree Protocol configuration for this switch
        switch_mgmt:
          allOf:
          - $ref: '#/components/schemas/switch_mgmt6'
          - description: Management-plane settings for this switch
        type:
          const: switch
          type: string
          description: Device type discriminator for switch records
          readOnly: true
        use_router_id_as_source_ip:
          type: boolean
          description: Whether to use it for snmp / syslog / tacplus / radius
          default: false
        vars:
          type: object
          additionalProperties:
            type: string
          description: Variable values that override site variables for this switch
          examples:
          - RADIUS_IP1: 172.31.2.5
            RADIUS_SECRET: 11s64632d
        virtual_chassis:
          allOf:
          - $ref: '#/components/schemas/switch_virtual_chassis2'
          - description: Virtual Chassis membership and provisioning settings for this switch
        vrf_config:
          allOf:
          - $ref: '#/components/schemas/vrf_config8'
          - description: VRF configuration applied to this switch
        vrf_instances:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_vrf_instance'
          description: VRF instances configured on this switch
          examples:
          - guest:
              extra_routes:
                0.0.0.0/0:
                  via: 192.168.31.1
              networks:
              - guest
        vrrp_config:
          allOf:
          - $ref: '#/components/schemas/vrrp_config3'
          - description: VRRP configuration applied to this switch
        x:
          type: number
          description: Horizontal map position of the switch, in pixels
          examples:
          - 53.5
        y:
          type: number
          description: Vertical map position of the switch, in pixels
          examples:
          - 173.1
      description: >-
        You can configure `port_usages` and `networks` settings at the device level, but most of the time it's better use the Site Setting to achieve better consistency and be able to re-use the same settings across switches entries defined here will "replace" those defined in Site Setting/Network Template

        In addition it is possible to use the `port_config_overwrite` to overwrite some attributes of the port_usage without having to create a new port_usage.
    device_type:
      title: device_type
      enum:
      - ap
      - gateway
      - switch
      type: string
      description: 'enum: `ap`, `gateway`, `switch`'
    device_type_ap:
      title: device_type_ap
      const: ap
      type: string
      description: 'Device Type. enum: `ap`'
    device_type_default_ap:
      title: device_type_default_ap
      enum:
      - ap
      - gateway
      - switch
      type: string
      description: 'enum: `ap`, `gateway`, `switch`'
    device_type_gateway:
      title: device_type_gateway
      const: gateway
      type: string
      description: 'Device Type. enum: `gateway`'
    device_type_switch:
      title: device_type_switch
      const: switch
      type: string
      description: 'Device Type. enum: `switch`'
    device_upgrade:
      title: device_upgrade
      required:
      - version
      type: object
      properties:
        reboot:
          type: boolean
          description: For Switches and Gateways only (APs are automatically rebooted). Reboot device immediately after upgrade is completed
          default: false
        reboot_at:
          type: integer
          description: For Switches and Gateways only and if `reboot`==`true`. Reboot start time in epoch seconds, default is `start_time`
          contentEncoding: int32
        snapshot:
          type: boolean
          description: For Junos devices only. Perform recovery snapshot after device is rebooted
          default: false
        start_time:
          type: integer
          description: Firmware download start time in epoch
          contentEncoding: int32
        version:
          type: string
          description: Specific version / `stable`, default is to use the latest
      description: Device firmware upgrade request options
    device_version_item:
      title: device_version_item
      required:
      - model
      - version
      type: object
      properties:
        model:
          type: string
          description: Device model (as seen in the device stats)
        tag:
          type: string
          description: Annotation, suggested / alpha. Or it can be empty or nothing which is likely a dev build
        version:
          type: string
          description: Available firmware version for this device model
      description: Available firmware version for a specific device model and release tag
    deviceprofile_ap:
      title: deviceprofile_ap
      required:
      - type
      type: object
      properties:
        aeroscout:
          allOf:
          - $ref: '#/components/schemas/ap_aeroscout2'
          - description: Location integration defaults for AeroScout in this AP profile
        airista:
          allOf:
          - $ref: '#/components/schemas/ap_airista2'
          - description: Location integration defaults for Airista in this AP profile
        ble_config:
          allOf:
          - $ref: '#/components/schemas/ble_config2'
          - description: Bluetooth Low Energy beacon and asset defaults in this AP profile
        created_time:
          type: number
          description: Timestamp when the AP device profile was created
          readOnly: true
        disable_eth1:
          type: boolean
          description: Whether to disable eth1 port
          default: false
        disable_eth2:
          type: boolean
          description: Whether to disable eth2 port
          default: false
        disable_eth3:
          type: boolean
          description: Whether to disable eth3 port
          default: false
        disable_module:
          type: boolean
          description: Whether to disable module port
          default: false
        esl_config:
          allOf:
          - $ref: '#/components/schemas/ap_esl_config2'
          - description: Electronic shelf label integration defaults in this AP profile
        for_site:
          type: boolean
          description: Whether this AP profile is scoped directly to a site
          readOnly: true
        id:
          type: string
          description: Unique identifier of the AP device profile
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        iot_config:
          allOf:
          - $ref: '#/components/schemas/ap_iot2'
          - description: Digital and analog IoT pin defaults in this AP profile
        ip_config:
          allOf:
          - $ref: '#/components/schemas/ap_ip_config2'
          - description: Management IP addressing defaults in this AP profile
        lacp_config:
          allOf:
          - $ref: '#/components/schemas/device_ap_lacp_config2'
          - description: Link aggregation defaults for supported AP Ethernet uplinks
        led:
          allOf:
          - $ref: '#/components/schemas/ap_led2'
          - description: Indicator light behavior defaults in this AP profile
        mesh:
          allOf:
          - $ref: '#/components/schemas/ap_mesh2'
          - description: Wireless mesh role and band defaults in this AP profile
        modified_time:
          type: number
          description: Timestamp when the AP device profile was last modified
          readOnly: true
        mqtt_config:
          allOf:
          - $ref: '#/components/schemas/ap_mqtt2'
          - description: MQTT broker publishing settings for this AP profile
        name:
          type:
          - string
          - 'null'
          description: Display name of the AP device profile
        ntp_servers:
          uniqueItems: true
          type: array
          items:
            type: string
          description: NTP servers configured by this AP profile
        org_id:
          type: string
          description: Organization that owns this AP device profile
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        poe_passthrough:
          type: boolean
          description: Whether to enable power out through module port (for APH) or eth1 (for APL/BT11)
          default: false
        port_config:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ap_port_config'
          description: eth0 is not allowed here. Property key is the interface(s) name (e.g. `eth1` or `eth1,eth2`). If specified, this takes precedence over switch_config (deprecated)
        pwr_config:
          allOf:
          - $ref: '#/components/schemas/ap_pwr_config2'
          - description: Power negotiation and peripheral power defaults in this AP profile
        radio_config:
          allOf:
          - $ref: '#/components/schemas/ap_radio2'
          - description: Radio configuration defaults in this AP profile
        site_id:
          type: string
          description: Site where this AP device profile is defined, when scoped to a site
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        switch_config:
          allOf:
          - $ref: '#/components/schemas/ap_switch1'
          - description: Deprecated AP switch configuration defaults in this profile
            deprecated: true
        type:
          const: ap
          type: string
          description: Device type discriminator for AP device profiles
        uplink_port_config:
          allOf:
          - $ref: '#/components/schemas/ap_uplink_port_config2'
          - description: Authentication and failover defaults for AP uplink ports
        usb_config:
          allOf:
          - $ref: '#/components/schemas/ap_usb2'
          - description: Legacy USB integration defaults in this AP profile
        uwb_config:
          allOf:
          - $ref: '#/components/schemas/ap_uwb_config2'
          - description: UWB RTLS / OMLOX asset-visibility settings; overrides the site-level `uwb_config` and is overridden by device-level `uwb_config`
        vars:
          type: object
          additionalProperties:
            type: string
          description: Variable values provided by this AP device profile
          examples:
          - RADIUS_IP1: 172.31.2.5
            RADIUS_SECRET: 11s64632d
        zigbee_config:
          allOf:
          - $ref: '#/components/schemas/ap_zigbee2'
          - description: Zigbee radio and network defaults in this AP profile
      description: AP device profile configuration applied to APs at a site or organization
    deviceprofile_gateway:
      title: deviceprofile_gateway
      required:
      - name
      - type
      type: object
      properties:
        additional_config_cmds:
          type: array
          items:
            type: string
          description: Additional CLI configuration commands provided by this gateway profile
        bgp_config:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/bgp_config'
          description: BGP routing defaults for this gateway profile. Property key is the BGP session name
        created_time:
          type: number
          description: Timestamp when the gateway profile was created
          readOnly: true
        dhcpd_config:
          allOf:
          - $ref: '#/components/schemas/dhcpd_config1'
          - description: DHCP server defaults provided by this gateway profile
        dnsOverride:
          type: boolean
          description: Whether DNS server and suffix settings in this profile override inherited values
          default: false
        dns_servers:
          type: array
          items:
            type: string
          description: DNS servers provided by this gateway profile
        dns_suffix:
          type: array
          items:
            type: string
          description: DNS search suffixes provided by this gateway profile
        extra_routes:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/gateway_extra_route'
          description: Additional IPv4 route defaults in this gateway profile
        extra_routes6:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/gateway_extra_route6'
          description: Additional IPv6 route defaults in this gateway profile
          examples:
          - 2a02:1234:420a:10c9::/64:
              via: 2a02:1234:200a::100
        gateway_matching:
          allOf:
          - $ref: '#/components/schemas/gateway_matching3'
          - description: Matching rules that select gateways for this profile
        id:
          type: string
          description: Unique identifier of the gateway profile
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        idp_profiles:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/idp_profile'
          description: Intrusion detection and prevention profile defaults in this gateway profile
        ip_configs:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/gateway_ip_config_property'
          description: Gateway interface IP configuration defaults by network name
        modified_time:
          type: number
          description: Timestamp when the gateway profile was last modified
          readOnly: true
        name:
          type: string
          description: Display name of the gateway profile
          examples:
          - gw_template
        networks:
          type: array
          items:
            $ref: '#/components/schemas/network'
          description: Layer 3 networks configured by this gateway profile
        ntpOverride:
          type: boolean
          description: Whether NTP servers in this profile override inherited values
          default: false
        ntp_servers:
          type: array
          items:
            type: string
          description: NTP servers provided by this gateway profile
        oob_ip_config:
          allOf:
          - $ref: '#/components/schemas/gateway_oob_ip_config1'
          - description: Out-of-band management IP defaults in this gateway profile
        org_id:
          type: string
          description: Organization that owns this gateway profile
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        path_preferences:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/gateway_path_preferences'
          description: Property key is the path name
        port_config:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/gateway_port_config'
          description: Property key is the port(s) name or range (e.g. "ge-0/0/0-10")
        router_id:
          type: string
          description: Auto assigned if not set
          examples:
          - 10.2.1.10
        routing_policies:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/gw_routing_policy'
          description: Routing policy defaults applied by this gateway profile
        service_policies:
          type: array
          items:
            $ref: '#/components/schemas/service_policy'
          description: Traffic service policy defaults enforced by this gateway profile
        tunnel_configs:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/tunnel_config'
          description: Property key is the tunnel name
        tunnel_provider_options:
          allOf:
          - $ref: '#/components/schemas/tunnel_provider_options1'
          - description: Provider-specific tunnel options defined by this gateway profile
        type:
          const: gateway
          type: string
          description: Device type discriminator for gateway profiles
        url_filtering_deny_msg:
          type: string
          description: When a service policy denies a app_category, what message to show in user's browser
          default: Access to this URL Category has been blocked
          examples:
          - Access to this URL Category has been blocked
        vrf_config:
          allOf:
          - $ref: '#/components/schemas/vrf_config2'
          - description: VRF defaults applied by this gateway profile
        vrf_instances:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/gateway_vrf_instance'
          description: VRF instances configured by this gateway profile
          examples:
          - CORP_VRF:
              networks:
              - CORP_NET
              - MGMT_NET
      description: Gateway Template is applied to a site for gateway(s) in a site.
    deviceprofile_switch:
      title: deviceprofile_switch
      required:
      - name
      - type
      type: object
      properties:
        acl_policies:
          type: array
          items:
            $ref: '#/components/schemas/acl_policy'
          description: ACL policy defaults provided by this switch profile
        acl_tags:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/acl_tag'
          description: ACL tags available to switch access policies in this profile
        additional_config_cmds:
          type: array
          items:
            type: string
          description: Additional CLI configuration commands provided by this switch profile
        aggregate_routes:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/aggregate_route'
          description: Additional IPv4 aggregate route defaults in this switch profile
          examples:
          - 172.16.3.0/24:
              discard: false
              metric: null
              preference: 30
        aggregate_routes6:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/aggregate_route'
          description: Additional IPv6 aggregate route defaults in this switch profile
          examples:
          - 2a02:1234:420a:10c9::/64:
              discard: false
              metric: null
              preference: 30
        created_time:
          type: number
          description: Timestamp when the switch profile was created
          readOnly: true
        dhcp_snooping:
          allOf:
          - $ref: '#/components/schemas/dhcp_snooping1'
          - description: DHCP snooping defaults provided by this switch profile
        dhcpd_config:
          allOf:
          - $ref: '#/components/schemas/switch_dhcpd_config1'
          - description: DHCP server defaults provided by this switch profile
        dns_servers:
          type: array
          items:
            type: string
          description: DNS servers provided by this switch profile
        dns_suffix:
          type: array
          items:
            type: string
          description: DNS search suffixes provided by this switch profile
        evpn_config:
          allOf:
          - $ref: '#/components/schemas/evpn_config1'
          - description: EVPN defaults applied by this switch profile
          readOnly: true
        extra_routes:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/extra_route'
          description: Additional IPv4 route defaults in this switch profile
          examples:
          - 0.0.0.0/0:
              via: 192.168.1.10
        extra_routes6:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/extra_route6'
          description: Additional IPv6 route defaults in this switch profile
          examples:
          - 2a02:1234:420a:10c9::/64:
              via: 2a02:1234:200a::100
        id:
          type: string
          description: Unique identifier of the switch profile
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        iot_config:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_iot_port'
          description: IoT port defaults provided by this switch profile
        ip_config:
          allOf:
          - $ref: '#/components/schemas/junos_ip_config1'
          - description: Management IP addressing defaults in this switch profile
        mist_nac:
          allOf:
          - $ref: '#/components/schemas/switch_mist_nac1'
          - description: Mist NAC defaults applied by this switch profile
        modified_time:
          type: number
          description: Timestamp when the switch profile was last modified
          readOnly: true
        name:
          type: string
          description: Display name of the switch profile
        networks:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_network'
          description: Layer 3 networks configured by this switch profile
        ntp_servers:
          type: array
          items:
            type: string
          description: NTP servers provided by this switch profile
        oob_ip_config:
          allOf:
          - $ref: '#/components/schemas/switch_oob_ip_config1'
          - description: Out-of-band management IP defaults in this switch profile
        org_id:
          type: string
          description: Organization that owns this switch profile
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        ospf_areas:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ospf_area'
          description: OSPF area defaults provided by this switch profile
        other_ip_configs:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/junos_other_ip_config'
          description: Property key is the network name. Defines the additional IP Addresses configured on the device.
        port_config:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/junos_port_config'
          description: Per-port wired defaults provided by this switch profile
        port_mirroring:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_port_mirroring_property'
          description: Port mirroring defaults provided by this switch profile
        port_usages:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_port_usage'
          description: Reusable switch port usage profiles provided by this switch profile
        radius_config:
          allOf:
          - $ref: '#/components/schemas/switch_radius_config2'
          - description: RADIUS authentication and accounting defaults in this switch profile
        remote_syslog:
          allOf:
          - $ref: '#/components/schemas/remote_syslog1'
          - description: Remote syslog defaults provided by this switch profile
        routing_policies:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/sw_routing_policy'
          description: Routing policy defaults applied by this switch profile
        site_id:
          type: string
          description: Site where this switch profile is defined, when scoped to a site
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        snmp_config:
          allOf:
          - $ref: '#/components/schemas/snmp_config1'
          - description: SNMP defaults provided by this switch profile
        stp_config:
          allOf:
          - $ref: '#/components/schemas/switch_stp_config1'
          - description: Spanning Tree Protocol defaults provided by this switch profile
        switch_mgmt:
          allOf:
          - $ref: '#/components/schemas/switch_mgmt1'
          - description: Management-plane defaults provided by this switch profile
        type:
          const: switch
          type: string
          description: Device type discriminator for switch profiles
          readOnly: true
        use_router_id_as_source_ip:
          type: boolean
          description: Whether to use it for snmp / syslog / tacplus / radius
          default: false
        vrf_config:
          allOf:
          - $ref: '#/components/schemas/vrf_config3'
          - description: VRF defaults applied by this switch profile
        vrf_instances:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_vrf_instance'
          description: VRF instances configured by this switch profile
          examples:
          - guest:
              extra_routes:
                0.0.0.0/0:
                  via: 192.168.31.1
              networks:
              - guest
        vrrp_config:
          allOf:
          - $ref: '#/components/schemas/vrrp_config1'
          - description: VRRP defaults applied by this switch profile
      description: Switch Device Profiles can be applied to one or multiple switches. The settings from the Device Profile will override the settings from the Switch Template and the Site Settings.
    devices_gbp_tag:
      title: devices_gbp_tag
      required:
      - gbp_tag
      - macs
      type: object
      properties:
        gbp_tag:
          type: integer
          description: Group-Based Policy tag value to apply to the devices
          contentEncoding: int32
        macs:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            type: string
          description: Device MAC addresses that receive the GBP tag
          examples:
          - - 683b679ac024
      description: Request body for assigning a GBP tag to multiple devices
    devices_ids:
      title: devices_ids
      required:
      - device_ids
      type: object
      properties:
        device_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Device identifiers to operate on in the request
      description: Request body containing device identifiers
    dhcp_client_option:
      title: dhcp_client_option
      type: object
      properties:
        code:
          type: string
          description: DHCP option code and option name
          examples:
          - DHO_DHCP_MESSAGE_TYPE(53)
        data:
          type: string
          description: Decoded value carried by the DHCP option
          examples:
          - DHCPREQUEST
      description: DHCP client option observed in a DHCP packet
    dhcp_snooping:
      title: dhcp_snooping
      type: object
      properties:
        all_networks:
          type: boolean
          description: Whether DHCP snooping applies to all configured networks
        enable_arp_spoof_check:
          type: boolean
          description: Enable for dynamic ARP inspection check
        enable_ip_source_guard:
          type: boolean
          description: Enable for check for forging source IP address
        enabled:
          type: boolean
          description: Whether DHCP snooping is enabled
        networks:
          type: array
          items:
            type: string
          description: Network names with DHCP snooping enabled when `all_networks`==`false`
      description: DHCP snooping security settings
    dhcpd_config:
      title: dhcpd_config
      type: object
      properties:
        enabled:
          type: boolean
          description: If set to `false`, disable the DHCP server
          default: true
      additionalProperties:
        allOf:
        - $ref: '#/components/schemas/dhcpd_config_property'
        - description: DHCP server or relay configuration for one network
      description: DHCP server configuration map with a global enable flag
    dhcpd_config_fixed_binding:
      title: dhcpd_config_fixed_binding
      type: object
      properties:
        ip:
          type: string
          description: Reserved IPv4 address for this fixed DHCP binding
          examples:
          - 192.168.70.35
        ip6:
          type: string
          description: Reserved IPv6 address for this fixed DHCP binding
          examples:
          - 2607:f8b0:4005:808::2
        name:
          type: string
          description: Friendly name for this fixed DHCP binding
      description: Static DHCP binding for a client MAC address
    dhcpd_config_option:
      title: dhcpd_config_option
      type: object
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/dhcpd_config_option_type2'
          - description: 'Data type used to encode this DHCP option value. enum: `boolean`, `hex`, `int16`, `int32`, `ip`, `string`, `uint16`, `uint32`.'
        value:
          type: string
          description: Option value to send for this DHCP option
      description: Custom DHCP option value
    dhcpd_config_option_type:
      title: dhcpd_config_option_type
      enum:
      - boolean
      - hex
      - int16
      - int32
      - ip
      - string
      - uint16
      - uint32
      type: string
      description: 'enum: `boolean`, `hex`, `int16`, `int32`, `ip`, `string`, `uint16`, `uint32`'
    dhcpd_config_property:
      title: dhcpd_config_property
      type: object
      properties:
        dns_servers:
          type: array
          items:
            type: string
          description: If `type`==`local` or `type6`==`local`, DNS servers advertised to DHCP clients
          examples:
          - - 8.8.8.8
            - 4.4.4.4
            - 2001:4860:4860::8888
        dns_suffix:
          type: array
          items:
            type: string
          description: If `type`==`local` or `type6`==`local`, DNS search suffixes advertised to DHCP clients
          examples:
          - - .mist.local
            - .mist.com
        fixed_bindings:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/dhcpd_config_fixed_binding'
          description: If `type`==`local` or `type6`==`local`, fixed client bindings for local DHCP service
          examples:
          - 5684dae9ac8b:
              ip: 192.168.70.35
              name: John
        gateway:
          type: string
          description: If `type`==`local` - optional, `ip` will be used if not provided
          examples:
          - 192.168.70.1
        ip6_end:
          type: string
          description: If `type6`==`local`, ending IPv6 address for the DHCP lease pool
          examples:
          - 2607:f8b0:4005:808::ff
        ip6_start:
          type: string
          description: If `type6`==`local`, starting IPv6 address for the DHCP lease pool
          examples:
          - 2607:f8b0:4005:808::2
        ip_end:
          type: string
          description: If `type`==`local`, ending IPv4 address for the DHCP lease pool
          examples:
          - 192.168.70.200
        ip_start:
          type: string
          description: If `type`==`local`, starting IPv4 address for the DHCP lease pool
          examples:
          - 192.168.70.100
        lease_time:
          maximum: 604800
          minimum: 3600
          type: integer
          description: In seconds, lease time has to be between 3600 [1hr] - 604800 [1 week], default is 86400 [1 day]
          contentEncoding: int32
          default: 86400
        options:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/dhcpd_config_option'
          description: If `type`==`local` or `type6`==`local`, custom DHCP options advertised to clients
        server_id_override:
          type: boolean
          description: "`server_id_override`==`true` means the device, when acts as DHCP relay and forwards DHCP responses from DHCP server to clients, \nshould overwrite the Sever Identifier option (i.e. DHCP option 54) in DHCP responses with its own IP address."
          default: false
        servers:
          type: array
          items:
            type: string
          description: If `type`==`relay`, upstream IPv4 DHCP servers
          examples:
          - - 11.2.3.4
        serversv6:
          type: array
          items:
            type: string
          description: If `type6`==`relay`, upstream IPv6 DHCP servers
          examples:
          - - 2607:f8b0:4005:808::64
        type:
          allOf:
          - $ref: '#/components/schemas/dhcpd_config_type2'
          - description: 'IPv4 DHCP mode for this network. enum: `local`, `none`, `relay`.'
        type6:
          allOf:
          - $ref: '#/components/schemas/dhcpd_config_type62'
          - description: 'IPv6 DHCP mode for this network. enum: `local`, `none`, `relay`.'
        vendor_encapsulated:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/dhcpd_config_vendor_option'
          description: If `type`==`local` or `type6`==`local`, vendor-encapsulated DHCP options advertised to clients
      description: DHCP server or relay configuration for one network
    dhcpd_config_type:
      title: dhcpd_config_type
      enum:
      - local
      - none
      - relay
      type: string
      description: 'enum: `local` (DHCP Server), `none`, `relay` (DHCP Relay)'
    dhcpd_config_vendor_option:
      title: dhcpd_config_vendor_option
      type: object
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/dhcpd_config_vendor_option_type2'
          - description: 'Data type used to encode this vendor option value. enum: `boolean`, `hex`, `int16`, `int32`, `ip`, `string`, `uint16`, `uint32`.'
        value:
          type: string
          description: Option value to send for this vendor option
      description: Vendor-encapsulated DHCP option value
    dhcpd_config_vendor_option_type:
      title: dhcpd_config_vendor_option_type
      enum:
      - boolean
      - hex
      - int16
      - int32
      - ip
      - string
      - uint16
      - uint32
      type: string
      description: 'enum: `boolean`, `hex`, `int16`, `int32`, `ip`, `string`, `uint16`, `uint32`'
    dhcpd_stat_lan:
      title: dhcpd_stat_lan
      type: object
      properties:
        num_ips:
          type: integer
          description: Total number of IP addresses in the DHCP pool
          contentEncoding: int32
          examples:
          - 100
        num_leased:
          type: integer
          description: Number of DHCP pool addresses currently leased
          contentEncoding: int32
          examples:
          - 20
      description: DHCP lease statistics for one network
    discovered_switch:
      title: discovered_switch
      type: object
      properties:
        adopted:
          type: boolean
          description: Whether the discovered switch has been adopted into Mist management
        ap_redundancy:
          allOf:
          - $ref: '#/components/schemas/ap_redundancy1'
          - description: AP switch redundancy summary for APs connected through the discovered switch
        aps:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/discovered_switch_ap'
          description: Connected APs observed on ports of the discovered switch
        chassis_id:
          uniqueItems: true
          type: array
          items:
            type: string
          description: LLDP chassis identifier reported by the discovered switch
        for_site:
          type: boolean
          description: Whether the discovered switch is associated with the requested site
          readOnly: true
        mgmt_addr:
          type: string
          description: Management IP address advertised by the discovered switch
        model:
          type: string
          description: Switch model reported for the discovered switch
        org_id:
          type: string
          description: Organization that contains the discovered switch record
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        site_id:
          type: string
          description: Site where the switch was discovered
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        system_desc:
          type: string
          description: LLDP system description advertised by the discovered switch
        system_name:
          type: string
          description: LLDP system name advertised by the discovered switch
        timestamp:
          type: number
          description: Time when the discovered switch data was observed
          readOnly: true
        vendor:
          type: string
          description: Switch vendor reported for the discovered switch
        version:
          type: string
          description: Software version reported for the discovered switch
      description: Switch discovered from AP uplink LLDP data and site switch discovery
    discovered_switch_ap:
      title: discovered_switch_ap
      type: object
      properties:
        hostname:
          type: string
          description: AP hostname observed on the discovered switch
        inactive_wired_vlans:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: Inactive wired VLAN IDs reported for the AP attachment
        mac:
          type: string
          description: AP MAC address observed on the discovered switch
        poe_status:
          type: boolean
          description: Whether the upstream switch port provides PoE for the AP
        port:
          type: string
          description: Switch port name connected to the AP
        port_id:
          type: string
          description: LLDP port identifier for the AP uplink
        power_draw:
          type: number
          description: Power draw reported for the AP connection
        when:
          type: string
          description: Timestamp when this AP attachment was last observed
      description: AP attachment details observed on a discovered switch
    discovered_switch_metric:
      title: discovered_switch_metric
      type: object
      properties:
        adopted:
          type: boolean
          description: Whether the discovered switch in this metric has been adopted into Mist management
        aps:
          type: array
          items:
            $ref: '#/components/schemas/discovered_switch_metric_ap'
          description: AP attachment details included with this discovered switch metric
        chassis_id:
          type: array
          items:
            type: string
          description: LLDP chassis identifiers associated with this metric result
        hostname:
          type: string
          description: Switch hostname associated with this metric result
          examples:
          - SW-HLAB-ea2e00
        mgmt_addr:
          type: string
          description: Management IP address associated with this metric result
          examples:
          - 10.10.20.42
        model:
          type: string
          description: Switch model associated with this metric result
        org_id:
          type: string
          description: Organization that contains the discovered switch metric
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        scope:
          type: string
          description: Aggregation scope for the discovered switch metric result
          examples:
          - site
        score:
          type: integer
          description: Compliance or health score for the discovered switch metric
          contentEncoding: int32
          examples:
          - 100
        site_id:
          type: string
          description: Site associated with the discovered switch metric
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        system_desc:
          type: string
          description: LLDP system description associated with this metric result
          examples:
          - 'Juniper Networks, Inc. ex4100-f-12p Ethernet Switch, kernel JUNOS 22.4R3.25, Build date: 2024-02-10 00:49:09 UTC Copyright (c) 1996-2024 Juniper Networks, Inc.'
        system_name:
          type: string
          description: LLDP system name associated with this metric result
          examples:
          - SW-HLAB-ea2e00
        timestamp:
          type: number
          description: Time bucket for the discovered switch metric result
          readOnly: true
        type:
          type: string
          description: Metric category represented by this discovered switch metric
          examples:
          - inactive_wired_vlans
        vendor:
          type: string
          description: Switch vendor associated with this metric result
        version:
          type: string
          description: Software version associated with this metric result
      description: Time-series metric result for discovered switch health or compliance
    discovered_switch_metric_ap:
      title: discovered_switch_metric_ap
      type: object
      properties:
        hostname:
          type: string
          description: AP hostname included in the discovered switch metric
        mac:
          type: string
          description: AP MAC address included in the discovered switch metric
        poe_status:
          type: boolean
          description: Whether the upstream switch port provides PoE for this AP
        port:
          type: string
          description: Switch port name connected to this AP
        port_id:
          type: string
          description: LLDP port identifier for this AP uplink
        power_draw:
          type: integer
          description: Power draw reported for this AP connection
          contentEncoding: int32
        when:
          type: string
          description: Timestamp when this AP attachment metric was observed
      description: AP attachment details included in a discovered switch metric
    discovered_switch_metric_type:
      title: discovered_switch_metric_type
      enum:
      - inactive_wired_vlans
      - poe_compliance
      - switch_ap_affinity
      - version_compliance
      type: string
      description: 'enum: `inactive_wired_vlans`, `poe_compliance`, `switch_ap_affinity`, `version_compliance`'
    discovered_switches_metric_scope:
      title: discovered_switches_metric_scope
      enum:
      - site
      - switch
      type: string
      description: 'Scope level used when querying discovered switch metrics. enum: `site`, `switch`'
    dot11_bandwidth:
      title: dot11_bandwidth
      enum:
      - 0
      - 20
      - 40
      - 80
      - 160
      type: integer
      description: 'channel width for the band.enum: `0`(disabled, response only), `20`, `40`, `80` (only applicable for band_5 and band_6), `160` (only for band_6)'
      examples:
      - 20
    dot11_bandwidth24:
      title: dot11_bandwidth24
      enum:
      - 0
      - 20
      - 40
      type: integer
      description: 'channel width for the 2.4GHz band. enum: `0`(disabled, response only), `20`, `40`'
      examples:
      - 20
    dot11_bandwidth5:
      title: dot11_bandwidth5
      enum:
      - 0
      - 20
      - 40
      - 80
      type: integer
      description: 'channel width for the 5GHz band. enum: `0`(disabled, response only), `20`, `40`, `80`'
      examples:
      - 40
    dot11_bandwidth6:
      title: dot11_bandwidth6
      enum:
      - 0
      - 20
      - 40
      - 80
      - 160
      type: integer
      description: 'channel width for the 6GHz band. enum: `0`(disabled, response only), `20`, `40`, `80`, `160`'
      examples:
      - 80
    dot11_proto:
      title: dot11_proto
      enum:
      - a
      - ac
      - ax
      - b
      - be
      - g
      - n
      type: string
      description: 'enum: `a`, `ac`, `ax`, `b`, `be`, `g`, `n`'
    dswitches_compliance_major_version:
      title: dswitches_compliance_major_version
      required:
      - major_count
      - model
      type: object
      properties:
        major_count:
          type: number
          description: Number of major software versions observed for this switch model
        model:
          type: string
          description: Switch model represented by this version-compliance grouping
        system_names:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Discovered switch system names included in this version-compliance grouping
      description: Version-compliance grouping for one discovered switch model
    dswitches_metrics_inactive_wired_vlans:
      title: dswitches_metrics_inactive_wired_vlans
      required:
      - details
      - score
      type: object
      properties:
        details:
          type: object
          description: Metric-specific details for inactive wired VLAN findings
        score:
          type: number
          description: Compliance score for the inactive wired VLAN metric
      description: Inactive wired VLAN metric for APs connected to discovered switches
    dswitches_metrics_poe_compliance:
      title: dswitches_metrics_poe_compliance
      required:
      - details
      - score
      type: object
      properties:
        details:
          allOf:
          - $ref: '#/components/schemas/dswitches_metrics_poe_compliance_details2'
          - description: Counts and power totals used to calculate the PoE compliance score
        score:
          type: number
          description: Compliance score for the PoE compliance metric
      description: PoE compliance metric for APs connected to discovered switches
    dswitches_metrics_poe_compliance_details:
      title: dswitches_metrics_poe_compliance_details
      required:
      - total_aps
      - total_power
      type: object
      properties:
        total_aps:
          type: integer
          description: Number of APs evaluated for PoE compliance
          contentEncoding: int32
        total_power:
          type: number
          description: Aggregate AP PoE power demand across evaluated APs, in mW
      description: Detail values used by the discovered-switch PoE compliance metric
    dswitches_metrics_switch_ap_affinity:
      title: dswitches_metrics_switch_ap_affinity
      required:
      - details
      - score
      type: object
      properties:
        details:
          allOf:
          - $ref: '#/components/schemas/dswitches_metrics_switch_ap_affinity_details2'
          - description: Switch names and threshold used to calculate the affinity score
        score:
          type: number
          description: Compliance score for the switch/AP affinity metric
      description: Switch/AP affinity metric for discovered switches
    dswitches_metrics_switch_ap_affinity_details:
      title: dswitches_metrics_switch_ap_affinity_details
      required:
      - system_name
      - threshold
      type: object
      properties:
        system_name:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Discovered switch system names reported for the affinity metric
        threshold:
          type: number
          description: APs-per-switch threshold used for the affinity metric
      description: Detail values used by the switch/AP affinity metric
    dswitches_metrics_version_compliance:
      title: dswitches_metrics_version_compliance
      required:
      - details
      - score
      type: object
      properties:
        details:
          allOf:
          - $ref: '#/components/schemas/dswitches_metrics_version_compliance_details2'
          - description: Version grouping details used to calculate the compliance score
        score:
          type: number
          description: Compliance score for the discovered-switch version metric
      description: Version compliance metric for discovered switches
    dswitches_metrics_version_compliance_details:
      title: dswitches_metrics_version_compliance_details
      required:
      - major_versions
      - total_switch_count
      type: object
      properties:
        major_versions:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/dswitches_compliance_major_version'
          description: Per-model major version groupings used for version compliance
        total_switch_count:
          type: integer
          description: Number of discovered switches evaluated for version compliance
          contentEncoding: int32
      description: Detail values used by the discovered-switch version compliance metric
    dynamic_psk_source:
      title: dynamic_psk_source
      enum:
      - cloud_psks
      - radius
      type: string
      description: 'Origin used to retrieve per-user PSKs. enum: `cloud_psks`, `radius`'
      examples:
      - cloud_psks
    edgeconnect_register_cmd:
      title: edgeconnect_register_cmd
      type: object
      properties:
        registration_code:
          type: string
          description: Registration code used to adopt an EdgeConnect device into Mist
      description: EdgeConnect device registration command response
    edr_provider:
      title: edr_provider
      enum:
      - crowdstrike
      - sentinelone
      type: string
      description: 'EDR provider associated with the NAC client. enum: `crowdstrike`, `sentinelone`'
    edr_status:
      title: edr_status
      enum:
      - sentinelone_healthy
      - sentinelone_infected
      - crowdstrike_low
      - crowdstrike_medium
      - crowdstrike_high
      - crowdstrike_critical
      - crowdstrike_informational
      type: string
      description: 'EDR Status of the NAC client. enum: `sentinelone_healthy`, `sentinelone_infected`, `crowdstrike_low`, `crowdstrike_medium`, `crowdstrike_high`, `crowdstrike_critical`, `crowdstrike_informational`'
    email_string:
      title: email_string
      required:
      - email
      type: object
      properties:
        email:
          type: string
          description: Request email address provided in the payload
          contentEncoding: email
      description: Request body containing an email address
    error_delete_failed:
      title: error_delete_failed
      required:
      - detail
      - org_id
      type: object
      properties:
        detail:
          type: string
          description: Reason the delete request failed
          examples:
          - inventory not empty
        org_id:
          type: string
          description: Organization that could not be deleted and caused the delete request to fail
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
      description: Error response returned when an organization delete request is blocked
    event_fastroam:
      title: event_fastroam
      required:
      - ap_mac
      - client_mac
      - fromap
      - latency
      - ssid
      - timestamp
      type: object
      properties:
        ap_mac:
          type: string
          description: Destination AP MAC address for the roam
        client_mac:
          type: string
          description: Roaming client MAC address for the event
        fromap:
          type: string
          description: Source AP MAC address reported for the roam
        latency:
          type: number
          description: Roaming latency measured for the client event, in seconds
        ssid:
          type: string
          description: Wireless network SSID involved in the roam
        subtype:
          type: string
          description: Detailed roaming event subtype
        timestamp:
          type: number
          description: Time when the roaming event occurred
          readOnly: true
        type:
          allOf:
          - $ref: '#/components/schemas/event_fastroam_type2'
          - description: 'Fast-roam result category for the event. enum: `fail`, `none`, `pingpong`, `poor`, `slow`, `success`.'
      description: Fast-roaming event observed for a wireless client
    event_fastroam_type:
      title: event_fastroam_type
      enum:
      - fail
      - none
      - pingpong
      - poor
      - slow
      - success
      type: string
      description: 'enum: `fail`, `none`, `pingpong`, `poor`, `slow`, `success`'
    event_otherdevice:
      title: event_otherdevice
      type: object
      properties:
        device_mac:
          type: string
          description: Attached device MAC address associated with the other-device event
        mac:
          type: string
          description: Other-device MAC address associated with the event
          examples:
          - 5c5b351e13b5
        org_id:
          type: string
          description: Organization that contains the other-device event
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        site_id:
          type: string
          description: Site where the other-device event occurred
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        text:
          type: string
          description: Human-readable message for the other-device event
          examples:
          - 'Plugged: The Internal 5GB (SIM1) has been inserted into Internal 1.'
        timestamp:
          type: number
          description: Time when the other-device event occurred
          readOnly: true
        type:
          type: string
          description: Event type for the other-device event
          examples:
          - CELLULAR_EDGE_MODEM_WAN_PLUGGED
        vendor:
          type: string
          description: Manufacturer or vendor name reported for the other device
          examples:
          - cradlepoint
      description: Event generated by an other-device integration or attached device
    event_severity:
      title: event_severity
      enum:
      - normal
      - critical
      - high
      - warning
      type: string
      description: 'Severity level for an event. enum: `normal`, `critical`, `high`, `warning`'
    events_client:
      title: events_client
      required:
      - band
      - timestamp
      type: object
      properties:
        ap:
          type: string
          description: Access point MAC address associated with the wireless client event
        band:
          allOf:
          - $ref: '#/components/schemas/dot11_band1'
          - description: 'Radio band used for the wireless client event. enum: `24`, `5`, `5-dedicated`, `5-selectable`, `6`, `6-dedicated`, `6-selectable`.'
        bssid:
          type: string
          description: Wireless BSSID involved in the client event
        channel:
          type: integer
          description: Radio channel used for the wireless client event
          contentEncoding: int32
        key_mgmt:
          allOf:
          - $ref: '#/components/schemas/client_key_mgmt1'
          - description: 'Key management protocol used by the client session. enum: `WPA2-PSK`, `WPA2-PSK/CCMP`, `WPA2-PSK-FT`, `WPA2-PSK-SHA256`, `WPA3-EAP-SHA256`, `WPA3-EAP-SHA256/CCMP`, `WPA3-EAP-FT/GCMP256`, `WPA3-SAE-FT`, `WPA3-SAE-PSK`.'
            examples:
            - WPA2-PSK
        proto:
          allOf:
          - $ref: '#/components/schemas/dot11_proto1'
          - description: '802.11 protocol used by the client session. enum: `a`, `ac`, `ax`, `b`, `be`, `g`, `n`.'
        ssid:
          type: string
          description: Wireless network SSID involved in the client event
        text:
          type: string
          description: Human-readable message for the client event
        timestamp:
          type: number
          description: Time when the client event occurred
          readOnly: true
        type:
          type: string
          description: Event type, e.g. MARVIS_EVENT_CLIENT_FBT_FAILURE
        type_code:
          type: integer
          description: Reason code for association or disassociation client events
          contentEncoding: int32
        wlan_id:
          type: string
          description: Wireless LAN identifier associated with the client event
          contentEncoding: uuid
      description: Wireless client event returned by client event search APIs
    events_client_wan:
      title: events_client_wan
      type: object
      properties:
        When:
          type: string
          description: Event timestamp string reported by the WAN client event source
          examples:
          - 2022-12-31 23:59:59.293000+00:00
        ev_type:
          type: string
          description: WAN client event type identifier
          examples:
          - CLIENT_IP_ASSIGNED
        metadata:
          type: object
          description: Additional attributes provided with the WAN client event
        org_id:
          type: string
          description: Organization that contains the WAN client event
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        random_mac:
          type: boolean
          description: Whether the WAN client used a randomized MAC address
        site_id:
          type: string
          description: Site where the WAN client event occurred
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        text:
          type: string
          description: Human-readable message for the WAN client event
          examples:
          - DHCP Ack IP 192.168.88.216
        wcid:
          type: string
          description: WAN client identifier associated with the event
          contentEncoding: uuid
          examples:
          - 62bbfb75-10d8-49d1-dec7-d2df91624287
      description: WAN client event returned by WAN client event search APIs
    events_rogue:
      title: events_rogue
      required:
      - ap
      - bssid
      - channel
      - rssi
      - ssid
      - timestamp
      type: object
      properties:
        ap:
          type: string
          description: Access point MAC address that detected the rogue BSSID
        bssid:
          type: string
          description: Rogue BSSID observed by the AP
        channel:
          type: integer
          description: Radio channel where the rogue BSSID was observed
          contentEncoding: int32
        rssi:
          type: integer
          description: Received signal strength of the rogue BSSID, in dBm
          contentEncoding: int32
        ssid:
          type: string
          description: Wireless network SSID advertised by the rogue BSSID
        timestamp:
          type: number
          description: Time when the rogue event was observed
          readOnly: true
      description: Rogue wireless network event detected by a site AP
    events_skyatp:
      title: events_skyatp
      required:
      - device_mac
      - ip
      - mac
      - org_id
      - site_id
      - threat_level
      - timestamp
      - type
      type: object
      properties:
        device_mac:
          type: string
          description: Network device MAC address that reported the SkyATP event
          readOnly: true
        for_site:
          type: boolean
          description: Whether the SkyATP event is scoped to a site rather than only the organization
          readOnly: true
        ip:
          type: string
          description: Client IP address associated with the SkyATP event
          readOnly: true
        mac:
          type: string
          description: Client MAC address associated with the SkyATP event
          readOnly: true
        org_id:
          type: string
          description: Organization that contains the SkyATP event
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        site_id:
          type: string
          description: Site where the SkyATP event occurred
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        threat_level:
          type: integer
          description: Numeric SkyATP threat level reported for the event
          contentEncoding: int32
          readOnly: true
        timestamp:
          type: number
          description: Time when the SkyATP event occurred
          readOnly: true
        type:
          type: string
          description: SkyATP event type, such as `cc`, `fs`, or `mw`
          readOnly: true
      description: SkyATP threat event returned by SkyATP event search APIs
    evpn_config:
      title: evpn_config
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether EVPN configuration is enabled on the switch
          readOnly: true
        role:
          allOf:
          - $ref: '#/components/schemas/evpn_config_role2'
          - description: 'EVPN topology role for the switch. enum: `access`, `border`, `collapsed-core`, `core`, `distribution`, `esilag-access`, `none`.'
          readOnly: true
      description: EVPN configuration settings applied to a Junos switch
    evpn_config_role:
      title: evpn_config_role
      enum:
      - access
      - border
      - collapsed-core
      - core
      - distribution
      - esilag-access
      - none
      type: string
      description: 'enum: `access`, `border`, `collapsed-core`, `core`, `distribution`, `esilag-access`, `none`'
    evpn_options:
      title: evpn_options
      type: object
      properties:
        auto_loopback_subnet:
          type: string
          description: Optional, for dhcp_relay, unique loopback IPs are required for ERB or IPClos where we can set option-82 server_id-overrides
          default: 172.16.192.0/24
        auto_loopback_subnet6:
          type: string
          description: Optional, for dhcp_relay, unique loopback IPs are required for ERB or IPClos where we can set option-82 server_id-overrides
          default: fd33:ab00:2::/64
        auto_router_id_subnet:
          type: string
          description: Optional, this generates router_id automatically, if specified, `router_id_prefix` is ignored
          default: 172.16.254.0/23
        auto_router_id_subnet6:
          type: string
          description: Optional, this generates router_id automatically, if specified, `router_id_prefix` is ignored
          examples:
          - fd31:5700:1::/64
        core_as_border:
          type: boolean
          description: Optional, for ERB or CLOS, you can either use esilag to upstream routers or to also be the virtual-gateway. When `routed_at` != `core`, whether to do virtual-gateway at core as well
          default: false
        enable_inband_mgmt:
          type: boolean
          description: Whether to route management traffic inband; routes will be propagated to downstream switches
          default: false
        enable_inband_ztp:
          type: boolean
          description: if the mangement traffic goes inbnd, during installation, only the border/core switches are connected to the Internet to allow initial configuration to be pushed down and leave the downstream access switches stay in the Factory Default state enabling inband-ztp allows upstream switches to use LLDP to assign IP and gives Internet to downstream switches in that state
          default: false
        overlay:
          allOf:
          - $ref: '#/components/schemas/evpn_options_overlay2'
          - description: EVPN overlay BGP settings for the topology
        per_vlan_vga_v4_mac:
          type: boolean
          description: Only for by Core-Distribution architecture when `evpn_options.routed_at`==`core`. By default, JUNOS uses 00-00-5e-00-01-01 as the virtual-gateway-address's v4_mac. If enabled, 00-00-5e-00-0X-YY will be used (where XX=vlan_id/256, YY=vlan_id%256)
          default: false
        per_vlan_vga_v6_mac:
          type: boolean
          description: Only for by Core-Distribution architecture when `evpn_options.routed_at`==`core`. By default, JUNOS uses 00-00-5e-00-02-01 as the virtual-gateway-address's v6_mac. If enabled, 00-00-5e-00-1X-YY will be used (where XX=vlan_id/256, YY=vlan_id%256)
          default: false
        routed_at:
          allOf:
          - $ref: '#/components/schemas/evpn_options_routed_at2'
          - description: 'Topology tier where EVPN virtual gateway routing is placed. enum: `core`, `distribution`, `edge`.'
        underlay:
          allOf:
          - $ref: '#/components/schemas/evpn_options_underlay2'
          - description: EVPN underlay BGP and subnet settings for the topology
        vs_instances:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/evpn_options_vs_instance'
          description: Virtual-switch instance mappings used to segregate EVPN networks
          examples:
          - guest:
              networks:
              - guest
            iot:
              networks:
              - iot-wifi
              - iot-lan
      description: EVPN topology generation options for campus fabric configuration
    evpn_options_overlay:
      title: evpn_options_overlay
      type: object
      properties:
        as:
          maximum: 65535
          minimum: 1
          type: integer
          description: Overlay BGP Local AS Number
          contentEncoding: int32
          default: 65000
          examples:
          - 65000
      description: EVPN overlay BGP settings
    evpn_options_routed_at:
      title: evpn_options_routed_at
      enum:
      - core
      - distribution
      - edge
      type: string
      description: 'optional, where virtual-gateway should reside. enum: `core`, `distribution`, `edge`'
    evpn_options_underlay:
      title: evpn_options_underlay
      type: object
      properties:
        as_base:
          maximum: 65535
          minimum: 1
          type: integer
          description: Underlay BGP Base AS Number
          contentEncoding: int32
          default: 65001
          examples:
          - 65001
        routed_id_prefix:
          type: string
          description: Prefix length used for automatically derived underlay router identifiers
          examples:
          - /24
        subnet:
          type: string
          description: Underlay subnet, by default, `10.255.240.0/20`, or `fd31:5700::/64` for ipv6
          examples:
          - 10.255.240.0/20
        use_ipv6:
          type: boolean
          description: If v6 is desired for underlay
          default: false
      description: EVPN underlay BGP and subnet settings
    evpn_options_vs_instance:
      title: evpn_options_vs_instance
      type: object
      properties:
        networks:
          uniqueItems: true
          type: array
          items:
            type: string
          description: List of network names included in this virtual-switch instance
      description: EVPN virtual-switch instance network mapping
    evpn_topology_response:
      title: evpn_topology_response
      type: object
      properties:
        created_time:
          type: number
          description: Timestamp when the EVPN topology was created
          readOnly: true
        evpn_options:
          allOf:
          - $ref: '#/components/schemas/evpn_options1'
          - description: Generation options applied to the EVPN topology
        for_site:
          type: boolean
          description: Whether the EVPN topology is scoped to a site rather than the organization
        id:
          type: string
          description: Unique identifier of the EVPN topology
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        modified_time:
          type: number
          description: Timestamp when the EVPN topology was last modified
          readOnly: true
        name:
          type: string
          description: Display name for the EVPN topology
          examples:
          - CC
        org_id:
          type: string
          description: Organization that owns the EVPN topology
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        overwrite:
          type: boolean
          description: Whether generated EVPN configuration changes are applied automatically
        pod_names:
          type: object
          additionalProperties:
            type: string
          description: Property key is the pod number
        site_id:
          type: string
          description: Site associated with the EVPN topology
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
      description: EVPN topology metadata returned by EVPN topology APIs
    evpn_topology:
      title: evpn_topology
      required:
      - switches
      type: object
      properties:
        created_time:
          type: number
          description: Timestamp when the EVPN topology was created
          readOnly: true
        evpn_options:
          allOf:
          - $ref: '#/components/schemas/evpn_options1'
          - description: Generation options applied to the EVPN topology
        id:
          type: string
          description: Unique identifier of the EVPN topology
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        modified_time:
          type: number
          description: Timestamp when the EVPN topology was last modified
          readOnly: true
        name:
          type: string
          description: Display name for the EVPN topology
          examples:
          - CC
        org_id:
          type: string
          description: Organization that owns the EVPN topology
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        overwrite:
          type: boolean
          description: Whether to apply generated EVPN configuration changes automatically
        pod_names:
          type: object
          additionalProperties:
            type: string
          description: Property key is the pod number
        site_id:
          type: string
          description: Site associated with the EVPN topology
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        switch_configs:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/evpn_topology_switch_config'
          description: Per-switch configuration overrides included in the EVPN topology
        switches:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/evpn_topology_switch'
          description: Topology member switches, roles, and links
      description: EVPN topology create or update payload
    evpn_topology_switch:
      title: evpn_topology_switch
      required:
      - mac
      - role
      type: object
      properties:
        config:
          allOf:
          - $ref: '#/components/schemas/evpn_topology_switch_config1'
          - description: Per-switch configuration supplied for this topology member. Use the [Update Site Device]($e/Sites%20Devices/updateSiteDevice) endpoint to update the switch configuration.
        deviceprofile_id:
          type: string
          description: Associated device profile identifier for the switch. Use the [Assign Org Device Profile]($e/Orgs%20Device%20Profiles/assignOrgDeviceProfile) endpoint to assign a Device Profile to the switch.
          contentEncoding: uuid
          readOnly: true
          examples:
          - 6a1deab1-96df-4fa2-8455-d5253f943d06
        downlink_ips:
          type: array
          items:
            type: string
          description: IP addresses used by this switch for EVPN downlinks
          readOnly: true
        downlinks:
          type: array
          items:
            type: string
          description: Switch MAC addresses connected as downlinks from this topology member
          examples:
          - - 5c5b35000005
            - 5c5b35000006
        esilaglinks:
          type: array
          items:
            type: string
          description: Switch MAC addresses connected through ESI-LAG from this topology member
          examples:
          - - 5c5b35000005
            - 5c5b35000006
        evpn_id:
          minimum: 1
          type: integer
          description: Topology identifier number for this EVPN switch member
          contentEncoding: int32
          readOnly: true
        mac:
          minLength: 1
          type: string
          description: Switch MAC address used to identify the topology member
          examples:
          - 5c5b35000003
        model:
          type: string
          description: Switch model for this topology member
          readOnly: true
          examples:
          - QFX10002-36Q
        pod:
          maximum: 255
          minimum: 1
          type: integer
          description: "Optionally, for distribution / access / esilag-access, they can be placed into different pods. e.g. \n  * for CLOS, to group dist / access switches into pods\n  * for ERB/CRB, to group dist / esilag-access into pods"
          contentEncoding: int32
          default: 1
        pods:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: List of pod numbers this switch participates in
        role:
          allOf:
          - $ref: '#/components/schemas/evpn_topology_switch_role2'
          - minLength: 1
            description: 'EVPN topology role for this switch. enum: `access`, `border`, `collapsed-core`, `core`, `distribution`, `esilag-access`, `none`.'
        router_id:
          type: string
          description: Routing identifier used by this switch for EVPN routing
          readOnly: true
          examples:
          - 172.16.254.4
        site_id:
          type: string
          description: Associated site for this EVPN topology switch
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        suggested_downlinks:
          type: array
          items:
            type: string
          description: Builder-suggested downlink switch MAC addresses
          readOnly: true
          examples:
          - - 5c5b35000005
            - 5c5b35000006
        suggested_esilaglinks:
          type: array
          items:
            type: string
          description: Builder-suggested ESI-LAG switch MAC addresses
          readOnly: true
          examples:
          - - 5c5b35000005
            - 5c5b35000006
        suggested_uplinks:
          type: array
          items:
            type: string
          description: Builder-suggested uplink switch MAC addresses
          readOnly: true
          examples:
          - - 5c5b35000005
            - 5c5b35000006
        uplinks:
          type: array
          items:
            type: string
          description: Switch MAC addresses connected as uplinks from this topology member
          examples:
          - - 5c5b35000005
            - 5c5b35000006
      description: Switch member of an EVPN topology, including role and link relationships
    evpn_topology_switch_config:
      title: evpn_topology_switch_config
      type: object
      properties:
        dhcpd_config:
          allOf:
          - $ref: '#/components/schemas/evpn_topology_switch_config_dhcpd_config2'
          - description: Switch DHCP server configuration for the topology member
        networks:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_network'
          description: EVPN network definitions for the topology member
        other_ip_configs:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/junos_other_ip_config'
          description: Additional interface IP configurations for the topology member
        port_config:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/junos_port_config'
          description: Switch port configuration for the topology member
        port_usages:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_port_usage'
          description: Switch port usage definitions for the topology member
        router_id:
          type: string
          description: Used for OSPF / BGP / EVPN
          examples:
          - 10.2.1.10
        vrf_config:
          allOf:
          - $ref: '#/components/schemas/evpn_topology_switch_config_vrf_config2'
          - description: Routing instance and VRF settings for the topology member
      description: Per-switch configuration used by an EVPN topology member
    evpn_topology_switch_config_dhcpd_config:
      title: evpn_topology_switch_config_dhcpd_config
      type: object
      properties:
        enabled:
          type: boolean
          description: If DHCPD is enabled on the switch
      description: DHCP server enablement for an EVPN topology switch override
    junos_other_ip_config:
      title: junos_other_ip_config
      type: object
      properties:
        evpn_anycast:
          type: boolean
          description: For EVPN, whether anycast is desired
          default: false
        ip:
          type: string
          description: Required if `type`==`static`; IPv4 address for the additional Junos L3 presence
          examples:
          - 10.3.3.1
        ip6:
          type: string
          description: Required if `type6`==`static`; IPv6 address for the additional Junos L3 presence
          examples:
          - fdad:b0bc:f29e::3d16
        netmask:
          type: string
          description: Optional IPv4 netmask; `subnet` from `network` definition will be used if defined
          examples:
          - 255.255.255.0
        netmask6:
          type: string
          description: Optional IPv6 prefix length; `subnet` from `network` definition will be used if defined
          examples:
          - /64
        type:
          allOf:
          - $ref: '#/components/schemas/ip_type3'
          - description: 'IPv4 assignment mode for the additional Junos L3 presence. enum: `dhcp`, `static`.'
            examples:
            - static
        type6:
          allOf:
          - $ref: '#/components/schemas/ip_type61'
          - description: 'IPv6 assignment mode for the additional Junos L3 presence. enum: `autoconf`, `dhcp`, `disabled`, `static`.'
            examples:
            - static
      description: Optional switch L3 presence on an additional network or VLAN
    evpn_topology_switch_config_vrf_config:
      title: evpn_topology_switch_config_vrf_config
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether to enable VRF (when supported on the device)
      description: VRF enablement for an EVPN topology switch override
    evpn_topology_switch_role:
      title: evpn_topology_switch_role
      enum:
      - access
      - border
      - collapsed-core
      - core
      - distribution
      - esilag-access
      - none
      type: string
      description: 'use `role`==`none` to remove a switch from the topology. enum: `access`, `border`, `collapsed-core`, `core`, `distribution`, `esilag-access`, `none`'
    extra_route:
      title: extra_route
      type: object
      properties:
        discard:
          type: boolean
          description: Whether to install a discard route; this takes precedence over next-hop settings
          default: false
        metric:
          maximum: 2147483647
          minimum: 0
          type:
          - integer
          - 'null'
          description: Route metric for the IPv4 static route
          contentEncoding: int32
        next_qualified:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/extra_route_next_qualified_properties'
          description: Qualified next-hop settings keyed by IPv4 next-hop address
          examples:
          - 10.3.1.1:
              metric: null
              preference: 40
        no_resolve:
          type: boolean
          description: Whether to prevent recursive next-hop resolution for the IPv4 static route
          default: false
        preference:
          maximum: 2147483647
          minimum: 0
          type:
          - integer
          - 'null'
          description: Route preference for the IPv4 static route
          contentEncoding: int32
          examples:
          - 30
        via:
          oneOf:
          - type: string
          - type: array
            items:
              type: string
          description: Next-hop IPv4 address or ECMP next-hop IPv4 addresses for the route
          examples:
          - 10.2.1.1
          - >-
            [
              "10.2.1.1",
              "10.2.1.2"
            ]
      description: IPv4 static route settings for a destination prefix
    extra_route6:
      title: extra_route6
      type: object
      properties:
        discard:
          type: boolean
          description: Whether to install a discard route; this takes precedence over next-hop settings
          default: false
        metric:
          maximum: 2147483647
          minimum: 0
          type:
          - integer
          - 'null'
          description: Route metric for the IPv6 static route
          contentEncoding: int32
        next_qualified:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/extra_route6_next_qualified_properties'
          description: Qualified next-hop settings keyed by IPv6 next-hop address
          examples:
          - 2a02:1234:200a::100:
              metric: null
              preference: 40
        no_resolve:
          type: boolean
          description: Whether to prevent recursive next-hop resolution for the IPv6 static route
          default: false
        preference:
          maximum: 2147483647
          minimum: 0
          type:
          - integer
          - 'null'
          description: Route preference for the IPv6 static route
          contentEncoding: int32
          examples:
          - 30
        via:
          oneOf:
          - type: string
          - type: array
            items:
              type: string
          description: Next-hop IPv6 address or ECMP next-hop IPv6 addresses for the route
          examples:
          - 10.2.1.1
          - >-
            [
              "10.2.1.1",
              "10.2.1.2"
            ]
      description: IPv6 static route settings for a destination prefix
    extra_route6_next_qualified_properties:
      title: extra_route6_next_qualified_properties
      type: object
      properties:
        metric:
          type:
          - integer
          - 'null'
          description: Route metric for this qualified IPv6 next hop
          contentEncoding: int32
        preference:
          type:
          - integer
          - 'null'
          description: Route preference for this qualified IPv6 next hop
          contentEncoding: int32
      description: Qualified next-hop attributes for an IPv6 static route
    extra_route_next_qualified_properties:
      title: extra_route_next_qualified_properties
      type: object
      properties:
        metric:
          type:
          - integer
          - 'null'
          description: Route metric for this qualified IPv4 next hop
          contentEncoding: int32
        preference:
          type:
          - integer
          - 'null'
          description: Route preference for this qualified IPv4 next hop
          contentEncoding: int32
      description: Qualified next-hop attributes for an IPv4 static route
    fast_roam_result:
      title: fast_roam_result
      enum:
      - fail
      - none
      - success
      type: string
      description: 'enum: `fail`, `none`, `success`'
    fingerprint:
      title: fingerprint
      type: object
      properties:
        family:
          type: string
          description: Device family or category inferred from client fingerprinting
          readOnly: true
        mac:
          type: string
          description: Client device MAC address for the fingerprint record
          readOnly: true
        mfg:
          type: string
          description: Manufacturer name inferred from client fingerprinting
          readOnly: true
        model:
          type: string
          description: Device model inferred from client fingerprinting
          readOnly: true
        org_id:
          type: string
          description: Organization that contains the fingerprint record
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        os:
          type: string
          description: Operating system name and version inferred from client fingerprinting
          readOnly: true
        os_type:
          type: string
          description: Operating system family inferred from client fingerprinting
          readOnly: true
        random_mac:
          type: boolean
          description: Whether the client device uses a randomized MAC address
          readOnly: true
        site_id:
          type: string
          description: Site associated with the fingerprint record
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        timestamp:
          type: number
          description: Time when the fingerprint record was observed
          readOnly: true
      description: Client device fingerprint record returned by NAC fingerprint insights
    fingerprint_search_result:
      title: fingerprint_search_result
      required:
      - end
      - limit
      - results
      - start
      - total
      type: object
      properties:
        end:
          type: integer
          description: Upper bound of the time range for the fingerprint search
          contentEncoding: int32
          examples:
          - 1711035686
        limit:
          type: integer
          description: Maximum number of fingerprint records returned in the response
          contentEncoding: int32
          examples:
          - 10
        next:
          type: string
          description: Pagination URL for the next page of fingerprint search results
        results:
          type: array
          items:
            $ref: '#/components/schemas/fingerprint'
          description: Fingerprint records returned for the search
        start:
          type: integer
          description: Lower bound of the time range for the fingerprint search
          contentEncoding: int32
          examples:
          - 1710949286
        total:
          type: integer
          description: Number of fingerprint records matching the search
          contentEncoding: int32
          examples:
          - 232
      description: Search response for client device fingerprint records
    fingerprints_count_distinct:
      title: fingerprints_count_distinct
      enum:
      - family
      - model
      - os
      - os_type
      type: string
      description: 'enum: `family`, `model`, `os`, `os_type`'
    flow_record:
      title: flow_record
      type: object
      properties:
        device_mac:
          type: string
          description: MAC address of the device
        direction:
          allOf:
          - $ref: '#/components/schemas/flow_record_direction'
          - description: 'Flow direction. enum: `egress`, `ingress`'
        dst_ip:
          type: string
          description: Destination IP address
        dst_port:
          type: integer
          description: Destination port number
          contentEncoding: int32
        duration:
          type: integer
          description: Flow duration in seconds
          contentEncoding: int64
        end_time:
          type: integer
          description: Flow end time in epoch seconds
          contentEncoding: int64
        flow_id:
          type: integer
          description: Unique flow identifier
          contentEncoding: int64
        org_id:
          type: string
          description: UUID of the org
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        protocol:
          type: string
          description: Protocol (e.g. `tcp`, `udp`, `icmp`)
        sampling_percentage:
          type: number
          description: Percentage of packets sampled (e.g. `0.1` means 0.1% of packets are captured via sFlow; `100.0` means all packets are captured via FBT)
        site_id:
          type: string
          description: UUID of the site
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        src_ip:
          type: string
          description: Source IP address
        src_port:
          type: integer
          description: Source port number
          contentEncoding: int32
        start_time:
          type: integer
          description: Flow start time in epoch seconds
          contentEncoding: int64
        state:
          allOf:
          - $ref: '#/components/schemas/flow_record_state'
          - description: 'Flow state. enum: `active`, `aged-out`'
        timestamp:
          type: integer
          description: Epoch time (in seconds) when the flow record was last updated or completed
          contentEncoding: int64
        total_bytes:
          type: integer
          description: Total number of bytes in the flow
          contentEncoding: int64
        total_pkts:
          type: integer
          description: Total number of packets in the flow
          contentEncoding: int64
      description: Network flow record reported by a switch device
    flow_record_direction:
      title: flow_record_direction
      enum:
      - egress
      - ingress
      type: string
      description: 'Flow direction. enum: `egress`, `ingress`'
    flow_record_state:
      title: flow_record_state
      enum:
      - active
      - aged-out
      type: string
      description: 'Flow state. enum: `active`, `aged-out`'
    for_site:
      title: for_site
      enum:
      - any
      - 'true'
      - 'false'
      type: string
      description: 'enum: `any`, `true`, `false`'
    fwupdate_stat:
      title: fwupdate_stat
      type: object
      properties:
        progress:
          maximum: 100
          minimum: 0
          type:
          - integer
          - 'null'
          description: Firmware update progress percentage, or null when unavailable
          contentEncoding: int32
          readOnly: true
          examples:
          - 10
        status:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/fwupdate_stat_status2'
          - description: 'Current firmware update status. enum: `inprogress`, `failed`, `upgraded`, `success`, `scheduled`, `error`.'
          readOnly: true
        status_id:
          type:
          - integer
          - 'null'
          description: Numeric firmware update status identifier
          contentEncoding: int32
          readOnly: true
          examples:
          - 5
        timestamp:
          type: number
          description: Time when the firmware update status was last updated
          readOnly: true
        will_retry:
          type:
          - boolean
          - 'null'
          description: Whether the firmware update process will retry after the current status
          readOnly: true
          examples:
          - false
      description: Firmware update status for a device
    fwupdate_stat_status:
      title: fwupdate_stat_status
      enum:
      - inprogress
      - failed
      - upgraded
      - success
      - scheduled
      - error
      type: string
      description: 'enum: `inprogress`, `failed`, `upgraded`, `success`, `scheduled`, `error`'
    gateway_cluster:
      title: gateway_cluster
      required:
      - nodes
      type: object
      properties:
        nodes:
          maxItems: 2
          minItems: 1
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/gateway_cluster_node'
          description: Gateway nodes that form the HA cluster
      description: Gateway HA cluster request or response body
    gateway_cluster_node:
      title: gateway_cluster_node
      required:
      - mac
      type: object
      properties:
        mac:
          type: string
          description: Gateway device MAC address. Format is `[0-9a-f]{12}` (e.g. "5684dae9ac8b")
      description: Gateway cluster node identified by MAC address
    gateway_compliance_major_version_properties:
      title: gateway_compliance_major_version_properties
      type: object
      properties:
        major_count:
          type: integer
          description: Number of gateways counted in this major-version compliance entry
          contentEncoding: int32
        major_version:
          type: string
          description: Gateway software major version represented by this compliance entry
          examples:
          - 19.4R2-S1.2
      description: Version-compliance details for one gateway model
    gateway_compliance_version:
      title: gateway_compliance_version
      type: object
      properties:
        major_version:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/gateway_compliance_major_version_properties'
          description: Per-model gateway major-version compliance details
        score:
          type: number
          description: Gateway software version compliance score
          examples:
          - 99.9
        type:
          type: string
          description: Device type represented by the gateway compliance metric
          examples:
          - gateway
      description: Version compliance metric for gateway devices
    gateway_extra_route:
      title: gateway_extra_route
      type: object
      properties:
        via:
          type: string
          description: Next-hop IPv4 address for the gateway extra route
          contentEncoding: ipv4
      description: Gateway IPv4 extra route next-hop settings
    gateway_extra_route6:
      title: gateway_extra_route6
      type: object
      properties:
        via:
          type: string
          description: Next-hop IPv6 address for the gateway extra route
          contentEncoding: ipv6
      description: Gateway IPv6 extra route next-hop settings
    idp_profile:
      title: idp_profile
      type: object
      properties:
        base_profile:
          allOf:
          - $ref: '#/components/schemas/idp_profile_base_profile2'
          - description: 'Built-in IDP baseline profile inherited before applying overwrites. enum: `critical`, `standard`, `strict`.'
            examples:
            - strict
        created_time:
          type: number
          description: Timestamp when the IDP profile was created
          readOnly: true
        id:
          type: string
          description: Unique identifier of the IDP profile
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        modified_time:
          type: number
          description: Timestamp when the IDP profile was last modified
          readOnly: true
        name:
          type: string
          description: Display name of the IDP profile
          examples:
          - relaxed
        org_id:
          type: string
          description: Owning organization for the IDP profile
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        overwrites:
          type: array
          items:
            $ref: '#/components/schemas/idp_profile_overwrite'
          description: IDP signature override rules applied on top of the base profile
      description: Organization IDP profile with a base profile and targeted overwrite rules
    gateway_ip_config_property:
      title: gateway_ip_config_property
      type: object
      properties:
        ip:
          type: string
          description: Static IPv4 address for the gateway network interface when `type`==`static`
          contentEncoding: ipv4
        ip6:
          type: string
          description: Static IPv6 address for the gateway network interface when `type6`==`static`
          contentEncoding: ipv6
        netmask:
          type: string
          description: IPv4 netmask or prefix length for the gateway network interface when `type`==`static`
          examples:
          - /24
        netmask6:
          type: string
          description: IPv6 netmask or prefix length for the gateway network interface when `type6`==`static`
          examples:
          - 2001:db8:abcd:12::1
        secondary_ips:
          type: array
          items:
            type: string
          description: Additional IPv4 addresses in CIDR notation for this gateway network interface
          examples:
          - - 192.168.50.1/24
            - 192.168.60.1/26
        type:
          allOf:
          - $ref: '#/components/schemas/ip_type4'
          - description: 'IPv4 address assignment mode for this gateway network interface. enum: `dhcp`, `static`.'
            examples:
            - static
        type6:
          allOf:
          - $ref: '#/components/schemas/ip_type62'
          - description: 'IPv6 address assignment mode for this gateway network interface. enum: `autoconf`, `dhcp`, `disabled`, `static`.'
            examples:
            - static
      description: Gateway network interface IP configuration
    gateway_matching:
      title: gateway_matching
      type: object
      properties:
        enable:
          type: boolean
          description: Whether gateway matching is enabled
        rules:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/gateway_matching_rule'
          description: Gateway matching rules evaluated for this configuration
      description: Gateway matching configuration used to apply gateway-specific settings
    gateway_matching_rule:
      title: gateway_matching_rule
      type: object
      properties:
        additional_config_cmds:
          type: array
          items:
            type: string
          description: For SRX only, additional Junos CLI commands appended when this gateway matching rule applies
        name:
          type: string
          description: Display name for the gateway matching rule
        port_config:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/gateway_port_config'
          description: Property key is the port(s) name or range (e.g. "ge-0/0/0-10").
      additionalProperties:
        type: string
        description: 'Property key defines the type of matching. e.g: `match_name[0:3]`, `match_model[0-6]` or `match_role`'
      description: Gateway matching rule that applies settings when its match keys select a gateway
    gateway_metrics:
      title: gateway_metrics
      type: object
      properties:
        config_success:
          type: number
          description: Gateway configuration success score
          examples:
          - 99.9
        version_compliance:
          allOf:
          - $ref: '#/components/schemas/gateway_compliance_version1'
          - description: Gateway software version compliance metric
      description: Gateway metric scores returned by the site gateway metrics API
    gateway_mgmt:
      title: gateway_mgmt
      type: object
      properties:
        admin_sshkeys:
          type: array
          items:
            type: string
          description: SSR-only SSH public keys for administrative access
          examples:
          - - ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAA...Wxa6p6UW0ZbcP john@host
        app_probing:
          allOf:
          - $ref: '#/components/schemas/app_probing1'
          - description: Application probing configuration for gateway monitoring
        app_usage:
          type: boolean
          description: Consumes uplink bandwidth, requires WA license
        auto_signature_update:
          allOf:
          - $ref: '#/components/schemas/gateway_mgmt_auto_signature_update2'
          - description: Schedule for automatic security signature updates
        config_revert_timer:
          maximum: 30
          minimum: 1
          type: integer
          description: Rollback timer for commit confirmed
          contentEncoding: int32
          default: 10
        disable_console:
          type: boolean
          description: For SSR and SRX, disable console port
          default: false
        disable_idp_pcap:
          type: boolean
          description: For SRX only, disable IDP packet capture
          default: false
        disable_oob:
          type: boolean
          description: For SSR and SRX, disable management interface
          default: false
        disable_usb:
          type: boolean
          description: For SSR and SRX, disable usb interface
          default: false
        fips_enabled:
          type: boolean
          description: Whether FIPS mode is enabled on the gateway
          default: false
        probe_hosts:
          type: array
          items:
            type: string
          description: IPv4 probe targets used for gateway connectivity checks
          examples:
          - - 8.8.8.8
        probe_hostsv6:
          type: array
          items:
            type: string
          description: IPv6 probe targets used for gateway connectivity checks
          examples:
          - - 2001:4860:4860::8888
        protect_re:
          allOf:
          - $ref: '#/components/schemas/protect_re1'
          - description: Control-plane protection settings for the gateway
        root_password:
          type: string
          description: SRX only. Root password for local gateway access
          contentEncoding: password
        security_log_source_address:
          type: string
          description: IPv4 source address used for gateway security log traffic
          contentEncoding: ipv4
          examples:
          - 192.168.1.1
        security_log_source_interface:
          type: string
          description: Source interface used for gateway security log traffic
          examples:
          - ge-0/0/1.0
      description: Gateway management-plane and access settings
    gateway_mgmt_auto_signature_update:
      title: gateway_mgmt_auto_signature_update
      type: object
      properties:
        day_of_week:
          allOf:
          - $ref: '#/components/schemas/day_of_week1'
          - description: 'Scheduled weekday for automatic signature updates. enum: `any`, `fri`, `mon`, `sat`, `sun`, `thu`, `tue`, `wed`.'
        enable:
          type: boolean
          description: Whether automatic security signature updates are enabled
          default: true
        time_of_day:
          type: string
          description: Optional, Mist will decide the timing
      description: Automatic security signature update schedule
    gateway_mgmt_host_out_policy:
      title: gateway_mgmt_host_out_policy
      type: object
      properties:
        path_preference:
          type: string
          description: Preferred path name for this gateway-originated service traffic
      description: Host-out path policy for gateway-originated management traffic
    gateway_mgmt_host_out_policy_syslog:
      title: gateway_mgmt_host_out_policy_syslog
      type: object
      properties:
        path_preference:
          type: string
          description: Preferred path name used by default for gateway syslog traffic
          examples:
          - broadband_wans
        servers:
          type: array
          items:
            $ref: '#/components/schemas/gateway_mgmt_host_out_policy_syslog_server'
          description: Per-server host-out path policies for gateway syslog traffic
      description: Host-out path policy for gateway syslog traffic
    gateway_mgmt_host_out_policy_syslog_server:
      title: gateway_mgmt_host_out_policy_syslog_server
      type: object
      properties:
        host:
          type: string
          description: Syslog server hostname or IP address
          examples:
          - 103.35.3.5
        path_preference:
          type: string
          description: Preferred path name used for this syslog server
          examples:
          - dc_only
        server_name:
          type: string
          description: Remote syslog server name referenced by the policy
          examples:
          - dc_syslog_server
      description: Per-syslog-server host-out path policy override
    gateway_oob_ip_config:
      title: gateway_oob_ip_config
      type: object
      properties:
        gateway:
          type: string
          description: Default gateway for the out-of-band management interface when `type`==`static`
        ip:
          type: string
          description: Static IPv4 address for the out-of-band management interface when `type`==`static`
        netmask:
          type: string
          description: IPv4 netmask or prefix length for the out-of-band management interface when `type`==`static`
        node1:
          allOf:
          - $ref: '#/components/schemas/gateway_oob_ip_config_node12'
          - description: Out-of-band management IP configuration override for node1 in an HA cluster
        type:
          allOf:
          - $ref: '#/components/schemas/ip_type2'
          - description: 'IP assignment mode for the out-of-band management interface. enum: `dhcp`, `static`.'
            examples:
            - static
        use_mgmt_vrf:
          type: boolean
          description: If supported on the platform. If enabled, DNS will be using this routing-instance, too
          default: false
        use_mgmt_vrf_for_host_out:
          type: boolean
          description: For host-out traffic (NTP/TACPLUS/RADIUS/SYSLOG/SNMP), if alternative source network/ip is desired
          default: false
        vlan_id:
          oneOf:
          - type: string
          - maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
          description: VLAN ID used for out-of-band management traffic
      description: Out-of-band management IP configuration for gateway interfaces such as vme, em0, or fxp0
    gateway_oob_ip_config_node1:
      title: gateway_oob_ip_config_node1
      type: object
      properties:
        gateway:
          type: string
          description: Default gateway for the node1 out-of-band management interface when `type`==`static`
        ip:
          type: string
          description: Static IPv4 address for the node1 out-of-band management interface when `type`==`static`
        netmask:
          type: string
          description: IPv4 netmask or prefix length for the node1 out-of-band management interface when `type`==`static`; used only if `subnet` is not specified in `networks`
        type:
          allOf:
          - $ref: '#/components/schemas/ip_type5'
          - description: 'IP assignment mode for the node1 out-of-band management interface. enum: `dhcp`, `static`.'
            examples:
            - static
        use_mgmt_vrf:
          type: boolean
          description: If supported on the platform. If enabled, DNS will be using this routing-instance, too
          default: false
        use_mgmt_vrf_for_host_out:
          type: boolean
          description: Whether to use `mgmt_junos` for host-out traffic (NTP/TACPLUS/RADIUS/SYSLOG/SNMP), if alternative source network/ip is desired
          default: false
        vlan_id:
          oneOf:
          - type: string
          - maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
          description: VLAN ID used for node1 out-of-band management traffic
      description: Node1-specific out-of-band management IP configuration for HA clusters
    gateway_path_preferences:
      title: gateway_path_preferences
      type: object
      properties:
        paths:
          type: array
          items:
            $ref: '#/components/schemas/gateway_path_preferences_path'
          description: Candidate paths evaluated for this gateway path preference
        strategy:
          allOf:
          - $ref: '#/components/schemas/gateway_path_strategy2'
          - description: 'Selection strategy used to evaluate the candidate paths. enum: `ecmp`, `ordered`, `weighted`.'
      description: Gateway path preference that selects among one or more local, WAN, VPN, or tunnel paths
    gateway_path_preferences_path:
      title: gateway_path_preferences_path
      required:
      - type
      type: object
      properties:
        cost:
          type: integer
          description: Relative cost assigned to this path for gateway path selection
          contentEncoding: int32
        disabled:
          type: boolean
          description: For SSR Only. `true`, if this specific path is undesired
        gateway_ip:
          type: string
          description: Only if `type`==`local`, if a different gateway is desired
        internet_access:
          type: boolean
          description: Only if `type`==`vpn`, if this vpn path can be used for internet
        name:
          type: string
          description: "Required when \n  * `type`==`vpn`: the name of the VPN Path to use \n  * `type`==`wan`: the name of the WAN interface to use"
        networks:
          type: array
          items:
            type: string
          description: List of network names used when `type`==`local`
        target_ips:
          type: array
          items:
            type: string
          description: List of destination IP addresses to replace when `type`==`local`
        type:
          allOf:
          - $ref: '#/components/schemas/gateway_path_type2'
          - description: Gateway path source type, such as local network, WAN interface, VPN path, or tunnel
        wan_name:
          type: string
          description: Optional if `type`==`vpn`; WAN interface name associated with the VPN path
          examples:
          - wan0
      description: Candidate path within a gateway path preference
    gateway_path_strategy:
      title: gateway_path_strategy
      enum:
      - ecmp
      - ordered
      - weighted
      type: string
      description: 'enum: `ecmp`, `ordered`, `weighted`'
    gateway_path_type:
      title: gateway_path_type
      enum:
      - local
      - tunnel
      - vpn
      - wan
      type: string
      description: 'enum: `local`, `tunnel`, `vpn`, `wan`'
    gateway_port_config:
      title: gateway_port_config
      required:
      - usage
      type: object
      properties:
        ae_disable_lacp:
          type: boolean
          description: If `aggregated`==`true`. To disable LCP support for the AE interface
          default: false
        ae_idx:
          type:
          - string
          - 'null'
          description: If `aggregated`==`true`. Users could force to use the designated AE name (must be an integer between 0 and 127)
        ae_lacp_force_up:
          type: boolean
          description: 'For SRX only, if `aggregated`==`true`.Sets the state of the interface as UP when the peer has limited LACP capability. Use case: When a device connected to this AE port is ZTPing for the first time, it will not have LACP configured on the other end. **Note:** Turning this on will enable force-up on one of the interfaces in the bundle only'
          default: false
        aggregated:
          type: boolean
          description: Whether the port participates in an aggregated Ethernet interface
          default: false
        critical:
          type: boolean
          description: To generate port up/down alarm, set it to true
          default: false
        description:
          type: string
          description: Interface Description. Can be a variable (i.e. "{{myvar}}")
        disable_autoneg:
          type: boolean
          description: Whether Ethernet autonegotiation is disabled on the port
          default: false
        disabled:
          type: boolean
          description: Port admin up (true) / down (false)
          default: false
        dsl_type:
          allOf:
          - $ref: '#/components/schemas/gateway_port_dsl_type2'
          - description: 'If `wan_type`==`dsl`. DSL technology used by the WAN port. enum: `adsl`, `vdsl`.'
        dsl_vci:
          type: integer
          description: If `wan_type`==`dsl`, 16 bit int
          contentEncoding: int32
          default: 35
        dsl_vpi:
          type: integer
          description: If `wan_type`==`dsl`, 8 bit int
          contentEncoding: int32
          default: 0
        duplex:
          allOf:
          - $ref: '#/components/schemas/gateway_port_duplex2'
          - description: 'Ethernet duplex mode configured on the port. enum: `auto`, `full`, `half`.'
            examples:
            - full
        ip_config:
          allOf:
          - $ref: '#/components/schemas/gateway_port_config_ip_config2'
          - description: Layer 3 IP configuration for the port
        lte_apn:
          type: string
          description: If `wan_type`==`lte`. APN used by the LTE uplink
        lte_auth:
          allOf:
          - $ref: '#/components/schemas/gateway_port_lte_auth2'
          - description: 'If `wan_type`==`lte`. Authentication method used by the LTE uplink. enum: `chap`, `none`, `pap`.'
        lte_backup:
          type: boolean
          description: Whether the LTE uplink is used as a backup WAN connection
        lte_password:
          type: string
          description: If `wan_type`==`lte`. Password used for LTE uplink authentication
          contentEncoding: password
        lte_username:
          type: string
          description: If `wan_type`==`lte`. Username used for LTE uplink authentication
        mtu:
          type: integer
          description: Layer 3 MTU configured on the port
          contentEncoding: int32
        name:
          type: string
          description: Interface name used to derive device configuration
        networks:
          type: array
          items:
            type: string
          description: If `usage`==`lan`. Networks attached to the interface
        outer_vlan_id:
          type: integer
          description: For Q-in-Q. Outer VLAN ID used for QinQ encapsulation
          contentEncoding: int32
        poe_disabled:
          type: boolean
          description: Whether PoE output is disabled on the port
          default: false
        poe_keep_state_when_reboot:
          type: boolean
          description: Whether Perpetual PoE capabilities are enabled for a port
          default: false
        port_network:
          type: string
          description: Only for SRX and if `usage`==`lan`, the name of the Network to be used as the Untagged VLAN
        preserve_dscp:
          type: boolean
          description: Whether to preserve dscp when sending traffic over VPN (SSR-only)
          default: true
        redundant:
          type: boolean
          description: If HA mode. Whether the port participates in the redundant Ethernet configuration
        redundant_group:
          maximum: 128
          minimum: 1
          type: integer
          description: If HA mode, SRX Only - support redundancy-group. 1-128 for physical SRX, 1-64 for virtual SRX
          contentEncoding: int32
        reth_idx:
          anyOf:
          - type: integer
            contentEncoding: int32
          - type: string
          description: If HA mode and for SRX only. Redundant Ethernet interface index assigned to the port
        reth_node:
          type: string
          description: If HA mode. Node associated with the redundant Ethernet interface
        reth_nodes:
          type: array
          items:
            type: string
          description: If HA mode and for SSR only. Per-network node assignment used for VLAN-based redundancy
          examples:
          - - node0
            - node1
        speed:
          type: string
          description: Link speed configured on the port
          default: auto
          examples:
          - 1g
        ssr_no_virtual_mac:
          type: boolean
          description: When SSR is running as VM, this is required on certain hosting platforms
          default: false
        svr_port_range:
          type: string
          description: For SSR only. Port range configured on the interface
          default: none
          examples:
          - 60000-60005
        traffic_shaping:
          allOf:
          - $ref: '#/components/schemas/gateway_traffic_shaping3'
          - description: Traffic shaping settings applied to the port
        usage:
          allOf:
          - $ref: '#/components/schemas/gateway_port_usage2'
          - description: 'Logical usage assigned to the port. enum: `ha_control`, `ha_data`, `lan`, `wan`.'
        vlan_id:
          oneOf:
          - type: string
          - maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
          description: VLAN ID or variable used when the WAN interface is carried on a VLAN
        vpn_paths:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/gateway_port_vpn_path'
          description: Per-VPN path settings for traffic that uses this port
        wan_arp_policer:
          allOf:
          - $ref: '#/components/schemas/gateway_port_wan_arp_policer2'
          - description: 'Only when `wan_type`==`broadband`. ARP policer profile applied to the WAN port. enum: `default`, `max`, `recommended`.'
        wan_ext_ip:
          type: string
          description: Only if `usage`==`wan`, optional. If spoke should reach this port by a different IP
          examples:
          - 64.2.4.3
        wan_ext_ip6:
          type: string
          description: Only if `usage`==`wan`, optional. If spoke should reach this port by a different IPv6
          examples:
          - 2601:1700:43c0:dc0::10
        wan_extra_routes:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/wan_extra_routes'
          description: Only if `usage`==`wan`. Property Key is the destination CIDR (e.g. "100.100.100.0/24")
        wan_extra_routes6:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/wan_extra_routes6'
          description: Only if `usage`==`wan`. Property Key is the destination CIDR (e.g. "2a02:1234:420a:10c9::/64")
        wan_networks:
          type: array
          items:
            type: string
          description: Only if `usage`==`wan`. Networks reachable through this WAN port for policy definition
        wan_probe_override:
          allOf:
          - $ref: '#/components/schemas/gateway_wan_probe_override2'
          - description: Optional WAN health probe override settings for this port
        wan_source_nat:
          allOf:
          - $ref: '#/components/schemas/gateway_port_wan_source_nat2'
          - description: Source NAT settings applied to traffic leaving this WAN port
        wan_speedtest_mode:
          allOf:
          - $ref: '#/components/schemas/gateway_port_config_wan_speedtest_mode2'
          - description: 'Controls whether Marvis or the scheduler can run speed tests on this WAN port. enum: `auto`, `enabled`, `disabled`.'
            examples:
            - auto
        wan_type:
          allOf:
          - $ref: '#/components/schemas/gateway_port_wan_type2'
          - description: 'Only if `usage`==`wan`. WAN uplink type configured on the port. enum: `broadband`, `dsl`, `lte`.'
      description: Gateway port configuration for LAN, WAN, tunnel, and HA interfaces
    gateway_port_config_ip_config:
      title: gateway_port_config_ip_config
      type: object
      properties:
        dns:
          type: array
          items:
            type: string
          description: Resolver server IP addresses used by this interface, except on out-of-band interfaces such as vme, em0, or fxp0
        dns_suffix:
          type: array
          items:
            type: string
          description: DNS search suffixes used by this interface, except on out-of-band interfaces such as vme, em0, or fxp0
        gateway:
          type: string
          description: Except for out-of_band interface (vme/em0/fxp0). Interface Default Gateway IP address (i.e. "192.168.1.1") or a Variable (i.e. "{{myvar}}")
          examples:
          - 192.168.1.1
        gateway6:
          type: string
          description: Except for out-of_band interface (vme/em0/fxp0). Interface Default Gateway IPv6 Address (i.e. "2001:db8::1") or a Variable (i.e. "{{myvar}}")
          examples:
          - 2001:db8::1
        ip:
          type: string
          description: Interface IP address (i.e. "192.168.1.8") or a Variable (i.e. "{{myvar}}")
          contentEncoding: ipv4
          examples:
          - 192.168.1.8
        ip6:
          type: string
          description: Interface IPv6 Address (i.e. "2001:db8::123") or a Variable (i.e. "{{myvar}}")
          contentEncoding: ipv6
          examples:
          - 2001:db8::123
        netmask:
          type: string
          description: Used only if `subnet` is not specified in `networks`. Interface Netmask (i.e. "/24") or a Variable (i.e. "{{myvar}}")
          examples:
          - /24
        netmask6:
          type: string
          description: Used only if `subnet` is not specified in `networks`. Interface IPv6 Netmask (i.e. "/64") or a Variable (i.e. "{{myvar}}")
          examples:
          - /64
        network:
          type: string
          description: Optional, the network to be used for mgmt
        poser_password:
          type: string
          description: Password used for PPPoE when `type`==`pppoe`
          contentEncoding: password
        pppoe_auth:
          allOf:
          - $ref: '#/components/schemas/gateway_wan_ppoe_auth2'
          - description: 'Authentication protocol used for PPPoE when `type`==`pppoe`. enum: `chap`, `none`, `pap`.'
        pppoe_username:
          type: string
          description: Username used for PPPoE when `type`==`pppoe`
        type:
          allOf:
          - $ref: '#/components/schemas/gateway_wan_type2'
          - description: 'IPv4 assignment mode for this gateway port interface. enum: `dhcp`, `pppoe`, `static`.'
        type6:
          allOf:
          - $ref: '#/components/schemas/gateway_wan_type62'
          - description: 'IPv6 assignment mode for this gateway port interface. enum: `autoconf`, `dhcp`, `static`.'
      description: Junos IP configuration for a gateway port interface
    gateway_port_config_wan_speedtest_mode:
      title: gateway_port_config_wan_speedtest_mode
      enum:
      - auto
      - enabled
      - disabled
      type: string
      description: 'Controls whether Marvis/scheduler can run speedtest on this port. enum: `auto`, `enabled`, `disabled`'
      examples:
      - auto
    gateway_port_dsl_type:
      title: gateway_port_dsl_type
      enum:
      - adsl
      - vdsl
      type: string
      description: 'if `wan_type`==`dsl`. enum: `adsl`, `vdsl`'
    gateway_port_duplex:
      title: gateway_port_duplex
      enum:
      - auto
      - full
      - half
      type: string
      description: 'enum: `auto`, `full`, `half`'
      examples:
      - full
    gateway_port_lte_auth:
      title: gateway_port_lte_auth
      enum:
      - chap
      - none
      - pap
      type: string
      description: 'if `wan_type`==`lte`. enum: `chap`, `none`, `pap`'
    gateway_port_mirroring:
      title: gateway_port_mirroring
      type: object
      properties:
        port_mirror:
          allOf:
          - $ref: '#/components/schemas/gateway_port_mirroring_port_mirror2'
          - description: Mirroring rule that copies ingress traffic from source ports to an output port
      description: Port mirroring settings for a gateway interface
    gateway_port_mirroring_port_mirror:
      title: gateway_port_mirroring_port_mirror
      type: object
      properties:
        family_type:
          type: string
          description: Packet family used for this port mirroring rule
        ingress_port_ids:
          type: array
          items:
            type: string
          description: Source gateway port IDs whose ingress traffic is mirrored
        output_port_id:
          type: string
          description: Destination gateway port ID that receives mirrored traffic
          examples:
          - ge-0/0/5
        rate:
          type: integer
          description: Sampling rate applied to mirrored traffic
          contentEncoding: int32
        run_length:
          minimum: 0
          type: integer
          description: Number of bytes copied from each mirrored packet
          contentEncoding: int32
      description: Gateway port mirroring rule
    gateway_port_usage:
      title: gateway_port_usage
      enum:
      - ha_control
      - ha_data
      - lan
      - wan
      type: string
      description: 'port usage name. enum: `ha_control`, `ha_data`, `lan`, `wan`'
    gateway_port_vpn_path:
      title: gateway_port_vpn_path
      type: object
      properties:
        bfd_profile:
          allOf:
          - $ref: '#/components/schemas/gateway_port_vpn_path_bfd_profile2'
          - description: 'BFD profile used for this VPN path when the VPN `type`==`hub_spoke`. enum: `broadband`, `lte`.'
        bfd_use_tunnel_mode:
          type: boolean
          description: Only if the VPN `type`==`hub_spoke`. Whether to use tunnel mode. SSR only
          default: false
        preference:
          type: integer
          description: Only if the VPN `type`==`hub_spoke`. For a given VPN, when `path_selection.strategy`==`simple`, the preference for a path (lower is preferred)
          contentEncoding: int32
        role:
          allOf:
          - $ref: '#/components/schemas/gateway_port_vpn_path_role2'
          - description: 'Gateway role for this VPN path; valid values depend on the VPN `type`. enum: `hub`, `mesh`, `spoke`.'
        traffic_shaping:
          allOf:
          - $ref: '#/components/schemas/gateway_traffic_shaping1'
          - description: Traffic shaping settings applied to this VPN path
      description: VPN path settings for traffic that uses a gateway port
    gateway_port_vpn_path_bfd_profile:
      title: gateway_port_vpn_path_bfd_profile
      enum:
      - broadband
      - lte
      type: string
      description: 'Only if the VPN `type`==`hub_spoke`. enum: `broadband`, `lte`'
    gateway_port_vpn_path_role:
      title: gateway_port_vpn_path_role
      enum:
      - hub
      - mesh
      - spoke
      type: string
      description: 'If the VPN `type`==`hub_spoke`, enum: `hub`, `spoke`. If the VPN `type`==`mesh`, enum: `mesh`'
    gateway_port_wan_arp_policer:
      title: gateway_port_wan_arp_policer
      enum:
      - default
      - max
      - recommended
      type: string
      description: 'Only when `wan_type`==`broadband`. enum: `default`, `max`, `recommended`'
    gateway_port_wan_source_nat:
      title: gateway_port_wan_source_nat
      type: object
      properties:
        disabled:
          type: boolean
          description: Or to disable the source-nat
          default: false
        nat6_pool:
          type: string
          description: If alternative nat_pool is desired
          examples:
          - 2601:1700:43c0:dc0:20c:29ff:fea7:93bc/126
        nat_pool:
          type: string
          description: If alternative nat_pool is desired
          examples:
          - 64.2.4.0/30
      description: Only if `usage`==`wan`, optional. By default, source-NAT is performed on all WAN Ports using the interface-ip
    gateway_port_wan_type:
      title: gateway_port_wan_type
      enum:
      - broadband
      - dsl
      - lte
      type: string
      description: 'Only if `usage`==`wan`. enum: `broadband`, `dsl`, `lte`'
    gateway_search:
      title: gateway_search
      required:
      - type
      type: object
      properties:
        clustered:
          type: boolean
          description: Whether the gateway is part of a gateway cluster
        evpn_missing_links:
          type: boolean
          description: Whether EVPN topology links are missing for this gateway
        evpntopo_id:
          type: string
          description: EVPN topology ID associated with this gateway
        ext_ip:
          type: string
          description: External IP address observed for gateway management traffic
        hostname:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Observed hostnames detected for the gateway in search results
        ip:
          type: string
          description: Management IP address currently reported for the gateway
        last_config_status:
          type: string
          description: Most recent configuration status reported for the gateway
        last_hostname:
          type: string
          description: Most recent hostname detected for the gateway
        last_trouble_code:
          type: string
          description: Most recent trouble code reported for the gateway
        last_trouble_timestamp:
          type: integer
          description: Timestamp when the most recent gateway trouble code was reported
          contentEncoding: int32
        mac:
          type: string
          description: Gateway MAC address reported in search results
        managed:
          type: boolean
          description: Whether the gateway is managed by Mist. Deprecated in favor of `mist_configured`
          deprecated: true
        mist_configured:
          type: boolean
          description: Whether the gateway can be configured by Mist. Replaces `managed` for adopted devices and `disable_auto_config` for claimed devices
        model:
          type: string
          description: Gateway model reported for this search result
        node:
          type: string
          description: Gateway cluster node associated with this search result
        node0_mac:
          type: string
          description: Cluster node0 MAC address reported for an HA gateway
        node1_mac:
          type: string
          description: Cluster node1 MAC address reported for an HA gateway
        num_members:
          type: integer
          description: Number of members in the gateway cluster
          contentEncoding: int32
        org_id:
          type: string
          description: Organization that owns this gateway search result
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        role:
          type: string
          description: Gateway cluster role reported for this search result
        site_id:
          type: string
          description: Site that contains this gateway search result
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        t128agent_version:
          type: string
          description: Session Smart Router agent version reported by the gateway
        time_drifted:
          type: boolean
          description: Whether the gateway clock has drifted from the expected time
        timestamp:
          type: number
          description: Time associated with this gateway search result
          readOnly: true
        type:
          const: gateway
          type: string
          description: Device type for this gateway search result
        uptime:
          type: integer
          description: Device uptime for the gateway, in seconds
          contentEncoding: int32
        version:
          type: string
          description: Software version currently running on the gateway
      description: Gateway record returned by device search endpoints
    gateway_template:
      title: gateway_template
      required:
      - name
      type: object
      properties:
        additional_config_cmds:
          type: array
          items:
            type: string
          description: Additional CLI configuration commands provided by this gateway template
        bgp_config:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/bgp_config'
          description: BGP routing defaults for this gateway template. Property key is the BGP session name
        created_time:
          type: number
          description: Timestamp when the gateway template was created
          readOnly: true
        dhcpd_config:
          allOf:
          - $ref: '#/components/schemas/dhcpd_config3'
          - description: DHCP server defaults provided by this gateway template
        dnsOverride:
          type: boolean
          description: Whether DNS server and suffix settings in this template override inherited values
          default: false
        dns_servers:
          type: array
          items:
            type: string
          description: DNS servers provided by this gateway template
        dns_suffix:
          type: array
          items:
            type: string
          description: DNS search suffixes provided by this gateway template
        extra_routes:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/gateway_extra_route'
          description: Additional IPv4 route defaults in this gateway template
        extra_routes6:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/gateway_extra_route6'
          description: Additional IPv6 route defaults in this gateway template
          examples:
          - 2a02:1234:420a:10c9::/64:
              via: 2a02:1234:200a::100
        gateway_matching:
          allOf:
          - $ref: '#/components/schemas/gateway_matching2'
          - description: Matching rules that select gateways for this template
        gateway_mgmt:
          allOf:
          - $ref: '#/components/schemas/gateway_mgmt2'
          - description: Management-plane defaults provided by this gateway template
        id:
          type: string
          description: Unique identifier of the gateway template
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        idp_profiles:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/idp_profile'
          description: Intrusion detection and prevention profile defaults in this gateway template
        ip_configs:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/gateway_ip_config_property'
          description: Gateway interface IP configuration defaults by network name
        modified_time:
          type: number
          description: Timestamp when the gateway template was last modified
          readOnly: true
        name:
          type: string
          description: Display name of the gateway template
          examples:
          - gw_template
        networks:
          type: array
          items:
            $ref: '#/components/schemas/network'
          description: Layer 3 networks configured by this gateway template
        ntpOverride:
          type: boolean
          description: Whether NTP servers in this template override inherited values
          default: false
        ntp_servers:
          type: array
          items:
            type: string
          description: NTP servers provided by this gateway template
        oob_ip_config:
          allOf:
          - $ref: '#/components/schemas/gateway_oob_ip_config3'
          - description: Out-of-band management IP defaults in this gateway template
        org_id:
          type: string
          description: Organization that owns this gateway template
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        path_preferences:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/gateway_path_preferences'
          description: Property key is the path name
        port_config:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/gateway_port_config'
          description: Property key is the Port Name (i.e. "ge-0/0/0"), the Ports Range (i.e. "ge-0/0/0-10"), the List of Ports (i.e. "ge-0/0/0,ge-1/0/0", only allowed for Aggregated or Redundant interfaces) or a Variable (i.e. "{{myvar}}").
        router_id:
          type: string
          description: Auto assigned if not set
          examples:
          - 10.2.1.10
        routing_policies:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/gw_routing_policy'
          description: Routing policy defaults applied by this gateway template
        service_policies:
          type: array
          items:
            $ref: '#/components/schemas/service_policy'
          description: Traffic service policy defaults enforced by this gateway template
        tunnel_configs:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/tunnel_config'
          description: Property key is the tunnel name
        tunnel_provider_options:
          allOf:
          - $ref: '#/components/schemas/tunnel_provider_options2'
          - description: Provider-specific tunnel options defined by this gateway template
        type:
          allOf:
          - $ref: '#/components/schemas/gateway_template_type2'
          - description: 'Gateway template deployment type. enum: `spoke`, `standalone`.'
            examples:
            - standalone
        url_filtering_deny_msg:
          type: string
          description: When a service policy denies a app_category, what message to show in user's browser
          default: Access to this URL Category has been blocked
          examples:
          - Access to this URL Category has been blocked
        vrf_config:
          allOf:
          - $ref: '#/components/schemas/vrf_config4'
          - description: VRF defaults applied by this gateway template
        vrf_instances:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/gateway_vrf_instance'
          description: VRF instances configured by this gateway template
          examples:
          - CORP_VRF:
              networks:
              - CORP_NET
              - MGMT_NET
      description: Gateway Template is applied to a site for gateway(s) in a site.
    gateway_template_type:
      title: gateway_template_type
      enum:
      - spoke
      - standalone
      type: string
      description: 'Gateway template deployment type. enum: `spoke`, `standalone`'
      examples:
      - standalone
    gateway_traffic_shaping:
      title: gateway_traffic_shaping
      type: object
      properties:
        class_percentages:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: Traffic class bandwidth percentages for high, medium, low, and best-effort queues
        enabled:
          type: boolean
          description: Whether traffic shaping is enabled
          default: false
        max_tx_kbps:
          type: integer
          description: Maximum transmit bandwidth for the interface, in Kbps
          contentEncoding: int32
      description: Traffic shaping settings for a gateway interface or VPN path
    gateway_vrf_instance:
      title: gateway_vrf_instance
      type: object
      properties:
        networks:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Network names included in this gateway VRF instance
      description: Gateway VRF instance and its member networks
      examples:
      - networks:
        - CORP_NET
        - MGMT_NET
    gateway_wan_ppoe_auth:
      title: gateway_wan_ppoe_auth
      enum:
      - chap
      - none
      - pap
      type: string
      description: 'if `type`==`pppoe`. enum: `chap`, `none`, `pap`'
    gateway_wan_probe_override:
      title: gateway_wan_probe_override
      type: object
      properties:
        hostnames:
          uniqueItems: true
          type: array
          items:
            type: string
          description: List of hostnames used as probe destinations; applicable for both IPv4 and IPv6
        http:
          allOf:
          - $ref: '#/components/schemas/gateway_wan_probe_override_http2'
          - description: HTTP probe settings; success from any ICMP or HTTP probe indicates the WAN is up
        ip6s:
          uniqueItems: true
          type: array
          items:
            type: string
          description: List of IPv6 probe host addresses used by this WAN override
        ips:
          uniqueItems: true
          type: array
          items:
            type: string
          description: List of IPv4 probe host addresses used by this WAN override
        probe_profile:
          allOf:
          - $ref: '#/components/schemas/gateway_wan_probe_override_probe_profile2'
          - description: 'WAN probe profile used for health checks on this port. enum: `broadband`, `lte`.'
      description: Only if `usage`==`wan`. WAN health probe override for this gateway port
    gateway_wan_probe_override_http:
      title: gateway_wan_probe_override_http
      type: object
      properties:
        accepted_status_codes:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: HTTP response status codes that indicate a successful probe. Defaults to 200 if not specified.
          examples:
          - - 204
        urls:
          type: array
          items:
            type: string
          description: HTTP or HTTPS URLs to probe
          examples:
          - - http://www.google.com/generate_204
            - https://www.google.com/generate_204
      description: HTTP probe settings for a WAN probe override
    gateway_wan_probe_override_probe_profile:
      title: gateway_wan_probe_override_probe_profile
      enum:
      - broadband
      - lte
      type: string
      description: 'WAN probe profile used for health checks on this port. enum: `broadband`, `lte`'
    gateway_wan_type:
      title: gateway_wan_type
      enum:
      - dhcp
      - pppoe
      - static
      type: string
      description: 'enum: `dhcp`, `pppoe`, `static`'
    gateway_wan_type6:
      title: gateway_wan_type6
      enum:
      - autoconf
      - dhcp
      - static
      type: string
      description: 'enum: `autoconf`, `dhcp`, `static`'
    get_org_mxedge_upgrade_info_channel:
      title: get_org_mxedge_upgrade_info_channel
      enum:
      - alpha
      - beta
      - stable
      type: string
      description: 'enum: `alpha`, `beta`, `stable`'
    guest:
      title: guest
      type: object
      properties:
        access_code_email:
          type: string
          description: If `auth_method`==`email`, the email address where the authorization code has been sent to
          readOnly: true
        ap_mac:
          type: string
          description: MAC address of the AP used during guest registration
          readOnly: true
        auth_method:
          type: string
          description: Guest authentication method used for the authorization
          readOnly: true
        authorized:
          type: boolean
          description: Whether the guest is currently authorized
          default: true
        authorized_expiring_time:
          type: number
          description: Unix timestamp when the guest authorization expires
          readOnly: true
          examples:
          - 1480704955
        authorized_time:
          type: number
          description: Unix timestamp when the guest was authorized
          readOnly: true
          examples:
          - 1480704355
        company:
          type: string
          description: Optional company name provided by the guest during registration
          examples:
          - abc
        email:
          type: string
          description: Optional email address provided by the guest during registration
          contentEncoding: email
          examples:
          - john@abc.com
        field1:
          type: string
          description: Optional custom field 1 value provided by the guest during registration
        field2:
          type: string
          description: Optional custom field 2 value provided by the guest during registration
        field3:
          type: string
          description: Optional custom field 3 value provided by the guest during registration
        field4:
          type: string
          description: Optional custom field 4 value provided by the guest during registration
        mac:
          type: string
          description: Device MAC address captured during guest registration
          readOnly: true
        minutes:
          maximum: 259200
          minimum: 0
          type: integer
          description: Authorization duration, in minutes. Default is 1440 minutes (1 day), maximum is 259200 (180 days)
          contentEncoding: int32
          default: 1440
        name:
          type: string
          description: Optional name provided by the guest during registration
          readOnly: true
          examples:
          - John Smith
        random_mac:
          type: boolean
          description: Whether the guest device used a randomized MAC address to connect to the SSID
          readOnly: true
        ssid:
          type: string
          description: Name of the SSID
          readOnly: true
          examples:
          - Guest-SSID
        wlan_id:
          type: string
          description: Identifier of the WLAN used for the guest authorization
          contentEncoding: uuid
          readOnly: true
          examples:
          - 6748cfa6-4e12-11e6-9188-0242ac110007
      description: Guest authorization record at site scope
    guest_org:
      title: guest_org
      required:
      - wlan_id
      type: object
      properties:
        access_code_email:
          type: string
          description: If `auth_method`==`email`, the email address where the authorization code has been sent to
          readOnly: true
        allow_wlan_id_roam:
          type: boolean
          description: Based on the WLAN portal configuration (field `allow_wlan_id_roam`), if the user is also authorized on other Guest WLANs of the same Org without reauthentication
          readOnly: true
        ap_mac:
          type: string
          description: MAC address of the AP used during guest registration
          readOnly: true
        auth_method:
          type: string
          description: Guest authentication method used for the authorization
          readOnly: true
        authorized:
          type: boolean
          description: Whether the guest is currently authorized
          default: true
        authorized_expiring_time:
          type: number
          description: Unix timestamp when the guest authorization expires
          readOnly: true
          examples:
          - 1480704955
        authorized_time:
          type: number
          description: Unix timestamp when the guest was authorized
          readOnly: true
          examples:
          - 1480704355
        company:
          type: string
          description: Optional company name provided by the guest during registration
          examples:
          - abc
        cross_site:
          type: boolean
          description: Based on the WLAN portal configuration (field `cross_site`), if the user is also authorized on other sites (same `wlan.ssid`) of the same Org without reauthentication
          readOnly: true
        email:
          type: string
          description: Optional email address provided by the guest during registration
          contentEncoding: email
          examples:
          - john@abc.com
        field1:
          type: string
          description: Optional custom field 1 value provided by the user during registration
        field2:
          type: string
          description: Optional custom field 2 value provided by the user during registration
        field3:
          type: string
          description: Optional custom field 3 value provided by the user during registration
        field4:
          type: string
          description: Optional custom field 4 value provided by the user during registration
        mac:
          type: string
          description: Device MAC address captured during guest registration
        minutes:
          maximum: 259200
          minimum: 0
          type: integer
          description: Authorization duration, in minutes. Default is 1440 minutes (1 day), maximum is 259200 (180 days)
          contentEncoding: int32
          default: 1440
        name:
          type: string
          description: Optional name provided by the guest during registration
          examples:
          - John Smith
        random_mac:
          type: boolean
          description: Whether the guest device used a randomized MAC address to connect to the SSID
          readOnly: true
        ssid:
          type: string
          description: Name of the SSID
          readOnly: true
          examples:
          - Guest-SSID
        wlan_id:
          type: string
          description: Identifier of the WLAN used for the guest authorization
          contentEncoding: uuid
          examples:
          - 6748cfa6-4e12-11e6-9188-0242ac110007
      description: Guest authorization record at organization scope
    gw_routing_policy:
      title: gw_routing_policy
      type: object
      properties:
        terms:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/gw_routing_policy_term'
          description: Ordered terms evaluated by this gateway routing policy
      description: Gateway routing policy made of ordered match-action terms
    gw_routing_policy_term:
      title: gw_routing_policy_term
      type: object
      properties:
        actions:
          allOf:
          - $ref: '#/components/schemas/gw_routing_policy_term_action2'
          - description: Policy actions applied when this routing policy term matches
        matching:
          allOf:
          - $ref: '#/components/schemas/gw_routing_policy_term_matching2'
          - description: Route match criteria that must be satisfied before actions are applied
      description: Gateway routing policy term with match criteria and actions
    gw_routing_policy_term_action:
      title: gw_routing_policy_term_action
      type: object
      properties:
        accept:
          type: boolean
          description: Whether to accept routes that match this term. Precedence is `accept` > `next_term` > `next_policy`; routes are rejected if all three are false
        add_community:
          type: array
          items:
            type: string
          description: BGP communities to add to routes that match this term
        add_target_vrfs:
          type: array
          items:
            type: string
          description: SSR target VRFs to add when leaking routes from hub to spoke
        community:
          type: array
          items:
            type: string
          description: BGP communities to set when this term is used as an export policy
        exclude_as_path:
          type: array
          items:
            type: string
          description: AS path values to exclude when this term is used as an export policy
        exclude_community:
          type: array
          items:
            type: string
          description: BGP communities to exclude from routes that match this term
        export_communities:
          type: array
          items:
            type: string
          description: BGP communities allowed for export when this term is used as an export policy
        local_preference:
          anyOf:
          - type: string
          - maximum: 4294967295
            minimum: 1
            type: integer
            contentEncoding: int32
          description: Preference value to set when this term is used as an import policy
        next_policy:
          type: boolean
          description: When true, continue evaluating the next routing policy in the chain after this term matches; default is false
          default: false
        next_term:
          type: boolean
          description: When true, continue evaluating the next term in the same routing policy after this term matches; default is false
          default: false
        prepend_as_path:
          type: array
          items:
            type: string
          description: AS path values to prepend when this term is used as an export policy
      description: Actions applied to routes matched by a gateway routing policy term
    gw_routing_policy_term_matching:
      title: gw_routing_policy_term_matching
      type: object
      properties:
        as_path:
          type: array
          items:
            $ref: '#/components/schemas/bgp_as'
          description: AS path values that routes must match
        community:
          type: array
          items:
            type: string
          description: BGP communities that routes must match
        network:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Configured network names that routes must match
        prefix:
          type: array
          items:
            type: string
          description: Route prefixes that routes must match
        protocol:
          type: array
          items:
            $ref: '#/components/schemas/gw_routing_policy_term_matching_protocol_enum'
          description: Routing protocols that routes must match
        route_exists:
          allOf:
          - $ref: '#/components/schemas/gw_routing_policy_term_matching_route_exists2'
          - description: Existing route condition that must be satisfied before this term matches
        vpn_neighbor_mac:
          type: array
          items:
            type: string
          description: Overlay neighbor MAC addresses used as match criteria for BGP sessions with `via`==`vpn`
        vpn_path:
          type: array
          items:
            type: string
          description: Overlay path names used as match criteria for BGP sessions with `via`==`vpn`
        vpn_path_sla:
          allOf:
          - $ref: '#/components/schemas/gw_routing_policy_term_matching_vpn_path_sla2'
          - description: SLA thresholds used when matching a VPN path
      description: Route match criteria for a gateway routing policy term; all specified criteria must match
    gw_routing_policy_term_matching_protocol_enum:
      title: gw_routing_policy_term_matching_protocol_enum
      enum:
      - aggregate
      - bgp
      - direct
      - ospf
      - static
      type: string
      description: 'enum: `aggregate`, `bgp`, `direct`, `ospf`, `static` (SRX Only)'
    gw_routing_policy_term_matching_route_exists:
      title: gw_routing_policy_term_matching_route_exists
      type: object
      properties:
        route:
          type: string
          description: Prefix that must exist for this condition to match
          examples:
          - 192.168.0.0/24
        vrf_name:
          type: string
          description: Name of the VRF instance where the route is checked; can also be a VPN or WAN name when applicable
          default: default
      description: Route-existence match condition for a gateway routing policy term
    gw_routing_policy_term_matching_vpn_path_sla:
      title: gw_routing_policy_term_matching_vpn_path_sla
      type: object
      properties:
        max_jitter:
          type:
          - integer
          - 'null'
          description: Maximum jitter threshold allowed for the VPN path
          contentEncoding: int32
        max_latency:
          type:
          - integer
          - 'null'
          description: Maximum latency threshold allowed for the VPN path
          contentEncoding: int32
          examples:
          - 1500
        max_loss:
          type:
          - integer
          - 'null'
          description: Maximum packet-loss threshold allowed for the VPN path
          contentEncoding: int32
          examples:
          - 30
      description: SLA thresholds used when matching VPN paths
    ha_cluster_config:
      title: ha_cluster_config
      type: object
      properties:
        disable_auto_config:
          type: boolean
          description: This disables the default behavior of a cloud-ready switch/gateway being managed/configured by Mist. Setting this to `true` means you want to disable the default behavior and do not want the device to be Mist-managed.
          deprecated: true
        managed:
          type: boolean
          description: An adopted switch/gateway will not be managed/configured by Mist by default. Setting this parameter to `true` enables the adopted switch/gateway to be managed/configured by Mist.
          deprecated: true
        mist_configured:
          type: boolean
          description: whether the device can be configured by Mist or not. This deprecates `managed` (for adopted device) and `disable_auto_config` for claimed device)
        nodes:
          type: array
          items:
            $ref: '#/components/schemas/ha_cluster_config_node'
          description: Gateway nodes to include in the HA cluster; each node must be currently unassigned in inventory
        site_id:
          type: string
          description: Site where the HA cluster should be created
          contentEncoding: uuid
          examples:
          - 43e9c864-a7e4-4310-8031-d9817d2c5a43
      description: Request to create an HA cluster from unassigned gateway inventory nodes
    ha_cluster_config_node:
      title: ha_cluster_config_node
      maxProperties: 2
      type: object
      properties:
        mac:
          type: string
          description: Gateway node MAC address for an inventory node that is currently unassigned
          examples:
          - aff827549235
      description: HA cluster inventory node identified by MAC address
    ha_cluster_delete:
      title: ha_cluster_delete
      type: object
      properties:
        mac:
          type: string
          description: Node0 MAC address identifying the HA cluster to delete
          examples:
          - aff827549235
      description: Request body identifying the HA cluster node to remove
    ha_cluster_node:
      title: ha_cluster_node
      type: object
      properties:
        node:
          allOf:
          - $ref: '#/components/schemas/ha_cluster_node_enum22'
          - description: 'HA cluster node on which to run the device operation. enum: `node0`, `node1`.'
      description: HA cluster node selector for device operations
    ha_cluster_node_enum:
      title: ha_cluster_node_enum
      enum:
      - node0
      - node1
      type: string
      description: 'HA cluster node selector. enum: `node0`, `node1`'
    hours:
      title: hours
      type: object
      properties:
        fri:
          type: string
          description: Operating hour range for Friday
          examples:
          - 09:00-17:00
        mon:
          type: string
          description: Operating hour range for Monday
          examples:
          - 09:00-17:00
        sat:
          type: string
          description: Operating hour range for Saturday
          examples:
          - 09:00-17:00
        sun:
          type: string
          description: Operating hour range for Sunday
          examples:
          - 09:00-17:00
        thu:
          type: string
          description: Operating hour range for Thursday
          examples:
          - 09:00-17:00
        tue:
          type: string
          description: Operating hour range for Tuesday
          examples:
          - 09:00-17:00
        wed:
          type: string
          description: Operating hour range for Wednesday
          examples:
          - 09:00-17:00
      description: Day-of-week operating hour filters using hour ranges such as 09:00-17:00
    idp_config:
      title: idp_config
      type: object
      properties:
        alert_only:
          type: boolean
          description: Whether to alert without enforcing IDP prevention actions
        enabled:
          type: boolean
          description: Whether IDP inspection is enabled for the policy
          default: false
        idpprofile_id:
          type: string
          description: org_level IDP Profile can be used, this takes precedence over `profile`
          contentEncoding: uuid
          examples:
          - 89b9d208-84a4-fa8f-af57-78f92c639cf2
        profile:
          type: string
          description: 'enum: `Custom`, `strict` (default), `standard` or keys from idp_profiles'
          default: strict
      description: Intrusion detection and prevention settings for a service policy
    idp_machine_cert_lookup_field:
      title: idp_machine_cert_lookup_field
      enum:
      - automatic
      - cn
      - dns
      type: string
      description: "allow customer to choose the EAP-TLS client certificate's field to use for IDP Machine Groups lookup. enum: `automatic`, `cn`, `dns`"
    idp_profile_action:
      title: idp_profile_action
      enum:
      - alert
      - close
      - drop
      type: string
      description: 'IDP profile action. enum: `alert`, `close`, `drop`. `alert` is the default, `drop` silently drops packets, and `close` asks the client/server to close the connection'
      examples:
      - alert
    idp_profile_base_profile:
      title: idp_profile_base_profile
      enum:
      - critical
      - standard
      - strict
      type: string
      description: 'enum: `critical`, `standard`, `strict`'
      examples:
      - strict
    idp_profile_matching:
      title: idp_profile_matching
      type: object
      properties:
        attack_name:
          type: array
          items:
            type: string
          description: Signature names matched by the IDP profile overwrite
        dst_subnet:
          type: array
          items:
            type: string
          description: Destination subnets matched by the IDP profile overwrite
        severity:
          type: array
          items:
            $ref: '#/components/schemas/idp_profile_matching_severity_value'
          description: Threat levels matched by the IDP profile overwrite
      description: Criteria that select IDP signatures for an overwrite rule
    idp_profile_matching_severity_value:
      title: idp_profile_matching_severity_value
      enum:
      - critical
      - info
      - major
      - minor
      type: string
      description: 'enum: `critical`, `info`, `major`, `minor`'
      examples:
      - major
    idp_profile_overwrite:
      title: idp_profile_overwrite
      type: object
      properties:
        action:
          allOf:
          - $ref: '#/components/schemas/idp_profile_action2'
          - description: 'Enforcement action applied when this overwrite rule matches. enum: `alert`, `close`, `drop`.'
            examples:
            - alert
        matching:
          allOf:
          - $ref: '#/components/schemas/idp_profile_matching2'
          - description: Criteria that select signatures for this overwrite rule
        name:
          type: string
          description: Display name for this IDP profile overwrite rule
      description: Override rule that changes the IDP action for matching signatures
    idp_user_cert_lookup_field:
      title: idp_user_cert_lookup_field
      enum:
      - automatic
      - cn
      - email
      - upn
      type: string
      description: "allow customer to choose the EAP-TLS client certificate's field to use for IDP User Groups lookup. enum: `automatic`, `cn`, `email`, `upn`"
    if_stat_property:
      title: if_stat_property
      type: object
      properties:
        address_mode:
          type: string
          description: Address assignment mode reported for the interface
        ips:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Interface IP addresses reported with prefix information
        nat_addresses:
          uniqueItems: true
          type: array
          items:
            type: string
          description: NAT addresses associated with this interface
        network_name:
          type: string
          description: Mist network name associated with this interface
        port_id:
          type: string
          description: Physical or logical port identifier for this interface
        port_usage:
          type: string
          description: Configured usage for this interface, such as LAN or WAN
        redundancy_state:
          type: string
          description: Redundancy state reported for this interface
        rx_bytes:
          type:
          - integer
          - 'null'
          description: Received byte counter for this interface
          contentEncoding: int64
          readOnly: true
          examples:
          - 8515104416
        rx_pkts:
          type:
          - integer
          - 'null'
          description: Received packet counter for this interface
          contentEncoding: int64
          readOnly: true
          examples:
          - 57770567
        servp_info:
          allOf:
          - $ref: '#/components/schemas/if_stat_property_servp_info2'
          - description: Service-provider and geolocation details for this interface
        tx_bytes:
          type:
          - integer
          - 'null'
          description: Transmitted byte counter for this interface
          contentEncoding: int64
          readOnly: true
          examples:
          - 211217389682
        tx_pkts:
          type:
          - integer
          - 'null'
          description: Transmitted packet counter for this interface
          contentEncoding: int64
          readOnly: true
          examples:
          - 812204062
        up:
          type: boolean
          description: Whether the interface is operationally up
        vlan:
          type: integer
          description: Associated VLAN ID for this interface
          contentEncoding: int32
        wan_name:
          type: string
          description: Configured WAN name associated with this interface
        wan_type:
          type: string
          description: Configured WAN uplink type associated with this interface
      description: Interface statistics and metadata reported by a device
    if_stat_property_servp_info:
      title: if_stat_property_servp_info
      type: object
      properties:
        asn:
          type: string
          description: Autonomous System Number associated with the service provider
        city:
          type: string
          description: Detected city for the service provider address
        country_code:
          type: string
          description: ISO country code for the service provider address
        latitude:
          type: number
          description: Geographic latitude for the service provider address
        longitude:
          type: number
          description: Geographic longitude for the service provider address
        org:
          type: string
          description: Service provider organization name
        region_code:
          type: string
          description: Administrative region code for the service provider address
      description: Service-provider and geolocation details associated with an interface address
    image_import:
      title: image_import
      required:
      - file
      type: object
      properties:
        file:
          type: string
          description: Image file content uploaded as multipart form data
          contentEncoding: base64
        json:
          type: string
          description: Optional JSON metadata submitted with the image upload
      description: Multipart image upload payload
    import_site_assets_upsert:
      title: import_site_assets_upsert
      enum:
      - 'False'
      - 'True'
      type: string
      description: 'Whether site asset import should update matching existing assets. enum: `False`, `True`'
    insight_metrics:
      title: insight_metrics
      required:
      - end
      - interval
      - start
      type: object
      properties:
        end:
          type: integer
          description: Window end timestamp for the returned insight metrics
          contentEncoding: int32
        interval:
          type: integer
          description: Aggregation interval used for the metric results
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of insight metric result items returned
          contentEncoding: int32
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/insight_metrics_results_item'
          description: Metric result values for the requested insight metric
        start:
          type: integer
          description: Window start timestamp for the returned insight metrics
          contentEncoding: int32
      description: Insight metric response for a requested time range and aggregation interval
    insight_rogue_ap:
      title: insight_rogue_ap
      required:
      - ap_mac
      - avg_rssi
      - bssid
      - channel
      - num_aps
      type: object
      properties:
        ap_mac:
          type: string
          description: Reporting AP MAC address with the strongest signal for the SSID/BSSID pair
        avg_rssi:
          type: number
          description: Average RSSI for the SSID/BSSID pair as heard by the reporting AP
        bssid:
          type: string
          description: Rogue or neighbor BSSID detected as a threat
        channel:
          type: string
          description: Radio channel where the reporting AP heard the SSID/BSSID pair
        delta_x:
          type: number
          description: X position relative to the reporting AP (`ap_mac`)
        delta_y:
          type: number
          description: Y position relative to the reporting AP (`ap_mac`)
        num_aps:
          type: integer
          description: Number of APs that heard the SSID/BSSID pair
          contentEncoding: int32
        seen_on_lan:
          type: boolean
          description: Whether the reporting AP sees a LAN-side client associated with the BSSID
        ssid:
          type: string
          description: Wireless SSID detected for the rogue or neighbor BSSID
        times_heard:
          type: integer
          description: Represents number of times the pair was heard in the interval. Each count roughly corresponds to a minute.
          contentEncoding: int32
      description: Rogue or neighbor AP observation returned by site insights
    insight_rogue_client:
      title: insight_rogue_client
      required:
      - annotation
      - ap_mac
      - avg_rssi
      - band
      - bssid
      - client_mac
      - num_aps
      type: object
      properties:
        annotation:
          type: string
          description: Rogue client annotation or classification
        ap_mac:
          type: string
          description: Reporting AP MAC address that observed the rogue client
        avg_rssi:
          type: number
          description: Average RSSI for the rogue client as heard by reporting APs
        band:
          type: string
          description: Radio band on which the rogue client was observed
        bssid:
          type: string
          description: Rogue BSSID associated with the client
        client_mac:
          type: string
          description: Observed client MAC address on the rogue BSSID
        num_aps:
          type: integer
          description: Number of APs that observed the rogue client
          contentEncoding: int32
      description: Rogue client observation returned by site insights
    installer_device:
      title: installer_device
      type: object
      properties:
        ble_stat:
          allOf:
          - $ref: '#/components/schemas/installer_device_ble_stat2'
          - description: BLE beacon statistics reported by the device
        connected:
          type: boolean
          description: Whether the device is currently connected to Mist
          examples:
          - true
        deviceprofile_name:
          type: string
          description: Device profile name associated with this installer device
          examples:
          - SJ1
        ext_ip:
          type: string
          description: External IP address observed for device management traffic
          examples:
          - 12.34.56.78
        height:
          type: number
          description: Mounting height recorded for map placement
          examples:
          - 2.7
        ip:
          type: string
          description: Management IP address currently reported for the device
          examples:
          - 192.168.1.111
        last_seen:
          type:
          - number
          - 'null'
          description: Timestamp when the device was last seen by Mist
          readOnly: true
          examples:
          - 1470417522
        mac:
          type: string
          description: Device MAC address shown to installers
          examples:
          - 5c5b35000018
        map_id:
          type: string
          description: Map where the installer placed this device
          contentEncoding: uuid
          examples:
          - 845a23bf-bed9-e43c-4c86-6fa474be7ae5
        model:
          type: string
          description: Device model reported for this installer device
          examples:
          - AP41
        name:
          type: string
          description: Device name configured through the installer workflow
          examples:
          - hallway
        orientation:
          type: integer
          description: Device orientation in degrees from 0 to 359, where 0 is up and 90 is right
          contentEncoding: int32
          examples:
          - 90
        serial:
          type: string
          description: Device serial number reported to installer workflows
          examples:
          - FXLH2015150025
        site_name:
          type: string
          description: Site name associated with this installer device
          examples:
          - SJ1
        uptime:
          type: integer
          description: Device uptime, in seconds
          contentEncoding: int32
          examples:
          - 12345
        vc_mac:
          type:
          - string
          - 'null'
          description: Virtual Chassis MAC address when this device is part of a VC
        version:
          type: string
          description: Software version currently running on the device
          examples:
          - 0.10.24362
        x:
          type: number
          description: Horizontal map position of the device, in pixels
          examples:
          - 150
        y:
          type: number
          description: Vertical map position of the device, in pixels
          examples:
          - 300
      description: Recently claimed device visible to installer workflows
    installer_device_ble_stat:
      title: installer_device_ble_stat
      type: object
      properties:
        major:
          type: integer
          description: iBeacon major value reported by the device
          contentEncoding: int32
          examples:
          - 12345
        minors:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: iBeacon minor values reported by the device
        uuid:
          type: string
          description: iBeacon UUID advertised by the device
          contentEncoding: uuid
          examples:
          - ada72f8f-1643-e5c6-94db-f2a5636f1a64
      description: BLE statistics for the device
    installer_provision_device:
      title: installer_provision_device
      required:
      - name
      type: object
      properties:
        deviceprofile_name:
          type: string
          description: Profile name applied to the device during installer provisioning
          examples:
          - SJ1
        for_site:
          type: boolean
          description: Whether this installer provisioning request is scoped to a site
          readOnly: true
        height:
          type: number
          description: Mounting height recorded for map placement
          examples:
          - 2.7
        map_id:
          type: string
          description: Identifier of the map where the device should be placed
          contentEncoding: uuid
          examples:
          - 845a23bf-bed9-e43c-4c86-6fa474be7ae5
        name:
          type: string
          description: Device name to set during installer provisioning
          examples:
          - SJ1-AP1
        orientation:
          type: integer
          description: Device orientation in degrees from 0 to 359, where 0 is up and 90 is right
          contentEncoding: int32
          examples:
          - 90
        replacing_mac:
          type: string
          description: Only if replacing an existing device; MAC address of the device being replaced
          examples:
          - 5c5b3500003
        role:
          type: string
          description: Optional role for switch / gateway
        site_id:
          type: string
          description: Identifier of the destination site for installer provisioning
          contentEncoding: uuid
          examples:
          - 72771e6a-6f5e-4de4-a5b9-1266c4197811
        site_name:
          type: string
          description: Destination site name for installer provisioning
          examples:
          - SJ1
        x:
          type: number
          description: Horizontal map position for the device, in pixels
          examples:
          - 150
        y:
          type: number
          description: Vertical map position for the device, in pixels
          examples:
          - 300
      description: Installer payload for provisioning or replacing a device
    installer_site:
      title: installer_site
      required:
      - address
      - country_code
      - latlng
      - name
      type: object
      properties:
        address:
          type: string
          description: Street or postal address for the installer site
          examples:
          - 1601 S. Deanza Blvd., Cupertino, CA, 95014
        country_code:
          type: string
          description: ISO country code for the installer site
          examples:
          - US
        id:
          type: string
          description: Unique identifier of the installer site
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        latlng:
          allOf:
          - $ref: '#/components/schemas/lat_lng4'
          - description: Geographic coordinates of the installer site
        name:
          type: string
          description: Display name of the installer site
          examples:
          - Mist Office
        rftemplate_name:
          type: string
          description: RF template name applied to the installer site
          examples:
          - rftemplate1
        sitegroup_names:
          type: array
          items:
            type: string
          description: Names of site groups associated with the installer site
          examples:
          - - sg1
            - sg2
        timezone:
          type: string
          description: Time zone configured for the installer site
          examples:
          - America/Los_Angeles
      description: Site definition available to installer workflows
    installers_item:
      title: installers_item
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the installer access entry
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        name:
          type: string
          description: Display name of the installer access entry
          examples:
          - 'Entry #1'
      description: Installer access entry with scope and role details
    inventory:
      title: inventory
      type: object
      properties:
        adopted:
          type: boolean
          description: Only if `type`==`switch` or `type`==`gateway`, whether the switch/gateway is adopted
        chassis_mac:
          type: string
          description: For Virtual Chassis only, MAC address of the FPC0 member
        chassis_serial:
          type: string
          description: For Virtual Chassis only, the Serial Number of the FPC0
        connected:
          type: boolean
          description: Whether the device is connected
        created_time:
          type: number
          description: Timestamp when the inventory record was created
          readOnly: true
        deviceprofile_id:
          type:
          - string
          - 'null'
          description: Deviceprofile id if assigned, null if not assigned
        hostname:
          type: string
          description: Inventory hostname value reported by the device
        hw_rev:
          type: string
          description: Device hardware revision number
        id:
          type: string
          description: Unique identifier of the inventory record
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        jsi:
          type: boolean
          description: Whether the inventory device is in JSI mode
        last_disconnected:
          type: integer
          description: Timestamp when the device last disconnected, in epoch seconds
          contentEncoding: int32
        mac:
          type: string
          description: Device MAC address for this inventory record
        magic:
          type: string
          description: Claim code used to add this device to inventory
        model:
          type: string
          description: Device model reported in inventory
        modified_time:
          type: number
          description: Timestamp when the inventory record was last modified
          readOnly: true
        name:
          type: string
          description: Device name if configured
        org_id:
          type: string
          description: Organization that owns this inventory record
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        serial:
          type: string
          description: Device serial number reported in inventory
        site_id:
          type: string
          description: Site associated with this inventory record, when assigned
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        sku:
          type: string
          description: Device stock keeping unit
        type:
          allOf:
          - $ref: '#/components/schemas/device_type_default_ap3'
          - description: 'Device type for this inventory record. enum: `ap`, `gateway`, `switch`.'
        vc_mac:
          type: string
          description: If `type`==`switch` and the device is part of a Virtual Chassis, MAC address of the Virtual Chassis. If `type`==`gateway` and the device is part of a cluster, MAC address of the cluster
      description: Organization inventory record for a claimed device
    inventory_count_distinct:
      title: inventory_count_distinct
      enum:
      - model
      - status
      - site_id
      - sku
      - version
      type: string
      description: 'enum: `model`, `status`, `site_id`, `sku`, `version`'
    inventory_search:
      title: inventory_search
      type: object
      properties:
        end:
          type: integer
          description: Page ending index for this inventory search response
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of inventory search results requested
          contentEncoding: int32
          examples:
          - 1000
        next:
          type: string
          description: URL for the next page of inventory search results
        results:
          type: array
          items:
            $ref: '#/components/schemas/inventory_search_result'
          description: Inventory records returned by the search
        start:
          type: integer
          description: Page starting index for this inventory search response
          contentEncoding: int32
        total:
          type: integer
          description: Number of inventory records matching the search
          contentEncoding: int32
          examples:
          - 1
      description: Paginated inventory search response
    inventory_search_result:
      title: inventory_search_result
      type: object
      properties:
        mac:
          type: string
          description: Device MAC address for this inventory search result
          examples:
          - f01c2df166e0
        magic:
          type: string
          description: Device claim code (magic) for this inventory search result
          examples:
          - WVTFBLTNPXD23H2
        master:
          type: boolean
          description: Whether this search result represents the master member of a Virtual Chassis
          examples:
          - true
        members:
          type: array
          items:
            $ref: '#/components/schemas/inventory_search_result_member'
          description: Virtual Chassis members included in this inventory search result
        model:
          type: string
          description: Device model for this inventory search result
          examples:
          - EX4300-48P
        name:
          type: string
          description: Configured device name in this inventory search result
          examples:
          - mist-wa-ex4300-VC
        org_id:
          type: string
          description: Organization that owns this inventory search result
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        serial:
          type: string
          description: Device serial number for this inventory search result
          examples:
          - PD3714460200
        site_id:
          type: string
          description: Site associated with this inventory search result, when assigned
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        sku:
          type: string
          description: Device SKU for this inventory search result
          examples:
          - EX4300-48P
        status:
          type: string
          description: Current inventory status for the device
          examples:
          - disconnected
        type:
          allOf:
          - $ref: '#/components/schemas/device_type_default_ap4'
          - description: 'Device type for this inventory search result. enum: `ap`, `gateway`, `switch`.'
        vc_mac:
          type: string
          description: Virtual Chassis MAC address for this inventory search result
          examples:
          - f01c2df166e0
        version:
          type: string
          description: Software version reported for this inventory search result
          examples:
          - 21.4R3.5
      description: Inventory record returned by inventory search
    inventory_search_result_member:
      title: inventory_search_result_member
      type: object
      properties:
        mac:
          type: string
          description: Member device MAC address in this inventory search result
          examples:
          - f01c2df166e0
        model:
          type: string
          description: Member device model in this inventory search result
          examples:
          - EX4300-48P
        serial:
          type: string
          description: Member device serial number in this inventory search result
          examples:
          - PD3714460200
      description: Virtual Chassis member in an inventory search result
    inventory_update:
      title: inventory_update
      required:
      - op
      type: object
      properties:
        disable_auto_config:
          type: boolean
          description: If `op`==`assign`, this disables the default behavior of a cloud-ready switch/gateway being managed/configured by Mist. Setting this to `true` means you want to disable the default behavior and do not want the device to be Mist-managed.
          default: false
          deprecated: true
        macs:
          type: array
          items:
            type: string
          description: Device MAC addresses affected by this inventory operation
        managed:
          type: boolean
          description: If `op`==`assign`. An adopted switch/gateway will not be managed/configured by Mist by default. Setting this parameter to `true` enables the adopted switch/gateway to be managed/configured by Mist.
          default: false
          deprecated: true
        mist_configured:
          type: boolean
          description: Whether the device can be configured by Mist. Replaces `managed` for adopted devices and `disable_auto_config` for claimed devices
        no_reassign:
          type: boolean
          description: If `op`==`assign`, if true, treat site assignment against an already assigned AP as error
          default: false
        op:
          allOf:
          - $ref: '#/components/schemas/inventory_update_operation2'
          - description: 'Inventory operation to apply to the listed devices. enum: `assign`, `delete`, `downgrade_to_jsi`, `unassign`, `upgrade_to_mist`.'
        serials:
          type: array
          items:
            type: string
          description: Device serial numbers affected by this inventory operation
        site_id:
          type: string
          description: If `op`==`assign`, target site ID for the inventory operation
          contentEncoding: uuid
      description: Request to assign, unassign, delete, or change management mode for inventory devices
    inventory_update_operation:
      title: inventory_update_operation
      enum:
      - assign
      - delete
      - downgrade_to_jsi
      - unassign
      - upgrade_to_mist
      type: string
      description: >-
        enum:
          * `upgrade_to_mist`: Upgrade to mist-managed
          * `downgrade_to_jsi`: Downgrade to basic monitoring. When downgrading a VC member to jsi, we will move the cloud connection of the VC to jsi-terminator and keep all VC device/inventories intact for pain-free upgrading back to mist.
          * `assign`: Assign inventory to a site
          * `unassign`: Unassign inventory from a site
          * `delete`: Delete multiple inventory from org. If the device is already assigned to a site, it will be unassigned
    iotendpoint_stats:
      title: iotendpoint_stats
      type: object
      properties:
        ap_mac:
          type: string
          description: MAC address of the AP the endpoint was seen on
          examples:
          - 5c5b350e0001
        id:
          type: string
          description: Unique identifier for the IoT endpoint
          examples:
          - 63f9e299182b63f9
        lqi:
          maximum: 255
          minimum: 0
          type: integer
          description: Link Quality Indicator (0–255)
          contentEncoding: int32
        mac:
          type: string
          description: Endpoint MAC address reported in IoT statistics
          examples:
          - 63f9e299182b63f9
        mfg:
          type: string
          description: Manufacturer name reported for the IoT endpoint
          examples:
          - Assa Abloy
        model:
          type: string
          description: Device model reported for the IoT endpoint
          examples:
          - Assa Abloy
        timestamp:
          type: number
          description: Epoch timestamp of the last observation, in seconds
        type:
          type: string
          description: 'IoT endpoint type. enum: `zigbee`'
          examples:
          - zigbee
      description: IoT endpoint statistics returned by a search response
    iotproxy:
      title: iotproxy
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether the site IoT proxy is enabled
          default: false
        visionline:
          allOf:
          - $ref: '#/components/schemas/iotproxy_visionline2'
          - description: Site access-control integration settings for Visionline
      description: IoT proxy configuration for the site
    iotproxy_visionline:
      title: iotproxy_visionline
      type: object
      properties:
        access_id:
          type: string
          description: Access ID for the Visionline service
          examples:
          - 790e6c1790e6c18541d
        cacerts:
          type: array
          items:
            type: string
          description: PEM-encoded CA certificates used to verify the Visionline collector's TLS certificate. Required when the collector uses a self-signed certificate
        enabled:
          type: boolean
          description: Whether the Visionline integration is enabled
          default: false
        host:
          type: string
          description: Collector hostname or IP address for Visionline
          examples:
          - visionline_collector1.local
        password:
          type: string
          description: Visionline service password used by the IoT proxy
          contentEncoding: password
        port:
          type: integer
          description: TCP port of the Visionline collector
          contentEncoding: int32
          default: 443
        username:
          type: string
          description: Visionline service username used by the IoT proxy
          examples:
          - card_administrator
      description: Visionline integration settings for IoT proxy
    ip_stat:
      title: ip_stat
      type: object
      properties:
        dhcp_server:
          type:
          - string
          - 'null'
          description: Reported DHCP server IPv4 address for the interface, when available
          readOnly: true
          examples:
          - 192.168.95.1
        dns:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Reported DNS server addresses for the interface
        dns_suffix:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Reported DNS search suffixes for the interface
        gateway:
          type:
          - string
          - 'null'
          description: Current IPv4 default gateway for the interface, when available
          readOnly: true
        gateway6:
          type:
          - string
          - 'null'
          description: Current IPv6 default gateway for the interface, when available
          readOnly: true
          examples:
          - fdad:b0bc:f29e::1
        ip:
          type:
          - string
          - 'null'
          description: Current IPv4 address for the interface, when available
          readOnly: true
          examples:
          - 10.3.3.1
        ip6:
          type:
          - string
          - 'null'
          description: Current IPv6 address for the interface, when available
          readOnly: true
          examples:
          - fdad:b0bc:f29e::3d16
        ips:
          type: object
          additionalProperties:
            type: string
            nullable: true
          description: Per-VLAN IP address summaries keyed by VLAN name
        netmask:
          type:
          - string
          - 'null'
          description: Current IPv4 subnet mask for the interface, when available
          readOnly: true
          examples:
          - 255.255.255.0
        netmask6:
          type:
          - string
          - 'null'
          description: Current IPv6 prefix length for the interface, when available
          readOnly: true
          examples:
          - /64
      description: Read-only IP addressing status reported by a device interface
    ip_type:
      title: ip_type
      enum:
      - dhcp
      - static
      type: string
      description: 'IP address assignment mode, either DHCP or static. enum: `dhcp`, `static`'
      examples:
      - static
    ip_type6:
      title: ip_type6
      enum:
      - autoconf
      - dhcp
      - disabled
      - static
      type: string
      description: 'enum: `autoconf`, `dhcp`, `disabled`, `static`'
      examples:
      - static
    issued_client_certificate:
      title: issued_client_certificate
      type: object
      properties:
        cert_provider:
          type: string
          description: Certificate provider that issued this client certificate
          examples:
          - byod
        common_name:
          type: string
          description: Subject common name encoded in the issued client certificate
          examples:
          - john@corp.com
        created_time:
          type: integer
          description: Certificate issuance time, in epoch seconds
          contentEncoding: int32
        device_id:
          type: string
          description: Device associated with the issued client certificate
          contentEncoding: uuid
          readOnly: true
          examples:
          - 00000000-0000-0000-1000-d8695a0f9e61
        expire_time:
          type: integer
          description: Certificate expiry time, in epoch seconds
          contentEncoding: int32
        serial_number:
          type: string
          description: Certificate serial number used for lookup or revocation
          examples:
          - 91984382552102771A2B3C4E5F224719956718003374658
      description: Issued Mist SCEP client certificate metadata
    issued_client_certificates_results:
      title: issued_client_certificates_results
      type: object
      properties:
        limit:
          type: integer
          description: Maximum number of results requested
          contentEncoding: int32
        page:
          type: integer
          description: Current page number
          contentEncoding: int32
        results:
          type: array
          items:
            $ref: '#/components/schemas/issued_client_certificate'
          description: List of issued client certificates returned by the query
      description: Issued client certificate search results wrapper
    js_inventory_item:
      title: js_inventory_item
      type: object
      properties:
        availability:
          type: string
          description: Current operational availability status of the device; only returned for onboarded (claimed) devices
        claimed:
          type: boolean
          description: Indicates if the device is claimed by any org
        contract_end_date:
          type: string
          description: Expiration date of the service contract; only returned for onboarded (claimed) devices
        contract_id:
          type: string
          description: Unique identifier of the service contract; only returned for onboarded (claimed) devices
        contract_reseller:
          type: string
          description: Name of the reseller associated with the contract; only returned for onboarded (claimed) devices
        contract_sku:
          type: string
          description: SKU associated with the service contract; only returned for onboarded (claimed) devices
        contract_start_date:
          type: string
          description: Official commencement date of the service contract; only returned for onboarded (claimed) devices
        contract_type:
          type: string
          description: General classification of the contract; only returned for onboarded (claimed) devices
        current_contract_flag:
          type: string
          description: Current status of the contract (e.g., 'Active', 'Expired'); only returned for onboarded (claimed) devices
        device_name:
          type: string
          description: Name of the device
        distributor:
          type: string
          description: Name of the distributor who provided the device; only returned for onboarded (claimed) devices
        end_of_sale_time:
          type: integer
          description: End of sale epoch timestamp
          contentEncoding: int32
        end_of_service_time:
          type: integer
          description: End of service epoch timestamp
          contentEncoding: int32
        eol_psn:
          type: string
          description: Product support notice associated with the device end-of-life milestone
          examples:
          - TSB18097
        eos_time:
          type: integer
          description: End of support time
          contentEncoding: int32
        has_support:
          type: boolean
          description: Indicates if the device is covered under active support contract
        ia_address:
          type: string
          description: Physical installation street address of the asset; only returned for onboarded (claimed) devices
        ia_country:
          type: string
          description: Country of installation; only returned for onboarded (claimed) devices
        ia_region:
          type: string
          description: Geographic region where the device is installed; only returned for onboarded (claimed) devices
        ia_zip_postal:
          type: string
          description: ZIP or postal code of the installation site; only returned for onboarded (claimed) devices
        master:
          type: boolean
          description: Indicates whether it is Master
        model:
          type: string
          description: Hardware model recorded in the install base inventory
        org_id:
          type: string
          description: Organization identifier that has claimed the device, when applicable
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        serial:
          type: string
          description: Device serial number recorded in the install base inventory
        service_contract_no:
          type: string
          description: Unique identifier for the service contract; only returned for onboarded (claimed) devices
        service_contract_type:
          type: string
          description: Specific service level or contract category for the device; only returned for onboarded (claimed) devices
        service_decline_flag:
          type: string
          description: Indicates if the service offer was declined (e.g., 'Y'/'N'); only returned for onboarded (claimed) devices
        service_eligible:
          type: string
          description: Indicator of whether the device is eligible for service coverage ('Yes', 'No'); only returned for onboarded (claimed) devices
        ship_date_calc:
          type: string
          description: Calculated or actual date the device was shipped; only returned for onboarded (claimed) devices
        sku:
          type: string
          description: Serviceable SKU associated with the device
        status:
          type: string
          description: Current inventory status reported for the device
        suggested_version:
          type: string
          description: Recommended software version for the device
        support_contract_status:
          allOf:
          - $ref: '#/components/schemas/support_contract_status2'
          - description: 'Service contract status; only returned for onboarded (claimed) devices. enum: `Active`, `Declined`, `EOL`, `Service Available`.'
        type:
          allOf:
          - $ref: '#/components/schemas/device_type2'
          - description: 'Device category for the inventory item. enum: `ap`, `gateway`, `switch`.'
        version:
          type: string
          description: Software version currently running on the device
        version_description:
          type: string
          description: Release description associated with the reported software version
        version_eos_time:
          type: integer
          description: End of Service of version
          contentEncoding: int32
        version_time:
          type: integer
          description: FRS date of the version
          contentEncoding: int32
        warranty:
          type: string
          description: Coverage details associated with the device warranty
        warranty_end:
          type: string
          description: Expiration date of the warranty period; only returned for onboarded (claimed) devices
        warranty_start:
          type: string
          description: Start date of the manufacturer or secondary warranty; only returned for onboarded (claimed) devices
        warranty_time:
          type: integer
          description: Timestamp when warranty needs to be renewed
          contentEncoding: int32
        warranty_type:
          type: string
          description: Warranty category reported for the device
      description: Juniper Support inventory item with entitlement, lifecycle, and software metadata
    js_inventory_search:
      title: js_inventory_search
      type: object
      properties:
        end:
          type: integer
          description: Offset to end at
          contentEncoding: int32
        limit:
          type: integer
          description: Number of results to return
          contentEncoding: int32
        next:
          type: string
          description: URL for the next page of JSI inventory results
        results:
          type: array
          items:
            $ref: '#/components/schemas/js_inventory_item'
          description: JSI inventory records returned by the search
        start:
          type: integer
          description: Offset to start from
          contentEncoding: int32
        total:
          type: integer
          description: Number of JSI inventory records matching the search
          contentEncoding: int32
      description: Paginated JSI inventory search response
    jse_device:
      title: jse_device
      type: object
      properties:
        ext_ip:
          type: string
          description: External IP address for the JSE device, when available
        last_seen:
          type:
          - number
          - 'null'
          description: Timestamp when the JSE device was last seen
          readOnly: true
          examples:
          - 1470417522
        mac:
          type: string
          description: Device MAC address for the JSE device
        model:
          type: string
          description: Device model for the JSE device
        serial:
          type: string
          description: Device serial number for the JSE device
      description: JSE device reported for an organization
    jsi_inventory_count_distinct:
      title: jsi_inventory_count_distinct
      enum:
      - account_id
      - claimed
      - has_support
      - end_of_sale_time
      - eos_time
      - version_time
      - model
      - sku
      - status
      - type
      - version
      - warranty_type
      type: string
      description: 'Distinct field used when counting Juniper Support Insight inventory records. enum: `account_id`, `claimed`, `has_support`, `end_of_sale_time`, `eos_time`, `version_time`, `model`, `sku`, `status`, `type`, `version`, `warranty_type`'
    jsi_pbn_bug_type:
      title: jsi_pbn_bug_type
      enum:
      - Day-1
      - Regression
      type: string
      description: 'Type of the bug. enum: `Day-1`, `Regression`'
    jsi_pbn_item:
      title: jsi_pbn_item
      type: object
      properties:
        bug_type:
          allOf:
          - $ref: '#/components/schemas/jsi_pbn_bug_type'
          - description: 'Type of the bug. enum: `Day-1`, `Regression`'
        customer_risk:
          type: string
          description: Customer impact risk level for the PBN advisory
        fixed_in:
          type: string
          description: Release in which the issue was fixed
        id:
          type: string
          description: Unique PBN advisory identifier from Juniper Support Insights
          examples:
          - '1403338'
        introduced_in:
          type: string
          description: Release where the PBN issue was introduced
        models:
          type: array
          items:
            type: string
          description: Device models affected by the PBN issue
        product_family:
          type: array
          items:
            type: string
          description: Product families affected by the PBN issue
        release_notes:
          type: string
          description: Release notes for this PBN
        restoration:
          type: string
          description: Steps recommended to restore service or recover from the PBN issue
        title:
          type: string
          description: Summary title for the PBN issue
        updated_date:
          type: integer
          description: Time when the PBN advisory was last updated
          contentEncoding: int32
        versions:
          type: array
          items:
            type: string
          description: Software versions affected by the PBN issue
        workaround:
          type: string
          description: Mitigation or workaround guidance for the PBN issue
        workaround_provided:
          type: string
          description: Indicator of whether workaround guidance is available
      description: PBN (Problem Bug Notification) advisory item
    jsi_pbn_search:
      title: jsi_pbn_search
      type: object
      properties:
        end:
          type: integer
          description: Upper bound timestamp for the PBN search window
          contentEncoding: int32
        limit:
          type: integer
          description: Number of results to return
          contentEncoding: int32
        next:
          type: string
          description: Pagination URL for the next page of PBN advisories
        results:
          type: array
          items:
            $ref: '#/components/schemas/jsi_pbn_item'
          description: List of PBN advisories
        start:
          type: integer
          description: Lower bound timestamp for the PBN search window
          contentEncoding: int32
        total:
          type: integer
          description: Count of PBN advisories matching the search
          contentEncoding: int32
      description: Juniper Security Intelligence PBN search response with result metadata
    jsi_sirt_item:
      title: jsi_sirt_item
      type: object
      properties:
        cvss_score:
          type: number
          description: Common Vulnerability Scoring System score for the SIRT advisory
        id:
          type: string
          description: Unique SIRT or JSA advisory identifier from Juniper Support Insights
          examples:
          - JSA100053
        models:
          type: array
          items:
            type: string
          description: Device models affected by the SIRT advisory
        problem:
          type: string
          description: Issue details described by the SIRT advisory
        published_date:
          type: integer
          description: Release date of the SIRT issue
          contentEncoding: int32
        release_notes:
          type: string
          description: Release notes if any
        severity:
          allOf:
          - $ref: '#/components/schemas/jsi_sirt_severity'
          - description: 'Security severity assigned to the SIRT advisory. enum: `Critical`, `High`, `Low`, `Medium`'
        solution:
          type: string
          description: Recommended fix or remediation for the security issue
        title:
          type: string
          description: Summary title for the SIRT advisory
        updated_date:
          type: integer
          description: Time when the JSA advisory was last updated
          contentEncoding: int32
        versions:
          type: array
          items:
            type: string
          description: Software versions affected by the SIRT advisory
        workaround:
          type: string
          description: Mitigation or workaround guidance for the SIRT advisory
      description: Juniper Security Intelligence SIRT advisory item
    jsi_sirt_search:
      title: jsi_sirt_search
      type: object
      properties:
        end:
          type: integer
          description: Upper bound timestamp for the SIRT search window
          contentEncoding: int32
        limit:
          type: integer
          description: Number of results to return
          contentEncoding: int32
        next:
          type: string
          description: Pagination URL for the next page of SIRT advisories
        results:
          type: array
          items:
            $ref: '#/components/schemas/jsi_sirt_item'
          description: List of SIRT advisories
        start:
          type: integer
          description: Lower bound timestamp for the SIRT search window
          contentEncoding: int32
        total:
          type: integer
          description: Count of SIRT advisories matching the search
          contentEncoding: int32
      description: Juniper Security Intelligence SIRT search response with result metadata
    jsi_sirt_severity:
      title: jsi_sirt_severity
      enum:
      - Critical
      - High
      - Low
      - Medium
      type: string
      description: 'Security severity assigned to the SIRT advisory. enum: `Critical`, `High`, `Low`, `Medium`'
    juniper_account:
      title: juniper_account
      type: object
      properties:
        linked_by:
          type: string
          description: User who linked this Juniper account
          readOnly: true
          examples:
          - John Smith (john@abccorp.com)
        name:
          type: string
          description: Display name of the linked Juniper account
          readOnly: true
          examples:
          - ABC Corp
      description: Linked Juniper account available to the organization
    juniper_srx_auto_upgrade:
      title: juniper_srx_auto_upgrade
      type: object
      properties:
        custom_versions:
          type: object
          additionalProperties:
            type: string
          description: Per-SRX-model firmware versions to deploy instead of the default version
        enabled:
          type: boolean
          description: Whether SRX auto-upgrade is enabled for newly onboarded devices
          default: false
        snapshot:
          type: boolean
          description: Whether to take a snapshot during the SRX upgrade process
          default: false
        version:
          type: string
          description: Firmware version to deploy (e.g. 23.4R2-S5.5). Optional, used when custom_versions not specified
          examples:
          - 23.4R2-S5.5
      description: SRX firmware auto-upgrade settings applied when a device is first onboarded
    junos_ip_config:
      title: junos_ip_config
      type: object
      properties:
        dns:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Configured DNS server addresses for Junos management traffic
        dns_suffix:
          uniqueItems: true
          type: array
          items:
            type: string
          description: DNS search suffixes configured for Junos management traffic
        gateway:
          type: string
          description: Default gateway IPv4 address for this Junos IP configuration
        ip:
          type: string
          description: Configured IPv4 address for this Junos IP configuration
        netmask:
          type: string
          description: Used only if `subnet` is not specified in `networks`
        network:
          type: string
          description: Management network for this IP configuration; used as the default source network for outbound SSH, DNS, NTP, TACACS+, RADIUS, syslog, and SNMP
        type:
          allOf:
          - $ref: '#/components/schemas/ip_type1'
          - description: 'IP assignment mode for this Junos IP configuration. enum: `dhcp`, `static`.'
            examples:
            - static
      description: Junos management IP configuration
    junos_local_port_config:
      title: junos_local_port_config
      required:
      - usage
      type: object
      properties:
        all_networks:
          type: boolean
          description: Only if `mode`==`trunk` whether to trunk all network/vlans
          default: false
        allow_dhcpd:
          type: boolean
          description: 'Controls whether DHCP server traffic is allowed on ports using this configuration if DHCP snooping is enabled. This is a tri-state setting; `true`: ports become trusted ports allowing DHCP server traffic, `false`: ports become untrusted blocking DHCP server traffic, undefined: use system defaults (access ports default to untrusted, trunk ports default to trusted).'
        allow_multiple_supplicants:
          type: boolean
          description: Whether multiple supplicants may authenticate on the port
          default: false
        bypass_auth_when_server_down:
          type: boolean
          description: Only if `port_auth`==`dot1x` bypass auth for known clients if set to true when RADIUS server is down
          default: false
        bypass_auth_when_server_down_for_unknown_client:
          type: boolean
          description: Only if `port_auth`=`dot1x` bypass auth for all (including unknown clients) if set to true when RADIUS server is down
          default: false
        description:
          type: string
          description: Human-readable description for this local port configuration
        disable_autoneg:
          type: boolean
          description: Only if `mode`!=`dynamic` if speed and duplex are specified, whether to disable autonegotiation
          default: false
        disabled:
          type: boolean
          description: Whether the port is disabled
          default: false
        duplex:
          allOf:
          - $ref: '#/components/schemas/switch_port_local_usage_duplex2'
          - description: 'Link duplex mode for this local port configuration. enum: `auto`, `full`, `half`.'
        dynamic_vlan_networks:
          type: array
          items:
            type: string
          description: Only if `port_auth`==`dot1x`, networks or VLANs that RADIUS can return for dynamic VLAN assignment
          examples:
          - - corp
            - user
        enable_mac_auth:
          type: boolean
          description: Only if `port_auth`==`dot1x` whether to enable MAC Auth
          default: false
        enable_qos:
          type: boolean
          description: Whether QoS is enabled on ports using this local configuration
          default: false
        guest_network:
          type:
          - string
          - 'null'
          description: Only if `port_auth`==`dot1x` which network to put the device into if the device cannot do dot1x. default is null (i.e. not allowed)
        inter_switch_link:
          type: boolean
          description: Used together with "isolation" under networks for links between Juniper devices; must be applied to both connected ports
          default: false
        mac_auth_only:
          type: boolean
          description: Only if `enable_mac_auth`==`true`, whether to use MAC authentication without 802.1X
        mac_auth_preferred:
          type: boolean
          description: Only if `enable_mac_auth`==`true` + `mac_auth_only`==`false`, dot1x will be given priority then mac_auth. Enable this to prefer mac_auth over dot1x.
        mac_auth_protocol:
          allOf:
          - $ref: '#/components/schemas/switch_port_local_usage_mac_auth_protocol2'
          - description: 'Only if `enable_mac_auth`==`true`, MAC authentication protocol to use. enum: `eap-md5`, `eap-peap`, `pap`.'
        mac_limit:
          minimum: 0
          type: integer
          description: Max number of MAC addresses, default is 0 for unlimited, otherwise range is 1 or higher, with upper bound constrained by platform
          contentEncoding: int32
          default: 0
        mode:
          allOf:
          - $ref: '#/components/schemas/switch_port_local_usage_mode2'
          - description: 'Switching mode for this local port configuration. enum: `access`, `inet`, `trunk`.'
        mtu:
          type: integer
          description: Media maximum transmission unit (MTU) is the largest data unit that can be forwarded without fragmentation. The default value is 1514.
          contentEncoding: int32
        networks:
          type: array
          items:
            type: string
          description: Only if `mode`==`trunk`, network or VLAN names to trunk
        note:
          type: string
          description: Additional note for the port config override
          examples:
          - force 100M for camera
        persist_mac:
          type: boolean
          description: Only if `mode`==`access` and `port_auth`!=`dot1x` whether the port should retain dynamically learned MAC addresses
          default: false
        poe_disabled:
          type: boolean
          description: Whether PoE capabilities are disabled for a port
          default: false
        port_auth:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/switch_port_local_usage_dot1x2'
          - description: '802.1X authentication mode for this local port configuration. enum: `dot1x`.'
        port_network:
          type: string
          description: Native network/vlan for untagged traffic
        reauth_interval:
          anyOf:
          - maximum: 65535
            minimum: 10
            type: integer
            contentEncoding: int32
            default: 3600
          - type: string
          description: Only if `port_auth`==`dot1x`, RADIUS reauthentication interval for clients on the port
        server_fail_network:
          type:
          - string
          - 'null'
          description: Only if `port_auth`==`dot1x` sets server fail fallback vlan
        server_reject_network:
          type:
          - string
          - 'null'
          description: Only if `port_auth`==`dot1x` when RADIUS server reject / fails
        speed:
          allOf:
          - $ref: '#/components/schemas/junos_port_config_speed3'
          - description: 'Link speed for this local port configuration. enum: `10m`, `100m`, `1g`, `2.5g`, `5g`, `10g`, `25g`, `40g`, `100g`, `auto`.'
        storm_control:
          allOf:
          - $ref: '#/components/schemas/switch_port_local_usage_storm_control'
          - description: Storm-control settings for this local port configuration
        stp_edge:
          type: boolean
          description: When enabled, the port is not expected to receive BPDU frames
          default: false
        stp_no_root_port:
          type: boolean
          description: Whether STP should prevent this port from becoming a root port
          default: false
        stp_p2p:
          type: boolean
          description: Whether STP treats this port as a point-to-point link
          default: false
        usage:
          type: string
          description: Port usage profile name for this local port configuration
        use_vstp:
          type: boolean
          description: If this is connected to a vstp network
          default: false
        voip_network:
          type: string
          description: Network/vlan for voip traffic, must also set port_network. to authenticate device, set port_auth
      description: Per-port Switch Port Operator (SPO) override configuration used in `local_port_config` to customize settings inherited from `port_config`
    junos_port_config:
      title: junos_port_config
      required:
      - usage
      type: object
      properties:
        ae_disable_lacp:
          type: boolean
          description: To disable LACP support for the AE interface
        ae_idx:
          type: integer
          description: Users could force to use the designated AE name
          contentEncoding: int32
        ae_lacp_force_up:
          type: boolean
          description: 'If `aggregated`==`true`, sets the state of the interface as UP when the peer has limited LACP capability. Use case: When a device connected to this AE port is ZTPing for the first time, it will not have LACP configured on the other end. **Note:** Turning this on will enable force-up on one of the interfaces in the bundle only'
          default: false
        ae_lacp_passive:
          type: boolean
          description: If `aggregated`==`true`, sets LACP to passive mode on this AE interface; by default, active (fast) mode is used
          default: false
        ae_lacp_slow:
          type: boolean
          description: To use slow timeout
        aggregated:
          type: boolean
          description: Whether this port is configured as an aggregated Ethernet member
          default: false
        critical:
          type: boolean
          description: To generate port up/down alarm
          default: false
        description:
          type: string
          description: Human-readable description for this Junos port
        disable_autoneg:
          type: boolean
          description: If `speed` and `duplex` are specified, whether to disable autonegotiation
          default: false
        duplex:
          allOf:
          - $ref: '#/components/schemas/junos_port_config_duplex2'
          - description: 'Link duplex mode for this Junos port. enum: `auto`, `full`, `half`.'
        dynamic_usage:
          type:
          - string
          - 'null'
          description: Enable dynamic usage for this port. Set to `dynamic` to enable.
        esilag:
          type: boolean
          description: Whether this Junos port participates in an ESI-LAG
        mtu:
          type: integer
          description: Media maximum transmission unit (MTU) is the largest data unit that can be forwarded without fragmentation
          contentEncoding: int32
          default: 1514
        networks:
          type: array
          items:
            type: string
          description: List of network names. Required if `usage`==`inet`
        no_local_overwrite:
          type: boolean
          description: Prevent helpdesk to override the port config
          default: true
        poe_disabled:
          type: boolean
          description: Whether PoE capabilities are disabled for this Junos port
          default: false
        port_network:
          type: string
          description: Required if `usage`==`vlan_tunnel`. Q-in-Q tunneling using All-in-one bundling. This also enables standard L2PT for interfaces that are not encapsulation tunnel interfaces and uses MAC rewrite operation. [View more information](https://www.juniper.net/documentation/us/en/software/junos/multicast-l2/topics/topic-map/q-in-q.html#id-understanding-qinq-tunneling-and-vlan-translation)
        speed:
          allOf:
          - $ref: '#/components/schemas/junos_port_config_speed1'
          - description: 'Link speed for this Junos port. enum: `10m`, `100m`, `1g`, `2.5g`, `5g`, `10g`, `25g`, `40g`, `100g`, `auto`.'
        usage:
          type: string
          description: Port usage name. For Q-in-Q, use `vlan_tunnel`. If EVPN is used, use `evpn_uplink`or `evpn_downlink`
      description: Junos switch port configuration
    junos_port_config_duplex:
      title: junos_port_config_duplex
      enum:
      - auto
      - full
      - half
      type: string
      description: 'enum: `auto`, `full`, `half`'
    junos_port_config_speed:
      title: junos_port_config_speed
      enum:
      - 10m
      - 100m
      - 1g
      - 2.5g
      - 5g
      - 10g
      - 25g
      - 40g
      - 100g
      - auto
      type: string
      description: 'enum: `100m`, `10m`, `1g`, `2.5g`, `5g`, `10g`, `25g`, `40g`, `100g`,`auto`'
    l2tp_state:
      title: l2tp_state
      enum:
      - established
      - established_with_session
      - idle
      - wait-ctrl-conn
      - wait-ctrl-reply
      type: string
      description: 'enum: `established`, `established_with_session`, `idle`, `wait-ctrl-conn`, `wait-ctrl-reply`'
      examples:
      - established
    last_config_device_type:
      title: last_config_device_type
      enum:
      - ap
      - gateway
      - switch
      - mxedge
      type: string
      description: 'enum: `ap`, `gateway`, `mxedge`, `switch`'
    last_trouble:
      title: last_trouble
      type: object
      properties:
        code:
          type: string
          description: Trouble code; definitions are listed at [List Ap Led Definition]($e/Constants%20Definitions/listApLedDefinition)
          examples:
          - '03'
        timestamp:
          type: number
          description: Time when the last trouble code was reported
          readOnly: true
      description: Last trouble indicator reported by a switch
    lat_lng:
      title: lat_lng
      required:
      - lat
      - lng
      type: object
      properties:
        lat:
          type: number
          description: Geographic latitude in decimal degrees
          examples:
          - 37.295833
        lng:
          type: number
          description: Geographic longitude in decimal degrees
          examples:
          - -122.032946
      description: Geographic latitude and longitude coordinate pair
    latlng_br:
      title: latlng_br
      type: object
      properties:
        lat:
          type: string
          description: Bottom-right latitude for the Google map bounds
        lng:
          type: string
          description: Bottom-right longitude for the Google map bounds
      description: When `type`==`google`, latitude and longitude of the bottom-right corner
    latlng_tl:
      title: latlng_tl
      type: object
      properties:
        lat:
          type: string
          description: Top-left latitude for the Google map bounds
        lng:
          type: string
          description: Top-left longitude for the Google map bounds
      description: When `type`==`google`, latitude and longitude of the top-left corner
    license:
      title: license
      type: object
      properties:
        amendments:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/license_amendment'
          description: Read-only license amendments associated with the organization
          readOnly: true
        entitled:
          type: object
          additionalProperties:
            type: integer
            format: int32
          description: Property key is license type (e.g. SUB-MAN) and Property value is the number of licenses entitled.
          readOnly: true
        fully_loaded:
          type: object
          additionalProperties:
            type: integer
            format: int32
          description: Maximum license demand by service if all organization devices use each service
          readOnly: true
        licenses:
          type: array
          items:
            $ref: '#/components/schemas/license_sub'
          description: Read-only license subscriptions for the organization
        summary:
          type: object
          additionalProperties:
            type: integer
            format: int32
          description: Current license consumption by license type
          readOnly: true
        usages:
          type: object
          additionalProperties:
            type: integer
            format: int32
          description: Available license counts by service
          readOnly: true
      description: Organization license entitlement, subscription, and usage summary
    license_amendment:
      title: license_amendment
      type: object
      properties:
        created_time:
          type: number
          description: Timestamp when the license amendment was created
          readOnly: true
        end_time:
          type: integer
          description: End time of the license amendment
          contentEncoding: int32
          readOnly: true
        id:
          type: string
          description: Unique identifier of the license amendment
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        modified_time:
          type: number
          description: Timestamp when the license amendment was last modified
          readOnly: true
        quantity:
          type: integer
          description: License quantity associated with this amendment
          contentEncoding: int32
          readOnly: true
        start_time:
          type: integer
          description: Start time of the license amendment
          contentEncoding: int32
          readOnly: true
        subscription_id:
          type: string
          description: Subscription identifier associated with this amendment
          readOnly: true
        type:
          type: string
          description: License type affected by this amendment
          readOnly: true
      description: Read-only change applied to a license subscription
    license_sub:
      title: license_sub
      type: object
      properties:
        created_time:
          type: number
          description: Timestamp when the license subscription was created
          readOnly: true
        end_time:
          type: integer
          description: End date of the license term
          contentEncoding: int32
          readOnly: true
        id:
          type: string
          description: Unique identifier of the license subscription
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        modified_time:
          type: number
          description: Timestamp when the license subscription was last modified
          readOnly: true
        order_id:
          type: string
          description: Order identifier for this license subscription
          readOnly: true
        org_id:
          type: string
          description: Organization that owns this license subscription
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        quantity:
          type: integer
          description: Number of devices entitled for this license
          contentEncoding: int32
          readOnly: true
        remaining_quantity:
          type: integer
          description: Number of licenses left in this subscription
          contentEncoding: int32
        start_time:
          type: integer
          description: Start date of the license term
          contentEncoding: int32
          readOnly: true
        subscription_id:
          type: string
          description: Subscription identifier for this license subscription
          readOnly: true
        type:
          type: string
          description: License type for this subscription
          readOnly: true
      description: Read-only license subscription record
    license_usage_org:
      title: license_usage_org
      required:
      - num_devices
      - site_id
      - usages
      type: object
      properties:
        for_site:
          type: boolean
          description: Whether this license usage record is scoped to a site
          readOnly: true
        fully_loaded:
          type: object
          additionalProperties:
            type: integer
            format: int32
          description: Maximum license demand by service if all organization devices use each service
          readOnly: true
        num_devices:
          type: integer
          description: Number of devices counted in this license usage scope
          contentEncoding: int32
          readOnly: true
        site_id:
          type: string
          description: Site associated with this license usage record
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        summary:
          type: object
          additionalProperties:
            type: integer
            format: int32
          description: Current license consumption by license type for this usage scope
          readOnly: true
        usages:
          type: object
          additionalProperties:
            type: integer
            format: int32
          description: Available license counts by service for this usage scope
          readOnly: true
      description: License usage record for an organization usage scope
    license_usage_site:
      title: license_usage_site
      required:
      - org_entitled
      - svna_enabled
      - trial_enabled
      - usages
      - vna_eligible
      - vna_ui
      - wvna_eligible
      type: object
      properties:
        org_entitled:
          type: object
          additionalProperties:
            type: integer
            format: int32
          description: Organization-level license entitlements available to this site
          examples:
          - SUB-LOC: 30
            SUB-MAN: 60
        svna_enabled:
          type: boolean
          description: Eligibility for the Switch SLE
        trial_enabled:
          type: boolean
          description: Whether trial licensing is enabled for the site
        usages:
          type: object
          additionalProperties:
            type: integer
            format: int32
          description: License usage counts by subscription type for this site
          examples:
          - SUB-LOC: 30
            SUB-MAN: 60
        vna_eligible:
          type: boolean
          description: Eligibility for the AP/Client SLE
        vna_ui:
          type: boolean
          description: If True, Conversational Assistant and Marvis Action available
        wvna_eligible:
          type: boolean
          description: Eligibility for the WAN SLE
      description: Site license usage and entitlement response
    list_msp_logs_sort:
      title: list_msp_logs_sort
      enum:
      - -timestamp
      - admin_id
      - site_id
      - timestamp
      type: string
      description: 'enum: `-timestamp`, `admin_id`, `site_id`, `timestamp`'
    list_org_logs_sort:
      title: list_org_logs_sort
      enum:
      - -timestamp
      - admin_id
      - site_id
      - timestamp
      type: string
      description: 'enum: `-timestamp`, `admin_id`, `site_id`, `timestamp`'
    locate_switch:
      title: locate_switch
      type: object
      properties:
        duration:
          maximum: 120
          minimum: 1
          type: integer
          description: Minutes the leds should keep flashing
          contentEncoding: int32
          default: 5
        mac:
          type: string
          description: For virtual chassis, the MAC of the member
          examples:
          - f01c2d4ff760
      description: Request body for locating a switch or virtual chassis member by MAC address for a limited duration
    log_event:
      title: log_event
      required:
      - message
      - org_id
      - timestamp
      type: object
      properties:
        admin_id:
          type:
          - string
          - 'null'
          description: Admin user identifier associated with the log event
          contentEncoding: uuid
          readOnly: true
        admin_name:
          type:
          - string
          - 'null'
          description: Name of the admin that performs the action
          readOnly: true
        after:
          type: object
          description: field values after the change
          readOnly: true
        before:
          type: object
          description: field values prior to the change
          readOnly: true
        device_id:
          type:
          - string
          - 'null'
          description: Device identifier associated with the log event
          contentEncoding: uuid
          readOnly: true
        for_site:
          type: boolean
          description: Whether this log event is scoped to a site
          readOnly: true
        id:
          type: string
          description: Unique identifier of the log event
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        message:
          type: string
          description: Human-readable log message describing the event
          readOnly: true
        org_id:
          type: string
          description: Organization associated with the log event
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        site_id:
          type:
          - string
          - 'null'
          description: Site associated with the log event, if any
          contentEncoding: uuid
          readOnly: true
        src_ip:
          type: string
          description: sender source IP address
        timestamp:
          type: number
          description: Time when the log event occurred
          readOnly: true
      description: Audit log event recorded for an organization or site
    login:
      title: login
      required:
      - email
      - password
      type: object
      properties:
        email:
          type: string
          description: Administrator email address used to log in
          examples:
          - test@mistsys.com
        password:
          type: string
          description: Administrator password used to log in
          examples:
          - foryoureyesonly
        two_factor:
          type: string
          description: Optional two-factor authentication code for the login request
          examples:
          - '123456'
      description: Login request using email/password and an optional two-factor code
    login_failures:
      title: login_failures
      type: object
      properties:
        email:
          type: string
          description: User email address for the failed login attempts
          examples:
          - admin@test.com
        last_failure_at:
          type: integer
          description: Time of the most recent failed login attempt
          contentEncoding: int32
          examples:
          - 1509161968
        num_attempts:
          type: integer
          description: Number of failed login attempts
          contentEncoding: int32
          examples:
          - 1
        src_ips:
          type: array
          items:
            type: string
          description: Source IP addresses observed for failed login attempts
          examples:
          - - 192.168.1.39
            - 192.168.1.38
            - 192.168.1.37
        user_agents:
          type: array
          items:
            type: string
          description: User-Agent strings observed for failed login attempts
          examples:
          - - Test UA 39
            - Test UA 38
            - Test UA 37
      description: Failed login attempt summary with source IPs and user agents
    mac_addresses:
      title: mac_addresses
      required:
      - macs
      type: object
      properties:
        macs:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            type: string
          description: List of MAC addresses included in the request
          examples:
          - - 683b679ac024
      description: Request containing one or more MAC addresses
    mac_table_stats:
      title: mac_table_stats
      type: object
      properties:
        mac_table_count:
          type: integer
          description: Number of learned MAC table entries currently present
          contentEncoding: int32
        max_mac_entries_supported:
          type: integer
          description: Maximum number of MAC table entries supported
          contentEncoding: int32
      description: MAC table capacity and usage statistics
    map:
      title: map
      type: object
      properties:
        created_time:
          type: number
          description: Timestamp when the map was created
          readOnly: true
        flags:
          type: object
          additionalProperties:
            type: integer
            format: int32
          description: Name/val pair objects for location engine to use
          readOnly: true
          examples:
          - assetHoldTime: 5
            storeTime: 10
        for_site:
          type: boolean
          description: Whether this map belongs to a site scope
          readOnly: true
        geofences:
          type: array
          items:
            $ref: '#/components/schemas/map_geofence'
          description: Location boundary definitions configured on this map
        group_idx:
          type: integer
          description: Optional floor or group ordering index for this map
          contentEncoding: int32
          examples:
          - 1
        group_name:
          type: string
          description: Optional floor or group display name for this map
          examples:
          - East Wing
        height:
          type: integer
          description: When `type`==`image`, height of the map image in pixels
          contentEncoding: int32
          examples:
          - 1500
        height_m:
          type: number
          description: Physical height of the map in meters
        id:
          type: string
          description: Unique identifier of the map
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        latlng_br:
          allOf:
          - $ref: '#/components/schemas/latlng_br1'
          - description: When `type`==`google`, bottom-right map bounds coordinate
        latlng_tl:
          allOf:
          - $ref: '#/components/schemas/latlng_tl1'
          - description: When `type`==`google`, top-left map bounds coordinate
        locked:
          type: boolean
          description: Whether this map is considered locked down
          default: false
        modified_time:
          type: number
          description: Timestamp when the map was last modified
          readOnly: true
        name:
          type: string
          description: The name of the map
          examples:
          - Mist Office
        occupancy_limit:
          type: integer
          description: Maximum occupancy configured for this map
          contentEncoding: int32
        org_id:
          type: string
          description: Organization associated with this map
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        orientation:
          maximum: 359
          minimum: 0
          type: integer
          description: Map orientation in degrees; 0 means up is north, 90 means up is west
          contentEncoding: int32
          default: 0
          examples:
          - 30
        origin_x:
          type: integer
          description: User-annotated X origin, pixels
          contentEncoding: int32
          examples:
          - 35
        origin_y:
          type: integer
          description: User-annotated Y origin, pixels
          contentEncoding: int32
          examples:
          - 60
        ppm:
          type: number
          description: When `type`==`image`, pixels per meter for the map image
          examples:
          - 40.94
        site_id:
          type: string
          description: Site associated with this map, when scoped to a site
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        sitesurvey_path:
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/map_sitesurvey_path_items'
          description: Site survey path geometry for this map
        thumbnail_url:
          type: string
          description: When `type`==`image`, URL for the thumbnail image or preview
          readOnly: true
          examples:
          - https://url/to/image.png
        type:
          allOf:
          - $ref: '#/components/schemas/map_type2'
          - description: Map type, such as `image` or `google`
            examples:
            - image
        url:
          type: string
          description: When `type`==`image`, URL for the map image
          readOnly: true
          examples:
          - https://url/to/image.png
        view:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/map_view2'
          - description: 'If `type`==`google`, map tile view to display. enum: `hybrid`, `roadmap`, `satellite`, `terrain`.'
        wall_path:
          allOf:
          - $ref: '#/components/schemas/map_wall_path2'
          - description: Wall path geometry for this map
        wayfinding:
          allOf:
          - $ref: '#/components/schemas/map_wayfinding2'
          - description: Navigation pathfinding settings for this map
        wayfinding_path:
          allOf:
          - $ref: '#/components/schemas/map_wayfinding_path2'
          - description: Wayfinding path geometry for this map
        width:
          type: integer
          description: When `type`==`image`, width of the map image in pixels
          contentEncoding: int32
          examples:
          - 1250
        width_m:
          type: number
          description: Physical width of the map in meters
      description: Map or floorplan metadata for a site or organization
    map_geofence:
      title: map_geofence
      type: object
      properties:
        name:
          type: string
          description: Display name for the map geofence
          examples:
          - example
        vertices:
          type: array
          items:
            $ref: '#/components/schemas/map_geofence_vertice'
          description: Polygon points that define the geofence boundary
      description: Geofence drawn on a map
    map_geofence_vertice:
      title: map_geofence_vertice
      type: object
      properties:
        X:
          type: number
          description: Geofence vertex X coordinate in map units
          examples:
          - 700
        Y:
          type: number
          description: Geofence vertex Y coordinate in map units
          examples:
          - 100
      description: Vertex coordinate for a map geofence polygon
    map_import_json:
      title: map_import_json
      required:
      - vendor_name
      type: object
      properties:
        import_all_floorplans:
          type: boolean
          description: Whether to import all floorplans from the uploaded map JSON
          default: false
        import_height:
          type: boolean
          description: Whether to import height metadata from the uploaded map JSON
          default: true
        import_orientation:
          type: boolean
          description: Whether to import orientation metadata from the uploaded map JSON
          default: true
        vendor_name:
          allOf:
          - $ref: '#/components/schemas/map_import_json_vendor_name2'
          - description: 'Map import vendor for the uploaded JSON. enum: `ekahau`, `ibwave`.'
            examples:
            - ekahau
      description: Options for importing map data from Ekahau or iBwave JSON
    map_import_json_vendor_name:
      title: map_import_json_vendor_name
      enum:
      - ekahau
      - ibwave
      type: string
      description: 'Map import vendor for the uploaded JSON. enum: `ekahau`, `ibwave`'
      examples:
      - ekahau
    map_jibestream:
      title: map_jibestream
      required:
      - client_id
      - client_secret
      - customer_id
      - endpoint_url
      - map_id
      - mmpp
      - ppm
      - vendor_name
      - venue_id
      type: object
      properties:
        client_id:
          type: string
          description: Client identifier for the Jibestream API
          contentEncoding: uuid
          examples:
          - 199d6770-0f6f-407a-9bd5-fc33c7840194
        client_secret:
          type: string
          description: Client secret for the Jibestream API
          contentEncoding: password
          examples:
          - /9Nog3yDzcYj0bY91XJZQLCt+m9DXaIVhx+Ghk3ddd
        customer_id:
          type: integer
          description: Jibestream customer record id
          contentEncoding: int32
          examples:
          - 123
        endpoint_url:
          type: string
          description: Map contents endpoint host
          examples:
          - https://api.jibestream.com
        map_id:
          type: string
          description: Jibestream map identifier to import
          contentEncoding: uuid
          examples:
          - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        mmpp:
          type: integer
          description: Millimeters per pixel for the Jibestream map
          contentEncoding: int32
          examples:
          - 223
        ppm:
          type: number
          description: Pixel per meter, same as the map JSON value.
          examples:
          - 4
        vendor_name:
          const: jibestream
          type: string
          description: Vendor identifier for a Jibestream import
        venue_id:
          type: integer
          description: Venue or organization id
          contentEncoding: int32
          examples:
          - 123
      description: Jibestream map import configuration
    map_jibestream_vendor_name:
      title: map_jibestream_vendor_name
      const: jibestream
      type: string
      description: 'The vendor ‘jibestream’. enum: `jibestream`'
    map_micello:
      title: map_micello
      required:
      - account_key
      - default_level_id
      - map_id
      - vendor_name
      type: object
      properties:
        account_key:
          type: string
          description: Account key that has access to the map
        default_level_id:
          type: integer
          description: Micello default floor or level identifier
          contentEncoding: int32
          examples:
          - 5
        map_id:
          type: string
          description: Micello map identifier to import
          contentEncoding: uuid
          examples:
          - 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
        vendor_name:
          const: micello
          type: string
          description: Vendor identifier for a Micello import
      description: Micello map import configuration
    map_micello_vendor_name:
      title: map_micello_vendor_name
      const: micello
      type: string
      description: 'The vendor ‘micello’. enum: `micello`'
    map_node:
      title: map_node
      required:
      - name
      type: object
      properties:
        edges:
          type: object
          additionalProperties:
            type: string
          description: Adjacent node IDs and path weights for this map node
          examples:
          - N1: '1'
        name:
          type: string
          description: Map node identifier or display name
          examples:
          - N1
        position:
          allOf:
          - $ref: '#/components/schemas/map_node_position2'
          - description: Coordinates of this map node
      description: Node in a map path graph
    map_node_position:
      title: map_node_position
      required:
      - x
      - y
      type: object
      properties:
        x:
          type: number
          description: Horizontal coordinate of the map node
          examples:
          - 746
        y:
          type: number
          description: Vertical coordinate of the map node
          examples:
          - 104
      description: Position of a map path node
    map_org_import_file:
      title: map_org_import_file
      type: object
      properties:
        auto_deviceprofile_assignment:
          type: boolean
          description: Whether to auto assign device to deviceprofile by name
          examples:
          - true
        csv:
          type: string
          description: Optional AP name-mapping CSV file
          contentEncoding: base64
        file:
          type: string
          description: Ekahau or iBwave floorplan file to import
          contentEncoding: base64
        json:
          allOf:
          - $ref: '#/components/schemas/map_org_import_file_json2'
          - description: Import options for the organization map file
      description: Multipart payload for importing map files at organization scope
    map_org_import_file_json:
      title: map_org_import_file_json
      required:
      - vendor_name
      type: object
      properties:
        import_all_floorplans:
          type: boolean
          description: Whether to import all floorplans from the uploaded map file
          default: false
        import_height:
          type: boolean
          description: Whether to import height metadata from the uploaded map file
          default: true
        import_orientation:
          type: boolean
          description: Whether to import orientation metadata from the uploaded map file
          default: true
        site_id:
          type: string
          description: Target site for imported floorplans, when specified
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        vendor_name:
          allOf:
          - $ref: '#/components/schemas/map_org_import_file_json_vendor_name2'
          - description: 'Map import vendor for the uploaded file. enum: `ekahau`, `ibwave`.'
            examples:
            - ekahau
      description: Options for importing map files at organization scope
    map_org_import_file_json_vendor_name:
      title: map_org_import_file_json_vendor_name
      enum:
      - ekahau
      - ibwave
      type: string
      description: 'Map import vendor for the uploaded file. enum: `ekahau`, `ibwave`'
      examples:
      - ekahau
    map_site_import_file:
      title: map_site_import_file
      type: object
      properties:
        auto_deviceprofile_assignment:
          type: boolean
          description: Whether to auto assign device to deviceprofile by name
          examples:
          - true
        csv:
          type: string
          description: Optional AP name-mapping CSV file
          contentEncoding: base64
        file:
          type: string
          description: Ekahau or iBwave floorplan file to import
          contentEncoding: base64
        json:
          allOf:
          - $ref: '#/components/schemas/map_import_json1'
          - description: Import options for the site map file
      description: Multipart payload for importing map files at site scope
    map_site_replace_file:
      title: map_site_replace_file
      required:
      - file
      type: object
      properties:
        file:
          type: string
          description: Map image file used to replace the existing site map
          contentEncoding: base64
        json:
          allOf:
          - $ref: '#/components/schemas/map_site_replace_file_json2'
          - description: Replacement transform options for the map image
      description: Multipart payload for replacing a site map image
    map_site_replace_file_json:
      title: map_site_replace_file_json
      type: object
      properties:
        transform:
          allOf:
          - $ref: '#/components/schemas/map_site_replace_file_json_transform2'
          - description: Coordinate transform to apply when replacing the map image
      description: Options for replacing a site map image
    map_site_replace_file_json_transform:
      title: map_site_replace_file_json_transform
      type: object
      properties:
        rotation:
          type: number
          description: Whether to rotate the replacing image, in degrees
          default: 0
        scale:
          type: number
          description: Whether to scale the replacing image
          default: 1
          examples:
          - 0.98
        x:
          type: number
          description: Where the (0, 0) of the new image is relative to the original map
          default: 0
          examples:
          - 3.16
        y:
          type: number
          description: Where the (0, 0) of the new image is relative to the original map
          default: 0
          examples:
          - 12
      description: If `transform` is provided, all the locations of the objects on the map (AP, Zone, Vbeacon, Beacon) will be transformed as well (relative to the new Map)
    map_sitesurvey_path_items:
      title: map_sitesurvey_path_items
      type: object
      properties:
        coordinate:
          type: string
          description: Site survey path coordinate space
          examples:
          - actual
        id:
          type: string
          description: Unique identifier of the site survey path
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        name:
          type: string
          description: Display name of the site survey path
          examples:
          - Default
        nodes:
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/map_node'
          description: Path nodes included in the site survey path
      description: Site survey path definition on a map
    map_type:
      title: map_type
      enum:
      - google
      - image
      type: string
      description: 'Map type, such as `image` or `google`. enum: `google`, `image`'
      examples:
      - image
    map_view:
      title: map_view
      enum:
      - hybrid
      - roadmap
      - satellite
      - terrain
      type: string
      description: 'if `type`==`google`. enum: `hybrid`, `roadmap`, `satellite`, `terrain`'
    map_wall_path:
      title: map_wall_path
      type: object
      properties:
        coordinate:
          type: string
          description: Wall path coordinate space
          examples:
          - actual
        nodes:
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/map_node'
          description: Path nodes that define the wall geometry
      description: JSON blob for wall definition (same format as wayfinding_path)
    map_wayfinding:
      title: map_wayfinding
      type: object
      properties:
        micello:
          allOf:
          - $ref: '#/components/schemas/map_wayfinding_micello2'
          - description: External Micello wayfinding integration settings for this map
        snap_to_path:
          type: boolean
          description: Whether wayfinding should snap routes to configured paths
      description: Properties related to wayfinding
    map_wayfinding_micello:
      title: map_wayfinding_micello
      type: object
      properties:
        account_key:
          type: string
          description: Micello account key used for wayfinding
          examples:
          - adasdf
        default_level_id:
          type: integer
          description: Default Micello floor or level identifier for wayfinding
          contentEncoding: int32
          examples:
          - 5
        map_id:
          type: string
          description: Micello map identifier used for wayfinding
          examples:
          - c660f81dd250c
      description: Micello wayfinding integration settings
    map_wayfinding_path:
      title: map_wayfinding_path
      type: object
      properties:
        coordinate:
          type: string
          description: Wayfinding path coordinate space
          examples:
          - actual
        nodes:
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/map_node'
          description: Path nodes used for wayfinding routes
      description: JSON blob for wayfinding (using Dijkstra’s algorithm)
    mapstack:
      title: mapstack
      type: object
      properties:
        name:
          type: string
          description: The name of the map stack
          examples:
          - Board Room
      description: Map Stack filter or creation payload
    mapstack_response:
      title: mapstack_response
      type: object
      properties:
        created_time:
          type: number
          description: Timestamp when the map stack was created
          readOnly: true
        id:
          type: string
          description: Unique identifier of the map stack
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        modified_time:
          type: number
          description: Timestamp when the map stack was last modified
          readOnly: true
        name:
          type: string
          description: The name of the map stack
          examples:
          - Board Room
        org_id:
          type: string
          description: Organization associated with the map stack
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        site_id:
          type: string
          description: Site associated with the map stack
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
      description: Map Stack response object
    marvis:
      title: marvis
      type: object
      properties:
        auto_operations:
          allOf:
          - $ref: '#/components/schemas/marvis_auto_operations2'
          - description: Automatic remediation operations controlled by Marvis
      description: Marvis automation and client settings
    marvis_auto_operations:
      title: marvis_auto_operations
      type: object
      properties:
        ap_insufficient_capacity:
          type: boolean
          description: Whether Marvis may remediate AP insufficient-capacity issues automatically
          default: false
        ap_loop:
          type: boolean
          description: Whether Marvis may remediate AP loop issues automatically
          default: false
        ap_non_compliant:
          type: boolean
          description: Whether Marvis may remediate AP non-compliance automatically
          default: false
        bounce_port_for_abnormal_poe_client:
          type: boolean
          description: Whether Marvis may bounce switch ports for abnormal PoE clients
          default: false
        disable_port_when_ddos_protocol_violation:
          type: boolean
          description: Whether Marvis may disable a port when DDOS protocol violations are detected
          default: false
        disable_port_when_rogue_dhcp_server_detected:
          type: boolean
          description: Whether Marvis may disable a port when a rogue DHCP server is detected
          default: false
        gateway_non_compliant:
          type: boolean
          description: Whether Marvis may remediate non-compliant gateways automatically
          default: false
        switch_misconfigured_port:
          type: boolean
          description: Whether Marvis may remediate misconfigured switch ports automatically
          default: false
        switch_port_stuck:
          type: boolean
          description: Whether Marvis may remediate stuck switch ports automatically
          default: false
      description: Marvis automatic remediation operation toggles
    marvis_client:
      title: marvis_client
      type: object
      properties:
        disabled:
          type: boolean
          description: Whether this Marvis Client profile is disabled
          default: false
        enrollment_url:
          type: string
          description: In MDM, add `--enrollment_url <enrollment_url>` to the install command
          readOnly: true
          examples:
          - marvisclient://api.mist.com/path/to/url
        id:
          type: string
          description: Unique identifier of the Marvis Client profile
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        location:
          allOf:
          - $ref: '#/components/schemas/marvis_client_location2'
          - description: Client location collection settings for Marvis Client
        name:
          type: string
          description: Display name for the Marvis Client profile
          examples:
          - Handhelds
        synthetic_test:
          allOf:
          - $ref: '#/components/schemas/marvis_client_synthetic_test'
          - description: Synthetic test settings for Marvis Client
        telemetry:
          allOf:
          - $ref: '#/components/schemas/marvis_client_telemetry2'
          - description: Client telemetry collection settings for Marvis Client
      description: Marvis Client configuration profile
    marvis_client_event:
      title: marvis_client_event
      type: object
      properties:
        band:
          type: string
          description: Wi-Fi band at the time of the event
        bssid:
          type: string
          description: BSSID the client roamed to (for roam events)
        channel:
          type: integer
          description: Channel the client roamed to (for roam events)
          contentEncoding: int32
        device_id:
          type: string
          description: UUID of the device the Marvis Client is installed on
          contentEncoding: uuid
        hostname:
          type: string
          description: Device hostname
        location:
          allOf:
          - $ref: '#/components/schemas/stats_marvis_client_location1'
          - description: Last known device location
        neighbor_ap_report:
          type: array
          items:
            $ref: '#/components/schemas/marvis_client_event_neighbor_ap'
          description: List of neighboring APs observed at the time of the event
        org_id:
          type: string
          description: Organization UUID
          contentEncoding: uuid
        percent:
          type: integer
          description: Battery level percentage at the time of the event (for battery events)
          contentEncoding: int32
        pre_bssid:
          type: string
          description: BSSID the client roamed from (for roam events)
        pre_channel:
          type: integer
          description: Channel the client roamed from (for roam events)
          contentEncoding: int32
        pre_rssi:
          type: integer
          description: RSSI before the roam event, in dBm
          contentEncoding: int32
        rssi:
          type: integer
          description: Wi-Fi RSSI at the time of the event, in dBm
          contentEncoding: int32
        ssid:
          type: string
          description: SSID the client was connected to
        timestamp:
          type: integer
          description: Event timestamp, in epoch seconds
          contentEncoding: int32
        type:
          type: string
          description: Event type
        wifi_ip:
          type: string
          description: Device Wi-Fi IP address at the time of the event
        wifi_mac:
          type: string
          description: Device Wi-Fi MAC address
      description: A Marvis Client event record
    marvis_client_event_neighbor_ap:
      title: marvis_client_event_neighbor_ap
      type: object
      properties:
        band:
          type: string
          description: Wi-Fi band the AP is operating on
        bssid:
          type: string
          description: BSSID of the neighboring AP
        channel:
          type: integer
          description: Channel the neighboring AP is on
          contentEncoding: int32
        rssi:
          type: integer
          description: RSSI of the neighboring AP signal, in dBm
          contentEncoding: int32
      description: A neighboring AP observed in a Marvis Client event
    marvis_client_events_search:
      title: marvis_client_events_search
      type: object
      properties:
        limit:
          type: integer
          description: Maximum number of results requested
          contentEncoding: int32
        results:
          type: array
          items:
            $ref: '#/components/schemas/marvis_client_event'
          description: List of Marvis Client events
        total:
          type: integer
          description: Total number of matching results
          contentEncoding: int32
      description: Paginated list of Marvis Client events
    marvis_client_insights:
      title: marvis_client_insights
      type: object
      properties:
        avg_battery:
          type: array
          items:
            type: number
          description: Average battery level per interval bucket
        avg_cellular_rssi:
          type: array
          items:
            type: number
          description: Average cellular RSSI per interval bucket, in dBm
        avg_cpu:
          type: array
          items:
            type: number
          description: Average CPU utilization per interval bucket (0–100)
        avg_memory:
          type: array
          items:
            type: number
          description: Average memory utilization per interval bucket (0–100)
        avg_wifi_rssi:
          type: array
          items:
            type: number
          description: Average Wi-Fi RSSI per interval bucket, in dBm
        end:
          type: integer
          description: End of the reporting window, in epoch seconds
          contentEncoding: int32
        interval:
          type: integer
          description: Duration of each interval bucket, in seconds
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of results requested
          contentEncoding: int32
        page:
          type: integer
          description: Current page number
          contentEncoding: int32
        rt:
          type: array
          items:
            type: string
          description: List of ISO 8601 timestamp strings for each interval bucket
        start:
          type: integer
          description: Start of the reporting window, in epoch seconds
          contentEncoding: int32
      description: Time-series performance metrics for a Marvis Client device
    marvis_client_location:
      title: marvis_client_location
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether location collection is enabled for Marvis Client
      description: Location collection settings for Marvis Client
    marvis_client_synthetic_test:
      title: marvis_client_synthetic_test
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether synthetic testing is enabled for Marvis Client
      description: Synthetic test settings for Marvis Client
    marvis_client_telemetry:
      title: marvis_client_telemetry
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether telemetry collection is enabled for Marvis Client
      description: "Note: some stats are not collected when it's not connected to Mist infrastructure"
    marvis_config_action:
      title: marvis_config_action
      type: object
      properties:
        admin_id:
          type: string
          description: Admin UUID associated with the config action
          contentEncoding: uuid
        id:
          type: string
          description: UUID of the config action
          contentEncoding: uuid
        mac:
          type: string
          description: Device MAC address
        op:
          type: string
          description: Operation type (e.g. disable_port, enable_port, update_mtu, add_vlans_to_port)
        org_id:
          type: string
          description: Organization UUID
          contentEncoding: uuid
        port_id:
          type: string
          description: Port identifier (e.g. ge-0/0/13)
        reason:
          type: string
          description: Reason for the config action (e.g. rogue_dhcp_server_detected)
        site_id:
          type: string
          description: Site UUID
          contentEncoding: uuid
        src:
          type: string
          description: Source of the config action (e.g. marvis)
        timestamp:
          type: number
          description: Timestamp when the config action was recorded, in epoch seconds
        type:
          type: string
          description: Config type (e.g. wired)
        vlan_ids:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: List of VLAN IDs involved in the config action
      description: A Marvis-injected config action record
    marvis_config_actions_search:
      title: marvis_config_actions_search
      type: object
      properties:
        end:
          type: integer
          description: Search window end timestamp, in epoch seconds
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of results requested
          contentEncoding: int32
        results:
          type: array
          items:
            $ref: '#/components/schemas/marvis_config_action'
          description: List of Marvis config actions
        start:
          type: integer
          description: Search window start timestamp, in epoch seconds
          contentEncoding: int32
        total:
          type: integer
          description: Total number of matching results
          contentEncoding: int32
      description: Paginated list of Marvis config actions
    marvis_config_feedback:
      title: marvis_config_feedback
      type: object
      properties:
        note:
          type: string
          description: Free-text note about the feedback
        type:
          allOf:
          - $ref: '#/components/schemas/marvis_config_feedback_type'
          - description: 'Feedback type. enum: `invalid`'
      description: Feedback submission for a Marvis config action
    marvis_config_feedback_response:
      title: marvis_config_feedback_response
      type: object
      properties:
        feedback_note:
          type: string
          description: The note provided with the feedback
        feedback_type:
          type: string
          description: The feedback type that was submitted
      description: Response after submitting feedback on a Marvis config action
    marvis_config_feedback_type:
      title: marvis_config_feedback_type
      const: invalid
      type: string
      description: 'Feedback type. enum: `invalid`'
    marvis_self_driving:
      title: marvis_self_driving
      type: object
      properties:
        wan:
          allOf:
          - $ref: '#/components/schemas/marvis_self_driving_domain4'
          - description: Self-driving automation settings for the WAN domain
        wired:
          allOf:
          - $ref: '#/components/schemas/marvis_self_driving_domain1'
          - description: Self-driving automation settings for the wired domain
        wireless:
          allOf:
          - $ref: '#/components/schemas/marvis_self_driving_domain2'
          - description: Self-driving automation settings for the wireless domain
      description: Self-driving network automation settings per domain
    marvis_self_driving_domain:
      title: marvis_self_driving_domain
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether self-driving automation is enabled for this domain
          default: false
      description: Self-driving automation settings for one Marvis domain
    memory_stat:
      title: memory_stat
      required:
      - usage
      type: object
      properties:
        usage:
          type: number
          description: Current memory utilization percentage for the device or master Routing Engine
      description: Memory utilization statistics for a device; in a virtual chassis, this reports the master Routing Engine
    mfa_secret_type:
      title: mfa_secret_type
      const: qrcode
      type: string
      description: 'MFA secret representation format for enrollment. enum: `qrcode`'
    mist_nacedge:
      title: mist_nacedge
      type: object
      properties:
        auth_ttl:
          maximum: 2592000
          minimum: 60
          type: integer
          description: Cache of last auth result; in seconds
          contentEncoding: int32
          default: 604800
        caching_site_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: List of site UUIDs whose auth requests should be cached by NAC Edges assigned to this site
          examples:
          - - 4ac1dcf4-9d8b-7910-ac87-6ad873648a5c
            - 7dc1acf4-9d8b-7910-ac87-6ad873648a5c
        default_dot1x_vlan:
          type: string
          description: Default vlan for all dot1x devices, if different from default_vlan
          examples:
          - '20'
        default_vlan:
          type: string
          description: Default vlan to assign for devices not in the cache
          examples:
          - test_vlan
        enabled:
          type: boolean
          description: Whether Mist Site Survivability is enabled for the site
        mxedge_hosts:
          type: array
          items:
            type: string
          description: NAC Edge hostnames used for the Site Survivability feature
          examples:
          - - mxedge1.local
      description: Mist NAC Site Survivability settings for the site
    ml_overwrite_additional_properties:
      title: ml_overwrite_additional_properties
      type: object
      properties:
        int:
          type: integer
          description: Location ML intercept value to use for the model
          contentEncoding: int32
        ple:
          type: integer
          description: Path-loss estimate value to use for the location machine learning model
          contentEncoding: int32
      description: Location machine learning parameter overwrite values for one client model
    module_stat_item_errors_items:
      title: module_stat_item_errors_items
      required:
      - since
      - type
      type: object
      properties:
        feature:
          type: string
          description: Affected feature associated with this module error condition
          examples:
          - Mist-Management
        minimum_version:
          type: string
          description: Minimum software version associated with this module error
          examples:
          - 128T-6.0.0-1
        reason:
          type: string
          description: Human-readable reason for the module error condition
        since:
          type: integer
          description: Epoch timestamp when the module error condition began
          contentEncoding: int32
          examples:
          - 1657497600
        type:
          type: string
          description: Module error type code reported by the device
          examples:
          - FW_UPGRADE_REQUIRED_BY_FEATURE
      description: Error condition reported for a device module
    module_stat_item_fans_items:
      title: module_stat_item_fans_items
      type: object
      properties:
        airflow:
          type: string
          description: Direction of airflow reported for the fan
          examples:
          - out
        name:
          type: string
          description: Fan label reported by the device
          examples:
          - Fan 0
        rpm:
          type: integer
          description: Current fan speed in revolutions per minute
          contentEncoding: int32
        status:
          type: string
          description: Operational status reported for the fan
          examples:
          - ok
      description: Cooling fan telemetry for a device module
    module_stat_item_network_resource:
      title: module_stat_item_network_resource
      type: object
      properties:
        count:
          minimum: 0
          type: integer
          description: Current utilization count for the network resource
          contentEncoding: int32
          examples:
          - 17
        limit:
          minimum: 0
          type: integer
          description: Maximum supported count for the network resource
          contentEncoding: int32
          examples:
          - 768000
        type:
          type: string
          description: Network resource category, such as FIB or FLOW
          examples:
          - FIB
      description: Network resource usage counter reported by a device module
    module_stat_item_pics_item:
      title: module_stat_item_pics_item
      type: object
      properties:
        index:
          type: integer
          description: PIC index within the device module
          contentEncoding: int32
        model_number:
          type: string
          description: Model number reported for the PIC
        port_groups:
          type: array
          items:
            $ref: '#/components/schemas/module_stat_item_pics_item_port_groups_item'
          description: Port groups provided by this PIC
      description: Physical Interface Card summary for a device module
    module_stat_item_pics_item_port_groups_item:
      title: module_stat_item_pics_item_port_groups_item
      type: object
      properties:
        count:
          type: integer
          description: Number of ports in this PIC port group
          contentEncoding: int32
        type:
          type: string
          description: Port media or interface type for this PIC port group
      description: Port group summary for a PIC
    module_stat_item_poe:
      title: module_stat_item_poe
      type: object
      properties:
        max_power:
          type: number
          description: Total PoE power budget available to the module, in watts
          examples:
          - 250
        power_draw:
          type: number
          description: Current PoE power draw on the module, in watts
          examples:
          - 120.3
        status:
          type: string
          description: Operational status of PoE on the module
      description: Power over Ethernet telemetry for a device module
    module_stat_item_psus_item:
      title: module_stat_item_psus_item
      type: object
      properties:
        name:
          type: string
          description: Power supply label reported by the device
          examples:
          - Power Supply 0
        status:
          type: string
          description: Operational status reported for the power supply
          examples:
          - ok
      description: Power supply status for a device module
    module_stat_item_temperatures_item:
      title: module_stat_item_temperatures_item
      type: object
      properties:
        celsius:
          type: number
          description: Temperature reading for the sensor, in degrees Celsius
          examples:
          - 45
        name:
          type: string
          description: Temperature sensor label reported by the device
          examples:
          - CPU
        status:
          type: string
          description: Operational status reported for the temperature sensor
          examples:
          - ok
      description: Temperature sensor reading for a device module
    module_stat_item_vc_links_item:
      title: module_stat_item_vc_links_item
      type: object
      properties:
        neighbor_module_idx:
          type: integer
          description: Index of the neighboring module connected through this virtual chassis link
          contentEncoding: int32
          examples:
          - 1
        neighbor_port_id:
          type: string
          description: Port identifier on the neighboring module for this virtual chassis link
          examples:
          - vcp-255/1/0
        port_id:
          type: string
          description: Local port identifier for this virtual chassis link
          examples:
          - vcp-255/1/0
      description: Virtual chassis link endpoint for a device module
    msp:
      title: msp
      type: object
      properties:
        allow_mist:
          type: boolean
          description: Whether Mist support access is allowed for this MSP account
        created_time:
          type: number
          description: Timestamp when the MSP account was created
          readOnly: true
        id:
          type: string
          description: Unique identifier of the MSP account
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        logo_url:
          type: string
          description: For advanced tier (uMSPs) only
        modified_time:
          type: number
          description: Timestamp when the MSP account was last modified
          readOnly: true
        name:
          type: string
          description: Display name of the MSP account
        tier:
          allOf:
          - $ref: '#/components/schemas/msp_tier2'
          - description: 'Service tier for the MSP account. enum: `advanced`, `base`.'
        url:
          type: string
          description: For advanced tier (uMSPs) only
      description: Managed service provider account
    msp_license_action:
      title: msp_license_action
      required:
      - op
      type: object
      properties:
        amendment_id:
          type: string
          description: Required if `op`==`unamend`; identifies the license amendment to undo
        dst_org_id:
          type: string
          description: Required if `op`==`amend`; destination org ID that receives the amended license quantity
          contentEncoding: uuid
        notes:
          type: string
          description: Required if `op`==`annotate`; note text to attach to the license action
        op:
          allOf:
          - $ref: '#/components/schemas/msp_license_action_operation2'
          - minLength: 1
            description: 'License operation to perform for this MSP request. enum: `amend`, `annotate`, `delete`, `unamend`.'
        quantity:
          type: number
          description: Required if `op`==`amend`; license quantity to move to the destination org
        subscription_id:
          minLength: 1
          type: string
          description: Required if `op`==`annotate`; subscription ID for the license action
      description: License operation request for an MSP account
    msp_license_action_operation:
      title: msp_license_action_operation
      enum:
      - amend
      - annotate
      - delete
      - unamend
      type: string
      description: 'enum: `amend`, `annotate`, `delete`, `unamend`'
    msp_logo:
      title: msp_logo
      type: object
      properties:
        logo_url:
          type: string
          description: Public URL for the advanced-tier MSP logo image
      description: Payload for uploading an advanced-tier MSP logo
    msp_logs_count_distinct:
      title: msp_logs_count_distinct
      enum:
      - admin_id
      - admin_name
      - message
      - org_id
      type: string
      description: 'enum: `admin_id`, `admin_name`, `message`, `org_id`'
    msp_marvis_suggestions_count_distinct:
      title: msp_marvis_suggestions_count_distinct
      enum:
      - org_id
      - status
      type: string
      description: 'Distinct field used when counting MSP Marvis suggestions. enum: `org_id`, `status`'
    msp_org_change:
      title: msp_org_change
      required:
      - op
      - org_ids
      type: object
      properties:
        op:
          allOf:
          - $ref: '#/components/schemas/msp_org_change_operation2'
          - description: 'Assignment operation to apply to the listed org IDs. enum: `assign`, `unassign`.'
        org_ids:
          type: array
          items:
            type: string
          description: List of org IDs to assign to or unassign from the MSP account
      description: Request to assign or unassign orgs for an MSP account
    msp_org_change_operation:
      title: msp_org_change_operation
      enum:
      - assign
      - unassign
      type: string
      description: 'Assignment operation to apply to the listed org IDs. enum: `assign`, `unassign`'
    msp_search_type:
      title: msp_search_type
      const: orgs
      type: string
      description: 'Search result type returned by MSP organization search. enum: `orgs`'
    msp_tickets_count_distinct:
      title: msp_tickets_count_distinct
      enum:
      - org_id
      - status
      - type
      type: string
      description: 'enum: `org_id`, `status`, `type`'
    msp_tier:
      title: msp_tier
      enum:
      - advanced
      - base
      type: string
      description: 'Service tier for the MSP account. enum: `advanced`, `base`'
    mxcluster:
      title: mxcluster
      type: object
      properties:
        created_time:
          type: number
          description: Timestamp when the Mist Edge cluster was created
          readOnly: true
        for_site:
          type: boolean
          description: Whether this Mist Edge cluster is scoped to a site
          readOnly: true
        id:
          type: string
          description: Unique identifier of the Mist Edge cluster
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        mist_das:
          allOf:
          - $ref: '#/components/schemas/mxedge_das3'
          - description: Dynamic authorization service settings for the cluster
        mist_nac:
          allOf:
          - $ref: '#/components/schemas/mxcluster_nac3'
          - description: NAC settings for the Mist Edge cluster
        mist_nacedge:
          allOf:
          - $ref: '#/components/schemas/mxcluster_nacedge2'
          - description: NAC Edge survivability settings for the cluster; requires `mist_nac` to be enabled
        modified_time:
          type: number
          description: Timestamp when the Mist Edge cluster was last modified
          readOnly: true
        mxedge_mgmt:
          allOf:
          - $ref: '#/components/schemas/mxedge_mgmt5'
          - description: Out-of-band management settings for Mist Edges in the cluster
        name:
          type: string
          description: Display name of the Mist Edge cluster
        org_id:
          type: string
          description: Identifier of the org that owns the Mist Edge cluster
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        proxy:
          allOf:
          - $ref: '#/components/schemas/proxy4'
          - description: Network proxy settings used by Mist Edges in the cluster to communicate with the Mist Cloud
        radsec:
          allOf:
          - $ref: '#/components/schemas/mxcluster_radsec3'
          - description: TLS RADIUS proxy settings for the Mist Edge cluster
        radsec_tls:
          allOf:
          - $ref: '#/components/schemas/mxcluster_radsec_tls2'
          - description: TLS keypair settings for RadSec on the Mist Edge cluster
        site_id:
          type: string
          description: Identifier of the site when the Mist Edge cluster is site-scoped
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        tunterm_ap_subnets:
          type: array
          items:
            type: string
          description: AP source subnets allowed to establish Mist tunnels
        tunterm_dhcpd_config:
          allOf:
          - $ref: '#/components/schemas/tunterm_dhcpd_config2'
          - description: DHCP relay or server settings for tunneled VLANs
        tunterm_extra_routes:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/mxcluster_tunterm_extra_route'
          description: Extra routes for Mist Tunnel VLAN traffic
        tunterm_hosts:
          type: array
          items:
            type: string
          description: Hostnames or IP addresses used as Mist Tunnel peers
        tunterm_hosts_order:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: Explicit host ordering indexes used when ordered selection is configured
        tunterm_hosts_selection:
          allOf:
          - $ref: '#/components/schemas/mxcluster_tunterm_hosts_selection2'
          - description: 'Selection strategy for ordering tunnel termination hosts. enum: `ordered`, `shuffle`, `shuffle-by-site`.'
        tunterm_monitoring:
          type: array
          items:
            type: array
            items:
              $ref: '#/components/schemas/tunterm_monitoring_item'
          description: Monitoring checks for tunnel termination reachability. Only for Org Mist Edges; use `tunterm_monitoring` in the `site_setting` for site-scoped Mist Edges
        tunterm_monitoring_disabled:
          type: boolean
          description: Whether tunnel termination monitoring is disabled for the cluster
      description: Mist Edge cluster that groups one or more Mist Edge devices for tunneling, RadSec, and related edge services
    mxcluster_nac:
      title: mxcluster_nac
      type: object
      properties:
        acct_server_port:
          type: integer
          description: RADIUS accounting port used by Mist NAC on the cluster
          contentEncoding: int32
          default: 1813
        auth_server_port:
          type: integer
          description: RADIUS authentication port used by Mist NAC on the cluster
          contentEncoding: int32
          default: 1812
        client_ips:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/mxcluster_nac_client_ip'
          description: Property key is the RADIUS Client IP/Subnet.
        enabled:
          type: boolean
          description: Whether Mist NAC is enabled on the cluster
          default: false
        secret:
          type: string
          description: Shared RADIUS secret used by Mist NAC clients
          examples:
          - testing123
      description: Mist NAC RADIUS settings for a Mist Edge cluster. Used when the Mist Edge Cluster is used as a RADIUS Proxy between the local devices and the Mist NAC
    mxcluster_nac_client_ip:
      title: mxcluster_nac_client_ip
      type: object
      properties:
        require_message_authenticator:
          type: boolean
          description: Whether to require Message-Authenticator in requests
          default: false
        secret:
          type: string
          description: Client-specific shared secret, if different from the cluster default
        site_id:
          type: string
          description: Present only for third-party clients, identifies the associated site
          contentEncoding: uuid
          examples:
          - 00000000-0000-0000-1234-000000000000
        vendor:
          allOf:
          - $ref: '#/components/schemas/mxcluster_nac_client_vendor2'
          - description: 'RADIUS client vendor profile for this IP or subnet. enum: `aruba`, `cisco-aironet`, `cisco-dnac`, `cisco-ios`, `cisco-meraki`, `brocade`, `generic`, `juniper`, `paloalto`.'
            examples:
            - cisco-ios
      description: Mist NAC client settings for a RADIUS client IP or subnet
    mxcluster_nac_client_vendor:
      title: mxcluster_nac_client_vendor
      enum:
      - aruba
      - cisco-aironet
      - cisco-dnac
      - cisco-ios
      - cisco-meraki
      - brocade
      - generic
      - juniper
      - paloalto
      type: string
      description: 'convention to be followed is : "<vendor>-<variant>", <variant> could be an os/platform/model/company. For ex: for cisco vendor, there could variants wrt os (such as ios, nxos etc), platforms (asa etc), or acquired companies (such as meraki, aironet) etc. enum: `aruba`, `cisco-aironet`, `cisco-dnac`, `cisco-ios`, `cisco-meraki`, `brocade`, `generic`, `juniper`, `paloalto`'
      examples:
      - cisco-ios
    mxcluster_nacedge:
      title: mxcluster_nacedge
      type: object
      properties:
        auth_ttl:
          maximum: 2592000
          minimum: 60
          type: integer
          description: Cache TTL for last auth result in seconds
          contentEncoding: int32
          default: 604800
        caching_site_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: List of site UUIDs whose auth requests should be cached by NAC Edges in this cluster
          examples:
          - - 4ac1dcf4-9d8b-7910-ac87-6ad873648a5c
            - 7dc1acf4-9d8b-7910-ac87-6ad873648a5c
        default_dot1x_vlan:
          type: string
          description: Default VLAN for all dot1x devices, if different from default_vlan
          examples:
          - '20'
        default_vlan:
          type: string
          description: Default VLAN to assign for devices not in the cache
          examples:
          - testVlan
        enabled:
          type: boolean
          description: Whether NAC Edge survivability is enabled for this cluster
          default: false
        nac_edge_hosts:
          type: array
          items:
            type: string
          description: NAC Edge hostnames used by APs for survivability authentication
          examples:
          - - nac-west-1.corp.com
            - nac-west-2.corp.com
      description: NAC Edge survivability settings for a Mist Edge cluster. Requires `mist_nac` to be enabled on the cluster
    mxcluster_rad_auth_server_keywrap_format:
      title: mxcluster_rad_auth_server_keywrap_format
      enum:
      - ascii
      - hex
      type: string
      description: 'if used for Mist APs. enum: `ascii`, `hex`'
    mxcluster_radsec:
      title: mxcluster_radsec
      type: object
      properties:
        acct_servers:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/mxcluster_radsec_acct_server'
          description: RADIUS accounting servers used by the RadSec proxy
        auth_servers:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/mxcluster_radsec_auth_server'
          description: RADIUS authentication servers used by the RadSec proxy
        enabled:
          type: boolean
          description: Whether to enable service on Mist Edge i.e. RADIUS proxy over TLS
        match_ssid:
          type: boolean
          description: Whether to match ssid in request message to select from a subset of RADIUS servers
        nas_ip_source:
          allOf:
          - $ref: '#/components/schemas/mxcluster_radsec_nas_ip_source2'
          - description: 'Source used to populate NAS-IP-Address and NAS-IPv6-Address attributes. enum: `any`, `oob`, `oob6`, `tunnel`, `tunnel6`.'
        proxy_hosts:
          type: array
          items:
            type: string
          description: AP-reachable hostnames or IP addresses advertised as RadSec TLS servers
        server_selection:
          allOf:
          - $ref: '#/components/schemas/mxcluster_radsec_server_selection2'
          - description: 'RADIUS server selection strategy for RadSec failover. enum: `ordered`, `unordered`.'
        src_ip_source:
          allOf:
          - $ref: '#/components/schemas/mxcluster_radsec_src_ip_source2'
          - description: 'Connection source interface or address used when reaching RADIUS servers. enum: `any`, `oob`, `oob6`, `tunnel`, `tunnel6`.'
      description: RadSec proxy configuration for a Mist Edge cluster. Used when the Mist Edge Cluster is used as a RADIUS Proxy between the local devices and external RADIUS Server.
    mxcluster_radsec_acct_server:
      title: mxcluster_radsec_acct_server
      type: object
      properties:
        host:
          type: string
          description: IP / hostname of RADIUS server
        port:
          type: integer
          description: Acct port of RADIUS server
          contentEncoding: int32
          default: 1813
        secret:
          type: string
          description: Shared secret used with this RADIUS accounting server
          contentEncoding: password
        ssids:
          type: array
          items:
            type: string
          description: WLAN SSID filters that use this accounting server when matching is enabled
      description: RadSec accounting server settings for a Mist Edge cluster
    mxcluster_radsec_auth_server:
      title: mxcluster_radsec_auth_server
      type: object
      properties:
        host:
          type: string
          description: IP / hostname of RADIUS server
        inband_status_check:
          type: boolean
          description: Whether to enable inband status check
          default: false
        inband_status_interval:
          minimum: 0
          type: integer
          description: Inband status interval, in seconds
          contentEncoding: int32
          default: 300
        keywrap_enabled:
          type: boolean
          description: If used for Mist APs, enable keywrap algorithm. Default is false
        keywrap_format:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/mxcluster_rad_auth_server_keywrap_format2'
          - description: 'Encoding format for Mist AP RADIUS keywrap keys. enum: `ascii`, `hex`.'
        keywrap_kek:
          type: string
          description: If used for Mist APs, encryption key
        keywrap_mack:
          type: string
          description: If used for Mist APs, Message Authentication Code Key
        port:
          type: integer
          description: Auth port of RADIUS server
          contentEncoding: int32
          default: 1812
        retry:
          type: integer
          description: Number of authentication request retries before failing over
          contentEncoding: int32
          default: 2
        secret:
          type: string
          description: Shared secret used with this RADIUS authentication server
          contentEncoding: password
        ssids:
          type: array
          items:
            type: string
          description: WLAN SSID filters that use this authentication server when matching is enabled
        timeout:
          type: integer
          description: Authentication request timeout, in seconds
          contentEncoding: int32
          default: 5
      description: RadSec authentication server settings for a Mist Edge cluster
    mxcluster_radsec_nas_ip_source:
      title: mxcluster_radsec_nas_ip_source
      enum:
      - any
      - oob
      - oob6
      - tunnel
      - tunnel6
      type: string
      description: 'SSpecify NAS-IP-ADDRESS, NAS-IPv6-ADDRESS to use with auth_servers. enum: `any`, `oob`, `oob6`, `tunnel`, `tunnel6`'
    mxcluster_radsec_server_selection:
      title: mxcluster_radsec_server_selection
      enum:
      - ordered
      - unordered
      type: string
      description: 'When ordered, Mist Edge will prefer and go back to the first RADIUS server if possible. enum: `ordered`, `unordered`'
    mxcluster_radsec_src_ip_source:
      title: mxcluster_radsec_src_ip_source
      enum:
      - any
      - oob
      - oob6
      - tunnel
      - tunnel6
      type: string
      description: 'Specify IP address to connect to auth_servers and acct_servers. enum: `any`, `oob`, `oob6`, `tunnel`, `tunnel6`'
    mxcluster_radsec_tls:
      title: mxcluster_radsec_tls
      type: object
      properties:
        keypair:
          type: string
          description: Name or identifier of the TLS keypair used by RadSec
      description: TLS settings for RadSec on a Mist Edge cluster
    mxcluster_tunterm_extra_route:
      title: mxcluster_tunterm_extra_route
      type: object
      properties:
        via:
          type: string
          description: Next-hop IP address for this extra route
      description: Extra route for Mist Tunneled VLAN traffic
    mxcluster_tunterm_hosts_selection:
      title: mxcluster_tunterm_hosts_selection
      enum:
      - ordered
      - shuffle
      - shuffle-by-site
      type: string
      description: >-
        Ordering of tunterm_hosts for Mist Edge within the same mxcluster. enum:
          * `shuffle`: the ordering of tunterm_hosts is randomized by the device''s MAC
          * `shuffle-by-site`: shuffle by site_id+tunnel_id (so when client connects to a specific Tunnel, it will go to the same (order of) mxedge, and we load-balancing between tunnels)
          * `ordered`: order decided by tunterm_hosts_order
    tunterm_monitoring_item:
      title: tunterm_monitoring_item
      type: object
      properties:
        host:
          minLength: 1
          type: string
          description: Can be ip, ipv6, hostname
          examples:
          - 10.2.8.15
        port:
          type: integer
          description: When `protocol`==`tcp`, TCP port checked by the monitoring probe
          contentEncoding: int32
          examples:
          - 80
        protocol:
          allOf:
          - $ref: '#/components/schemas/tunterm_monitoring_protocol2'
          - minLength: 1
            description: 'Monitoring method used for this tunnel termination check. enum: `arp`, `ping`, `tcp`.'
            examples:
            - tcp
        src_vlan_id:
          type: integer
          description: Optional source for the monitoring check, vlan_id configured in tunterm_other_ip_configs
          contentEncoding: int32
          examples:
          - 5
        timeout:
          type: integer
          description: Maximum time for this monitoring check, in seconds
          contentEncoding: int32
          default: 300
          examples:
          - 300
      description: Monitoring check for tunnel termination reachability
    mxedge:
      title: mxedge
      required:
      - model
      - name
      type: object
      properties:
        created_time:
          type: number
          description: Timestamp when the Mist Edge record was created
          readOnly: true
        for_site:
          type: boolean
          description: Whether this Mist Edge is scoped to a site
          readOnly: true
        id:
          type: string
          description: Unique identifier of the Mist Edge
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        mac:
          type: string
          description: Mist Edge MAC address
          readOnly: true
          examples:
          - 0200009fbe65
        magic:
          type: string
          description: Registration claim code for the Mist Edge
          readOnly: true
          examples:
          - L-NpT5gi-ADR8WTFd4EiQPY3cP5WdSoD
        model:
          type: string
          description: Mist Edge hardware or virtual appliance model
          examples:
          - ME-100
        modified_time:
          type: number
          description: Timestamp when the Mist Edge record was last modified
          readOnly: true
        mxagent_registered:
          type: boolean
          description: Whether the Mist Edge agent has registered with Mist cloud
          readOnly: true
        mxcluster_id:
          type:
          - string
          - 'null'
          description: Mist Edge cluster identifier that this appliance belongs to
          contentEncoding: uuid
          examples:
          - 572586b7-f97b-a22b-526c-8b97a3f609c4
        mxedge_mgmt:
          allOf:
          - $ref: '#/components/schemas/mxedge_mgmt1'
          - description: Management credentials and settings for the Mist Edge
        name:
          type: string
          description: Display name of the Mist Edge
          examples:
          - Guest
        notes:
          type: string
          description: Free-form notes for the Mist Edge
          examples:
          - note for mxedge
        ntp_servers:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Time synchronization servers used by the Mist Edge
        oob_ip_config:
          allOf:
          - $ref: '#/components/schemas/mxedge_oob_ip_config3'
          - description: Out-of-band management IP configuration for the Mist Edge
        org_id:
          type: string
          description: Identifier of the org that owns the Mist Edge
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        proxy:
          allOf:
          - $ref: '#/components/schemas/proxy1'
          - description: Network proxy settings used by the Mist Edge
        services:
          type: array
          items:
            type: string
          description: List of services enabled to run on the Mist Edge
        site_id:
          type: string
          description: Identifier of the site when the Mist Edge is site-scoped
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        tunterm_dhcpd_config:
          allOf:
          - $ref: '#/components/schemas/mxedge_tunterm_dhcpd_config2'
          - description: DHCP relay or server settings for Mist Tunneled VLANs
        tunterm_extra_routes:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/mxedge_tunterm_extra_route'
          description: Extra routes for Mist Tunneled VLAN traffic; property key is a CIDR
        tunterm_igmp_snooping_config:
          allOf:
          - $ref: '#/components/schemas/mxedge_tunterm_igmp_snooping_config2'
          - description: IGMP snooping settings for Mist Tunneled VLANs
        tunterm_ip_config:
          allOf:
          - $ref: '#/components/schemas/mxedge_tunterm_ip_config2'
          - description: Tunnel termination IP configuration for the Mist Edge
        tunterm_monitoring:
          type: array
          items:
            type: array
            items:
              $ref: '#/components/schemas/tunterm_monitoring_item'
          description: Monitoring checks for tunnel termination reachability
        tunterm_multicast_config:
          allOf:
          - $ref: '#/components/schemas/mxedge_tunterm_multicast_config'
          - description: Multicast forwarding settings for tunnel termination
        tunterm_other_ip_configs:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/mxedge_tunterm_other_ip_config'
          description: IPconfigs by VLAN ID. Property key is the VLAN ID
        tunterm_port_config:
          allOf:
          - $ref: '#/components/schemas/tunterm_port_config3'
          - description: Port configuration for tunnel termination traffic
        tunterm_registered:
          type: boolean
          description: Whether the tunnel termination service has registered with Mist cloud
          readOnly: true
        tunterm_switch_config:
          allOf:
          - $ref: '#/components/schemas/mxedge_tunterm_switch_configs2'
          - description: Switch VLAN settings for tunnel termination
        versions:
          allOf:
          - $ref: '#/components/schemas/mxedge_versions2'
          - description: Service version information reported by the Mist Edge
          readOnly: true
      description: Mist Edge appliance configuration and registration state
    mxedge_das:
      title: mxedge_das
      type: object
      properties:
        coa_servers:
          type: array
          items:
            $ref: '#/components/schemas/mxedge_das_coa_server'
          description: Dynamic authorization clients allowed to send CoA or Disconnect-Message requests
        enabled:
          type: boolean
          description: Whether cloud-assisted DAS is enabled for the Mist Edge cluster
          default: false
      description: Cloud-assisted Dynamic Authorization Service settings for a Mist Edge cluster
    mxedge_das_coa_server:
      title: mxedge_das_coa_server
      type: object
      properties:
        disable_event_timestamp_check:
          type: boolean
          description: Whether to disable Event-Timestamp Check
          default: false
        enabled:
          type: boolean
          description: Whether this DAS CoA or Disconnect-Message client is enabled
        host:
          type: string
          description: Server host allowed to send CoA or Disconnect-Message requests to Mist Edges
        port:
          type: integer
          description: UDP port where Mist Edges accept CoA or Disconnect-Message requests from this host
          contentEncoding: int32
          default: 3799
        require_message_authenticator:
          type: boolean
          description: Whether to require Message-Authenticator in requests
          default: false
        secret:
          type: string
          description: Shared secret used by this DAS CoA or Disconnect-Message client
          contentEncoding: password
      description: CoA or Disconnect-Message client allowed to contact Mist Edge DAS
    mxedge_event:
      title: mxedge_event
      type: object
      properties:
        audit_id:
          type: string
          description: Audit log identifier associated with this event, when available
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        component:
          type:
          - string
          - 'null'
          description: Mist Edge component that reported the event, such as a power supply or fan
          examples:
          - PS1
          - Fan1
        device_id:
          type:
          - string
          - 'null'
          description: Identifier of the device associated with the event, when available
          contentEncoding: uuid
          readOnly: true
        device_type:
          type: string
          description: Device type associated with the event
        from_version:
          type: string
          description: Service version before an upgrade-related event
        mac:
          type: string
          description: Mist Edge MAC address associated with the event
        mxcluster_id:
          type: string
          description: Mist Edge cluster identifier associated with the event
          examples:
          - 2815c917-58e7-472f-a190-bfd44fb58d05
        mxedge_id:
          type: string
          description: Mist Edge identifier associated with the event
          examples:
          - 00000000-0000-0000-1000-020000dc585c
        mxedge_name:
          type: string
          description: Display name of the Mist Edge associated with the event
        org_id:
          type: string
          description: Identifier of the org where the event occurred
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        package:
          type: string
          description: Software package associated with the event
        service:
          type: string
          description: Mist Edge service associated with the event
          examples:
          - tunterm
        severity:
          allOf:
          - $ref: '#/components/schemas/event_severity1'
          - description: 'Event severity level reported for this Mist Edge event. enum: `normal`, `critical`, `high`, `warning`.'
        sys_info.usage:
          allOf:
          - $ref: '#/components/schemas/mxedge_event_sys_info2'
          - description: System resource usage details associated with the event
        text:
          type: string
          description: Human-readable message describing the Mist Edge event
        timestamp:
          type: number
          description: Time when the Mist Edge event occurred
          readOnly: true
        to_version:
          type: string
          description: Service version after an upgrade-related event
        type:
          type: string
          description: Mist Edge event type code
          examples:
          - ME_SERVICE_STOPPED
      description: Event reported for a Mist Edge appliance or service
    mxedge_event_sys_info:
      title: mxedge_event_sys_info
      type: object
      properties:
        resource:
          type: string
          description: System resource referenced by the event
        severity:
          allOf:
          - $ref: '#/components/schemas/event_severity2'
          - description: 'Event severity for the system resource condition. enum: `normal`, `critical`, `high`, `warning`.'
      description: System resource details for a Mist Edge event
    mxedge_for_site:
      title: mxedge_for_site
      enum:
      - any
      - 'false'
      - 'true'
      type: string
      description: 'enum: `any`, `false`, `true`'
    mxedge_mgmt:
      title: mxedge_mgmt
      type: object
      properties:
        config_auto_revert:
          type: boolean
          description: Whether the Mist Edge automatically reverts configuration changes if connectivity is lost
          default: false
        fips_enabled:
          type: boolean
          description: Whether FIPS mode is enabled on the Mist Edge
          default: false
        mist_password:
          type: string
          description: Password for the Mist service account on the Mist Edge
          examples:
          - MIST_PASSWORD
        oob_ip_type:
          allOf:
          - $ref: '#/components/schemas/mxedge_mgmt_oob_ip_type2'
          - description: 'IPv4 address assignment mode for out-of-band management. enum: `dhcp`, `disabled`, `static`.'
        oob_ip_type6:
          allOf:
          - $ref: '#/components/schemas/mxedge_mgmt_oob_ip_type62'
          - description: 'IPv6 address assignment mode for out-of-band management. enum: `autoconf`, `dhcp`, `disabled`, `static`.'
        root_password:
          type: string
          description: Root account password for the Mist Edge
          contentEncoding: password
          examples:
          - ROOT_PASSWORD
      description: Management settings for a Mist Edge appliance
    mxedge_mgmt_oob_ip_type:
      title: mxedge_mgmt_oob_ip_type
      enum:
      - dhcp
      - disabled
      - static
      type: string
      description: 'enum: `dhcp`, `disabled`, `static`'
    mxedge_mgmt_oob_ip_type6:
      title: mxedge_mgmt_oob_ip_type6
      enum:
      - autoconf
      - dhcp
      - disabled
      - static
      type: string
      description: 'enum: `autoconf`, `dhcp`, `disabled`, `static`'
    mxedge_oob_ip_config:
      title: mxedge_oob_ip_config
      type: object
      properties:
        autoconf6:
          type: boolean
          description: Whether IPv6 autoconfiguration is enabled on the out-of-band management interface
          default: true
        dhcp6:
          type: boolean
          description: Whether DHCPv6 is enabled on the out-of-band management interface
          default: true
        dns:
          type: array
          items:
            type: string
          description: Name server addresses for out-of-band management
          default:
          - 8.8.8.8
          - 8.8.4.4
          - 2001:4860:4860::8888
          - 2001:4860:4860::8844
          examples:
          - - 8.8.8.8
            - 4.4.4.4
            - 2001:4860:4860::8888
            - 2001:4860:4860::8844
        gateway:
          type: string
          description: If `type`=`static`, IPv4 default gateway for the out-of-band management interface
          examples:
          - 10.2.1.254
        gateway6:
          type: string
          description: If `type6`=`static`, IPv6 default gateway for the out-of-band management interface
          examples:
          - 2601:1700:43c0:dc0::1
        ip:
          type: string
          description: If `type`=`static`, IPv4 address for the out-of-band management interface
          examples:
          - 10.2.1.2
        ip6:
          type: string
          description: If `type6`=`static`, IPv6 address for the out-of-band management interface
          examples:
          - 2601:1700:43c0:dc0:20c:29ff:fea7:93bc
        netmask:
          type: string
          description: If `type`=`static`, IPv4 netmask for the out-of-band management interface
          examples:
          - 255.255.255.0
        netmask6:
          type: string
          description: If `type6`=`static`, IPv6 prefix length for the out-of-band management interface
          examples:
          - /64
        type:
          allOf:
          - $ref: '#/components/schemas/ip_type9'
          - description: 'IPv4 address assignment mode for out-of-band management. enum: `dhcp`, `static`.'
            examples:
            - static
        type6:
          allOf:
          - $ref: '#/components/schemas/ip_type10'
          - description: 'IPv6 address assignment mode for out-of-band management. enum: `dhcp`, `static`.'
            examples:
            - static
      description: IP configuration for the Mist Edge out-of-band management interface
    mxedge_service_action:
      title: mxedge_service_action
      enum:
      - restart
      - start
      - stop
      type: string
      description: 'enum: `restart`, `start`, `stop`'
    mxedge_service_name:
      title: mxedge_service_name
      enum:
      - mxagent
      - mxdas
      - mxnacedge
      - mxocproxy
      - radsecproxy
      - tunterm
      type: string
      description: 'Mist Edge service name. enum: `mxagent`, `mxdas`, `mxnacedge`, `mxocproxy`, `radsecproxy`, `tunterm`'
    mxedge_tunterm_dhcpd_config:
      title: mxedge_tunterm_dhcpd_config
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether DHCP relay is enabled for Mist Tunneled VLANs
          default: false
        servers:
          type: array
          items:
            type: string
          description: DHCP relay server addresses used when `type`==`relay`
        type:
          allOf:
          - $ref: '#/components/schemas/mxedge_tunterm_dhcpd_type2'
          - description: 'DHCP handling mode for the global tunnel termination config. enum: `relay`.'
      additionalProperties:
        allOf:
        - $ref: '#/components/schemas/mxedge_tunterm_dhcpd_config_property'
        - description: Per-VLAN DHCP relay settings for a Mist Tunneled VLAN
      description: Global and per-VLAN DHCP relay settings for Mist Tunneled VLANs; property key is the VLAN ID
    mxedge_tunterm_dhcpd_config_property:
      title: mxedge_tunterm_dhcpd_config_property
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether DHCP relay is enabled for this tunneled VLAN
          default: false
        servers:
          type: array
          items:
            type: string
          description: DHCP relay server addresses used by this tunneled VLAN
        type:
          allOf:
          - $ref: '#/components/schemas/mxedge_tunterm_dhcpd_config_type2'
          - description: 'DHCP handling mode for this tunneled VLAN. enum: `relay`.'
      description: Per-VLAN DHCP relay settings for a Mist Tunneled VLAN
    mxedge_tunterm_dhcpd_config_type:
      title: mxedge_tunterm_dhcpd_config_type
      const: relay
      type: string
      description: 'DHCP handling mode for this tunneled VLAN. enum: `relay`'
    mxedge_tunterm_dhcpd_type:
      title: mxedge_tunterm_dhcpd_type
      const: relay
      type: string
      description: 'DHCP handling mode for the global tunnel termination config. enum: `relay`'
    mxedge_tunterm_extra_route:
      title: mxedge_tunterm_extra_route
      type: object
      properties:
        via:
          type: string
          description: Next-hop IP address for this Mist Tunnel extra route
      description: Extra route for Mist Tunnel traffic on a Mist Edge
    mxedge_tunterm_igmp_snooping_config:
      title: mxedge_tunterm_igmp_snooping_config
      type: object
      properties:
        enabled:
          oneOf:
          - type: boolean
            default: false
          - type: string
            default: 'False'
          description: Whether IGMP snooping is enabled for the configured VLANs
        querier:
          allOf:
          - $ref: '#/components/schemas/mxedge_tunterm_igmp_snooping_querier2'
          - description: IGMP querier settings used with tunnel termination snooping
        vlan_ids:
          anyOf:
          - type: array
            items:
              maximum: 4096
              minimum: 0
              type: integer
              contentEncoding: int32
          - type: string
          description: List of VLAN IDs where tunnel termination performs IGMP snooping
      description: IGMP snooping settings for Mist Tunnel VLANs
    mxedge_tunterm_igmp_snooping_querier:
      title: mxedge_tunterm_igmp_snooping_querier
      type: object
      properties:
        max_response_time:
          type: integer
          description: Querier's query response interval, in tenths-of-seconds
          contentEncoding: int32
          examples:
          - 10
        mtu:
          type: integer
          description: The MTU we use (needed when forming large IGMPv3 Reports)
          contentEncoding: int32
          examples:
          - 1500
        query_interval:
          type: integer
          description: Querier's query interval, in seconds
          contentEncoding: int32
          examples:
          - 125
        robustness:
          maximum: 7
          minimum: 1
          type: integer
          description: IGMP querier robustness variable
          contentEncoding: int32
        version:
          type: integer
          description: Querier's maximum protocol version
          contentEncoding: int32
          examples:
          - 3
      description: IGMP querier settings for tunnel termination
    mxedge_tunterm_ip_config:
      title: mxedge_tunterm_ip_config
      required:
      - gateway
      - ip
      - netmask
      type: object
      properties:
        gateway:
          type: string
          description: IPv4 gateway for the Mist Tunnel interface
          examples:
          - 10.2.1.254
        gateway6:
          type: string
          description: IPv6 gateway for the Mist Tunnel interface
          examples:
          - 2001:1010:1010:1010::1
        ip:
          type: string
          description: Address on the untagged Mist Tunnel interface, in IPv4 format
          examples:
          - 10.2.1.1
        ip6:
          type: string
          description: Address on the Mist Tunnel interface, in IPv6 format
          examples:
          - 2001:1010:1010:1010::2
        netmask:
          type: string
          description: Subnet mask for the Mist Tunnel IPv4 address
          examples:
          - 255.255.255.0
        netmask6:
          type: string
          description: Prefix length for the Mist Tunnel IPv6 address
          examples:
          - /64
      description: IP configuration for the Mist Tunnel interface
    mxedge_tunterm_multicast_config:
      title: mxedge_tunterm_multicast_config
      type: object
      properties:
        mdns:
          allOf:
          - $ref: '#/components/schemas/mxedge_tunterm_multicast_mdns2'
          - description: Settings for mDNS forwarding on tunnel termination VLANs
        ssdp:
          allOf:
          - $ref: '#/components/schemas/mxedge_tunterm_multicast_ssdp2'
          - description: Settings for SSDP forwarding on tunnel termination VLANs
      description: Multicast forwarding settings for tunnel termination
    mxedge_tunterm_multicast_mdns:
      title: mxedge_tunterm_multicast_mdns
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether mDNS forwarding is enabled for the configured VLANs
        vlan_ids:
          uniqueItems: true
          type: array
          items:
            type: string
          description: List of VLAN IDs where mDNS forwarding is enabled
      description: mDNS forwarding settings for tunnel termination
    mxedge_tunterm_multicast_ssdp:
      title: mxedge_tunterm_multicast_ssdp
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether SSDP forwarding is enabled for the configured VLANs
        vlan_ids:
          uniqueItems: true
          type: array
          items:
            type: string
          description: List of VLAN IDs where SSDP forwarding is enabled
      description: SSDP forwarding settings for tunnel termination
    mxedge_tunterm_other_ip_config:
      title: mxedge_tunterm_other_ip_config
      required:
      - ip
      - netmask
      type: object
      properties:
        ip:
          type: string
          description: Address for the additional Mist Tunnel interface, in IPv4 format
        netmask:
          type: string
          description: Subnet mask for the additional Mist Tunnel IPv4 address
      description: Additional IP configuration for a Mist Tunnel VLAN interface
    mxedge_tunterm_switch_config:
      title: mxedge_tunterm_switch_config
      type: object
      properties:
        port_vlan_id:
          type: integer
          description: Untagged VLAN ID for this tunnel termination switch port
          contentEncoding: int32
        vlan_ids:
          type: array
          items:
            $ref: '#/components/schemas/vlan_id_with_variable'
          description: List of tagged VLAN IDs allowed on this tunnel termination switch port
      description: Switch VLAN settings for one tunnel termination port
    mxedge_tunterm_switch_configs:
      title: mxedge_tunterm_switch_configs
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether custom tunnel termination switch VLAN settings are enabled
      additionalProperties:
        allOf:
        - $ref: '#/components/schemas/mxedge_tunterm_switch_config'
        - description: Switch VLAN settings for one tunnel termination port
      description: Custom VLAN settings for tunnel termination switch ports, if desired; property key is the port identifier
    mxedge_upgrade_channel:
      title: mxedge_upgrade_channel
      enum:
      - alpha
      - beta
      - stable
      type: string
      description: 'upgrade channel to follow. enum: `alpha`, `beta`, `stable`'
    mxedge_upgrade_info_items:
      title: mxedge_upgrade_info_items
      required:
      - package
      - version
      type: object
      properties:
        default:
          type: boolean
          description: Whether this version is the default upgrade target for the package
        distro:
          type: string
          description: Linux distribution codename for the package version
        package:
          type: string
          description: Mist Edge service package name
        version:
          type: string
          description: Available version for this package
      description: Available upgrade version for a Mist Edge package
    mxedge_upgrade_multi:
      title: mxedge_upgrade_multi
      required:
      - mxedge_ids
      type: object
      properties:
        allow_downgrades:
          allOf:
          - $ref: '#/components/schemas/mxedge_upgrade_multi_allow_downgrades2'
          - description: Per-service downgrade permission settings for this upgrade
        canary_phases:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: Canary phase percentages for phased Mist Edge upgrades
          default:
          - 1
          - 10
          - 50
          - 100
        channel:
          allOf:
          - $ref: '#/components/schemas/mxedge_upgrade_channel1'
          - description: 'Upgrade channel to use for qualified versions. enum: `alpha`, `beta`, `stable`.'
        distro:
          type: string
          description: Linux distribution codename for an optional distro upgrade, such as bullseye or `next` to upgrade to the next distro version. Uses highest qualified versions
        max_failure_percentage:
          type: integer
          description: Failure threshold before we stop the upgrade and mark it as failed
          contentEncoding: int32
          default: 5
        mxedge_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Mist Edge IDs included in the upgrade request
        start_time:
          type: integer
          description: Upgrade start time in epoch seconds, default is now
          contentEncoding: int32
        strategy:
          allOf:
          - $ref: '#/components/schemas/mxedge_upgrade_strategy2'
          - description: 'Upgrade rollout strategy for the selected Mist Edges. enum: `canary`, `big_bang`, `serial`.'
        versions:
          allOf:
          - $ref: '#/components/schemas/mxedge_upgrade_version2'
          - description: Per-service target versions for the upgrade request
      description: Request to schedule upgrades for one or more Mist Edges
    mxedge_upgrade_multi_allow_downgrades:
      title: mxedge_upgrade_multi_allow_downgrades
      type: object
      properties:
        mxagent:
          type: boolean
          description: Whether downgrades are allowed for the mxagent service
          default: false
        mxdas:
          type: boolean
          description: Whether downgrades are allowed for the mxdas service
          default: false
        mxocproxy:
          type: boolean
          description: Whether downgrades are allowed for the mxocproxy service
          default: false
        radsecproxy:
          type: boolean
          description: Whether downgrades are allowed for the radsecproxy service
          default: false
        tunterm:
          type: boolean
          description: Whether downgrades are allowed for the tunterm service
          default: false
      description: Whether downgrade is allowed when running version is higher than expected version for each service
    mxedge_upgrade_response_counts:
      title: mxedge_upgrade_response_counts
      required:
      - failed
      - queued
      - success
      - upgrading
      type: object
      properties:
        failed:
          type: integer
          description: Number of Mist Edge upgrades that failed
          contentEncoding: int32
        queued:
          type: integer
          description: Number of Mist Edge upgrades waiting to run
          contentEncoding: int32
        success:
          type: integer
          description: Number of Mist Edge upgrades completed successfully
          contentEncoding: int32
        upgrading:
          type: integer
          description: Number of Mist Edge upgrades currently in progress
          contentEncoding: int32
      description: Counts of Mist Edge upgrades by current status
    mxedge_upgrade_strategy:
      title: mxedge_upgrade_strategy
      enum:
      - canary
      - big_bang
      - serial
      type: string
      description: >-
        enum:
          * `big_bang`: upgrade all at once, no orchestration
          * `serial`: one at a time'
          * `canary`: upgrade in phases
    mxedge_upgrade_version:
      title: mxedge_upgrade_version
      required:
      - mxagent
      - tunterm
      type: object
      properties:
        mxagent:
          type: string
          description: Target version for the mxagent service
        mxdas:
          type: string
          description: Target version for the mxdas service
          default: current
        mxocproxy:
          type: string
          description: Target version for the mxocproxy service
          default: current
        radsecproxy:
          type: string
          description: Target version for the radsecproxy service
          default: current
        tunterm:
          type: string
          description: Target version for the tunterm service
      description: Version to upgrade for each service, `current` / `latest` / `default` / specific version (e.g. `2.5.100`).\nIgnored if distro upgrade, `tunterm`, `radsecproxy`, `mxagent`, `mxocproxy`, `mxdas` or `mxnacedge`
    mxedge_versions:
      title: mxedge_versions
      type: object
      properties:
        mxagent:
          type: string
          description: Reported version of the mxagent service
          readOnly: true
        tunterm:
          type: string
          description: Reported version of the tunnel termination service
          readOnly: true
      description: Read-only Mist Edge service versions
    mxedge_vm_params:
      title: mxedge_vm_params
      type: object
      properties:
        model:
          type: string
          description: Mist Edge VM SKU or model to deploy
          examples:
          - ME-VM
        name:
          type: string
          description: User given name (optional)
        user_data:
          type: string
          description: Base64 encoded user data
      description: Mist Edge VM parameters
    mxedges_assign:
      title: mxedges_assign
      required:
      - mxedge_ids
      - site_id
      type: object
      properties:
        mxedge_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Mist Edge identifiers to assign to the site
        site_id:
          type: string
          description: Identifier of the site that receives the Mist Edges
          contentEncoding: uuid
          examples:
          - 43e9c864-a7e4-4310-8031-d9817d2c5a43
      description: Request to assign Mist Edges to a site
    mxedges_unassign:
      title: mxedges_unassign
      required:
      - mxedge_ids
      type: object
      properties:
        mxedge_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Mist Edge identifiers to unassign from their site
      description: Request to unassign Mist Edges from their site
    mxtunnel:
      title: mxtunnel
      type: object
      properties:
        anchor_mxtunnel_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: IDs of anchor Mist Tunnels used for edge-to-edge tunnel formation
        auto_preemption:
          allOf:
          - $ref: '#/components/schemas/auto_preemption1'
          - description: Preemption behavior for restoring preferred tunnel peers after failover
        created_time:
          type: number
          description: Timestamp when the Mist Tunnel was created
          readOnly: true
        for_site:
          type: boolean
          description: Whether this Mist Tunnel is scoped to a site
          readOnly: true
        hello_interval:
          maximum: 300
          minimum: 1
          type:
          - integer
          - 'null'
          description: In seconds, used as heartbeat to detect if a tunnel is alive. AP will try another peer after missing N hellos specified by `hello_retries`.
          contentEncoding: int32
          default: 60
        hello_retries:
          maximum: 30
          minimum: 2
          type:
          - integer
          - 'null'
          description: Number of missed hello heartbeats before an AP tries another tunnel peer
          contentEncoding: int32
          default: 7
        id:
          type: string
          description: Unique identifier of the Mist Tunnel
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        ipsec:
          allOf:
          - $ref: '#/components/schemas/mxtunnel_ipsec2'
          - description: Security settings for IPsec support on this Mist Tunnel
        modified_time:
          type: number
          description: Timestamp when the Mist Tunnel was last modified
          readOnly: true
        mtu:
          maximum: 1500
          minimum: 0
          type: integer
          description: 0 to enable PMTU, 552-1500 to start PMTU with a lower MTU
          contentEncoding: int32
          default: 0
        mxcluster_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Mist Edge cluster IDs that host this Mist Tunnel
        name:
          type:
          - string
          - 'null'
          description: Display name of the Mist Tunnel
        org_id:
          type: string
          description: Identifier of the org that owns the Mist Tunnel
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        protocol:
          allOf:
          - $ref: '#/components/schemas/mxtunnel_protocol3'
          - description: 'Encapsulation protocol used for the Mist Tunnel. enum: `ip`, `udp`.'
        site_id:
          type: string
          description: Identifier of the site when the Mist Tunnel is site-scoped
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        vlan_ids:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: List of VLAN IDs carried by this Mist Tunnel
      description: Mist Tunnel configuration for tunneling AP user VLANs to Mist Edge clusters
    mxtunnel_ipsec:
      title: mxtunnel_ipsec
      type: object
      properties:
        dns_servers:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Name server addresses advertised for IPsec tunnel clients
        dns_suffix:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Search suffixes advertised for IPsec tunnel clients
        enabled:
          type: boolean
          description: Whether IPsec support is enabled for this Mist Tunnel
        extra_routes:
          type: array
          items:
            $ref: '#/components/schemas/mxtunnel_ipsec_extra_route'
          description: Additional routes advertised for the IPsec tunnel
        split_tunnel:
          type: boolean
          description: Whether split tunneling is enabled for IPsec clients
        use_mxedge:
          type: boolean
          description: Whether IPsec termination uses Mist Edge
      description: IPsec settings for a Mist Tunnel
    mxtunnel_ipsec_extra_route:
      title: mxtunnel_ipsec_extra_route
      type: object
      properties:
        dest:
          type: string
          description: Route destination CIDR for the IPsec extra route
        next_hop:
          type: string
          description: Route next-hop IPv4 address for the IPsec extra route
          contentEncoding: ipv4
      description: Extra route advertised for an IPsec tunnel
    mxtunnel_protocol:
      title: mxtunnel_protocol
      enum:
      - ip
      - udp
      type: string
      description: 'Encapsulation protocol used for Mist Tunnel traffic. enum: `ip`, `udp`'
    nac_access_type:
      title: nac_access_type
      enum:
      - wireless
      - wired
      - vty
      type: string
      description: 'Type of network access. enum: `wireless`, `wired`, `vty`'
      examples:
      - wireless
    nac_auth_type:
      title: nac_auth_type
      enum:
      - cert
      - device-auth
      - eap-teap
      - eap-tls
      - eap-ttls
      - idp
      - mab
      - eap-peap
      type: string
      description: 'enum: `cert`, `device-auth`, `eap-teap`, `eap-tls`, `eap-ttls`, `idp`, `mab`, `eap-peap`'
      examples:
      - eap-tls
    nac_client_coa:
      title: nac_client_coa
      type: object
      properties:
        coa_type:
          allOf:
          - $ref: '#/components/schemas/nac_coa_type3'
          - description: 'Change of Authorization command to send to the NAC client. enum: `reauth`, `disconnect`.'
      description: Change of Authorization request for a NAC client
    nac_client_coa_response:
      title: nac_client_coa_response
      type: object
      properties:
        device_mac:
          type: string
          description: Target AP or switch MAC address for the CoA command
        device_type:
          allOf:
          - $ref: '#/components/schemas/device_type3'
          - description: 'Type of network device that received the CoA command. enum: `ap`, `gateway`, `switch`.'
      description: Response returned after sending a NAC client CoA command
    nac_client_event:
      title: nac_client_event
      type: object
      properties:
        ap:
          type: string
          description: Access point MAC address for the client session
          examples:
          - 5c5b35513227
        auth_type:
          allOf:
          - $ref: '#/components/schemas/nac_auth_type2'
          - description: 'Authentication method used for the NAC event. enum: `cert`, `device-auth`, `eap-teap`, `eap-tls`, `eap-ttls`, `idp`, `mab`, `eap-peap`.'
            examples:
            - eap-tls
        bssid:
          type: string
          description: Wireless BSSID used for the client session
          examples:
          - 5c5b355fafcc
        client_type:
          allOf:
          - $ref: '#/components/schemas/nac_access_type2'
          - description: 'Access type for the NAC client event. enum: `wireless`, `wired`, `vty`.'
            examples:
            - wireless
        device_mac:
          type: string
          description: Network device MAC address for the AP or switch handling the client session
          readOnly: true
          examples:
          - 60c78d8c7f6f
        dryrun_nacrule_id:
          type: string
          description: Dry-run NAC rule ID that matched the event, when present
          contentEncoding: uuid
          readOnly: true
          examples:
          - 32f27e7d-ff26-4a9b-b3d1-ff9bcb264012
        dryrun_nacrule_matched:
          type: boolean
          description: Whether a dry-run NAC rule matched the event
          readOnly: true
        idp_id:
          type: string
          description: Identity provider configuration ID used for the event
          contentEncoding: uuid
          readOnly: true
          examples:
          - 912ef72e-2239-4996-b81e-469e87a27cd6
        idp_role:
          type: array
          items:
            type: string
          description: Roles or groups returned by the identity provider
          examples:
          - - itsuperusers
            - vip
        idp_username:
          type: string
          description: Username presented to the identity provider
          readOnly: true
          examples:
          - user@deaflyz.net
        mac:
          type: string
          description: Client MAC address for the NAC event
          readOnly: true
          examples:
          - ac3eb179e535
        mxedge_id:
          type: string
          description: Mist Edge ID used to connect to cloud
        nacrule_id:
          type: string
          description: NAC rule ID that matched the event
          contentEncoding: uuid
          readOnly: true
          examples:
          - 32f27e7d-ff26-4a9b-b3d1-ff9bcb264c62
        nacrule_matched:
          type: boolean
          description: Whether a NAC rule matched the event
          readOnly: true
        nas_vendor:
          type: string
          description: Vendor of the network access server
          readOnly: true
          examples:
          - juniper-mist
        org_id:
          type: string
          description: Identifier of the org where the NAC event occurred
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        port_id:
          type: string
          description: Switch port identifier where the NAC event occurred
          readOnly: true
          examples:
          - ge-0/0/17.0
        port_type:
          allOf:
          - $ref: '#/components/schemas/nac_access_type3'
          - description: 'Access type of the port where the NAC event occurred. enum: `wireless`, `wired`, `vty`.'
            examples:
            - wireless
        random_mac:
          allOf:
          - $ref: '#/components/schemas/random_mac1'
          - description: 'Whether the client used a randomized MAC address. enum: `true`, `false`.'
        resp_attrs:
          uniqueItems: true
          type: array
          items:
            type: string
          description: RADIUS response attributes returned by NAC to the NAS
          examples:
          - - Tunnel-Type=VLAN
            - Tunnel-Medium-Type=IEEE-802
            - Tunnel-Private-Group-Id=750
            - User-Name=anonymous
        site_id:
          type: string
          description: Identifier of the site where the NAC event occurred
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        ssid:
          type: string
          description: Wireless network SSID used for the NAC session
          readOnly: true
          examples:
          - MyCorp-NAC
        timestamp:
          type: number
          description: Time when the NAC event occurred
          readOnly: true
        type:
          type: string
          description: NAC event type code
          readOnly: true
          examples:
          - NAC_CLIENT_PERMIT
        usermac_label:
          type: array
          items:
            type: string
          description: Labels derived from the usermac entry matched by the client
          examples:
          - - bldg5
            - printer
        username:
          type: string
          description: Client-presented username for the NAC event
          readOnly: true
        vlan:
          type: string
          description: Network VLAN name or ID returned for the NAC client
          readOnly: true
        vlan_source:
          type: string
          description: Source of the assigned VLAN, for example `nactag` or `usermac`
          examples:
          - nactag
      description: NAC authentication event for a wired or wireless client
    nac_client_last_status:
      title: nac_client_last_status
      enum:
      - permitted
      - session_started
      - session_stopped
      - denied
      type: string
      description: 'Latest Authentication status of the client. enum: `denied`, `permitted`, `session_started`, `session_stopped`'
      examples:
      - permitted
    nac_coa_type:
      title: nac_coa_type
      enum:
      - reauth
      - disconnect
      type: string
      description: 'CoA type to send. enum: `reauth`, `disconnect`'
    nac_crl_file:
      title: nac_crl_file
      type: object
      properties:
        created_time:
          type: number
          description: Epoch timestamp when the NAC CRL file was uploaded
          readOnly: true
        id:
          type: string
          description: Unique ID for the uploaded CRL file, used to reference the file
          readOnly: true
          examples:
          - a1ca26f3-44dd-4833-9a7b-97bbb2ab5230
        modified_time:
          type: number
          description: Epoch timestamp when the NAC CRL file metadata was last modified
          readOnly: true
        name:
          type: string
          description: Issuer name for the CRL file
          examples:
          - SampleCertificateSigner
        url:
          type: string
          description: Download URL for the uploaded NAC CRL file
          examples:
          - http://url/to/crl_file
      description: Metadata for an uploaded NAC CRL file
    nac_portal:
      title: nac_portal
      type: object
      properties:
        access_type:
          allOf:
          - $ref: '#/components/schemas/nac_portal_access_type2'
          - description: 'If `type`==`marvis_client`, whether onboarding applies to wireless clients or both wireless and wired clients. enum: `wireless`, `wireless+wired`.'
        additional_cacerts:
          type: array
          items:
            type: string
          description: Additional CA certificates trusted during NAC portal certificate onboarding
          examples:
          - - '-----BEGIN CERTIFICATE-----\<redacted>\n-----END CERTIFICATE-----'
        additional_nac_server_name:
          type: array
          items:
            type: string
          description: Optional list of additional NAC server names
          examples:
          - - nac1.corp.com
            - nac2.corp.com
        bg_image_url:
          type: string
          description: URL of the NAC portal background image
        cert_expire_time:
          type: integer
          description: Validity duration for portal-issued client certificates, in days
          contentEncoding: int32
          examples:
          - 365
        eap_type:
          allOf:
          - $ref: '#/components/schemas/nac_portal_eap_type2'
          - description: 'EAP mode used when onboarding wireless clients through the NAC portal. enum: `wpa2`, `wpa3`.'
        enable_location:
          type: boolean
          description: Whether location data collection is enabled for devices onboarding through this NAC portal
          default: false
        enable_telemetry:
          type: boolean
          description: Model, version, fingering, events (connecting, disconnect, roaming), which ap
        expiry_notification_time:
          type: integer
          description: Number of days before certificate expiration to start sending reminder notifications
          contentEncoding: int32
        id:
          type: string
          description: Unique identifier of the NAC portal
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        name:
          type: string
          description: Human-readable name of the NAC portal
          examples:
          - get-wifi
        notify_expiry:
          type: boolean
          description: Whether to send reminder notifications before portal-issued certificates expire
        org_id:
          type: string
          description: Organization that owns this NAC portal
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        portal:
          allOf:
          - $ref: '#/components/schemas/nac_portal_guest_portal2'
          - description: Guest portal settings used when `type`==`guest_portal`
        portal_authorize_jwt_secret:
          type: string
          description: If `type`==`guest_portal` and `auth`==`external`, the `portal_authorize_jwt_secret` will be generated
          readOnly: true
          examples:
          - 1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
        portal_authorize_url:
          type: string
          description: If `type`==`guest_portal` and `auth`==`external`, the `portal_authorize_url` will be generated
          readOnly: true
          examples:
          - https://guest-mistnac.mist.com/callback/be22bba7-8e22-e1cf-5185-b880816fe2cf/authorize
        portal_sso_url:
          type: string
          description: If `type`==`guest_portal` or `type`==`guest_admin` and ans SSO is enabled, the `portal_sso_url` will be generated (which needs to be configured in your IDP
          readOnly: true
          examples:
          - https://guest-mistnac.mist.com/callback/be22bba7-8e22-e1cf-5185-b880816fe2cf/acs
        ssid:
          type: string
          description: Wireless SSID associated with the NAC portal
          examples:
          - Corp
        sso:
          allOf:
          - $ref: '#/components/schemas/nac_portal_sso2'
          - description: SAML SSO settings for NAC portal authentication and role mapping
        template_url:
          type: string
          description: URL for the NAC portal template customization resource
        thumbnail_url:
          type: string
          description: Read-only URL of the NAC portal background image thumbnail
          readOnly: true
        tos:
          type: string
          description: Terms of service text shown in the NAC portal
        type:
          allOf:
          - $ref: '#/components/schemas/nac_portal_type2'
          - description: 'NAC portal mode, such as guest admin, guest portal, or Marvis client onboarding. enum: `guest_admin`, `guest_portal`, `marvis_client`.'
        ui_url:
          type: string
          description: If `auth`==`guest_admin`, the URL to the guest admin portal
          readOnly: true
          examples:
          - https://guest-mistnac.mist.com/admin/51908ea7-dea7-4581-a578-f7320c4d5216/login
      description: NAC portal configuration for 802.1X onboarding, guest access, or Marvis client certificate provisioning
    nac_portal_access_type:
      title: nac_portal_access_type
      enum:
      - wireless
      - wireless+wired
      type: string
      description: 'if `type`==`marvis_client`. enum: `wireless`, `wireless+wired`'
    nac_portal_eap_type:
      title: nac_portal_eap_type
      enum:
      - wpa2
      - wpa3
      type: string
      description: 'EAP mode used when onboarding wireless clients through the NAC portal. enum: `wpa2`, `wpa3`'
    nac_portal_guest_portal:
      title: nac_portal_guest_portal
      type: object
      properties:
        auth:
          allOf:
          - $ref: '#/components/schemas/nac_portal_guest_portal_auth2'
          - description: 'Mode presented by the NAC guest portal for user authentication. enum: `external`, `multi`, `none`.'
        expire:
          type: integer
          description: If `auth`==`none` or `auth`==`multi`, whether to expire the guest after a certain time
          contentEncoding: int32
          examples:
          - 1440
        external_portal_url:
          type: string
          description: If `auth`==`external`, the URL to redirect the user to for authentication
          examples:
          - https://yourorg.com/external-guest-portal
        force_reconnect:
          type: boolean
          description: Disconnect client (workaround for reauth issues)
        forward:
          type: boolean
          description: If `auth`==`none` or `auth`==`multi`, whether to forward the user to the guest portal after authentication
          examples:
          - true
        forward_url:
          type: string
          description: If `auth`==`none` or `auth`==`multi`, URL to forward the user to after authentication
          examples:
          - https://yourorg.com/guest-portal-redirect
        max_num_devices:
          maximum: 100
          minimum: 0
          type: integer
          description: Maximum number of clients allowed per guest. 0 (default, unlimited), 1-100 range
          contentEncoding: int32
          default: 0
          examples:
          - 10
        privacy:
          type: boolean
          description: If `auth`==`none` or `auth`==`multi`, whether to show the privacy policy
          examples:
          - true
      description: "Guest portal configuration when `type`==`guest_portal`. If \n  * `auth`==`none`, the user is presented with a terms of service and can click and continue.\n  * `auth`==`external`, the user is redirected to an external URL for authentication.\n  * `auth`==`multi`, the user is presented with a choice of authentication methods:\n    - social logins: facebook / google / amazon / microsoft / azure\n    - sponsor\n    - sms: supported provider: twillio\n    - email\n    - sso\n    - userpass: pre created guest list"
    nac_portal_guest_portal_auth:
      title: nac_portal_guest_portal_auth
      enum:
      - external
      - multi
      - none
      type: string
      description: 'Guest portal authentication type. enum: `external`, `multi`, `none`'
    nac_portal_sso:
      title: nac_portal_sso
      type: object
      properties:
        idp_cert:
          type: string
          description: Identity provider certificate used to verify signed SAML responses
          examples:
          - '-----BEGIN CERTIFICATE-----\n<redacted>\n-----END CERTIFICATE-----'
        idp_sign_algo:
          allOf:
          - $ref: '#/components/schemas/nac_portal_sso_idp_sign_algo2'
          - description: 'Signing algorithm expected for SAML assertions from the identity provider. enum: `sha1`, `sha256`, `sha384`, `sha512`.'
        idp_sso_url:
          type: string
          description: Identity provider Single Sign-On URL for SAML authentication
          examples:
          - https://yourorg.onelogin.com/trust/saml2/http-post/sso/138130
        issuer:
          type: string
          description: Identity provider issuer URL for SAML authentication
          examples:
          - https://app.onelogin.com/saml/metadata/138130
        nameid_format:
          type: string
          description: SAML NameID format expected from the identity provider
          examples:
          - email
        sso_role_matching:
          type: array
          items:
            $ref: '#/components/schemas/nac_portal_sso_role_matching'
          description: Rules that map SSO role values from the identity provider to NAC portal roles
        use_sso_role_for_cert:
          type: boolean
          description: Whether to include the matched SSO role in the issued certificate subject for later policy matching
      description: SAML SSO configuration for a NAC portal
    nac_portal_sso_idp_sign_algo:
      title: nac_portal_sso_idp_sign_algo
      enum:
      - sha1
      - sha256
      - sha384
      - sha512
      type: string
      description: 'Signing algorithm for SAML Assertion. enum: `sha1`, `sha256`, `sha384`, `sha512`.'
    nac_portal_sso_role_matching:
      title: nac_portal_sso_role_matching
      type: object
      properties:
        assigned:
          type: string
          description: NAC portal role assigned when the SSO role value matches
          examples:
          - user
        match:
          type: string
          description: SSO role value to match from the SAML assertion
          examples:
          - Student
      description: Mapping rule from an SSO role claim value to a NAC portal role
    nac_portal_template:
      title: nac_portal_template
      type: object
      properties:
        alignment:
          allOf:
          - $ref: '#/components/schemas/portal_template_alignment4'
          - description: 'Text and content alignment for the NAC portal page. enum: `center`, `left`, `right`.'
        color:
          type: string
          description: Primary color used by the NAC portal template
          default: '#1074bc'
        logo:
          type: string
          description: Custom logo custom logo with "data:image/png;base64," format. default null, uses Juniper Mist Logo.
        poweredBy:
          type: boolean
          description: Whether to hide "Powered by Juniper Mist" and email footers
          default: false
      description: Visual template settings for a NAC portal
    nac_portal_type:
      title: nac_portal_type
      enum:
      - guest_admin
      - guest_portal
      - marvis_client
      type: string
      description: "enum: \n  * `guest_admin`: NAC-Based Portal Admin for Pre Created Guest Authentication\n  * `guest_portal`: NAC-Based Guest Portal\n  * `marvis_client`"
    nac_rule:
      title: nac_rule
      required:
      - action
      - name
      type: object
      properties:
        action:
          allOf:
          - $ref: '#/components/schemas/nac_rule_action2'
          - description: Allow or block decision applied when the NAC rule matches
            examples:
            - allow
        apply_tags:
          type: array
          items:
            type: string
          description: NAC tag IDs to include in the Access-Accept when the rule allows access
          examples:
          - - c049dfcd-0c73-5014-1c64-062e9903f1e5
        created_time:
          type: number
          description: Epoch timestamp when the NAC rule was created
          readOnly: true
        dry_run:
          type: boolean
          description: Whether the NAC rule is in dry-run mode, where matches are logged but the action is not enforced
        enabled:
          type: boolean
          description: Whether the NAC rule is evaluated during policy matching
          default: true
        guest_auth_state:
          allOf:
          - $ref: '#/components/schemas/nac_rule_guest_auth_state2'
          - description: 'Guest portal authorization state condition for the rule. enum: `authorized`, `unknown`.'
            examples:
            - authorized
        id:
          type: string
          description: Unique identifier of the NAC rule
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        matching:
          allOf:
          - $ref: '#/components/schemas/nac_rule_matching3'
          - description: Criteria that must match for the NAC rule to apply
        modified_time:
          type: number
          description: Epoch timestamp when the NAC rule was last modified
          readOnly: true
        name:
          type: string
          description: Human-readable name of the NAC rule
        not_matching:
          allOf:
          - $ref: '#/components/schemas/nac_rule_matching1'
          - description: Criteria that must not match for the NAC rule to apply
        order:
          minimum: 0
          type: integer
          description: Rule priority; lower values are evaluated with higher priority
          contentEncoding: int32
          examples:
          - 1
        org_id:
          type: string
          description: Org identifier that owns the NAC rule
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
      description: NAC authentication policy rule that matches request criteria and applies an allow or block action
    nac_rule_action:
      title: nac_rule_action
      enum:
      - allow
      - block
      type: string
      description: 'Allow or block decision applied when the NAC rule matches. enum: `allow`, `block`'
      examples:
      - allow
    nac_rule_guest_auth_state:
      title: nac_rule_guest_auth_state
      enum:
      - authorized
      - unknown
      type: string
      description: 'Guest portal authorization state. enum: `authorized`, `unknown`'
      examples:
      - authorized
    nac_rule_matching:
      title: nac_rule_matching
      type: object
      properties:
        auth_type:
          allOf:
          - $ref: '#/components/schemas/nac_auth_type3'
          - description: 'NAC authentication method that must match the request. enum: `cert`, `device-auth`, `eap-teap`, `eap-tls`, `eap-ttls`, `idp`, `mab`, `eap-peap`.'
            examples:
            - eap-tls
        family:
          type: array
          items:
            type: string
          description: Client device family values that must match the request
        mfg:
          type: array
          items:
            type: string
          description: Client device manufacturer values that must match the request
        model:
          type: array
          items:
            type: string
          description: Client device model values that must match the request
        nactags:
          type: array
          items:
            type: string
          description: NAC tag IDs whose match criteria must be satisfied by the request
          examples:
          - - 041d5d36-716c-4cfb-4988-3857c6aa14a2
            - a809a97f-d599-f812-eb8c-c3f84aabf6ba
        os_type:
          type: array
          items:
            type: string
          description: Client OS type values that must match the request
        port_types:
          type: array
          items:
            $ref: '#/components/schemas/nac_rule_matching_port_type'
          description: Wired or wireless access types that must match the request
          examples:
          - - wired
        site_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Site IDs where the rule criteria apply
          examples:
          - - bb19fc3e-4124-4b57-80d9-c3f6edce47c4
            - bb19fc3e-6564-4b57-80d9-c3f6edce47c1
        sitegroup_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Site group IDs where the rule criteria apply
          examples:
          - - bb19fc3e-4124-4b57-80d9-c3f6edce47c4
            - bb19fc3e-6564-4b57-80d9-c3f6edce47c1
        vendor:
          type: array
          items:
            type: string
          description: Client device vendor values that must match the request
      description: Criteria used to include or exclude a NAC authentication request from a rule
    nac_rule_matching_port_type:
      title: nac_rule_matching_port_type
      enum:
      - wired
      - wireless
      type: string
      description: 'Port attachment type matched by a NAC rule. enum: `wired`, `wireless`'
    nac_tag:
      title: nac_tag
      required:
      - name
      - type
      type: object
      properties:
        allow_usermac_override:
          type: boolean
          description: Whether usermac result values can override this NAC tag when the result type is also supported by usermac
          default: false
        created_time:
          type: number
          description: Epoch timestamp when the NAC tag was created
          readOnly: true
        egress_vlan_names:
          type: array
          items:
            type: string
          description: If `type`==`egress_vlan_names`, list of egress VLAN names returned by the NAC rule
          examples:
          - - 1vlan-30
            - 1vlan-20
            - 2-vlan10
        gbp_tag:
          anyOf:
          - maximum: 65535
            minimum: 1
            type: integer
            contentEncoding: int32
          - type: string
          description: If `type`==`gbp_tag`, GBP tag value returned by the NAC rule
        id:
          type: string
          description: Unique identifier of the NAC tag
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        match:
          allOf:
          - $ref: '#/components/schemas/nac_tag_match2'
          - minLength: 1
            description: 'If `type`==`match`, client or authentication attribute used for rule matching. enum: `cert_cn`, `cert_eku`, `cert_issuer`, `cert_san`, `cert_serial`, `cert_sub`, `cert_template`, `client_mac`, `edr_status`, `gbp_tag`, `hostname`, `idp_role`, `ingress_vlan`, `mdm_status`, `nas_ip`, `radius_group`, `realm`, `ssid`, `user_name`, `usermac_label`.'
        match_all:
          type: boolean
          description: >-
            This field is applicable only when `type`==`match`
              * `false`: means it is sufficient to match any of the values (i.e., match-any behavior)
              * `true`: means all values should be matched (i.e., match-all behavior)


            Currently it makes sense to set this field to `true` only if the `match`==`idp_role`, `match`==`usermac_label` and `edr_status`
          default: false
        modified_time:
          type: number
          description: Epoch timestamp when the NAC tag was last modified
          readOnly: true
        nacportal_id:
          type: string
          description: If `type`==`redirect_nacportal_id`, NAC portal ID used for client redirection
          contentEncoding: uuid
          examples:
          - 1e970fec-0a7a-4d73-a472-3ef3b6a456aa
        name:
          minLength: 1
          type: string
          description: Human-readable name of the NAC tag
        org_id:
          type: string
          description: Org identifier that owns the NAC tag
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        radius_attrs:
          type: array
          items:
            type: string
          description: If `type`==`radius_attrs`, standard RADIUS attributes returned by the NAC rule
          examples:
          - - Idle-Timeout=600
            - Termination-Action=RADIUS-Request
        radius_group:
          type: string
          description: If `type`==`radius_group`, RADIUS group value returned by the NAC rule
        radius_vendor_attrs:
          type: array
          items:
            type: string
          description: If `type`==`radius_vendor_attrs`, vendor-specific RADIUS attributes returned by the NAC rule
          examples:
          - - PaloAlto-Admin-Role=superuser
            - PaloAlto-Panorama-Admin-Role=administrator
        session_timeout:
          type: integer
          description: If `type`==`session_timeout`, session timeout returned by the NAC rule, in seconds
          contentEncoding: int32
          examples:
          - 86000
        type:
          allOf:
          - $ref: '#/components/schemas/nac_tag_type2'
          - minLength: 1
            description: 'NAC tag type that determines whether the tag is a matcher or a result attribute. enum: `egress_vlan_names`, `gbp_tag`, `match`, `radius_attrs`, `radius_group`, `radius_vendor_attrs`, `redirect_nacportal_id`, `session_timeout`, `username_attr`, `vlan`.'
        username_attr:
          allOf:
          - $ref: '#/components/schemas/nac_tag_username_attr2'
          - description: 'If `type`==`username_attr`, attribute used to derive the username returned by the NAC rule. enum: `automatic`, `cn`, `dns`, `email`, `upn`.'
        values:
          type: array
          items:
            type: string
          description: If `type`==`match`, attribute values used by the NAC tag matcher
        vlan:
          type: string
          description: If `type`==`vlan`, VLAN name or ID returned by the NAC rule
      description: NAC tag used as a rule-matching classifier or as a result attribute for allowed users
    nac_tag_match:
      title: nac_tag_match
      enum:
      - cert_cn
      - cert_eku
      - cert_issuer
      - cert_san
      - cert_serial
      - cert_sub
      - cert_template
      - client_mac
      - edr_status
      - gbp_tag
      - hostname
      - idp_role
      - ingress_vlan
      - mdm_status
      - nas_ip
      - radius_group
      - realm
      - ssid
      - user_name
      - usermac_label
      type: string
      description: 'if `type`==`match`. enum: `cert_cn`, `cert_eku`, `cert_issuer`, `cert_san`, `cert_serial`, `cert_sub`, `cert_template`, `client_mac`, `edr_status`, `gbp_tag`, `hostname`, `idp_role`, `ingress_vlan`, `mdm_status`, `nas_ip`, `radius_group`, `realm`, `ssid`, `user_name`, `usermac_label`'
    nac_tag_type:
      title: nac_tag_type
      enum:
      - egress_vlan_names
      - gbp_tag
      - match
      - radius_attrs
      - radius_group
      - radius_vendor_attrs
      - redirect_nacportal_id
      - session_timeout
      - username_attr
      - vlan
      type: string
      description: 'enum: `egress_vlan_names`, `gbp_tag`, `match`, `radius_attrs`, `radius_group`, `radius_vendor_attrs`, `redirect_nacportal_id`, `session_timeout`, `username_attr`, `vlan`'
    nac_tag_username_attr:
      title: nac_tag_username_attr
      enum:
      - automatic
      - cn
      - dns
      - email
      - upn
      type: string
      description: 'enum: `automatic`, `cn`, `dns`, `email`, `upn`'
    name_string:
      title: name_string
      type: object
      properties:
        name:
          type: string
          description: Value to create or update as the target resource name
      description: Request body containing a name value
    network:
      title: network
      required:
      - name
      type: object
      properties:
        created_time:
          type: number
          description: Epoch timestamp when the network was created
          readOnly: true
        disallow_mist_services:
          type: boolean
          description: Whether to disallow Mist Devices in the network
          default: false
        gateway:
          type: string
          description: IPv4 gateway address for this network
          contentEncoding: ipv4
          examples:
          - 192.168.70.1
        gateway6:
          type: string
          description: IPv6 gateway address for this network
          contentEncoding: ipv6
          examples:
          - fdad:b0bc:f29e::1
        id:
          type: string
          description: Unique identifier of the network
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        internal_access:
          allOf:
          - $ref: '#/components/schemas/network_internal_access2'
          - description: Internal access settings for this network
        internet_access:
          allOf:
          - $ref: '#/components/schemas/network_internet_access2'
          - description: Direct internet access and NAT settings for this network
        isolation:
          type: boolean
          description: Whether to allow clients in the network to talk to each other
        modified_time:
          type: number
          description: Epoch timestamp when the network was last modified
          readOnly: true
        multicast:
          allOf:
          - $ref: '#/components/schemas/network_multicast2'
          - description: Settings for multicast routing on this network
        name:
          type: string
          description: Display name of the organization network
        org_id:
          type: string
          description: Organization that owns this network
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        routed_for_networks:
          type: array
          items:
            type: string
          description: Other network names this network can route to, for example through BGP, OSPF or static routes
        subnet:
          type: string
          description: IPv4 subnet CIDR for this network
          examples:
          - 192.168.70.0/24
        subnet6:
          type: string
          description: IPv6 subnet CIDR for this network
          examples:
          - fdad:b0bc:f29e::/32
        tenants:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/network_tenant'
          description: Tenant address mappings associated with this network
        vlan_id:
          oneOf:
          - type: string
          - maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
          description: VLAN ID or variable associated with this network
        vpn_access:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/network_vpn_access_config'
          description: VPN access settings keyed by VPN name for this network
      description: Organization-level Layer 3 network definition that can be merged into site settings and used for service routes. Networks are used to define the service routes in the Gateway settings or templates
    network_internal_access:
      title: network_internal_access
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether internal access is enabled for this network
      description: Internal access settings for an organization network
    network_internet_access:
      title: network_internet_access
      type: object
      properties:
        create_simple_service_policy:
          type: boolean
          description: Whether Mist should create simple service policies for restricted internet access
          default: false
        destination_nat:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/network_internet_access_destination_nat_property'
          description: Destination NAT rules for direct internet access
        enabled:
          type: boolean
          description: Whether direct internet access is enabled for this network
        restricted:
          type: boolean
          description: By default, all access is allowed, to only allow certain traffic, make `restricted`=`true` and define service_policies
          default: false
        static_nat:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/network_internet_access_static_nat_property'
          description: Static NAT rules for direct internet access
      description: Direct internet access settings for an organization network
    network_internet_access_destination_nat_property:
      title: network_internet_access_destination_nat_property
      type: object
      properties:
        internal_ip:
          type: string
          description: The Destination NAT destination IP address. Must be an IP (i.e. "192.168.70.30") or a Variable (i.e. "{{myvar}}")
          examples:
          - 192.168.70.30
        name:
          type: string
          description: Label for this direct internet destination NAT rule
          examples:
          - web server
        port:
          type: string
          description: The Destination NAT destination IP address. Must be a Port (i.e. "443") or a Variable (i.e. "{{myvar}}")
          examples:
          - '443'
        wan_name:
          type: string
          description: SRX Only. If not set, we configure the nat policies against all WAN ports for simplicity
          examples:
          - wan0
      description: Direct-internet destination NAT rule target settings
    network_internet_access_static_nat_property:
      title: network_internet_access_static_nat_property
      type: object
      properties:
        internal_ip:
          type: string
          description: The Static NAT destination IP address. Must be an IP address (i.e. "192.168.70.3") or a Variable (i.e. "{{myvar}}")
          examples:
          - 192.168.70.3
        name:
          type: string
          description: Label for this direct internet static NAT rule
          examples:
          - pos_station-1
        wan_name:
          type: string
          description: SRX Only. If not set, we configure the nat policies against all WAN ports for simplicity. Can be a Variable (i.e. "{{myvar}}")
          examples:
          - wan0
      description: Direct-internet static NAT rule target settings
    network_multicast:
      title: network_multicast
      type: object
      properties:
        disable_igmp:
          type: boolean
          description: If the network will only be the source of the multicast traffic, IGMP can be disabled
          default: false
        enabled:
          type: boolean
          description: Whether multicast support is enabled for this network
          default: false
        groups:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/network_multicast_group'
          description: Multicast group-to-RP mappings for this network
      description: Whether to enable multicast support (only PIM-sparse mode is supported)
    network_multicast_group:
      title: network_multicast_group
      type: object
      properties:
        rp_ip:
          type: string
          description: RP (rendezvous point) IP address
      description: Multicast group rendezvous point mapping
    network_source_nat:
      title: network_source_nat
      type: object
      properties:
        external_ip:
          type: string
          description: External source NAT IP or subnet used when spoke hosts must be reachable from the hub
          examples:
          - 172.16.0.8/30
      description: If `routed`==`false` (usually at Spoke), but some hosts needs to be reachable from Hub
    network_template:
      title: network_template
      type: object
      properties:
        acl_policies:
          type: array
          items:
            $ref: '#/components/schemas/acl_policy'
          description: ACL policy defaults provided by this network template
        acl_tags:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/acl_tag'
          description: ACL tags available to access policies in this network template
        additional_config_cmds:
          type: array
          items:
            type: string
          description: Additional CLI configuration commands provided by this network template
        bgp_config:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_bgp_config'
          description: BGP routing defaults for this network template. Property key is the BGP session name
        created_time:
          type: number
          description: Timestamp when the network template was created
          readOnly: true
        dhcp_snooping:
          allOf:
          - $ref: '#/components/schemas/dhcp_snooping3'
          - description: DHCP snooping defaults provided by this network template
        dns_servers:
          type: array
          items:
            type: string
          description: DNS servers provided by this network template
        dns_suffix:
          type: array
          items:
            type: string
          description: DNS search suffixes provided by this network template
        extra_routes:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/extra_route'
          description: Additional IPv4 route defaults in this network template
          examples:
          - 0.0.0.0/0:
              via: 192.168.1.10
        extra_routes6:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/extra_route6'
          description: Additional IPv6 route defaults in this network template
          examples:
          - 2a02:1234:420a:10c9::/64:
              via: 2a02:1234:200a::100
        id:
          type: string
          description: Unique identifier of the network template
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        import_org_networks:
          type: array
          items:
            type: string
          description: Organization network names imported into this network template
        mist_nac:
          allOf:
          - $ref: '#/components/schemas/switch_mist_nac2'
          - description: Mist NAC defaults applied by this network template
        modified_time:
          type: number
          description: Timestamp when the network template was last modified
          readOnly: true
        multicast_config:
          allOf:
          - $ref: '#/components/schemas/switch_multicast_config1'
          - description: Multicast settings for networks in the master VRF (not assigned to any vrf_instances); PIM is automatically enabled when any master-VRF network has `multicast.enabled`==`true`
        name:
          type: string
          description: Display name of the network template
        networks:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_network'
          description: Layer 3 networks configured by this network template
        ntp_servers:
          type: array
          items:
            type: string
          description: NTP servers provided by this network template
        org_id:
          type: string
          description: Organization that owns this network template
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        ospf_areas:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ospf_area'
          description: OSPF area defaults provided by this network template
        port_mirroring:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_port_mirroring_property'
          description: Port mirroring defaults provided by this network template
        port_usages:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_port_usage'
          description: Reusable switch port usage profiles provided by this network template
        radius_config:
          allOf:
          - $ref: '#/components/schemas/switch_radius_config3'
          - description: RADIUS authentication and accounting defaults in this network template
        remote_syslog:
          allOf:
          - $ref: '#/components/schemas/remote_syslog2'
          - description: Remote syslog defaults provided by this network template
        remove_existing_configs:
          type: boolean
          description: By default, only the configuration generated by Mist is cleaned up during the configuration process. If `true`, all the existing configuration will be removed.
          default: false
        routing_policies:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/sw_routing_policy'
          description: Routing policy defaults applied by this network template
        snmp_config:
          allOf:
          - $ref: '#/components/schemas/snmp_config2'
          - description: SNMP defaults provided by this network template
        switch_matching:
          allOf:
          - $ref: '#/components/schemas/switch_matching3'
          - description: Matching rules that select switches for this network template
        switch_mgmt:
          allOf:
          - $ref: '#/components/schemas/switch_mgmt3'
          - description: Management-plane defaults provided by this network template
        vrf_config:
          allOf:
          - $ref: '#/components/schemas/vrf_config5'
          - description: VRF defaults applied by this network template
        vrf_instances:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_vrf_instance'
          description: VRF instances configured by this network template
          examples:
          - guest:
              extra_routes:
                0.0.0.0/0:
                  via: 192.168.31.1
              networks:
              - guest
      description: Network template configuration applied to sites or site groups
    network_tenant:
      title: network_tenant
      type: object
      properties:
        addresses:
          type: array
          items:
            type: string
          description: IP addresses or subnets assigned to this tenant in the network
      description: Tenant address entry for a network
    network_vpn_access_config:
      title: network_vpn_access_config
      type: object
      properties:
        advertised_subnet:
          type: string
          description: If `routed`==`true`, whether to advertise an aggregated subnet toward HUB this is useful when there are multiple networks on SPOKE's side
          examples:
          - 172.16.0.0/24
        allow_ping:
          type: boolean
          description: Whether to allow ping from vpn into this routed network
        destination_nat:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/network_vpn_access_destination_nat_property'
          description: Destination NAT rules applied for VPN access to this network
        nat_pool:
          type: string
          description: If `routed`==`false` (usually at Spoke), but some hosts needs to be reachable from Hub, a subnet is required to create and advertise the route to Hub
          examples:
          - 172.16.0.0/26
        no_readvertise_to_lan_bgp:
          type: boolean
          description: toward LAN-side BGP peers
          default: false
        no_readvertise_to_lan_ospf:
          type: boolean
          description: toward LAN-side OSPF peers
          default: false
        no_readvertise_to_overlay:
          type: boolean
          description: toward overlay, how HUB should deal with routes it received from Spokes
        other_vrfs:
          type: array
          items:
            type: string
          description: Other VRFs that can receive leaked routes from this spoke network
        routed:
          type: boolean
          description: Whether this network is routable
        source_nat:
          allOf:
          - $ref: '#/components/schemas/network_source_nat2'
          - description: Source NAT settings used when non-routed spoke hosts must be reachable from the hub
        static_nat:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/network_vpn_access_static_nat_property'
          description: Static NAT rules applied for VPN access to this network
        summarized_subnet:
          type: string
          description: toward overlay, how HUB should deal with routes it received from Spokes
          examples:
          - 172.16.0.0/16
        summarized_subnet_to_lan_bgp:
          type: string
          description: toward LAN-side BGP peers
          examples:
          - 172.16.0.0/16
        summarized_subnet_to_lan_ospf:
          type: string
          description: toward LAN-side OSPF peers
          examples:
          - 172.16.0.0/16
      description: VPN access settings for a network and VPN pair
    network_vpn_access_destination_nat_property:
      title: network_vpn_access_destination_nat_property
      type: object
      properties:
        internal_ip:
          type: string
          description: The Destination NAT destination IP address. Must be an IP (i.e. "192.168.70.30") or a Variable (i.e. "{{myvar}}")
          examples:
          - 192.168.70.30
        name:
          type: string
          description: Label for this VPN destination NAT rule
          examples:
          - web server
        port:
          type: string
          description: Destination port or variable for this VPN destination NAT rule
          examples:
          - '443'
      description: VPN access destination NAT rule target settings
    network_vpn_access_static_nat_property:
      title: network_vpn_access_static_nat_property
      type: object
      properties:
        internal_ip:
          type: string
          description: The Static NAT destination IP address. Must be an IP address (i.e. "192.168.70.3") or a Variable (i.e. "{{myvar}}")
          examples:
          - 192.168.70.3
        name:
          type: string
          description: Label for this VPN static NAT rule
          examples:
          - pos_station-1
      description: VPN access static NAT rule target settings
    note_string:
      title: note_string
      type: object
      properties:
        note:
          type: string
          description: Some text note describing the intent
          examples:
          - maintenance window
      description: Request body containing a note value
    notes_string:
      title: notes_string
      type: object
      properties:
        notes:
          type: string
          description: Text to attach to the target resource as notes
          examples:
          - wired pcap test
      description: Request body containing notes text
    oauth_app_name:
      title: oauth_app_name
      enum:
      - crowdstrike
      - intune
      - jamf
      - mobicontrol
      - prisma
      - sentinelone
      - teams
      - vmware
      - zdx
      - zoom
      type: string
      description: 'enum: `crowdstrike`, `intune`, `jamf`, `mobicontrol`, `prisma`, `sentinelone`, `teams`, `vmware`, `zdx`, `zoom`'
    oauth_ping_identity_region:
      title: oauth_ping_identity_region
      enum:
      - asia
      - au
      - ca
      - eu
      - us
      type: string
      description: 'enum: `us` (United States, default), `ca` (Canada), `eu` (Europe), `asia` (Asia), `au` (Australia)'
    oauth_provider_domain:
      title: oauth_provider_domain
      enum:
      - okta.com
      - oktapreview.com
      - okta-emea.com
      - okta-gov.com
      - okta.mil
      - mtls.okta.com
      type: string
      description: 'If `oauth_type`==`okta`, specifies the region-specific OAuth provider domain. enum: `okta.com`, `oktapreview.com`, `okta-emea.com`, `okta-gov.com`, `okta.mil`, `mtls.okta.com`'
      examples:
      - okta.com
    optic_port_config_port:
      title: optic_port_config_port
      type: object
      properties:
        channelized:
          type: boolean
          description: Whether channelization is enabled on this optic port
          default: false
        speed:
          type: string
          description: Interface speed (e.g. `25g`, `50g`), use the chassis speed by default
          examples:
          - 25g
      description: Per-interface optic port override settings
    org:
      title: org
      required:
      - name
      type: object
      properties:
        alarmtemplate_id:
          type:
          - string
          - 'null'
          description: Org-level alarm template ID used as the default for sites
          contentEncoding: uuid
        allow_mist:
          type: boolean
          description: Whether Mist support access is allowed for this organization
          default: true
        created_time:
          type: number
          description: Epoch timestamp when the organization was created
          readOnly: true
        id:
          type: string
          description: Unique identifier of the organization
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        modified_time:
          type: number
          description: Epoch timestamp when the organization was last modified
          readOnly: true
        msp_id:
          type: string
          description: Managed service provider account that owns this organization, when applicable
          contentEncoding: uuid
          readOnly: true
          examples:
          - b9d42c2e-88ee-41f8-b798-f009ce7fe909
        msp_logo_url:
          type: string
          description: logo uploaded by the MSP with advanced tier, only present if provided
          contentEncoding: uri
          readOnly: true
          examples:
          - https://example.com/logo/b9d42c2e-88ee-41f8-b798-f009ce7fe909.jpeg
        msp_name:
          type: string
          description: Name of the msp the org belongs to
          readOnly: true
          examples:
          - MSP
        name:
          type: string
          description: Display name of the organization
          examples:
          - Org
        orggroup_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Organization group IDs that include this organization
        session_expiry:
          maximum: 20160
          minimum: 10
          type: integer
          description: Admin session lifetime for the organization, in minutes
          contentEncoding: int32
          default: 1440
      description: Mist organization containing sites, devices, users, and organization-level settings
    org_apitoken:
      title: org_apitoken
      required:
      - name
      type: object
      properties:
        created_by:
          type:
          - string
          - 'null'
          description: email of the token creator / null if creator is deleted
          readOnly: true
          examples:
          - user@mycorp.com
        created_time:
          type: number
          description: Epoch timestamp when the organization API token was created
          readOnly: true
        id:
          type: string
          description: Unique identifier of the organization API token
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        key:
          type: string
          description: Token secret key. The full API Token is only returned when the API token is created and can only be partially retrieved afterward
          readOnly: true
          examples:
          - 1qkb...QQCL
        last_used:
          type:
          - number
          - 'null'
          description: Epoch timestamp when the token was last used, or null if it has not been used
          readOnly: true
          examples:
          - 1690115110
        name:
          type: string
          description: Display name of the organization API token
          examples:
          - org_token_xyz
        org_id:
          type: string
          description: Organization that owns this API token
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        privileges:
          maxItems: 10
          minItems: 1
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/privilege_org'
          description: Access scopes and roles granted to the organization API token
          examples:
          - - role: admin
              scope: org
        src_ips:
          type: array
          items:
            type: string
          description: Allowed source IP addresses or CIDRs from which the token may be used
          examples:
          - - 63.3.56.0/24
            - 63.3.55.4
      description: >-
        Organization API token with scoped privileges


        **Note:**

        `privileges` is required to create the object, but may not be returned in the POST API response. Retrieve the token afterward to inspect it.
    privilege_org:
      title: privilege_org
      required:
      - role
      - scope
      type: object
      properties:
        org_id:
          type: string
          description: If `scope`==`org`, organization ID this privilege applies to
          contentEncoding: uuid
          readOnly: true
        role:
          allOf:
          - $ref: '#/components/schemas/privilege_org_role2'
          - description: 'Access role granted by this organization privilege. enum: `admin`, `helpdesk`, `installer`, `read`, `write`.'
        scope:
          allOf:
          - $ref: '#/components/schemas/privilege_org_scope2'
          - description: 'Organization hierarchy level where this privilege applies. enum: `org`, `site`, `sitegroup`, `orgsites`.'
        site_id:
          type: string
          description: If `scope`==`site`, site ID this privilege applies to
          contentEncoding: uuid
        sitegroup_id:
          type: string
          description: If `scope`==`sitegroup`, site group ID this privilege applies to
          contentEncoding: uuid
        view:
          type: string
          description: Used for backward compatibility. Use `views` instead.
          deprecated: true
        views:
          type: array
          items:
            $ref: '#/components/schemas/admin_privilege_view'
          description: UI views allowed by custom role restrictions
      description: Organization privilege scope and role settings
    org_asset_count_distinct:
      title: org_asset_count_distinct
      enum:
      - ibeacon_major
      - ibeacon_minor
      - ibeacon_uuid
      - mac
      - map_id
      - site_id
      type: string
      description: 'enum: `ibeacon_major`, `ibeacon_minor`, `ibeacon_uuid`, `mac`, `map_id`, `site_id`'
    org_client_sessions_count_distinct:
      title: org_client_sessions_count_distinct
      enum:
      - ap
      - device
      - hostname
      - ip
      - model
      - os
      - ssid
      - vlan
      type: string
      description: 'enum: `ap`, `device`, `hostname`, `ip`, `model`, `os`, `ssid`, `vlan`'
    org_clients_count_distinct:
      title: org_clients_count_distinct
      enum:
      - ap
      - device
      - hostname
      - ip
      - mac
      - model
      - os
      - ssid
      - vlan
      type: string
      description: 'enum: `ap`, `device`, `hostname`, `ip`, `mac`, `model`, `os`, `ssid`, `vlan`'
    org_crl_import_file:
      title: org_crl_import_file
      type: object
      properties:
        file:
          type: string
          description: a PEM or DER formatted CRL file
          contentEncoding: base64
        json:
          type: string
          description: a JSON string with "name" field for CRL file issuer (optional)
      description: Multipart upload payload for importing an organization CRL file
    org_device:
      title: org_device
      required:
      - mac
      - name
      type: object
      properties:
        mac:
          type: string
          description: Organization device MAC address
        name:
          type: string
          description: Display name of the organization device
      description: Organization device identifier returned by the devices list
    org_devices_count_distinct:
      title: org_devices_count_distinct
      enum:
      - hostname
      - ip
      - lldp_mgmt_addr
      - lldp_port_id
      - lldp_system_desc
      - lldp_system_name
      - mac
      - model
      - mxedge_id
      - mxtunnel_status
      - site_id
      - version
      type: string
      description: 'enum: `hostname`, `ip`, `lldp_mgmt_addr`, `lldp_port_id`, `lldp_system_desc`, `lldp_system_name`, `mac`, `model`, `mxedge_id`, `mxtunnel_status`, `site_id`, `version`'
    org_devices_events_count_distinct:
      title: org_devices_events_count_distinct
      enum:
      - ap
      - apfw
      - model
      - org_id
      - site_id
      - text
      - timestamp
      - type
      type: string
      description: 'enum: `ap`, `apfw`, `model`, `org_id`, `site_id`, `text`, `timestamp`, `type`'
    org_devices_last_configs_count_distinct:
      title: org_devices_last_configs_count_distinct
      enum:
      - mac
      - name
      - site_id
      - version
      type: string
      description: 'enum: `mac`, `name`, `site_id`, `version`'
    org_e911_report:
      title: org_e911_report
      type: object
      properties:
        detail:
          type: string
          description: Human-readable description of the action taken
        last_generated:
          type: integer
          description: Unix timestamp of when the report file was last generated. Only present when `status` is `available`.
          contentEncoding: int32
        status:
          allOf:
          - $ref: '#/components/schemas/org_e911_report_status2'
          - description: 'Current generation state of the E911 AP BSSID report. enum: `disabled`, `scheduled`, `available`.'
        url:
          type: string
          description: Presigned URL to download the CSV file. Only present when `status` is `available`.
      description: E911 AP BSSID report status for the organization
    org_e911_report_status:
      title: org_e911_report_status
      enum:
      - disabled
      - scheduled
      - available
      type: string
      description: 'Current status of E911 report generation. enum: `disabled`, `scheduled`, `available`'
    org_event:
      title: org_event
      type: object
      properties:
        org_id:
          type: string
          description: Organization associated with this event
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        text:
          type: string
          description: Detailed human-readable message for the organization event
          examples:
          - authentication failed, API key invalid
        timestamp:
          type: number
          description: Time when the organization event occurred
          readOnly: true
        type:
          type: string
          description: Event type code for this organization event
          examples:
          - CRADLEPOINT_SYNC_FAILED
      description: Event record generated at the organization level
    org_guests_count_distinct:
      title: org_guests_count_distinct
      enum:
      - auth_method
      - company
      - ssid
      type: string
      description: 'enum: `auth_method`, `company`, `ssid`'
    org_license_action:
      title: org_license_action
      required:
      - op
      type: object
      properties:
        amendment_id:
          type: string
          description: If `op`==`unamend`, the ID of the operation to cancel
          contentEncoding: uuid
        dst_org_id:
          type: string
          description: If `op`==`amend`, the id of the org where the license is moved
          contentEncoding: uuid
        notes:
          type: string
          description: If `op`==`annotate`, note text to attach to the license
        op:
          allOf:
          - $ref: '#/components/schemas/org_license_action_operation2'
          - description: 'License action operation to perform. enum: `amend`, `annotate`, `delete`, `unamend`.'
        quantity:
          type: integer
          description: If `op`==`amend`, the number of licenses to move
          contentEncoding: int32
        subscription_id:
          type: string
          description: If `op`==`amend` or `op`==`delete`, the ID of the subscription to use
      description: Request to amend, annotate, delete, or unamend an organization license
    org_license_action_operation:
      title: org_license_action_operation
      enum:
      - amend
      - annotate
      - delete
      - unamend
      type: string
      description: 'to move a license, use the `amend` operation. enum: `amend`, `annotate`, `delete`, `unamend`'
    org_logs_count_distinct:
      title: org_logs_count_distinct
      enum:
      - admin_id
      - admin_name
      - message
      - site_id
      type: string
      description: 'enum: `admin_id`, `admin_name`, `message`, `site_id`'
    org_mxedge_count_distinct:
      title: org_mxedge_count_distinct
      enum:
      - distro
      - model
      - mxcluster_id
      - site_id
      - tunterm_version
      type: string
      description: 'enum: `distro`, `model`, `mxcluster_id`, `site_id`, `tunterm_version`'
    org_mxedge_events_count_distinct:
      title: org_mxedge_events_count_distinct
      enum:
      - mxcluster_id
      - mxedge_id
      - package
      - type
      type: string
      description: 'enum: `mxcluster_id`, `mxedge_id`, `package`, `type`'
    org_nac_client_events_count_distinct:
      title: org_nac_client_events_count_distinct
      enum:
      - ap
      - auth_type
      - dryrun_nacrule_id
      - mac
      - nacrule_id
      - nas_vendor
      - ssid
      - type
      - username
      - vlan
      type: string
      description: 'enum: `ap`, `auth_type`, `dryrun_nacrule_id`, `mac`, `nacrule_id`, `nas_vendor`, `ssid`, `type`, `username`, `vlan`'
    org_nac_clients_count_distinct:
      title: org_nac_clients_count_distinct
      enum:
      - ap
      - auth_type
      - device_mac
      - edr_managed
      - edr_providers
      - edr_status
      - family
      - hostname
      - idp_id
      - mfg
      - mdm_compliance
      - mdm_managed
      - mdm_provider
      - model
      - mxedge_id
      - nacrule_matched
      - nacrule_name
      - nacrule_id
      - nas_ip
      - nas_vendor
      - os
      - site_id
      - ssid
      - status
      - type
      - usermac_label
      - username
      - vlan
      type: string
      description: 'enum: `ap`, `auth_type`, `device_mac`, `edr_managed`, `edr_providers`, `edr_status`, `family`, `hostname`, `idp_id`, `mfg`, `mdm_compliance`, `mdm_managed`, `mdm_provider`, `model`, `mxedge_id`, `nacrule_matched`, `nacrule_name`, `nacrule_id`, `nas_ip`, `nas_vendor`, `os`, `site_id`, `ssid`, `status`, `type`, `usermac_label`, `username`, `vlan`'
    org_otherdevices_events_count_distinct:
      title: org_otherdevices_events_count_distinct
      enum:
      - mac
      - site_id
      - type
      - vendor
      type: string
      description: 'enum: `mac`, `site_id`, `type`, `vendor`'
    org_psk_portal_logs_count_distinct:
      title: org_psk_portal_logs_count_distinct
      enum:
      - admin_id
      - admin_name
      - psk_id
      - psk_name
      - pskportal_id
      - user_id
      type: string
      description: 'enum: `admin_id`, `admin_name`, `psk_id`, `psk_name`, `pskportal_id`, `user_id`'
    org_service_policy:
      title: org_service_policy
      type: object
      properties:
        aamw:
          allOf:
          - $ref: '#/components/schemas/service_policy_aamw2'
          - description: Advanced anti-malware settings applied by this service policy
        action:
          allOf:
          - $ref: '#/components/schemas/allow_deny2'
          - description: Allow or deny action for traffic matched by this service policy
        antivirus:
          allOf:
          - $ref: '#/components/schemas/service_policy_antivirus1'
          - description: Malware and virus inspection settings applied by this service policy
        appqoe:
          allOf:
          - $ref: '#/components/schemas/service_policy_appqoe1'
          - description: Application QoE settings applied by this service policy
        created_time:
          type: number
          description: Epoch timestamp when the service policy was created
          readOnly: true
        ewf:
          type: array
          items:
            $ref: '#/components/schemas/service_policy_ewf_rule'
          description: Enhanced web filtering rules applied by this service policy
        id:
          type: string
          description: Unique identifier of the service policy
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        idp:
          allOf:
          - $ref: '#/components/schemas/idp_config2'
          - description: Intrusion detection and prevention settings applied by this service policy
        local_routing:
          type: boolean
          description: Whether the policy permits access within the same VRF
        modified_time:
          type: number
          description: Epoch timestamp when the service policy was last modified
          readOnly: true
        name:
          type: string
          description: Display name of the service policy
        org_id:
          type: string
          description: Organization that owns this service policy
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        path_preference:
          type: string
          description: By default, we derive all paths available and use them, optionally, you can customize by using `path_preference`
        secintel:
          allOf:
          - $ref: '#/components/schemas/service_policy_secintel1'
          - description: Juniper SecIntel threat intelligence settings applied by this service policy
        services:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Application services or groups matched by this policy
        ssl_proxy:
          allOf:
          - $ref: '#/components/schemas/service_policy_ssl_proxy1'
          - description: SSL proxy inspection settings applied by this service policy
        tenants:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Tenant names matched by this service policy
      description: Organization-level service policy that allows or denies traffic for tenants and services
    org_setting:
      title: org_setting
      type: object
      properties:
        allow_mist:
          type: boolean
          description: whether to allow Mist to look at this org
          default: false
        ap_updown_threshold:
          maximum: 240
          minimum: 0
          type:
          - integer
          - 'null'
          description: Enable threshold-based device down delivery for AP devices only. When configured it takes effect for AP devices and `device_updown_threshold` is ignored.
          contentEncoding: int32
          default: 0
        api_policy:
          allOf:
          - $ref: '#/components/schemas/org_setting_api_policy2'
          - description: Policy for hiding API secrets and passwords in responses
        auto_device_naming:
          allOf:
          - $ref: '#/components/schemas/org_setting_auto_device_naming2'
          - description: Automatic device naming rules for claimed devices
        auto_deviceprofile_assignment:
          allOf:
          - $ref: '#/components/schemas/org_setting_auto_deviceprofile_assignment2'
          - description: Automatic device profile assignment rules for claimed devices
        auto_site_assignment:
          allOf:
          - $ref: '#/components/schemas/org_setting_auto_site_assignment2'
          - description: Automatic site assignment rules for claimed devices
        auto_upgrade:
          allOf:
          - $ref: '#/components/schemas/org_setting_auto_upgrade2'
          - description: AP automatic firmware upgrade policy for the organization
        blacklist_url:
          type: string
          description: Read-only URL for the organization blacklist file
          readOnly: true
          examples:
          - https://papi.s3.amazonaws.com/blacklist/xxx...
        cacerts:
          type: array
          items:
            type: string
          description: Legacy CA certificate list used to verify client certificates. If `cacerts_configs` is provided and non-empty, this field is ignored.
        cacerts_configs:
          type: array
          items:
            $ref: '#/components/schemas/org_setting_cacerts_config'
          description: Preferred per-issuer CA certificate configuration with optional OCSP and CRL settings. When provided and non-empty, `cacerts` is ignored.
        celona:
          allOf:
          - $ref: '#/components/schemas/org_setting_celona'
          - description: Integration settings for Celona
        cloudshark:
          allOf:
          - $ref: '#/components/schemas/org_setting_cloudshark'
          - description: Packet capture integration settings for CloudShark
        created_time:
          type: number
          description: Epoch timestamp when the organization settings were created
          readOnly: true
        device_cert:
          allOf:
          - $ref: '#/components/schemas/org_setting_device_cert2'
          - description: Common device certificate used by organization settings
        device_updown_threshold:
          maximum: 240
          minimum: 0
          type:
          - integer
          - 'null'
          description: "Enable threshold-based device down delivery via\n  * device-updowns webhooks topic, \n  * Mist Alert Framework; e.g. send AP/SW/GW down event only if AP/SW/GW Up is not seen within the threshold in minutes; 0 - 240, default is 0 (trigger immediate)"
          contentEncoding: int32
          default: 0
        disable_pcap:
          type: boolean
          description: Whether to disallow Mist to analyze pcap files (this is required for marvis pcap)
          default: false
        disable_remote_shell:
          type: boolean
          description: Whether to disable remote shell access for an entire org
          default: false
        for_site:
          type: boolean
          description: Read-only indicator that the settings object is scoped to a site
          readOnly: true
        gateway_mgmt:
          allOf:
          - $ref: '#/components/schemas/org_setting_gateway_mgmt2'
          - description: Gateway management defaults for the organization
        gateway_tunnel_updown_threshold:
          minimum: 0
          type:
          - integer
          - 'null'
          description: enable threshold-based gateway tunnel (secure edge tunnels) up-down delivery.
          contentEncoding: int32
        gateway_updown_threshold:
          maximum: 240
          minimum: 0
          type:
          - integer
          - 'null'
          description: Enable threshold-based device down delivery for Gateway devices only. When configured it takes effect for GW devices and `device_updown_threshold` is ignored.
          contentEncoding: int32
          default: 0
          examples:
          - 10
        id:
          type: string
          description: Unique identifier of the organization settings object
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        installer:
          allOf:
          - $ref: '#/components/schemas/org_setting_installer2'
          - description: Access settings for organization installer workflows
        jcloud:
          allOf:
          - $ref: '#/components/schemas/org_setting_jcloud2'
          - description: Integration settings for JCloud
        jcloud_ra:
          allOf:
          - $ref: '#/components/schemas/org_setting_jcloud_ra2'
          - description: Routing Assurance integration settings for JCloud
        juniper:
          allOf:
          - $ref: '#/components/schemas/account_juniper_info1'
          - description: Linked Juniper account information for this organization
        juniper_srx:
          allOf:
          - $ref: '#/components/schemas/org_setting_juniper_srx2'
          - description: SRX integration settings for Juniper devices
        junos_shell_access:
          allOf:
          - $ref: '#/components/schemas/org_setting_junos_shell_access2'
          - description: Role-based Junos web-shell access settings
        marvis:
          allOf:
          - $ref: '#/components/schemas/org_setting_marvis2'
          - description: AI assistant and self-driving feature settings for Marvis
        mgmt:
          allOf:
          - $ref: '#/components/schemas/org_setting_mgmt2'
          - description: Tunnel settings for organization management connectivity
        mist_nac:
          allOf:
          - $ref: '#/components/schemas/org_setting_mist_nac2'
          - description: NAC settings for Mist Access Assurance
        modified_time:
          type: number
          description: Epoch timestamp when the organization settings were last modified
          readOnly: true
        msp_id:
          type: string
          description: Managed service provider account associated with these settings
          contentEncoding: uuid
          readOnly: true
          examples:
          - b9d42c2e-88ee-41f8-b798-f009ce7fe909
        mxedge_mgmt:
          allOf:
          - $ref: '#/components/schemas/mxedge_mgmt3'
          - description: Management settings for Mist Edge devices
        optic_port_config:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/optic_port_config_port'
          description: Configuration defaults for optic ports
        org_id:
          type: string
          description: Organization that owns these settings
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        password_policy:
          allOf:
          - $ref: '#/components/schemas/org_setting_password_policy'
          - description: Admin credential policy settings for the organization
        pcap:
          allOf:
          - $ref: '#/components/schemas/org_setting_pcap2'
          - description: Packet capture settings for the organization
        pcap_bucket_verified:
          type: boolean
          description: Whether the configured packet capture bucket has been verified
          readOnly: true
        security:
          allOf:
          - $ref: '#/components/schemas/org_setting_security2'
          - description: Organization security controls such as local SSH restrictions
        simple_alert:
          allOf:
          - $ref: '#/components/schemas/simple_alert3'
          - description: Basic alert delivery settings for the organization
        ssr:
          allOf:
          - $ref: '#/components/schemas/setting_ssr3'
          - description: Session Smart Router settings for the organization
        switch:
          allOf:
          - $ref: '#/components/schemas/org_setting_switch'
          - description: Configuration defaults for switches in this organization
        switch_mgmt:
          allOf:
          - $ref: '#/components/schemas/org_setting_switch_mgmt2'
          - description: Management settings for switches in this organization
        switch_updown_threshold:
          type:
          - integer
          - 'null'
          description: Enable threshold-based device down delivery for Switch devices only. When configured it takes effect for SW devices and `device_updown_threshold` is ignored.
          contentEncoding: int32
          default: 0
          examples:
          - 0
        synthetic_test:
          allOf:
          - $ref: '#/components/schemas/synthetictest_config3'
          - description: Configuration for organization synthetic tests
        tags:
          type: array
          items:
            type: string
          description: Labels associated with these organization settings
        ui_idle_timeout:
          maximum: 480
          minimum: 0
          type: integer
          description: Automatically logout the user when UI session is inactive. `0` means disabled
          contentEncoding: int32
          default: 0
          examples:
          - 10
        ui_no_tracking:
          type: boolean
          description: Whether UI usage tracking is disabled for the organization
          default: false
        vpn_options:
          allOf:
          - $ref: '#/components/schemas/org_setting_vpn_options2'
          - description: Options for organization VPN behavior
        wan_pma:
          allOf:
          - $ref: '#/components/schemas/org_setting_wan_pma'
          - description: PMA feature settings for WAN Assurance
        wired_pma:
          allOf:
          - $ref: '#/components/schemas/org_setting_wired_pma'
          - description: PMA feature settings for Wired Assurance
        wireless_pma:
          allOf:
          - $ref: '#/components/schemas/org_setting_wireless_pma'
          - description: PMA feature settings for Wireless Assurance
      description: Organization-wide feature, integration, management, and security settings
    org_setting_api_policy:
      title: org_setting_api_policy
      type: object
      properties:
        enforce_src_ips_for_tokens:
          type: boolean
          description: Optional. When `true`, Org API tokens without their own `src_ips` also respect the org policy `src_ips`. Default is `false`.
          default: false
        no_reveal:
          type: boolean
          description: >-
            By default, API hides password/secrets when the user doesn't have write access
              * `true`: API will hide passwords/secrets for all users
              * `false`: API will hide passwords/secrets for read-only users
          default: false
        src_ips:
          maxItems: 10
          type: array
          items:
            type: string
          description: Optional list of IP addresses or CIDR subnets from which org API access is allowed. At most 10 entries. The source IP of the request making this update must be within one of the specified subnets.
          examples:
          - - 63.3.56.0/24
            - 63.3.55.4
      description: Organization API response policy for hiding secrets and passwords
    org_setting_auto_assignment_rule:
      title: org_setting_auto_assignment_rule
      required:
      - src
      type: object
      properties:
        create_new_site_if_needed:
          type: boolean
          description: If `src`==`geoip`. By default, a claimed device only gets assigned if the site exists to auto-create the site, enable this
          default: false
        expression:
          type:
          - string
          - 'null'
          description: "If `src`==`name`, `src`==`lldp_system_name`, `src`==`dns_suffix`  \n      \"[0:3]\"            // \"abcdef\" -> \"abc\"  \n      \"split(.)[1]\"      // \"a.b.c\" -> \"b\"  \n      \"split(-)[1][0:3]\" // \"a1234-b5678-c90\" -> \"b56\"'"
          examples:
          - split(.)[1]
        gatewaytemplate_id:
          type: string
          description: If `src`==`geoip` and `create_new_site_if_needed`==`true`. If a gateway template is desired for this newly created site
        match_country:
          type: string
          description: If `src`==`geoip`, country or region value that must match the device location
        match_device_type:
          allOf:
          - $ref: '#/components/schemas/device_type_default_ap6'
          - description: 'Device type filter that limits which claimed devices this rule applies to. enum: `ap`, `gateway`, `switch`.'
        match_model:
          type: string
          description: Optional additional device model filter for this assignment rule
        model:
          type: string
          description: If `src`==`model`, device model value to match
        prefix:
          type:
          - string
          - 'null'
          description: If `src`==`name`, prefix that must be present in the device name
          examples:
          - XX-
        src:
          allOf:
          - $ref: '#/components/schemas/org_setting_auto_site_assignment_src2'
          - description: 'Source attribute used to evaluate the automatic assignment rule. enum: `ext_ip`, `dns_suffix`, `geoip`, `lldp_port_desc`, `lldp_system_name`, `model`, `name`, `subnet`.'
        subnet:
          type: string
          description: If `src`==`subnet` or `ext_ip`==`ext_ip`
        suffix:
          type:
          - string
          - 'null'
          description: If `src`==`name`, suffix that must be present in the device name
          examples:
          - -YY
        value:
          type: string
          description: "If \n  * `src`==`ext_ip`, `src`==`subnet` or `src`==`model`, the site name\n  * `src`==`geoip`: site name for the device to be assigned to (\\\"city\\\" / \\\"city+country\\\" / ...)\""
      description: Automatic assignment rule used by org settings
    org_setting_auto_device_naming:
      title: org_setting_auto_device_naming
      type: object
      properties:
        enable:
          type: boolean
          description: Whether automatic device naming is enabled
        rules:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/org_setting_auto_device_naming_rule'
          description: List of rules used to derive device names automatically
      description: Automatic device naming configuration for claimed devices
    org_setting_auto_device_naming_rule:
      title: org_setting_auto_device_naming_rule
      type: object
      properties:
        expression:
          type: string
          description: "\"[0:3]\"            // \"abcdef\" -> \"abc\"  \n      \"split(.)[1]\"      // \"a.b.c\" -> \"b\"  \n      \"split(-)[1][0:3]\" // \"a1234-b5678-c90\" -> \"b56\"'"
          examples:
          - split(.)[1]
        match_device:
          allOf:
          - $ref: '#/components/schemas/device_type_default_ap5'
          - description: 'Device type filter for this naming rule. enum: `ap`, `gateway`, `switch`.'
        prefix:
          type: string
          description: Text prepended to the generated device name
        src:
          allOf:
          - $ref: '#/components/schemas/org_setting_auto_device_naming_rule_src2'
          - description: 'Device attribute used to generate the name. enum: `lldp_port_desc`, `mac`.'
        suffix:
          type: string
          description: Text appended to the generated device name
      description: Automatic device naming rule
    org_setting_auto_device_naming_rule_src:
      title: org_setting_auto_device_naming_rule_src
      enum:
      - lldp_port_desc
      - mac
      type: string
      description: 'Device attribute used to generate the name. enum: `lldp_port_desc`, `mac`'
    org_setting_auto_deviceprofile_assignment:
      title: org_setting_auto_deviceprofile_assignment
      type: object
      properties:
        enable:
          type: boolean
          description: Whether automatic device profile assignment is enabled
        rules:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/org_setting_auto_assignment_rule'
          description: Assignment rules evaluated for automatic device profile selection
      description: Automatic device profile assignment configuration
    org_setting_auto_site_assignment:
      title: org_setting_auto_site_assignment
      type: object
      properties:
        enable:
          type: boolean
          description: Whether automatic site assignment is enabled
        rules:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/org_setting_auto_assignment_rule'
          description: Assignment rules evaluated for automatic site selection
      description: Automatic site assignment configuration for claimed devices
    org_setting_auto_site_assignment_src:
      title: org_setting_auto_site_assignment_src
      enum:
      - ext_ip
      - dns_suffix
      - geoip
      - lldp_port_desc
      - lldp_system_name
      - model
      - name
      - subnet
      type: string
      description: 'enum: `ext_ip`, `dns_suffix`, `geoip`, `lldp_port_desc`, `lldp_system_name`, `model`, `name`, `subnet`'
    org_setting_auto_upgrade:
      title: org_setting_auto_upgrade
      type: object
      properties:
        custom_versions:
          type: object
          additionalProperties:
            type: string
          description: Per-AP-model firmware versions or channels used for auto-upgrade
          examples:
          - AP21: alpha
            AP41: 0.1.5135
            AP61: 0.1.7215
        day_of_week:
          allOf:
          - $ref: '#/components/schemas/day_of_week3'
          - description: 'Day of the week for the AP auto-upgrade maintenance window. enum: `any`, `fri`, `mon`, `sat`, `sun`, `thu`, `tue`, `wed`.'
        enabled:
          type: boolean
          description: Whether AP auto-upgrade is enabled. Note that Mist may auto-upgrade APs if the running version is no longer supported.
          default: false
        time_of_day:
          type: string
          description: '`any` or HH:MM (24-hour format). Upgrade will happen within up to 1 hour from this time.'
          examples:
          - 12:00
        version:
          allOf:
          - $ref: '#/components/schemas/site_auto_upgrade_version3'
          - description: 'Firmware release channel or specific version used for AP auto-upgrade. enum: `beta`, `custom`, `stable`.'
            examples:
            - beta
      description: Organization-wide AP automatic firmware upgrade policy
    org_setting_cacerts_config:
      title: org_setting_cacerts_config
      required:
      - cert
      type: object
      properties:
        cert:
          type: string
          description: PEM-encoded CA certificate
          examples:
          - '-----BEGIN CERTIFICATE-----\nMIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE\n-----END CERTIFICATE-----'
        crl_enabled:
          type: boolean
          description: Whether CRL checks are enabled. When true, CRL from AIA is used if available unless `crl_url` is set.
          default: true
        crl_url:
          type: string
          description: Optional override URL for the certificate CRL distribution point
          examples:
          - https://crl.example.com/issuer1.crl
        name:
          type: string
          description: Optional user-friendly label for the CA issuer configuration
          examples:
          - Issuer 1
        ocsp_enabled:
          type: boolean
          description: Whether OCSP checks are enabled. When true, OCSP responder from AIA is used if available unless `ocsp_url` is set.
          default: true
        ocsp_url:
          type: string
          description: Optional override URL for the OCSP responder
          examples:
          - https://ocsp.example.com
      description: Per-issuer CA certificate configuration used to verify client certificates
    org_setting_celona:
      title: org_setting_celona
      type: object
      properties:
        api_key:
          type: string
          description: Credential used by Mist for the Celona integration
          examples:
          - $2a$04$OkaLCoJn6rDjR8ha.oduQVDST3.kJNIrte
        api_prefix:
          type: string
          description: Celona API prefix configured for the integration
          examples:
          - cc3273fcb016470e
      description: Integration settings for Celona
    org_setting_cloudshark:
      title: org_setting_cloudshark
      type: object
      properties:
        apitoken:
          type: string
          description: Token used by Mist to access the CloudShark integration
          examples:
          - accbd6f10c6d05c3
        url:
          type: string
          description: CloudShark Enterprise URL, if using a self-hosted CS Enterprise instance
          examples:
          - https://cloudshark.hosted.domain
      description: Packet capture integration settings for CloudShark
    org_setting_device_cert:
      title: org_setting_device_cert
      type: object
      properties:
        cert:
          type: string
          description: PEM-encoded common device certificate used by organization settings
          examples:
          - '-----BEGIN CERTIFICATE-----\nMIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE\n-----END CERTIFICATE-----'
        key:
          type: string
          description: Private key paired with the common device certificate
          examples:
          - '-----BEGIN PRI...'
      description: Optional common device certificate configuration for organization settings
    org_setting_gateway_mgmt:
      title: org_setting_gateway_mgmt
      type: object
      properties:
        app_probing:
          allOf:
          - $ref: '#/components/schemas/org_setting_gateway_mgmt_app_probing2'
          - description: Application probing configuration applied to managed gateways
        app_usage:
          type: boolean
          description: For SRX only, whether gateway application usage collection is enabled; requires App Track license
        fips_enabled:
          type: boolean
          description: Whether FIPS mode is enabled for managed gateways
          default: false
        host_in_policies:
          allOf:
          - $ref: '#/components/schemas/org_setting_gateway_mgmt_host_in_policies2'
          - description: Host-in access policies for gateway management services such as ICMP and SNMP
        host_out_policies:
          allOf:
          - $ref: '#/components/schemas/org_setting_gateway_mgmt_host_out_policies2'
          - description: Path preference policies for gateway-originated management traffic
        overlay_ip:
          allOf:
          - $ref: '#/components/schemas/org_setting_gateway_mgmt_overlay_ip2'
          - description: Overlay IP addresses used when gateway management traffic uses the overlay
      description: Organization-level gateway management settings
    org_setting_gateway_mgmt_app_probing:
      title: org_setting_gateway_mgmt_app_probing
      type: object
      properties:
        apps:
          type: array
          items:
            type: string
          description: Predefined application keys to probe from managed gateways
          examples:
          - - facebook
      description: Application probing settings for organization gateway management
    org_setting_gateway_mgmt_host_in_policies:
      title: org_setting_gateway_mgmt_host_in_policies
      type: object
      properties:
        icmp:
          allOf:
          - $ref: '#/components/schemas/org_setting_gateway_mgmt_host_in_policy3'
          - description: Host-in access policy for ICMP traffic to managed gateways
        snmp:
          allOf:
          - $ref: '#/components/schemas/org_setting_gateway_mgmt_host_in_policy1'
          - description: Host-in access policy for SNMP traffic to managed gateways
      description: Host-in access policies for gateway management services
    org_setting_gateway_mgmt_host_in_policy:
      title: org_setting_gateway_mgmt_host_in_policy
      type: object
      properties:
        tenants:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Tenant names this host-in policy applies to
      description: Host-in access policy for a gateway management service
    org_setting_gateway_mgmt_host_out_policies:
      title: org_setting_gateway_mgmt_host_out_policies
      type: object
      properties:
        dns:
          allOf:
          - $ref: '#/components/schemas/gateway_mgmt_host_out_policy1'
          - description: Path preference policy for gateway-originated DNS traffic
        ntp:
          allOf:
          - $ref: '#/components/schemas/gateway_mgmt_host_out_policy2'
          - description: Path preference policy for gateway-originated NTP traffic
        syslog:
          allOf:
          - $ref: '#/components/schemas/gateway_mgmt_host_out_policy_syslog1'
          - description: Path preference policy for gateway-originated syslog traffic
      description: Optional path preferences for gateway-originated management traffic; ECMP is used across available paths when no preference is specified
    org_setting_gateway_mgmt_overlay_ip:
      title: org_setting_gateway_mgmt_overlay_ip
      type: object
      properties:
        ip:
          type: string
          description: When it's going overlay, a routable IP to overlay will be required
        node1_ip:
          type: string
          description: For SSR HA cluster, another IP for node1 will be required, too
      description: Overlay IP configuration used for gateway management traffic
    org_setting_installer:
      title: org_setting_installer
      type: object
      properties:
        allow_all_devices:
          type: boolean
          description: Whether installers may work with all eligible devices
        allow_all_sites:
          type: boolean
          description: Whether installers may work with all sites
        extra_site_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Additional site IDs that installers may access
        grace_period:
          type: integer
          description: Grace period, in days, during which installers can modify recent sites or devices
          contentEncoding: int32
      description: Organization-level permissions and grace period for installer workflows
    org_setting_jcloud:
      title: org_setting_jcloud
      type: object
      properties:
        org_apitoken:
          type: string
          description: JCloud organization API token used by this Mist organization
        org_apitoken_name:
          type: string
          description: Display name for the JCloud organization API token
        org_id:
          type: string
          description: JCloud organization identifier linked to this Mist organization
      description: JCloud integration settings for this Mist organization
    org_setting_jcloud_ra:
      title: org_setting_jcloud_ra
      type: object
      properties:
        org_apitoken:
          type: string
          description: JCloud Routing Assurance Org Token
        org_apitoken_name:
          type: string
          description: JCloud Routing Assurance Org Token Name
        org_id:
          type: string
          description: JCloud Routing Assurance Org ID
      description: JCloud Routing Assurance connexion
    org_setting_juniper_srx:
      title: org_setting_juniper_srx
      type: object
      properties:
        auto_upgrade:
          allOf:
          - $ref: '#/components/schemas/juniper_srx_auto_upgrade1'
          - description: SRX auto-upgrade settings applied when Juniper SRX devices are first onboarded
      description: Organization settings for Juniper SRX devices
    org_setting_junos_shell_access:
      title: org_setting_junos_shell_access
      type: object
      properties:
        admin:
          allOf:
          - $ref: '#/components/schemas/org_setting_junos_shell_access_admin2'
          - description: 'Shell access level used for administrator web-shell sessions. enum: `admin`, `none`, `viewer`.'
        helpdesk:
          allOf:
          - $ref: '#/components/schemas/org_setting_junos_shell_access_helpdesk2'
          - description: 'Shell access level used for helpdesk web-shell sessions. enum: `admin`, `none`, `viewer`.'
        read:
          allOf:
          - $ref: '#/components/schemas/org_setting_junos_shell_access_read2'
          - description: 'Shell access level used for read-only web-shell sessions. enum: `admin`, `none`, `viewer`.'
        write:
          allOf:
          - $ref: '#/components/schemas/org_setting_junos_shell_access_write2'
          - description: 'Shell access level used for write-role web-shell sessions. enum: `admin`, `none`, `viewer`.'
      description: "junos_shell_access: Manages role-based web-shell access.  \nWhen junos_shell access is not defined (Default) - No additional users are configured and web-shell uses default `mist` user to login.  \nWhen junos_shell_access is defined - Additional users mist-web-admin (admin permission), mist-web-viewer(viewer permission) are configured on the device and web-shell logs in with the mist-web-admin/mist-web-viewer user depending upon the shell access level. Setting the shell access level to \"none\", disables web-shell access for that specific role."
    org_setting_junos_shell_access_admin:
      title: org_setting_junos_shell_access_admin
      enum:
      - admin
      - none
      - viewer
      type: string
      description: 'enum: `admin`, `viewer`, `none`'
    org_setting_junos_shell_access_helpdesk:
      title: org_setting_junos_shell_access_helpdesk
      enum:
      - admin
      - none
      - viewer
      type: string
      description: 'enum: `admin`, `viewer`, `none`'
    org_setting_junos_shell_access_read:
      title: org_setting_junos_shell_access_read
      enum:
      - admin
      - none
      - viewer
      type: string
      description: 'enum: `admin`, `viewer`, `none`'
    org_setting_junos_shell_access_write:
      title: org_setting_junos_shell_access_write
      enum:
      - admin
      - none
      - viewer
      type: string
      description: 'enum: `admin`, `viewer`, `none`'
    org_setting_marvis:
      title: org_setting_marvis
      type: object
      properties:
        disable_proactive_monitoring:
          type: boolean
          description: 'Disable proactive monitoring in Marvis. NOTE: support access must be enabled for the org (`allow_mist`=`true`) for proactive monitoring to function.'
          default: false
        self_driving:
          allOf:
          - $ref: '#/components/schemas/marvis_self_driving1'
          - description: Self-driving network automation settings by domain
      description: Organization settings for Marvis automation
    org_setting_mgmt:
      title: org_setting_mgmt
      type: object
      properties:
        mxtunnel_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Mist Tunnel IDs selected for management connectivity
        use_mxtunnel:
          type: boolean
          description: Whether to use Mist Tunnel for mgmt connectivity, this takes precedence over use_wxtunnel
          default: false
        use_wxtunnel:
          type: boolean
          description: Whether to use wxtunnel for mgmt connectivity
          default: false
      description: Organization management connectivity settings
    org_setting_mist_nac:
      title: org_setting_mist_nac
      type: object
      properties:
        allow_teap_machine_auth_only:
          type: boolean
          description: allow clients to connect even when the user cert failed. TEAP authenticates both Machine Cert and User Cert. When enabled, clients who only succeed Machine Cert authentication will be accepted.
          default: false
        cacerts:
          type: array
          items:
            type: string
          description: CA certificates trusted by Mist NAC for certificate-based authentication
        default_idp_id:
          type: string
          description: use this IDP when no explicit realm present in the incoming username/CN OR when no IDP is explicitly mapped to the incoming realm.
        disable_rsae_algorithms:
          type: boolean
          description: to disable RSAE_PSS_SHA256, RSAE_PSS_SHA384, RSAE_PSS_SHA512 from server side. see https://www.openssl.org/docs/man3.0/man1/openssl-ciphers.html
          default: false
        eap_ssl_security_level:
          maximum: 4
          minimum: 1
          type: integer
          description: eap ssl security level, see https://www.openssl.org/docs/man1.1.1/man3/SSL_CTX_set_security_level.html#DEFAULT-CALLBACK-BEHAVIOUR
          contentEncoding: int32
          default: 2
        enable_eap_md5_for_mab:
          type: boolean
          description: 'Enable EAP-MD5 for MAB. WARNING: Not FIPS compliant, use only if required for legacy device support.'
          default: false
        eu_only:
          type: boolean
          description: By default, NAC POD failover considers all NAC pods available around the globe, i.e. EU, US, or APAC based, failover happens based on geo IP of the originating site. For strict GDPR compliance NAC POD failover would only happen between the PODs located within the EU environment, and no authentication would take place outside of EU. This is an org setting that is applicable to WLANs, switch templates, Mist Edge clusters that have mist_nac enabled
          default: false
        fingerprinting:
          allOf:
          - $ref: '#/components/schemas/org_setting_mist_nac_fingerprinting2'
          - description: Client fingerprinting settings used by Mist NAC
        idp_machine_cert_lookup_field:
          allOf:
          - $ref: '#/components/schemas/idp_machine_cert_lookup_field1'
          - description: 'Client certificate field used to look up machine groups in identity providers. enum: `automatic`, `cn`, `dns`.'
        idp_user_cert_lookup_field:
          allOf:
          - $ref: '#/components/schemas/idp_user_cert_lookup_field1'
          - description: 'Client certificate field used to look up user groups in identity providers. enum: `automatic`, `cn`, `email`, `upn`.'
        idps:
          type: array
          items:
            $ref: '#/components/schemas/org_setting_mist_nac_idp'
          description: Identity provider mappings used by Mist NAC realm matching
        mdm:
          allOf:
          - $ref: '#/components/schemas/org_setting_mist_nac_mdm2'
          - description: Mobile Device Management CoA settings for Mist NAC
        server_cert:
          allOf:
          - $ref: '#/components/schemas/org_setting_mist_nac_server_cert'
          - description: RADIUS server certificate presented by Mist NAC during EAP-TLS
        use_ip_version:
          allOf:
          - $ref: '#/components/schemas/org_setting_mist_nac_ip_version2'
          - description: 'IP version used by NAS devices and Mist Edge proxies to reach Mist NAC. enum: `v4`, `v6`.'
        use_ssl_port:
          type: boolean
          description: By default, NAS devices (switches/aps) and proxies(mxedge) are configured to use port TCP2083(RadSec) to reach mist-nac. Set `use_ssl_port`==`true` to override that port with TCP43 (ssl), This is an org level setting that is applicable to wlans, switch_templates, and mxedge_clusters that have mist-nac enabled
          default: false
        usermac_expiry:
          maximum: 1095
          minimum: 0
          type: integer
          description: Allow customer to configure an expiry time for usermacs by attaching an `inactive_endpoint` label to those which have been inactive for the configured period of time (in days). 0 means no expiry
          contentEncoding: int32
          default: 0
          examples:
          - 30
      description: Organization-level Mist NAC configuration
    org_setting_mist_nac_fingerprinting:
      title: org_setting_mist_nac_fingerprinting
      type: object
      properties:
        enabled:
          type: boolean
          description: enable/disable writes to NAC DDB fingerprint table
          default: false
        generate_coa:
          type: boolean
          description: enable/disable CoA triggers on fingerprint change for wired clients, always port-bounce
          default: false
        generate_wireless_coa:
          type: boolean
          description: enable/disable CoA triggers on fingerprint change for wireless clients
          default: false
        wireless_coa_type:
          allOf:
          - $ref: '#/components/schemas/org_setting_mist_nac_fingerprinting_wireless_coa2'
          - description: 'Change of Authorization action sent to wireless clients when fingerprints change. enum: `reauth`, `disconnect`.'
      description: Client fingerprinting settings used for Mist NAC policy enforcement
    org_setting_mist_nac_fingerprinting_wireless_coa:
      title: org_setting_mist_nac_fingerprinting_wireless_coa
      enum:
      - reauth
      - disconnect
      type: string
      description: 'Change of Authorization action sent to wireless clients when fingerprints change. enum: `reauth`, `disconnect`'
    org_setting_mist_nac_idp:
      title: org_setting_mist_nac_idp
      type: object
      properties:
        exclude_realms:
          type: array
          items:
            type: string
          description: When the IDP is `mxedge_proxy` type, realms excluded from proxying in addition to other valid home realms in this org
        id:
          type: string
          description: Unique identifier of the identity provider referenced by this Mist NAC mapping
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        user_realms:
          type: array
          items:
            type: string
          description: User realms that select this identity provider
      description: Mist NAC identity provider realm mapping
    org_setting_mist_nac_ip_version:
      title: org_setting_mist_nac_ip_version
      enum:
      - v4
      - v6
      type: string
      description: 'by default, NAS devices(switches/aps) and proxies(mxedge) are configured to reach mist-nac via IPv4. enum: `v4`, `v6`'
    org_setting_mist_nac_mdm:
      title: org_setting_mist_nac_mdm
      type: object
      properties:
        coa_type:
          allOf:
          - $ref: '#/components/schemas/nac_coa_type2'
          - description: 'Change of Authorization action sent for MDM posture changes. enum: `reauth`, `disconnect`.'
      description: MDM (Mobile Device Management) CoA configuration
    org_setting_mist_nac_server_cert:
      title: org_setting_mist_nac_server_cert
      type: object
      properties:
        cert:
          type: string
          description: PEM-encoded RADIUS server certificate presented during EAP-TLS
          examples:
          - '-----BEGIN CERTIFICATE-----\nMIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE\n-----END CERTIFICATE-----'
        key:
          type: string
          description: Private key paired with the Mist NAC RADIUS server certificate
          contentEncoding: password
          examples:
          - '-----BEGIN PRI...'
        password:
          type: string
          description: Optional password for the private key
          contentEncoding: password
      description: RADIUS server certificate presented by Mist NAC during EAP-TLS
    org_setting_password_policy:
      title: org_setting_password_policy
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether the policy is enabled
          default: false
        expiry_in_days:
          maximum: 365
          minimum: 1
          type: integer
          description: Password expiry in days. Password Expiry Notice banner will display in the UI 14 days before expiration
          contentEncoding: int32
          examples:
          - 60
        min_length:
          type: integer
          description: Minimum number of characters required for passwords
          contentEncoding: int32
          default: 8
        requires_special_char:
          type: boolean
          description: Whether to require special character
          default: false
        requires_two_factor_auth:
          type: boolean
          description: Whether to require two-factor auth
          default: false
      description: Admin credential policy settings for the organization
    org_setting_pcap:
      title: org_setting_pcap
      type: object
      properties:
        bucket:
          type: string
          description: Storage bucket name used for organization packet capture files
          examples:
          - myorg_pcap
        max_pkt_len:
          maximum: 128
          type: integer
          description: Maximum length of non-management packets to capture, in bytes
          contentEncoding: int32
          default: 128
          examples:
          - 128
      description: Packet capture export settings for the organization
    org_setting_scep:
      title: org_setting_scep
      type: object
      properties:
        cert_providers:
          type: array
          items:
            $ref: '#/components/schemas/org_setting_scep_cert_provider'
          description: Certificate providers enabled for Mist SCEP
        enable:
          type: boolean
          description: Whether SCEP is enabled for this org
        suspended:
          type: boolean
          description: Whether SCEP is suspended for this org
          default: false
      description: Mist SCEP settings for certificate enrollment
    org_setting_scep_cert_provider:
      title: org_setting_scep_cert_provider
      enum:
      - intune
      - jamf
      - byod
      type: string
      description: 'enum: `intune`, `jamf`, `byod`'
    org_setting_scep_response:
      title: org_setting_scep_response
      type: object
      properties:
        cert_providers:
          type: array
          items:
            $ref: '#/components/schemas/org_setting_scep_cert_provider'
          description: Certificate providers configured for Mist SCEP
        enabled:
          type: boolean
          description: Whether Mist SCEP is enabled for this organization
          readOnly: true
        intune_scep_url:
          type: string
          description: Intune SCEP enrollment URL for this organization
          readOnly: true
          examples:
          - https://scep.mistsys.com/api/v1/incoming/intune/:org_id/scep
        jamf_access_token:
          type: string
          description: Access token used by Jamf to call Mist SCEP
          readOnly: true
          examples:
          - 1Z4QqEnCt05Jjt3TV5LgPJ4V_WL_RWnJ7dqVMLYHj81=
        jamf_scep_url:
          type: string
          description: Jamf SCEP enrollment URL for this organization
          readOnly: true
          examples:
          - https://scep.mistsys.com/api/v1/incoming/intune/:org_id/scep
        jamf_webhook_url:
          type: string
          description: Jamf webhook URL for SCEP status callbacks
          readOnly: true
          examples:
          - https://scep.mistsys.com/api/v1/webhook/jamf/:org_id/scep
        suspended:
          type: boolean
          description: Whether SCEP is suspended for this org
          default: false
      description: Read-only Mist SCEP settings returned for the organization
    org_setting_security:
      title: org_setting_security
      type: object
      properties:
        disable_local_ssh:
          type: boolean
          description: Whether to disable local SSH (by default, local SSH is enabled with allow_mist in Org is enabled
        fips_zeroize_password:
          type: string
          description: password required to zeroize devices (FIPS) on site level
          examples:
          - NUKETHESITE
        limit_ssh_access:
          type: boolean
          description: Whether to allow certain SSH keys to SSH into the AP (see Site:Setting)
          default: false
      description: Organization security controls for local SSH and FIPS zeroize access
    org_setting_switch:
      title: org_setting_switch
      type: object
      properties:
        auto_upgrade:
          allOf:
          - $ref: '#/components/schemas/switch_auto_upgrade3'
          - description: Auto-upgrade defaults for switches in this organization
      description: Configuration defaults for switches in this organization
    org_setting_switch_mgmt:
      title: org_setting_switch_mgmt
      type: object
      properties:
        ap_affinity_threshold:
          type: integer
          description: If the field is set in both site/setting and org/setting, the value from site/setting will be used.
          contentEncoding: int32
          default: 12
          examples:
          - 10
      description: Organization-level switch management settings
    org_setting_vpn_options:
      title: org_setting_vpn_options
      type: object
      properties:
        as_base:
          maximum: 2147483647
          minimum: 1
          type: integer
          description: Base BGP autonomous system number used for generated VPN configurations
          contentEncoding: int32
        enable_ipv6:
          type: boolean
          description: Whether IPv6 is enabled for organization VPN configuration
          default: false
        st_subnet:
          type: string
          description: requiring /12 or bigger to support 16 private IPs for 65535 gateways
          default: 10.224.0.0/12
      description: Organization VPN behavior options
    org_setting_wan_pma:
      title: org_setting_wan_pma
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether PMA is enabled for WAN Assurance
          default: false
      description: PMA feature settings for WAN Assurance
    org_setting_wired_pma:
      title: org_setting_wired_pma
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether PMA is enabled for Wired Assurance
          default: false
      description: PMA feature settings for Wired Assurance
    org_setting_wireless_pma:
      title: org_setting_wireless_pma
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether PMA is enabled for Wireless Assurance
          default: true
      description: PMA feature settings for Wireless Assurance
    org_site_sle_type:
      title: org_site_sle_type
      enum:
      - wan
      - wifi
      - wired
      type: string
      description: 'enum: `wan`, `wifi`, `wired`'
    org_site_sle_wan_result:
      title: org_site_sle_wan_result
      required:
      - gateway-health
      - site_id
      type: object
      properties:
        application_health:
          type: number
          description: Application health SLE score for this site
        gateway-health:
          type: number
          description: Gateway health SLE score for this site
        num_clients:
          type: number
          description: Number of WAN clients included in this site result
        num_gateways:
          type: number
          description: Number of gateways included in this site result
        site_id:
          type: string
          description: Site associated with this WAN SLE result
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        wan-link-health:
          type: number
          description: WAN link health SLE score for this site
      description: WAN SLE scores and counts for one site
    org_site_sle_wifi:
      title: org_site_sle_wifi
      required:
      - end
      - interval
      - limit
      - page
      - results
      - start
      - total
      type: object
      properties:
        end:
          type: number
          description: Query end timestamp for the returned SLE window
        interval:
          type: integer
          description: Aggregation interval, in seconds, used for the SLE query
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of site results returned per page
          contentEncoding: int32
        page:
          type: integer
          description: Result page number returned by the query
          contentEncoding: int32
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/org_site_sle_wifi_result'
          description: Wi-Fi SLE results for the current page
        start:
          type: number
          description: Query start timestamp for the returned SLE window
        total:
          type: integer
          description: Number of matching site results available for the query
          contentEncoding: int32
      description: Paginated Wi-Fi SLE results for organization sites
    org_site_sle_wifi_result:
      title: org_site_sle_wifi_result
      required:
      - ap-availability
      - site_id
      type: object
      properties:
        ap-availability:
          type: number
          description: AP availability SLE score for this site
        ap-health:
          type: number
          description: AP health SLE score for this site
        capacity:
          type: number
          description: Wi-Fi capacity SLE score for this site
        coverage:
          type: number
          description: Wi-Fi coverage SLE score for this site
        num_aps:
          type: number
          description: Number of APs included in this site result
        num_clients:
          type: number
          description: Number of Wi-Fi clients included in this site result
        roaming:
          type: number
          description: Wi-Fi roaming SLE score for this site
        site_id:
          type: string
          description: Site associated with this Wi-Fi SLE result
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        successful-connect:
          type: number
          description: Successful connection SLE score for this site
        throughput:
          type: number
          description: Wi-Fi throughput SLE score for this site
        time-to-connect:
          type: number
          description: Client connection-time SLE score for this site
      description: Wi-Fi SLE scores and counts for one site
    org_site_sle_wired_result:
      title: org_site_sle_wired_result
      required:
      - site_id
      - switch-health
      type: object
      properties:
        num_clients:
          type: number
          description: Number of wired clients included in this site result
        num_switches:
          type: number
          description: Number of switches included in this site result
        site_id:
          type: string
          description: Site associated with this wired SLE result
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        switch-bandwidth:
          type: number
          description: Switch bandwidth SLE score for this site
        switch-health:
          type: number
          description: Switch health SLE score for this site
        switch-throughput:
          type: number
          description: Switch throughput SLE score for this site
      description: Wired SLE scores and counts for one site
    org_site_wan_wifi:
      title: org_site_wan_wifi
      required:
      - end
      - interval
      - limit
      - page
      - results
      - start
      - total
      type: object
      properties:
        end:
          type: number
          description: Query end timestamp for the returned SLE window
        interval:
          type: integer
          description: Aggregation interval, in seconds, used for the SLE query
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of site results returned per page
          contentEncoding: int32
        page:
          type: integer
          description: Result page number returned by the query
          contentEncoding: int32
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/org_site_sle_wan_result'
          description: WAN SLE results for the current page
        start:
          type: number
          description: Query start timestamp for the returned SLE window
        total:
          type: integer
          description: Number of matching site results available for the query
          contentEncoding: int32
      description: Paginated WAN SLE results for organization sites
    org_site_wired_wifi:
      title: org_site_wired_wifi
      required:
      - end
      - interval
      - limit
      - page
      - results
      - start
      - total
      type: object
      properties:
        end:
          type: number
          description: Query end timestamp for the returned SLE window
        interval:
          type: integer
          description: Aggregation interval, in seconds, used for the SLE query
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of site results returned per page
          contentEncoding: int32
        page:
          type: integer
          description: Result page number returned by the query
          contentEncoding: int32
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/org_site_sle_wired_result'
          description: Wired SLE results for the current page
        start:
          type: number
          description: Query start timestamp for the returned SLE window
        total:
          type: integer
          description: Number of matching site results available for the query
          contentEncoding: int32
      description: Paginated wired SLE results for organization sites
    org_sites_count_distinct:
      title: org_sites_count_distinct
      enum:
      - analytic_enabled
      - app_waking
      - asset_enabled
      - auto_upgrade_enabled
      - auto_upgrade_version
      - country_code
      - honeypot_enabled
      - id
      - locate_unconnected
      - mesh_enabled
      - name
      - remote_syslog_enabled
      - rogue_enabled
      - rtsa_enabled
      - vna_enabled
      - wifi_enabled
      type: string
      description: 'enum: `analytic_enabled`, `app_waking`, `asset_enabled`, `auto_upgrade_enabled`, `auto_upgrade_version`, `country_code`, `honeypot_enabled`, `id`, `locate_unconnected`, `mesh_enabled`, `name`, `remote_syslog_enabled`, `rogue_enabled`, `rtsa_enabled`, `vna_enabled`, `wifi_enabled`'
    org_ssl_proxy_cert:
      title: org_ssl_proxy_cert
      type: object
      properties:
        cert:
          type: string
          description: PEM-encoded SSL proxy certificate for the organization
          examples:
          - '-----BEGIN CERTIFICATE-----\nMIIowDQYJKoZIhvcNAQELBQE\n-----END CERTIFICATE-----'
      description: SSL proxy certificate returned for the organization
    org_system_event:
      title: org_system_event
      type: object
      properties:
        change_cat:
          type: string
          description: Category of configuration or administrative change for the event
          examples:
          - admin_action
        metadata:
          type: string
          description: JSON-encoded event metadata, such as affected object IDs and admin details
        org_id:
          type: string
          description: Organization where the system event occurred
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        scope:
          type: string
          description: Event scope, such as organization or site
          examples:
          - org
        site_id:
          type: string
          description: Site associated with the event, when the event is site-scoped
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        timestamp:
          type: number
          description: Epoch timestamp when the system event occurred
          readOnly: true
        type:
          type: string
          description: System event type, such as `add-wlan` or `delete-wlan`
          examples:
          - delete-wlan
      description: Organization system event record
    org_tickets_count_distinct:
      title: org_tickets_count_distinct
      enum:
      - status
      - type
      type: string
      description: 'Distinct field used when counting organization tickets. enum: `status`, `type`'
    org_tunnel_count_distinct:
      title: org_tunnel_count_distinct
      enum:
      - ap
      - auth_algo
      - encrypt_algo
      - ike_version
      - ip
      - last_event
      - mac
      - mxcluster_id
      - mxedge_id
      - node
      - peer_host
      - peer_ip
      - peer_mxedge_id
      - protocol
      - remote_ip
      - remote_port
      - site_id
      - state
      - tunnel_name
      - up
      - wxtunnel_id
      type: string
      description: 'enum: `ap`, `auth_algo`, `encrypt_algo`, `ike_version`, `ip`, `last_event`, `mac`, `mxcluster_id`, `mxedge_id`, `node`, `peer_host`, `peer_ip`, `peer_mxedge_id`, `protocol`, `remote_ip`, `remote_port`, `site_id`, `state`, `tunnel_name`, `up`, `wxtunnel_id`'
    org_tunnel_type_count:
      title: org_tunnel_type_count
      enum:
      - wan
      - wxtunnel
      type: string
      description: 'Tunnel type used when counting organization tunnels. enum: `wan`, `wxtunnel`'
    org_ui_settings:
      title: org_ui_settings
      type: object
      properties:
        created_time:
          type: number
          description: Epoch timestamp when the databoard was created
          readOnly: true
        description:
          type: string
          description: Text describing the databoard
          examples:
          - This databoard shows AP stats
        for_site:
          type: boolean
          description: Whether this databoard is scoped to a site
          readOnly: true
          examples:
          - false
        id:
          type: string
          description: Unique identifier of the databoard
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        isCustomDataboard:
          type: boolean
          description: Whether this is a custom databoard or not
        modified_time:
          type: number
          description: Epoch timestamp when the databoard was last modified
          readOnly: true
        name:
          type: string
          description: Display name of the databoard
          examples:
          - AP Stats
        org_id:
          type: string
          description: Organization that owns the databoard
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        purpose:
          allOf:
          - $ref: '#/components/schemas/org_ui_settings_purpose2'
          - description: 'UI surface or purpose for this databoard. enum: `marvisdashboard`.'
        site_id:
          type: string
          description: Site associated with the databoard when `for_site` is true
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        tiles:
          type: array
          items:
            $ref: '#/components/schemas/org_ui_settings_tile'
          description: Configured tiles for the databoard
      description: Organization UI settings databoard
    org_ui_settings_purpose:
      title: org_ui_settings_purpose
      const: marvisdashboard
      type: string
      description: 'UI surface or purpose for this databoard. enum: `marvisdashboard`'
    org_ui_settings_tile:
      title: org_ui_settings_tile
      type: object
      properties:
        description:
          type: string
          description: Text describing the databoard tile
          examples:
          - This tile shows the top 10 APs by bandwidth
        id:
          type: string
          description: Unique identifier of the databoard tile
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        isAutoTitle:
          type: boolean
          description: Whether the tile title is auto generated or not
        name:
          type: string
          description: Display name of the databoard tile
          examples:
          - Top 10 APs by Bandwidth
        nl_query:
          type: string
          description: Natural Language query for the tile
          examples:
          - List top 10 APs by bandwidth
        position:
          allOf:
          - $ref: '#/components/schemas/org_ui_settings_tile_position2'
          - description: Grid position and span for the databoard tile
      description: Tile shown on an organization UI databoard
    org_ui_settings_tile_position:
      title: org_ui_settings_tile_position
      type: object
      properties:
        col:
          type: integer
          description: Grid column index for the tile
          contentEncoding: int32
          examples:
          - 1
        colSpan:
          type: integer
          description: Grid column span for the tile
          contentEncoding: int32
          examples:
          - 5
        row:
          type: integer
          description: Grid row index for the tile
          contentEncoding: int32
          examples:
          - 1
        rowSpan:
          type: integer
          description: Grid row span for the tile
          contentEncoding: int32
          examples:
          - 2
      description: Grid position for a databoard tile
    org_wan_clients_count_distinct:
      title: org_wan_clients_count_distinct
      enum:
      - hostname
      - ip
      - mac
      - mfg
      - network
      type: string
      description: 'enum: `hostname`, `ip`, `mac`, `mfg`, `network`'
    org_wan_clients_events_count_distinct:
      title: org_wan_clients_events_count_distinct
      enum:
      - hostname
      - ip
      - mac
      - mfg
      - type
      type: string
      description: 'enum: `hostname`, `ip`, `mac`, `mfg`, `type`'
    org_wired_clients_count_distinct:
      title: org_wired_clients_count_distinct
      enum:
      - device_mac
      - mac
      - port_id
      - site_id
      - type
      - vlan
      type: string
      description: 'enum: `device_mac`, `mac`, `port_id`, `site_id`, `type`, `vlan`'
    orggroup:
      title: orggroup
      required:
      - name
      type: object
      properties:
        created_time:
          type: number
          description: Epoch timestamp when the organization group was created
          readOnly: true
        id:
          type: string
          description: Unique identifier of the organization group
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        modified_time:
          type: number
          description: Epoch timestamp when the organization group was last modified
          readOnly: true
        msp_id:
          type: string
          description: MSP account that owns the organization group
          contentEncoding: uuid
          readOnly: true
          examples:
          - b9d42c2e-88ee-41f8-b798-f009ce7fe909
        name:
          type: string
          description: Display name of the organization group
        org_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Organizations included in this organization group
      description: MSP organization group containing related organizations
    ospf_area:
      title: ospf_area
      type: object
      properties:
        include_loopback:
          type: boolean
          description: Whether loopback interfaces are included in this OSPF area
          default: false
        networks:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ospf_areas_network'
          description: OSPF network settings keyed by network name
          examples:
          - corp:
              auth_keys:
                '1': auth-key-1
              auth_type: md5
              bfd_minimum_interval: 500
              dead_interval: 40
              hello_interval: 10
              interface_type: nbma
              metric: 10000
            guest:
              passive: true
        type:
          allOf:
          - $ref: '#/components/schemas/ospf_area_type2'
          - description: 'Area type for this OSPF area. enum: `default`, `nssa`, `stub`.'
            examples:
            - default
      description: Property key is the OSPF Area (Area should be a number (0-255) / IP address)
    ospf_area_network_auth_type:
      title: ospf_area_network_auth_type
      enum:
      - md5
      - none
      - password
      type: string
      description: 'auth type. enum: `md5`, `none`, `password`'
      examples:
      - md5
    ospf_area_network_interface_type:
      title: ospf_area_network_interface_type
      enum:
      - broadcast
      - nbma
      - p2mp
      - p2p
      type: string
      description: 'interface type (nbma = non-broadcast multi-access). enum: `broadcast`, `nbma`, `p2mp`, `p2p`'
    ospf_area_type:
      title: ospf_area_type
      enum:
      - default
      - nssa
      - stub
      type: string
      description: 'OSPF type. enum: `default`, `nssa`, `stub`'
      examples:
      - default
    ospf_areas_network:
      title: ospf_areas_network
      type: object
      properties:
        auth_keys:
          type: object
          additionalProperties:
            type: string
          description: Required if `auth_type`==`md5`. Property key is the key number
          examples:
          - '1': auth-key-1
        auth_password:
          type: string
          description: Required if `auth_type`==`password`, the password, max length is 8
          examples:
          - simple
        auth_type:
          allOf:
          - $ref: '#/components/schemas/ospf_area_network_auth_type2'
          - description: 'Authentication method used by this OSPF network. enum: `md5`, `none`, `password`.'
            examples:
            - md5
        bfd_minimum_interval:
          maximum: 255000
          minimum: 1
          type: integer
          description: Minimum BFD interval for this OSPF network, in milliseconds
          contentEncoding: int32
          examples:
          - 500
        dead_interval:
          maximum: 65535
          minimum: 1
          type: integer
          description: OSPF dead interval for this network, in seconds
          contentEncoding: int32
          examples:
          - 40
        export_policy:
          type: string
          description: Routing policy used to export routes from this OSPF network
          examples:
          - export_policy
        hello_interval:
          maximum: 255
          minimum: 1
          type: integer
          description: OSPF hello interval for this network, in seconds
          contentEncoding: int32
        import_policy:
          type: string
          description: Routing policy used to import routes for this OSPF network
          examples:
          - import_policy
        interface_type:
          allOf:
          - $ref: '#/components/schemas/ospf_area_network_interface_type2'
          - description: 'OSPF interface type used for this network. enum: `broadcast`, `nbma`, `p2mp`, `p2p`.'
        metric:
          maximum: 65535
          minimum: 1
          type:
          - integer
          - 'null'
          description: OSPF metric assigned to this network
          contentEncoding: int32
          examples:
          - 10000
        no_readvertise_to_overlay:
          type: boolean
          description: By default, we'll re-advertise all learned OSPF routes toward overlay
          default: false
        passive:
          type: boolean
          description: Whether to send OSPF-Hello
          default: false
      description: Property key is the network name. Networks to participate in an OSPF area
    ospf_peer_stats_count_distinct:
      title: ospf_peer_stats_count_distinct
      enum:
      - site_id
      - org_id
      - mac
      - peer_ip
      - port_id
      - state
      - vrf_name
      type: string
      description: 'enum: `site_id`, `org_id`, `mac`, `peer_ip`, `port_id`, `state`, `vrf_name`'
    ospf_peer_stats_search_result:
      title: ospf_peer_stats_search_result
      type: object
      properties:
        end:
          type: integer
          description: Query end timestamp for the OSPF peer statistics search
          contentEncoding: int32
          examples:
          - 1711035686
        limit:
          type: integer
          description: Maximum number of OSPF peer statistics returned per page
          contentEncoding: int32
          examples:
          - 10
        next:
          type: string
          description: URL for the next page of OSPF peer statistics, when available
        results:
          type: array
          items:
            $ref: '#/components/schemas/ospf_peer_stats_search_results_items'
          description: OSPF peer statistic records returned for the current page
        start:
          type: integer
          description: Query start timestamp for the OSPF peer statistics search
          contentEncoding: int32
          examples:
          - 1710949286
        total:
          type: integer
          description: Number of OSPF peer statistic records matching the search
          contentEncoding: int32
          examples:
          - 232
      description: Paginated OSPF peer statistics search result
    ospf_peer_stats_search_results_items:
      title: ospf_peer_stats_search_results_items
      type: object
      properties:
        dead_time:
          type: integer
          description: Seconds remaining before the neighbor is considered inactive
          contentEncoding: int32
        mac:
          type: string
          description: Router MAC address of the device advertising the OSPF peer
        org_id:
          type: string
          description: Organization identifier of the router reporting the peer state
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        peer_ip:
          type: string
          description: IP address of the OSPF neighbor
        port_id:
          type: string
          description: Interface on which the OSPF neighbor is learned
        priority:
          maximum: 255
          minimum: 0
          type: integer
          description: OSPF priority advertised by the neighbor, from 0 to 255
          contentEncoding: int32
        site_id:
          type: string
          description: Site identifier of the router reporting the peer state
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        state:
          type: string
          description: Eg. full, down, 2way, init, exstart, exchange, loading
        timestamp:
          type: number
          description: Sampling time (in epoch seconds)
          readOnly: true
        up:
          type: boolean
          description: True if state is full
        vrf_name:
          type: string
          description: Instance name, e.g. master
      description: OSPF peer statistic record reported by a router
    other_device_update:
      title: other_device_update
      type: object
      properties:
        device_mac:
          type: string
          description: Other-device MAC address to associate with a site
        site_id:
          type: string
          description: Site ID to associate with the other device
          contentEncoding: uuid
          examples:
          - 43e9c864-a7e4-4310-8031-d9817d2c5a43
      description: Manual site association update for one other device
    other_device_update_multi:
      title: other_device_update_multi
      required:
      - op
      type: object
      properties:
        macs:
          type: array
          items:
            type: string
          description: Other-device MAC addresses included in the bulk update
        op:
          allOf:
          - $ref: '#/components/schemas/other_device_update_operation2'
          - description: 'Action to perform on the other devices. enum: `assign`, `unassign`.'
        site_id:
          type: string
          description: Site ID used when assigning other devices
          contentEncoding: uuid
      description: Bulk site assignment update for other devices
    other_device_update_operation:
      title: other_device_update_operation
      enum:
      - assign
      - unassign
      type: string
      description: 'The operation being performed. enum: `assign`, `unassign`'
    pcap_bucket:
      title: pcap_bucket
      required:
      - bucket
      type: object
      properties:
        bucket:
          type: string
          description: Customer bucket name to use for packet capture files
          examples:
          - company-private-pcap
      description: Request to configure a custom packet capture bucket
    pcap_bucket_verify:
      title: pcap_bucket_verify
      required:
      - bucket
      - verify_token
      type: object
      properties:
        bucket:
          type: string
          description: Customer bucket name being verified for packet capture storage
          examples:
          - company-private-pcap
        verify_token:
          type: string
          description: Token read from the MIST_TOKEN file written during bucket setup
          examples:
          - eyJhbGciOiJIUzI1J9.eyJzdWIiOiIxMjM0joiMjgxOG5MDIyfQ.2rzcRvMA3Eg09NnjCAC-1EWMRtxAnFDM
      description: Request to verify ownership of a custom packet capture bucket
    pcap_type:
      title: pcap_type
      enum:
      - client
      - gateway
      - new_assoc
      - radiotap
      - radiotap,wired
      - wired
      - wireless
      type: string
      description: 'enum: `client`, `gateway`, `new_assoc`, `radiotap`, `radiotap,wired`, `wired`, `wireless`'
      examples:
      - client
    pma_dashboard:
      title: pma_dashboard
      type: object
      properties:
        description:
          type: string
          description: Human-readable summary of the PMA dashboard
          examples:
          - Dashboard 1 description
        label:
          type: string
          description: Group label that categorizes the PMA dashboard
          examples:
          - Wireless
        name:
          type: string
          description: Display name of the PMA dashboard
          examples:
          - dashboard_1
        url:
          type: string
          description: Access URL that redirects the user to the PMA dashboard
          examples:
          - https://api.mist.com/api/v1/forward/looker?jwt=...
      description: PMA dashboard metadata and redirect URL
    poe_priority:
      title: poe_priority
      enum:
      - low
      - high
      type: string
      description: 'PoE priority. enum: `low`, `high`'
    port_auth_state:
      title: port_auth_state
      enum:
      - authenticated
      - authenticating
      - held
      - init
      type: string
      description: 'Port authentication state. enum: `""`, `authenticated`, `authenticating`, `held`, `init`'
    port_stp_role:
      title: port_stp_role
      enum:
      - alternate
      - backup
      - designated
      - disabled
      - root
      - root-prevented
      type: string
      description: 'Spanning Tree Protocol role for the port. enum: `""`, `alternate`, `backup`, `designated`, `disabled`, `root`, `root-prevented`'
    port_stp_state:
      title: port_stp_state
      enum:
      - blocking
      - disabled
      - forwarding
      - learning
      - listening
      type: string
      description: 'Spanning Tree Protocol state for the port. enum: `""`, `blocking`, `disabled`, `forwarding`, `learning`, `listening`'
    portal_template_alignment:
      title: portal_template_alignment
      enum:
      - center
      - left
      - right
      type: string
      description: 'defines alignment on portal. enum: `center`, `left`, `right`'
    privilege_msp:
      title: privilege_msp
      required:
      - role
      - scope
      type: object
      properties:
        org_id:
          type: string
          description: If `scope`==`org`, organization ID this MSP privilege applies to
          contentEncoding: uuid
        org_name:
          type: string
          description: Name of the org (for a site belonging to org)
          readOnly: true
        orggroup_id:
          type: string
          description: If `scope`==`orggroup`, organization group ID this MSP privilege applies to
          contentEncoding: uuid
        role:
          allOf:
          - $ref: '#/components/schemas/privilege_msp_role2'
          - description: 'Access role granted by this MSP privilege. enum: `admin`, `helpdesk`, `installer`, `read`, `write`.'
        scope:
          allOf:
          - $ref: '#/components/schemas/privilege_msp_scope2'
          - description: 'MSP hierarchy level where this privilege applies. enum: `msp`, `org`, `orggroup`.'
        views:
          type: array
          items:
            $ref: '#/components/schemas/admin_privilege_view'
          description: UI views allowed by custom role restrictions
      description: MSP privilege scope and role settings
    privilege_msp_role:
      title: privilege_msp_role
      enum:
      - admin
      - helpdesk
      - installer
      - read
      - write
      type: string
      description: 'access permissions. enum: `admin`, `helpdesk`, `installer`, `read`, `write`'
    privilege_msp_scope:
      title: privilege_msp_scope
      enum:
      - msp
      - org
      - orggroup
      type: string
      description: 'enum: `msp`, `org`, `orggroup`'
    privilege_org_role:
      title: privilege_org_role
      enum:
      - admin
      - helpdesk
      - installer
      - read
      - write
      type: string
      description: 'access permissions. enum: `admin`, `helpdesk`, `installer`, `read`, `write`'
    privilege_org_scope:
      title: privilege_org_scope
      enum:
      - org
      - site
      - sitegroup
      - orgsites
      type: string
      description: 'enum: `org`, `site`, `sitegroup`, `orgsites`'
    protect_re:
      title: protect_re
      type: object
      properties:
        allowed_services:
          type: array
          items:
            $ref: '#/components/schemas/protect_re_allowed_service'
          description: Built-in services explicitly allowed by the Protect RE policy
          examples:
          - - icmp
            - ssh
        custom:
          type: array
          items:
            $ref: '#/components/schemas/protect_re_custom'
          description: Additional ACL entries allowed by the Protect RE policy
        enabled:
          type: boolean
          description: >-
            When enabled, all traffic that is not essential to our operation will be dropped

            e.g. ntp / dns / traffic to mist will be allowed by default
                 if dhcpd is enabled, we'll make sure it works
          default: false
        hit_count:
          type: boolean
          description: Whether to enable hit count for Protect_RE policy
          default: false
        trusted_hosts:
          type: array
          items:
            type: string
          description: Trusted host or subnet entries allowed by the Protect RE policy
      description: "Restrict inbound-traffic to host\nwhen enabled, all traffic that is not essential to our operation will be dropped \ne.g. ntp / dns / traffic to mist will be allowed by default, if dhcpd is enabled, we'll make sure it works"
    protect_re_allowed_service:
      title: protect_re_allowed_service
      enum:
      - icmp
      - ssh
      type: string
      description: 'Services allowed through protect-RE filters. enum: `icmp`, `ssh`'
    protect_re_custom:
      title: protect_re_custom
      type: object
      properties:
        port_range:
          type: string
          description: Matched dst port, "0" means any
          default: '0'
          examples:
          - 80,1035-1040
        protocol:
          allOf:
          - $ref: '#/components/schemas/protect_re_custom_protocol2'
          - description: 'Transport protocol matched by this custom Protect RE ACL. enum: `any`, `icmp`, `tcp`, `udp`.'
        subnets:
          type: array
          items:
            type: string
          description: Source subnets matched by this custom Protect RE ACL
      description: Custom Protect RE ACL entry
    protect_re_custom_protocol:
      title: protect_re_custom_protocol
      enum:
      - any
      - icmp
      - tcp
      - udp
      type: string
      description: 'enum: `any`, `icmp`, `tcp`, `udp`'
    proxy:
      title: proxy
      type: object
      properties:
        disabled:
          type: boolean
          description: Whether this proxy configuration is disabled
          default: false
          examples:
          - true
        url:
          type: string
          description: Proxy URL used to reach Mist
          examples:
          - https://proxy.corp.com:8080/
      description: Proxy Configuration to talk to Mist
    psk:
      title: psk
      required:
      - name
      - passphrase
      - ssid
      type: object
      properties:
        admin_sso_id:
          type: string
          description: sso id for psk created from psk portal
          readOnly: true
        created_time:
          type: number
          description: Epoch timestamp when the PSK was created
          readOnly: true
        email:
          type: string
          description: Notification recipient email address for PSK creation notification and expiration reminders
        expire_time:
          type:
          - integer
          - 'null'
          description: Expire time for this PSK key (epoch time in seconds). Default `null` (as no expiration)
          contentEncoding: int32
          examples:
          - 1614990263
        expiry_notification_time:
          type: integer
          description: Number of days before psk is expired. Used as to when to start sending reminder notification when the psk is about to expire
          contentEncoding: int32
        id:
          type: string
          description: Unique identifier of the PSK
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        mac:
          type: string
          description: If `usage`==`single`, client MAC address this PSK is bound to; empty when auto-binding is used
        macs:
          type: array
          items:
            type: string
          description: Client MAC addresses or MAC patterns allowed when `usage`==`macs`
          examples:
          - - 112233abcedf
            - aabbcc*
        max_usage:
          type: integer
          description: For Org PSK Only. Max concurrent users for this PSK key. Default is 0 (unlimited)
          contentEncoding: int32
          default: 0
        modified_time:
          type: number
          description: Epoch timestamp when the PSK was last modified
          readOnly: true
        name:
          type: string
          description: Display name of the PSK
        note:
          type: string
          description: Admin note or description stored with the PSK
        notify_expiry:
          type: boolean
          description: If set to true, reminder notification will be sent when psk is about to expire
          default: false
        notify_on_create_or_edit:
          type: boolean
          description: If set to true, notification will be sent when psk is created or edited
        old_passphrase:
          type: string
          description: previous passphrase of the PSK if it has been rotated
        org_id:
          type: string
          description: Organization that owns the org-level PSK
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        passphrase:
          maxLength: 64
          minLength: 8
          type: string
          description: PSK passphrase, 8-63 characters or 64 hexadecimal characters
          contentEncoding: password
        role:
          maxLength: 32
          minLength: 0
          type: string
          description: Client role applied to users authenticated with this PSK
        site_id:
          type: string
          description: Site associated with the site-level PSK
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        ssid:
          type: string
          description: WLAN SSID where this PSK can be used
        usage:
          allOf:
          - $ref: '#/components/schemas/psk_usage2'
          - description: 'Binding mode for this PSK, enum: `macs`, `multi`, `single`, `usermac_labels`'
        usermac_labels:
          maxItems: 100
          type: array
          items:
            type: string
          description: Usermac labels allowed when `usage`==`usermac_labels`; this list is capped at 100 entries
          examples:
          - - iot
            - students
        vlan_id:
          oneOf:
          - type: string
          - maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
          description: VLAN ID returned for clients using this PSK
        vlan_name:
          type: string
          description: VLAN name to be assigned. Optional, `vlan_id` takes precedence if both are provided
      description: Personal pre-shared key configuration for WLAN access
    psk_id_list:
      title: psk_id_list
      type: object
      properties:
        psk_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: PSK IDs to delete
          examples:
          - - 0039c16c-ca87-4d3f-bb94-b97c58199f18
            - 6562cc8e-5893-418a-acaa-4d7c1af8084f
      description: PSK delete request payload
    psk_portal:
      title: psk_portal
      required:
      - name
      - ssid
      type: object
      properties:
        auth:
          allOf:
          - $ref: '#/components/schemas/psk_portal_auth2'
          - description: 'Portal access method, enum: `sponsor`, `sso`'
        bg_image_url:
          type: string
          description: URL of the background image used by the PSK portal
        cleanup_psk:
          type: boolean
          description: Whether to clean up existing PSKs when the portal is deleted or its SSID changes
          default: false
        created_time:
          type: number
          description: Epoch timestamp when the PSK portal was created
          readOnly: true
        expire_time:
          type: integer
          description: PSK lifetime, in minutes, for keys created through this portal
          contentEncoding: int32
        expiry_notification_time:
          type: integer
          description: Number of days before PSK expiration to start sending reminder notifications
          contentEncoding: int32
        hide_psks_created_by_other_admins:
          type: boolean
          description: Only if `type`==`admin`, hide PSKs created by other PSK admins
          default: false
        id:
          type: string
          description: Unique identifier of the PSK portal
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        max_usage:
          minimum: 0
          type: integer
          description: Maximum concurrent clients for each PSK created through this portal; `0` means unlimited
          contentEncoding: int32
          default: 0
        modified_time:
          type: number
          description: Epoch timestamp when the PSK portal was last modified
          readOnly: true
        name:
          type: string
          description: Display name of the PSK portal
        notification_renew_url:
          type: string
          description: Optional renewal URL included in notification emails. Use a custom URL, a Mist-generated URL, or a shortened URL pointing to either
          examples:
          - https://custom-sso/url
        notify_expiry:
          type: boolean
          description: Whether to send reminder notifications before PSKs created through this portal expire
        notify_on_create_or_edit:
          type: boolean
          description: Whether to send notifications when a PSK is created or edited through this portal
          default: false
        org_id:
          type: string
          description: Organization that owns the PSK portal
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        passphrase_rules:
          allOf:
          - $ref: '#/components/schemas/psk_portal_passphrase_rules2'
          - description: Generation rules for PSK passphrases created through this portal
        required_fields:
          type: array
          items:
            type: string
          description: User information fields requested by the portal when generating a PSK
        role:
          type: string
          description: Client role assigned to PSKs created through this portal
        ssid:
          type: string
          description: WLAN SSID for PSKs created through this portal
        sso:
          allOf:
          - $ref: '#/components/schemas/psk_portal_sso2'
          - description: Single sign-on configuration used when `auth`==`sso`
        template_url:
          type: string
          description: URL of the UI customization template for this portal
        thumbnail_url:
          type: string
          description: URL of the thumbnail image used by the PSK portal
        type:
          allOf:
          - $ref: '#/components/schemas/psk_portal_type2'
          - description: Portal mode for personal PSK onboarding, either admin or BYOD
        ui_url:
          type: string
          description: Public URL where users access the PSK portal
        vlan_id:
          oneOf:
          - type: string
          - maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
          description: VLAN ID returned for clients using PSKs from this portal
      description: Self-service portal configuration for issuing personal PSKs
    psk_portal_auth:
      title: psk_portal_auth
      enum:
      - sponsor
      - sso
      type: string
      description: 'Portal access method for guest authentication, either `sponsor` or `sso`. enum: `sponsor`, `sso`'
    psk_portal_image:
      title: psk_portal_image
      type: object
      properties:
        file:
          type: string
          description: Image binary payload to upload for the PSK portal
          contentEncoding: base64
        json:
          type: string
          description: Metadata JSON string describing the PSK portal image upload
      description: PSK portal image upload payload
    psk_portal_passphrase_rules:
      title: psk_portal_passphrase_rules
      type: object
      properties:
        alphabets_enabled:
          type: boolean
          description: Whether generated passphrases may include alphabetic characters
          default: true
        length:
          maximum: 63
          minimum: 8
          type: integer
          description: Fixed generated passphrase length used when min and max length are not both valid
          contentEncoding: int32
        max_length:
          maximum: 63
          minimum: 8
          type: integer
          description: Maximum generated passphrase length when paired with a valid `min_length`. If `max_length` or `min_length` is invalid, the portal uses `length`; if `length` is unset or invalid, it uses 8. Valid values are integers from 8 through 63, and `max_length` must be greater than `min_length`
          contentEncoding: int32
        min_length:
          maximum: 63
          minimum: 8
          type: integer
          description: Minimum generated passphrase length when paired with a valid `max_length`. If `max_length` or `min_length` is invalid, the portal uses `length`; if `length` is unset or invalid, it uses 8. Valid values are integers from 8 through 63, and `max_length` must be greater than `min_length`
          contentEncoding: int32
        numerics_enabled:
          type: boolean
          description: Whether generated passphrases may include numeric characters
          default: true
        symbols:
          type: string
          description: Allowed symbol characters for generated passphrases
          examples:
          - ()[]{}_%@#&$
        symbols_enabled:
          type: boolean
          description: Whether generated passphrases may include symbols
          default: true
      description: Passphrase generation rules for PSKs created through a portal
    psk_portal_sso:
      title: psk_portal_sso
      type: object
      properties:
        allowed_roles:
          type: array
          items:
            type: string
          description: SSO roles allowed to access the PSK portal; if empty, any role is permitted
        idp_cert:
          type: string
          description: Identity provider signing certificate in PEM format
        idp_sign_algo:
          allOf:
          - $ref: '#/components/schemas/psk_portal_sso_idp_sign_algo2'
          - description: 'SAML assertion signing algorithm expected from the identity provider. enum: `sha1`, `sha256`, `sha384`, `sha512`.'
        idp_sso_url:
          type: string
          description: Identity provider SSO URL for SAML login
        issuer:
          type: string
          description: SAML issuer value for the identity provider
        nameid_format:
          type: string
          description: SAML NameID format used for the portal login
        role_mapping:
          type: object
          additionalProperties:
            type: string
          description: Maps PSK portal role names to SSO attribute values
        use_sso_role_for_psk_role:
          type: boolean
          description: Whether to use SSO role mapping for the PSK role and ignore the portal-level `role` field
      description: Single sign-on settings used when `auth`==`sso`
    psk_portal_sso_idp_sign_algo:
      title: psk_portal_sso_idp_sign_algo
      enum:
      - sha1
      - sha256
      - sha384
      - sha512
      type: string
      description: 'Signing algorithm for SAML Assertion. enum: `sha1`, `sha256`, `sha384`, `sha512`. enum: `sha1`, `sha256`, `sha384`, `sha512`'
    psk_portal_template:
      title: psk_portal_template
      type: object
      properties:
        portal_template:
          allOf:
          - $ref: '#/components/schemas/psk_portal_template_setting2'
          - description: Template settings for customizing the PSK portal UI
      description: Portal UI customization payload
    psk_portal_template_setting:
      title: psk_portal_template_setting
      type: object
      properties:
        alignment:
          allOf:
          - $ref: '#/components/schemas/portal_template_alignment2'
          - description: 'Logo and text alignment for the PSK portal template. enum: `center`, `left`, `right`.'
        color:
          type: string
          description: Primary hex color used by the portal template
          default: '#1074bc'
        logo:
          type:
          - string
          - 'null'
          description: Custom logo with "data:image/png;base64," format. default null, uses Juniper Mist Logo
        poweredBy:
          type: boolean
          description: Whether to hide "Powered by Juniper Mist" and email footers
          default: false
        tos:
          type: boolean
          description: Whether to show Terms of Service
        tosAcceptLabel:
          type: string
          description: Terms of Service accept button label
          default: I accept the Terms of Service
        tosError:
          type: string
          description: Error message shown when the user has not accepted the Terms of Service
          default: Please review and accept the Terms of Service
        tosLink:
          type: string
          description: Terms of Service link label displayed in the portal footer
          default: Terms of Service
        tosText:
          type: string
          description: Terms of Service text displayed in the footer when Terms are enabled
          default: << provide your Terms of Service here >>
        tosUrl:
          type: string
          description: Custom URL for the Terms of Service policy
          examples:
          - https://company.com/wifi-policy
      description: Custom UI settings for the PSK portal template
    psk_portal_type:
      title: psk_portal_type
      enum:
      - admin
      - byod
      type: string
      description: 'for personal psk portal. enum: `admin`, `byod`'
    psk_usage:
      title: psk_usage
      enum:
      - macs
      - multi
      - single
      - usermac_labels
      type: string
      description: 'enum: `macs`, `multi`, `single`, `usermac_labels`'
    psks_import_file:
      title: psks_import_file
      type: object
      properties:
        file:
          type: string
          description: Uploaded CSV or binary file containing PSKs to import
          contentEncoding: base64
      description: Multipart upload payload for importing PSKs
    push_policy_push_window:
      title: push_policy_push_window
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether configuration pushes are limited to the configured push window
          default: false
        hours:
          allOf:
          - $ref: '#/components/schemas/hours1'
          - description: Day-of-week hour ranges when configuration pushes are allowed
      description: If enabled, new config will only be pushed to device within the specified time window
    radio_band_24_usage:
      title: radio_band_24_usage
      enum:
      - '24'
      - '5'
      - '6'
      - auto
      type: string
      description: 'enum: `24`, `5`, `6`, `auto`'
    radio_band_antenna_beam_pattern:
      title: radio_band_antenna_beam_pattern
      enum:
      - narrow
      - medium
      - wide
      type: string
      description: 'enum: `narrow`, `medium`, `wide`'
    radio_band_antenna_mode:
      title: radio_band_antenna_mode
      enum:
      - 1x1
      - 2x2
      - 3x3
      - 4x4
      - default
      type: string
      description: 'enum: `1x1`, `2x2`, `3x3`, `4x4`, `default`'
      examples:
      - default
    radio_band_preamble:
      title: radio_band_preamble
      enum:
      - auto
      - long
      - short
      type: string
      description: 'enum: `auto`, `long`, `short`'
    radius_acct_server:
      title: radius_acct_server
      required:
      - host
      - secret
      type: object
      properties:
        host:
          type: string
          description: Address or hostname of the RADIUS accounting server
          examples:
          - 1.2.3.4
        keywrap_enabled:
          type: boolean
          description: Whether RADIUS keywrap is enabled for messages sent to this accounting server
        keywrap_format:
          allOf:
          - $ref: '#/components/schemas/radius_keywrap_format1'
          - description: 'Encoding format for RADIUS keywrap KEK and MACK values. enum: `ascii`, `hex`.'
        keywrap_kek:
          type: string
          description: RADIUS keywrap key encryption key (KEK)
          examples:
          - '1122334455'
        keywrap_mack:
          type: string
          description: RADIUS keywrap message authentication code key (MACK)
          examples:
          - '1122334455'
        port:
          anyOf:
          - maximum: 65545
            minimum: 1
            type: integer
            contentEncoding: int32
          - type: string
          description: UDP port used by the RADIUS accounting server
        secret:
          type: string
          description: Shared secret used with this RADIUS accounting server
          contentEncoding: password
          examples:
          - testing123
      description: RADIUS accounting server settings
    radius_auth_server:
      title: radius_auth_server
      required:
      - host
      - secret
      type: object
      properties:
        host:
          type: string
          description: Address or hostname of the RADIUS authentication server
          examples:
          - 1.2.3.4
        keywrap_enabled:
          type: boolean
          description: Whether RADIUS keywrap is enabled for messages sent to this authentication server
        keywrap_format:
          allOf:
          - $ref: '#/components/schemas/radius_keywrap_format1'
          - description: 'Encoding format for RADIUS keywrap KEK and MACK values. enum: `ascii`, `hex`.'
        keywrap_kek:
          type: string
          description: RADIUS keywrap key encryption key (KEK)
          examples:
          - '1122334455'
        keywrap_mack:
          type: string
          description: RADIUS keywrap message authentication code key (MACK)
          examples:
          - '1122334455'
        port:
          anyOf:
          - maximum: 65545
            minimum: 1
            type: integer
            contentEncoding: int32
          - type: string
          description: UDP port used by the RADIUS authentication server
        require_message_authenticator:
          type: boolean
          description: Whether to require Message-Authenticator in requests
          default: false
        secret:
          type: string
          description: Shared secret used with this RADIUS authentication server
          contentEncoding: password
          examples:
          - testing123
      description: RADIUS authentication server settings
    radius_config:
      title: radius_config
      type: object
      properties:
        acct_interim_interval:
          maximum: 65535
          minimum: 0
          type: integer
          description: How frequently should interim accounting be reported, 60-65535. default is 0 (use one specified in Access-Accept request from RADIUS Server). Very frequent messages can affect the performance of the RADIUS server, 600 and up is recommended when enabled
          contentEncoding: int32
          default: 0
        acct_servers:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/radius_acct_server'
          description: RADIUS accounting servers used by this Junos configuration
        auth_servers:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/radius_auth_server'
          description: RADIUS authentication servers used by this Junos configuration
        auth_servers_retries:
          type: integer
          description: Number of RADIUS authentication request retries before failover
          contentEncoding: int32
          default: 3
        auth_servers_timeout:
          type: integer
          description: RADIUS authentication server timeout, in seconds
          contentEncoding: int32
          default: 5
        coa_enabled:
          type: boolean
          description: Whether RADIUS Change of Authorization (CoA) is enabled
          default: false
        coa_port:
          maximum: 65535
          minimum: 1
          type: integer
          description: UDP port used for RADIUS Change of Authorization (CoA)
          contentEncoding: int32
          default: 3799
        network:
          type: string
          description: Use `network` or `source_ip`. Network where the RADIUS server resides; if the network has a static IP, Mist uses it as the source IP
        source_ip:
          type: string
          description: Use `network` or `source_ip`. Explicit source IP address for RADIUS traffic
      description: Junos RADIUS authentication and accounting configuration
    radius_keywrap_format:
      title: radius_keywrap_format
      enum:
      - ascii
      - hex
      type: string
      description: 'Encoding format for RADIUS keywrap KEK and MACK values. enum: `ascii`, `hex`'
    radsec:
      title: radsec
      type: object
      properties:
        coa_enabled:
          type: boolean
          description: Whether RADIUS Change of Authorization (CoA) is enabled for RadSec traffic
          default: false
        enabled:
          type: boolean
          description: Whether RadSec is enabled
        idle_timeout:
          anyOf:
          - type: integer
            contentEncoding: int32
            default: 60
          - type: string
          description: Idle timeout, in seconds, for RadSec connections
        mxcluster_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Mist Edge cluster IDs used as RadSec proxies when the WLAN does not use mxtunnel
        proxy_hosts:
          type: array
          items:
            type: string
          description: RadSec proxy hostnames advertised to APs
        server_name:
          type: string
          description: TLS server name to verify against the CA certificates in Org Setting. Only if not Mist Edge.
          examples:
          - radsec.abc.com
        servers:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/radsec_server'
          description: External RadSec servers. Only if not Mist Edge.
        use_mxedge:
          type: boolean
          description: Whether to use organization Mist Edge instances as RadSec proxies
        use_site_mxedge:
          type: boolean
          description: Whether to use site Mist Edge instances when this WLAN does not use mxtunnel
          default: false
      description: RadSec settings for sending RADIUS traffic over TLS
    radsec_server:
      title: radsec_server
      type: object
      properties:
        host:
          type: string
          description: Address or hostname of the RadSec server
          examples:
          - 1.1.1.1
        port:
          maximum: 65535
          minimum: 1
          type: integer
          description: TCP port used by the RadSec server
          contentEncoding: int32
          examples:
          - 1812
      description: External RadSec server settings
    random_mac:
      title: random_mac
      enum:
      - 'true'
      - 'false'
      type: string
      description: 'Whether the client is using randomized MAC address or not. enum: `true`, `false`'
    recaptcha:
      title: recaptcha
      type: object
      properties:
        flavor:
          allOf:
          - $ref: '#/components/schemas/recaptcha_flavor1'
          - description: CAPTCHA provider used for registration, such as Google reCAPTCHA or hCaptcha
            examples:
            - hcaptcha
        required:
          type: boolean
          description: Whether CAPTCHA verification is required for registration
        sitekey:
          type: string
          description: Public site key used to render the selected CAPTCHA provider
      description: CAPTCHA settings returned for admin registration
    recaptcha_flavor:
      title: recaptcha_flavor
      enum:
      - google
      - hcaptcha
      type: string
      description: 'CAPTCHA provider flavor. enum: `google`, `hcaptcha`'
      examples:
      - hcaptcha
    recover:
      title: recover
      required:
      - email
      type: object
      properties:
        email:
          maxLength: 64
          type: string
          description: Admin email address requesting password recovery
          examples:
          - test@mistsys.com
        recaptcha:
          type: string
          description: CAPTCHA verification token submitted with the recovery request
        recaptcha_flavor:
          allOf:
          - $ref: '#/components/schemas/recaptcha_flavor3'
          - description: 'CAPTCHA provider flavor used for recovery verification. enum: `google`, `hcaptcha`.'
            examples:
            - hcaptcha
      description: Password recovery request submitted for an administrator account
    remote_syslog:
      title: remote_syslog
      type: object
      properties:
        archive:
          allOf:
          - $ref: '#/components/schemas/remote_syslog_archive3'
          - description: Retention settings for generated syslog archive files
        cacerts:
          type: array
          items:
            type: string
          description: CA certificates used to verify TLS syslog servers
          examples:
          - - '-----BEGIN CERTIFICATE-----\nMIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE\n-----END CERTIFICATE-----'
            - '-----BEGIN CERTIFICATE-----\nBhMCRVMxFDASBgNVBAoMC1N0YXJ0Q29tIENBMSwwKgYDVn-----END CERTIFICATE-----'
        console:
          allOf:
          - $ref: '#/components/schemas/remote_syslog_console2'
          - description: Log forwarding filters for console messages sent to remote syslog
        enabled:
          type: boolean
          description: Whether remote syslog forwarding is enabled
          default: false
        files:
          type: array
          items:
            $ref: '#/components/schemas/remote_syslog_file_config'
          description: Local syslog file definitions to generate and forward
        network:
          type: string
          description: Source network used for syslog traffic. If `source_address` is configured, Mist uses the VLAN first; otherwise it uses `source_ip`
          examples:
          - default
        send_to_all_servers:
          type: boolean
          description: Whether each log entry is sent to all configured remote syslog servers
          default: false
        servers:
          type: array
          items:
            $ref: '#/components/schemas/remote_syslog_server'
          description: Remote syslog server destinations
          examples:
          - - facility: config
              host: syslogd.internal
              port: 514
              protocol: udp
              severity: info
              tag: ''
        time_format:
          allOf:
          - $ref: '#/components/schemas/remote_syslog_time_format2'
          - description: 'Timestamp format used in forwarded syslog messages. enum: `millisecond`, `year`, `year millisecond`.'
            examples:
            - millisecond
        users:
          type: array
          items:
            $ref: '#/components/schemas/remote_syslog_user'
          description: User-specific syslog logging rules
      description: Remote syslog forwarding settings
    remote_syslog_archive:
      title: remote_syslog_archive
      type: object
      properties:
        files:
          anyOf:
          - type: string
          - type: integer
            contentEncoding: int32
          description: Number of archived syslog files to retain
          examples:
          - '20'
        size:
          type: string
          description: Maximum size of each archived syslog file, such as 5m
          examples:
          - 5m
      description: Syslog file archive retention settings
    remote_syslog_console:
      title: remote_syslog_console
      type: object
      properties:
        contents:
          type: array
          items:
            $ref: '#/components/schemas/remote_syslog_content'
          description: Syslog facilities and severities forwarded from console logs
      description: Console log forwarding filters for remote syslog
    remote_syslog_content:
      title: remote_syslog_content
      type: object
      properties:
        facility:
          allOf:
          - $ref: '#/components/schemas/remote_syslog_facility3'
          - description: 'Syslog facility to match for this selector. enum: `any`, `authorization`, `change-log`, `config`, `conflict-log`, `daemon`, `dfc`, `external`, `firewall`, `ftp`, `interactive-commands`, `kernel`, `ntp`, `pfe`, `security`, `user`.'
            examples:
            - config
        severity:
          allOf:
          - $ref: '#/components/schemas/remote_syslog_severity3'
          - description: 'Syslog severity to match for this selector. enum: `alert`, `any`, `critical`, `emergency`, `error`, `info`, `notice`, `warning`.'
      description: Syslog message content selector for remote logging
    remote_syslog_facility:
      title: remote_syslog_facility
      enum:
      - any
      - authorization
      - change-log
      - config
      - conflict-log
      - daemon
      - dfc
      - external
      - firewall
      - ftp
      - interactive-commands
      - kernel
      - ntp
      - pfe
      - security
      - user
      type: string
      description: 'enum: `any`, `authorization`, `change-log`, `config`, `conflict-log`, `daemon`, `dfc`, `external`, `firewall`, `ftp`, `interactive-commands`, `kernel`, `ntp`, `pfe`, `security`, `user`'
      examples:
      - config
    remote_syslog_file_config:
      title: remote_syslog_file_config
      type: object
      properties:
        archive:
          allOf:
          - $ref: '#/components/schemas/remote_syslog_archive1'
          - description: Retention settings for this generated syslog file
        contents:
          type: array
          items:
            $ref: '#/components/schemas/remote_syslog_content'
          description: Syslog facilities and severities written to this file
        enable_tls:
          type: boolean
          description: Only if `protocol`==`tcp`, enable TLS for this syslog file destination
        explicit_priority:
          type: boolean
          description: Whether to include explicit syslog priority values in file output
        file:
          type: string
          description: Generated syslog file name
          examples:
          - file-name
        match:
          type: string
          description: Expression used to filter log messages written to this file
          examples:
          - '!alarm|ntp|errors.crc_error[chan]'
        structured_data:
          type: boolean
          description: Whether to include structured syslog data in file output
      description: Generated syslog file output settings
    remote_syslog_server:
      title: remote_syslog_server
      type: object
      properties:
        contents:
          type: array
          items:
            $ref: '#/components/schemas/remote_syslog_content'
          description: Syslog facilities and severities sent to this server
        explicit_priority:
          type: boolean
          description: Whether to include explicit syslog priority values in messages sent to this server
        facility:
          allOf:
          - $ref: '#/components/schemas/remote_syslog_facility1'
          - description: 'Default syslog facility for messages sent to this server. enum: `any`, `authorization`, `change-log`, `config`, `conflict-log`, `daemon`, `dfc`, `external`, `firewall`, `ftp`, `interactive-commands`, `kernel`, `ntp`, `pfe`, `security`, `user`.'
            examples:
            - config
        host:
          type: string
          description: Address or hostname of the remote syslog server
          examples:
          - syslogd.internal
        match:
          type: string
          description: Expression used to filter log messages sent to this server
          examples:
          - '!alarm|ntp|errors.crc_error[chan]'
        port:
          anyOf:
          - maximum: 65545
            minimum: 1
            type: integer
            contentEncoding: int32
            default: 514
          - type: string
          description: Network port used by the remote syslog server
        protocol:
          allOf:
          - $ref: '#/components/schemas/remote_syslog_server_protocol2'
          - description: 'Transport protocol used for this remote syslog server. enum: `tcp`, `udp`.'
        routing_instance:
          type: string
          description: Routing instance used to reach this remote syslog server
          examples:
          - routing-instance-name
        server_name:
          type: string
          description: TLS server name used when verifying the remote syslog server certificate
          examples:
          - syslogd.internal
        severity:
          allOf:
          - $ref: '#/components/schemas/remote_syslog_severity1'
          - description: 'Default syslog severity for messages sent to this server. enum: `alert`, `any`, `critical`, `emergency`, `error`, `info`, `notice`, `warning`.'
        source_address:
          type: string
          description: Source address for syslog traffic. If configured, Mist uses the VLAN first; otherwise it uses `source_ip`
        structured_data:
          type: boolean
          description: Whether to include structured syslog data in messages sent to this server
        tag:
          type: string
          description: Syslog tag value added to messages sent to this server
      description: Remote syslog server destination settings
    remote_syslog_server_protocol:
      title: remote_syslog_server_protocol
      enum:
      - tcp
      - udp
      type: string
      description: 'Transport protocol used for this remote syslog server. enum: `tcp`, `udp`'
    remote_syslog_severity:
      title: remote_syslog_severity
      enum:
      - alert
      - any
      - critical
      - emergency
      - error
      - info
      - notice
      - warning
      type: string
      description: 'enum: `alert`, `any`, `critical`, `emergency`, `error`, `info`, `notice`, `warning`'
    remote_syslog_time_format:
      title: remote_syslog_time_format
      enum:
      - millisecond
      - year
      - year millisecond
      type: string
      description: 'enum: `millisecond`, `year`, `year millisecond`'
      examples:
      - millisecond
    remote_syslog_user:
      title: remote_syslog_user
      type: object
      properties:
        contents:
          type: array
          items:
            $ref: '#/components/schemas/remote_syslog_content'
          description: Syslog facilities and severities logged for this user rule
        match:
          type: string
          description: Expression used to filter user log messages
          examples:
          - '"!alarm|ntp|errors.crc_error[chan]"'
        user:
          type: string
          description: Account name or wildcard matched by this syslog rule
          examples:
          - '*'
      description: User-specific syslog logging rule
    replace_device:
      title: replace_device
      type: object
      properties:
        discard:
          type: array
          items:
            type: string
          description: Existing device attributes that should not be copied to the replacement device
        inventory_mac:
          type: string
          description: MAC address of the claimed, unassigned inventory device that will replace the old device
          examples:
          - 5c5b35000301
        mac:
          type: string
          description: Device MAC address being replaced
          examples:
          - 5c5b35000101
        site_id:
          type: string
          description: Site containing the device being replaced
          contentEncoding: uuid
          examples:
          - 4ac1dcf4-9d8b-7211-65c4-057819f0862b
        tunterm_port_config:
          allOf:
          - $ref: '#/components/schemas/tunterm_port_config1'
          - description: Tunnel termination Ethernet port configuration for a Mist Edge replacement
      description: Request payload for replacing an inventory device with a claimed, unassigned device
    resolution:
      title: resolution
      enum:
      - default
      - fine
      type: string
      description: 'Location resolution mode for map or placement calculations. enum: `default`, `fine`'
    response_anomaly_search:
      title: response_anomaly_search
      required:
      - end
      - limit
      - page
      - results
      - start
      type: object
      properties:
        end:
          type: integer
          description: Search window end timestamp for anomaly results, in epoch seconds
          contentEncoding: int32
          examples:
          - 1711035686
        limit:
          type: integer
          description: Maximum number of anomaly results requested per page
          contentEncoding: int32
          examples:
          - 10
        page:
          type: integer
          description: Current page number in the anomaly search results
          contentEncoding: int32
          examples:
          - 1
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/anomaly'
          description: Anomaly records returned for this page
        start:
          type: integer
          description: Search window start timestamp for anomaly results, in epoch seconds
          contentEncoding: int32
          examples:
          - 1710949286
        total:
          type: integer
          description: Number of anomaly records matching the search
          contentEncoding: int32
          examples:
          - 232
      description: Paginated anomaly search response
    response_assign_success:
      title: response_assign_success
      required:
      - success
      type: object
      properties:
        success:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Messages describing successful assignment results
      description: Assignment operation success response
    response_async_claim_create:
      title: response_async_claim_create
      type: object
      properties:
        claim_id:
          type: string
          description: Unique identifier for the async claim job, used to poll status
          contentEncoding: uuid
        inventory_pending:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/response_claim_license_inventory_pending_item'
          description: Inventory devices queued for async claim processing
      description: Response to an async inventory claim request
    response_async_claim_status:
      title: response_async_claim_status
      type: object
      properties:
        claim_id:
          type: string
          description: Unique identifier of the async claim job
          contentEncoding: uuid
        completed:
          type: array
          items:
            type: string
          description: Device MAC addresses that completed async claim processing
        details:
          type: array
          items:
            $ref: '#/components/schemas/response_async_license_detail'
          description: Per-device status details for async claim processing; present when `detail=true`
        failed:
          type: integer
          description: Number of devices that failed claim processing
          contentEncoding: int32
        incompleted:
          type: array
          items:
            type: string
          description: Device MAC addresses not yet completed in async claim processing
        org_id:
          type: string
          description: Organization that owns the async claim job
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        processed:
          type: integer
          description: Number of devices processed so far
          contentEncoding: int32
        scheduled_at:
          type: integer
          description: Epoch timestamp when the async claim was scheduled
          contentEncoding: int32
        status:
          allOf:
          - $ref: '#/components/schemas/response_async_license_status3'
          - description: 'Current async claim processing state. enum: `prepared`, `ongoing`, `done`.'
        succeed:
          type: integer
          description: Number of devices that successfully completed claim processing
          contentEncoding: int32
        timestamp:
          type: number
          description: Epoch timestamp of the last status report
          readOnly: true
        total:
          type: integer
          description: Total number of devices included in the claim
          contentEncoding: int32
      description: Async inventory claim job status
    response_async_claims_list:
      title: response_async_claims_list
      type: object
      properties:
        claims:
          type: array
          items:
            $ref: '#/components/schemas/response_async_claim_status'
          description: Async claim job status records
      description: List of async inventory claim jobs for the organization
    response_async_license:
      title: response_async_license
      type: object
      properties:
        completed:
          type: array
          items:
            type: string
          description: Device MAC addresses that completed asynchronous license claim processing
        details:
          type: array
          items:
            $ref: '#/components/schemas/response_async_license_detail'
          description: Per-device status details for asynchronous license claim processing
        failed:
          type: integer
          description: Number of devices that failed license claim processing
          contentEncoding: int32
        incompleted:
          type: array
          items:
            type: string
          description: Device MAC addresses not yet completed in asynchronous license claim processing
        processed:
          type: integer
          description: Number of devices processed so far by asynchronous license claim
          contentEncoding: int32
        scheduled_at:
          type: integer
          description: Epoch timestamp when the asynchronous license claim was scheduled
          contentEncoding: int32
        status:
          allOf:
          - $ref: '#/components/schemas/response_async_license_status1'
          - description: 'Current asynchronous license claim processing state. enum: `prepared`, `ongoing`, `done`.'
        succeed:
          type: integer
          description: Number of devices that successfully completed license claim processing
          contentEncoding: int32
        timestamp:
          type: number
          description: Epoch timestamp when this asynchronous license status was reported
          readOnly: true
        total:
          type: integer
          description: Number of devices included in the license claim
          contentEncoding: int32
      description: Asynchronous license claim progress response
    response_async_license_detail:
      title: response_async_license_detail
      type: object
      properties:
        mac:
          type: string
          description: Device MAC address for this license claim detail
        status:
          type: string
          description: Claim processing state for this device
        timestamp:
          type: number
          description: Epoch timestamp when this device claim status was reported
          readOnly: true
      description: Per-device asynchronous license claim status
    response_async_license_status:
      title: response_async_license_status
      enum:
      - prepared
      - ongoing
      - done
      type: string
      description: 'Processing state for an asynchronous license claim. enum: `prepared`, `ongoing`, `done`'
    response_auto_map_assignment:
      title: response_auto_map_assignment
      type: object
      properties:
        devices:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/response_auto_map_assignment_device'
          description: Per-device validation results for auto map assignment, keyed by device MAC address
        estimated_runtime:
          type: integer
          description: Estimated runtime for the process in seconds
          contentEncoding: int32
        reason:
          type: string
          description: Provides the reason for the status
        started:
          type: boolean
          description: Indicates whether the auto map assignment process has started
        valid:
          type: boolean
          description: Indicates whether the auto map assignment request is valid
      description: Auto map assignment start response
    response_auto_map_assignment_apply:
      title: response_auto_map_assignment_apply
      required:
      - accepted_maps
      - message
      type: object
      properties:
        accepted_maps:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: List of map IDs that were successfully accepted
        message:
          type: string
          description: Human-readable description of the operation result
      description: Result returned after applying accepted auto map assignments
    response_auto_map_assignment_clear:
      title: response_auto_map_assignment_clear
      required:
      - message
      - rejected_maps
      type: object
      properties:
        message:
          type: string
          description: Human-readable description of the operation result
        rejected_maps:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: List of map IDs that were successfully rejected
      description: Result returned after clearing auto map assignment candidates
    response_auto_map_assignment_device:
      title: response_auto_map_assignment_device
      type: object
      properties:
        reason:
          type: string
          description: Provides the reason for the status if the AP is invalid
        valid:
          type: boolean
          description: Indicates whether the device meets requirements for auto map assignment
      description: Per-device validation result for auto map assignment
    response_auto_map_assignment_info:
      title: response_auto_map_assignment_info
      required:
      - status
      type: object
      properties:
        est_time_left:
          type: number
          description: Only when `status`==`in_progress`, estimated seconds remaining
        start_time:
          type: number
          description: Unix timestamp when auto map assignment was started
        status:
          allOf:
          - $ref: '#/components/schemas/response_auto_map_assignment_info_status2'
          - description: 'Current auto map assignment processing state. enum: `not_started`, `in_progress`, `completed`, `error`.'
        stop_time:
          type: number
          description: Only when `status`==`completed`, Unix timestamp when auto map assignment stopped
        time_updated:
          type: number
          description: Unix timestamp when status was last updated
      description: Auto map assignment status response
    response_auto_map_assignment_info_status:
      title: response_auto_map_assignment_info_status
      enum:
      - not_started
      - in_progress
      - completed
      - error
      type: string
      description: >-
        The status of auto map assignment for a given site. enum:
          * `not_started`: Auto map assignment has not been requested
          * `in_progress`: Auto map assignment is currently processing
          * `completed`: The auto map assignment process has completed
          * `error`: There was an error in the auto map assignment process
    response_auto_orientation:
      title: response_auto_orientation
      type: object
      properties:
        devices:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/response_auto_orientation_device'
          description: Per-device validation results for auto orientation, keyed by device MAC address
        estimated_runtime:
          type: integer
          description: Estimated runtime for the process in seconds
          contentEncoding: int32
        reason:
          type: string
          description: Provides the reason for the status.
        started:
          type: boolean
          description: Indicates whether the auto orient process has started.
        valid:
          type: boolean
          description: Indicates whether the auto orient request is valid.
        wifi_interrupting:
          type: boolean
          description: Indicates whether the auto orient process will interrupt WiFi traffic.
      description: Auto orientation start response
    response_auto_orientation_device:
      title: response_auto_orientation_device
      type: object
      properties:
        reason:
          type: string
          description: Provides the reason for the status if the AP is invalid.
        valid:
          type: boolean
          description: Indicates whether the auto orient request is valid for the device.
      description: Per-device validation result for auto orientation
    response_auto_orientation_info:
      title: response_auto_orientation_info
      type: object
      properties:
        est_time_left:
          type: number
          description: Only when `status`==`inprogress`, estimate of the time to completion
        start_time:
          type: number
          description: Timestamp when auto orient process was last queued for this map
        status:
          allOf:
          - $ref: '#/components/schemas/response_auto_orientation_info_status2'
          - description: 'Current auto orientation processing state. enum: `pending`, `inprogress`, `done`, `error`.'
        stop_time:
          type: number
          description: Timestamp when auto orient completed or was manually stopped
      description: Auto orientation status response
    response_auto_orientation_info_status:
      title: response_auto_orientation_info_status
      enum:
      - pending
      - inprogress
      - done
      - error
      type: string
      description: >-
        The status of auto orient for a given map. enum:
          * `pending`: Auto orient has not been requested for this map
          * `inprogress`: Auto orient is currently processing
          * `done`: The auto orient process has completed
          * `error`: There was an error in the auto orient process
    response_auto_placement_info:
      title: response_auto_placement_info
      type: object
      properties:
        end_time:
          type: number
          description: Timestamp when autoplacement completed or was manually stopped
        est_time_left:
          type: number
          description: (Only when inprogress) estimate of the time to completion
        start_time:
          type: integer
          description: Timestamp when autoplacement process was last queued for this map
          contentEncoding: int32
        status:
          allOf:
          - $ref: '#/components/schemas/auto_placement_info_status1'
          - description: 'Current autoplacement processing state. enum: `done`, `error`, `inprogress`, `pending`.'
      description: Auto-placement status response with progress and validation details
    response_auto_zone:
      title: response_auto_zone
      type: object
      properties:
        status:
          allOf:
          - $ref: '#/components/schemas/response_auto_zone_status2'
          - description: 'Current auto zones service state for the map. enum: `in_progress`, `awaiting_review`, `not_started`, `error`.'
        zones:
          type: array
          items:
            $ref: '#/components/schemas/response_auto_zone_zone'
          description: Suggested zones awaiting review for the map
      description: Auto zones status and suggested zone response
    response_auto_zone_status:
      title: response_auto_zone_status
      enum:
      - in_progress
      - awaiting_review
      - not_started
      - error
      type: string
      description: 'Status of auto-zone generation for a map. enum: `in_progress`, `awaiting_review`, `not_started`, `error`. `not_started` means the service has not run or results were cleared, `in_progress` means generation is active, `awaiting_review` means suggested zones are ready for review, and `error` means generation failed'
    response_auto_zone_zone:
      title: response_auto_zone_zone
      type: object
      properties:
        name:
          type: string
          description: Human-readable name of the suggested zone
          examples:
          - zone1
        vertices:
          type: array
          items:
            $ref: '#/components/schemas/response_auto_zone_zone_vertex'
          description: Polygon vertices defining the suggested zone on the map image
      description: Suggested zone returned by the auto zones service
    response_auto_zone_zone_vertex:
      title: response_auto_zone_zone_vertex
      type: object
      properties:
        x:
          type: integer
          description: Horizontal pixel coordinate of the vertex
          contentEncoding: int32
          examples:
          - 10
        y:
          type: integer
          description: Vertical pixel coordinate of the vertex
          contentEncoding: int32
          examples:
          - 42
      description: Pixel coordinate for a suggested zone vertex
    response_autoplacement:
      title: response_autoplacement
      type: object
      properties:
        devices:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/response_autoplacement_device'
          description: Per-device validation results for autoplacement, keyed by AP MAC address
          readOnly: true
        estimated_runtime:
          type: integer
          description: Estimated runtime for the process in seconds.
          contentEncoding: int32
          readOnly: true
        reason:
          type: string
          description: Provides the reason for the status.
          readOnly: true
        started:
          type: boolean
          description: Indicates whether the autoplacement process has started.
          readOnly: true
        valid:
          type: boolean
          description: Indicates whether the autoplacement request is valid.
          readOnly: true
        wifi_interrupting:
          type: boolean
          description: Indicates whether the auto placement process will interrupt WiFi traffic.
      description: Auto-placement start response returned after scheduling the run
    response_autoplacement_device:
      title: response_autoplacement_device
      type: object
      properties:
        reason:
          type: string
          description: Provides the reason for the status if the AP is invalid.
          readOnly: true
        valid:
          type: boolean
          description: Indicates whether the ap is valid.
          readOnly: true
      description: Per-AP validation result for autoplacement
    response_call_troubleshoot_summary:
      title: response_call_troubleshoot_summary
      type: object
      properties:
        mac:
          type: string
          description: Client MAC address for the summarized call troubleshooting result
          examples:
          - 983a78ea4a44
        meeting_id:
          type: string
          description: Meeting identifier for the summarized call troubleshooting result
          contentEncoding: uuid
          examples:
          - b784d744-9a7c-4fad-9af0-f78858a319b1
        results:
          type: array
          items:
            $ref: '#/components/schemas/call_troubleshoot_summary'
          description: Summary troubleshooting results returned for matching calls
      description: Site call troubleshooting summary response
    response_certificate:
      title: response_certificate
      required:
      - cert
      type: object
      properties:
        cert:
          type: string
          description: Current organization CA certificate in PEM format
        pending_cert:
          type: string
          description: Pending auto-renewed organization CA certificate returned when the current certificate nears expiry
        pending_cert_expiry:
          type: integer
          description: Epoch timestamp when the pending certificate is expected to replace the current certificate
          contentEncoding: int32
      description: If the current Org CA certificate is set to expire within 30 days, a pending certificate will be returned along with the expected auto-renewal timestamp.
    response_claim_license:
      title: response_claim_license
      required:
      - inventory_added
      - inventory_duplicated
      - license_added
      - license_duplicated
      - license_error
      type: object
      properties:
        inventory_added:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/response_claim_license_inventory_item'
          description: Inventory devices added by the claim operation
        inventory_duplicated:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/response_claim_license_inventory_item'
          description: Inventory devices already present during the claim operation
        inventory_pending:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/response_claim_license_inventory_pending_item'
          description: Inventory devices pending asynchronous claim processing
        license_added:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/response_claim_license_license_item'
          description: License entitlements added by the claim operation
        license_duplicated:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/response_claim_license_license_item'
          description: License entitlements already present during the claim operation
        license_error:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/response_claim_license_license_error_item'
          description: License claim errors returned by order number
      description: Result of claiming licenses or activation codes
    response_claim_license_inventory_item:
      title: response_claim_license_inventory_item
      required:
      - mac
      - magic
      - model
      - serial
      - type
      type: object
      properties:
        mac:
          type: string
          description: Device MAC address for the claimed inventory item
        magic:
          type: string
          description: Activation code or claim code associated with the inventory item
        model:
          type: string
          description: Device model for the claimed inventory item
        serial:
          type: string
          description: Device serial number for the claimed inventory item
        type:
          type: string
          description: Device type for the claimed inventory item
      description: Inventory device returned by a license claim
    response_claim_license_inventory_pending_item:
      title: response_claim_license_inventory_pending_item
      type: object
      properties:
        mac:
          type: string
          description: Device MAC address pending asynchronous inventory claim
      description: Inventory device pending asynchronous claim processing
    response_claim_license_license_item:
      title: response_claim_license_license_item
      required:
      - end
      - quantity
      - start
      - type
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp when the license entitlement ends
          contentEncoding: int32
        quantity:
          type: integer
          description: Number of license units included in the entitlement
          contentEncoding: int32
        start:
          type: integer
          description: Epoch timestamp when the license entitlement starts
          contentEncoding: int32
        type:
          type: string
          description: License SKU or subscription type
      description: License entitlement returned by a claim operation
    response_claim_license_license_error_item:
      title: response_claim_license_license_error_item
      required:
      - order
      - reason
      type: object
      properties:
        order:
          type: string
          description: License order number or claim identifier that failed
        reason:
          type: string
          description: Explanation of why the license order could not be claimed
      description: License order that could not be claimed
    response_claim_mx_edge:
      title: response_claim_mx_edge
      required:
      - id
      - magic
      type: object
      properties:
        id:
          type: string
          description: Unique identifier assigned to the claimed Mist Edge
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        magic:
          type: string
          description: Claim magic token returned for the Mist Edge
      description: Mist Edge claim response
    response_client_events_search:
      title: response_client_events_search
      required:
      - end
      - limit
      - results
      - start
      - total
      type: object
      properties:
        end:
          type: integer
          description: Search window end timestamp for client events, in epoch seconds
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of client event results requested
          contentEncoding: int32
        next:
          type: string
          description: URL for the next page of client event results
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/events_client'
          description: Client event records returned for this page
        start:
          type: integer
          description: Search window start timestamp for client events, in epoch seconds
          contentEncoding: int32
        total:
          type: integer
          description: Number of client event records matching the search
          contentEncoding: int32
      description: Paginated client event search response
    response_client_nac_search:
      title: response_client_nac_search
      type: object
      properties:
        end:
          type: integer
          description: Search window end timestamp for NAC clients, in epoch seconds
          contentEncoding: int32
          examples:
          - 1513362753
        limit:
          type: integer
          description: Maximum number of NAC client results requested
          contentEncoding: int32
          examples:
          - 3
        next:
          type: string
          description: URL for the next page of NAC client results
        results:
          type: array
          items:
            $ref: '#/components/schemas/client_nac'
          description: NAC client records returned for this page
        start:
          type: integer
          description: Search window start timestamp for NAC clients, in epoch seconds
          contentEncoding: int32
          examples:
          - 1513276353
        total:
          type: integer
          description: Number of NAC client records matching the search
          contentEncoding: int32
          examples:
          - 2
      description: Paginated NAC client search response
    response_client_search:
      title: response_client_search
      required:
      - end
      - limit
      - results
      - start
      - total
      type: object
      properties:
        end:
          type: number
          description: Search window end timestamp for wireless clients, in epoch seconds
        limit:
          type: integer
          description: Maximum number of wireless client results requested
          contentEncoding: int32
        next:
          type: string
          description: URL for the next page of wireless client results
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/client_wireless'
          description: Wireless client records returned for this page
        start:
          type: number
          description: Search window start timestamp for wireless clients, in epoch seconds
        total:
          type: integer
          description: Number of wireless client records matching the search
          contentEncoding: int32
      description: Paginated wireless client search response
    response_client_sessions_search:
      title: response_client_sessions_search
      required:
      - end
      - limit
      - results
      - start
      - total
      type: object
      properties:
        end:
          type: integer
          description: Search window end timestamp for wireless client sessions, in epoch seconds
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of wireless client session results requested
          contentEncoding: int32
        next:
          type: string
          description: URL for the next page of wireless client session results
        results:
          type: array
          items:
            $ref: '#/components/schemas/response_client_sessions_search_item'
          description: Wireless client session records returned for this page
        start:
          type: integer
          description: Search window start timestamp for wireless client sessions, in epoch seconds
          contentEncoding: int32
        total:
          type: integer
          description: Number of wireless client session records matching the search
          contentEncoding: int32
      description: Paginated wireless client session search response
    response_client_sessions_search_item:
      title: response_client_sessions_search_item
      required:
      - ap
      - band
      - client_manufacture
      - connect
      - disconnect
      - duration
      - mac
      - org_id
      - site_id
      - ssid
      - timestamp
      - wlan_id
      type: object
      properties:
        ap:
          type: string
          description: Access point MAC address associated with the client session
          readOnly: true
        band:
          type: string
          description: Radio band used by the client session
          readOnly: true
        client_manufacture:
          type: string
          description: Manufacturer reported for the client device
          readOnly: true
        connect:
          type: number
          description: Epoch timestamp when the client session connected
          readOnly: true
        disconnect:
          type: number
          description: Epoch timestamp when the client session disconnected
          readOnly: true
        duration:
          type: number
          description: Length of the client session, in seconds
          readOnly: true
        mac:
          type: string
          description: Client MAC address for the session
          readOnly: true
        org_id:
          type: string
          description: Organization associated with the client session
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        site_id:
          type: string
          description: Site associated with the client session
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        ssid:
          type: string
          description: WLAN SSID used by the client session
          readOnly: true
        tags:
          type: array
          items:
            type: string
          description: Event or classification tags attached to the client session
          readOnly: true
        timestamp:
          type: number
          description: Epoch timestamp when the client session record was observed
          readOnly: true
        wlan_id:
          type: string
          description: WLAN identifier associated with the client session
          contentEncoding: uuid
      description: Wireless client session record
    response_config_history_search:
      title: response_config_history_search
      required:
      - end
      - limit
      - results
      - start
      - total
      type: object
      properties:
        end:
          type: integer
          description: Search window end timestamp for config history, in epoch seconds
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of config history entries requested
          contentEncoding: int32
        next:
          type: string
          description: URL for the next page of config history results
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/response_config_history_search_item'
          description: Device config history entries returned for this page
        start:
          type: integer
          description: Search window start timestamp for config history, in epoch seconds
          contentEncoding: int32
        total:
          type: integer
          description: Number of config history entries matching the search
          contentEncoding: int32
      description: Paginated device config history search response
    response_config_history_search_item:
      title: response_config_history_search_item
      required:
      - channel_24
      - channel_5
      - secpolicy_violated
      - timestamp
      - version
      type: object
      properties:
        channel_24:
          type: integer
          description: 2.4 GHz channel configured in this history entry
          contentEncoding: int32
        channel_5:
          type: integer
          description: 5 GHz channel configured in this history entry
          contentEncoding: int32
        radio_macs:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Radio MAC addresses included in this config history entry
        radios:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/response_config_history_search_item_radio'
          description: Radio configuration details included in this history entry
        secpolicy_violated:
          type: boolean
          description: Whether the device configuration violated a security policy
        ssids:
          uniqueItems: true
          type: array
          items:
            type: string
          description: WLAN SSIDs included in this config history entry
        ssids_24:
          uniqueItems: true
          type: array
          items:
            type: string
          description: 2.4 GHz WLAN SSIDs included in this config history entry
        ssids_5:
          uniqueItems: true
          type: array
          items:
            type: string
          description: 5 GHz WLAN SSIDs included in this config history entry
        timestamp:
          type: number
          description: Epoch timestamp when this config history entry was recorded
          readOnly: true
        version:
          type: string
          description: Configuration version associated with this history entry
        wlans:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/response_config_history_search_item_wlan'
          description: WLAN configuration details included in this history entry
      description: Device config history entry
    response_config_history_search_item_radio:
      title: response_config_history_search_item_radio
      required:
      - band
      - channel
      type: object
      properties:
        band:
          type: string
          description: Radio band for this config history detail
        channel:
          type: integer
          description: Configured channel for this radio
          contentEncoding: int32
      description: Radio config history detail
    response_config_history_search_item_wlan:
      title: response_config_history_search_item_wlan
      required:
      - auth
      - id
      - ssid
      type: object
      properties:
        auth:
          type: string
          description: Configured authentication method for this WLAN
        bands:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Radio bands where this WLAN was configured
        id:
          type: string
          description: Unique identifier of the WLAN configuration
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        ssid:
          type: string
          description: WLAN SSID for this config history detail
        vlan_ids:
          uniqueItems: true
          type: array
          items:
            type: string
          description: VLAN IDs configured for this WLAN
      description: WLAN config history detail
    response_count:
      title: response_count
      required:
      - distinct
      - end
      - limit
      - results
      - start
      - total
      type: object
      properties:
        distinct:
          type: string
          description: Field used to group the count results
        end:
          type: integer
          description: Search window end timestamp for the count request, in epoch seconds
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of distinct count results requested
          contentEncoding: int32
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/count_result'
          description: Count results grouped by the distinct field
        start:
          type: integer
          description: Search window start timestamp for the count request, in epoch seconds
          contentEncoding: int32
        total:
          type: integer
          description: Number of distinct result buckets returned
          contentEncoding: int32
      description: Distinct count response for time-bounded search results
    response_count_marvis_actions:
      title: response_count_marvis_actions
      type: object
      properties:
        distinct:
          type: string
          description: Field used to group Marvis action count results
          examples:
          - status
        limit:
          type: integer
          description: Maximum number of Marvis action count results requested
          contentEncoding: int32
          examples:
          - 1000
        results:
          type: array
          items:
            $ref: '#/components/schemas/response_count_marvis_actions_result'
          description: Marvis action count results grouped by the distinct field
          examples:
          - - count: 24
              status: 002e176a-0000-000-1111-002e208b20e1
            - count: 12
              status: 2d3f176a-0000-000-2222-002e208f176a
            - count: 15
              status: 08b2176a-0000-000-3333-002e208b2d3f
        total:
          type: integer
          description: Number of Marvis action count result buckets returned
          contentEncoding: int32
          examples:
          - 3
      description: Distinct count response for Marvis action suggestions
    response_count_marvis_actions_result:
      title: response_count_marvis_actions_result
      type: object
      properties:
        count:
          type: integer
          description: Number of Marvis actions matching this distinct value
          contentEncoding: int32
          examples:
          - 24
      additionalProperties:
        type: string
      description: Marvis action count result for one distinct value
    response_detail_string:
      title: response_detail_string
      type: object
      properties:
        detail:
          type: string
          description: Human-readable detail message returned by the API
      description: Response containing a human-readable detail message
    response_device_bios_upgrade:
      title: response_device_bios_upgrade
      type: object
      properties:
        status:
          type: string
          description: Current BIOS upgrade status for the device
        timestamp:
          type: number
          description: Epoch timestamp when the BIOS upgrade status was reported
          readOnly: true
      description: Device BIOS upgrade status response
    response_device_config_cli:
      title: response_device_config_cli
      required:
      - cli
      type: object
      properties:
        cli:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Command lines generated for the device configuration in CLI syntax
      description: Device configuration rendered as CLI commands
    response_device_config_cmd:
      title: response_device_config_cmd
      required:
      - cmd
      type: object
      properties:
        cmd:
          type: string
          description: Configuration command returned for the device
      description: Device configuration command response
    response_device_events_search:
      title: response_device_events_search
      required:
      - end
      - limit
      - results
      - start
      - total
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp for the end of the event search window
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of event records returned in this page
          contentEncoding: int32
        next:
          type: string
          description: Pagination cursor or URL for retrieving the next page of event records
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/device_event'
          description: Device or system event records matching the search filters
        start:
          type: integer
          description: Epoch timestamp for the start of the event search window
          contentEncoding: int32
        total:
          type: integer
          description: Number of event records matching the search filters across all pages
          contentEncoding: int32
      description: Paginated response for device or system event search results
    response_device_flow_records_search:
      title: response_device_flow_records_search
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp, in seconds, for the end of the flow record search window
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of flow records returned in this page
          contentEncoding: int32
        results:
          type: array
          items:
            $ref: '#/components/schemas/flow_record'
          description: Flow records matching the search filters
        search_after:
          type: string
          description: Cursor token for retrieving the next page of flow records
        start:
          type: integer
          description: Epoch timestamp, in seconds, for the start of the flow record search window
          contentEncoding: int32
        total:
          type: integer
          description: Number of flow records matching the search filters
          contentEncoding: int32
      description: Paginated response for device flow record search results
    response_device_metrics:
      title: response_device_metrics
      required:
      - end
      - interval
      - results
      - start
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp for the end of the metric query window
          contentEncoding: int32
        interval:
          type: integer
          description: Aggregation interval in seconds for each metric sample
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of metric samples returned in this page
          contentEncoding: int32
        page:
          type: integer
          description: Returned page number for paginated metric samples
          contentEncoding: int32
        results:
          type: array
          items:
            $ref: '#/components/schemas/response_device_metrics_results_items'
          description: Metric values for the requested insight metric, aligned by position with the `rt` timestamps
        rt:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Timestamps for the metric samples, aligned by position with the `results` values
        start:
          type: integer
          description: Epoch timestamp for the start of the metric query window
          contentEncoding: int32
      description: Time-series insight metric response for a device
    response_device_radio_channels:
      title: response_device_radio_channels
      required:
      - band24_40mhz_allowed
      - band24_channels
      - band24_enabled
      - band5_channels
      - band5_enabled
      - certified
      - code
      - dfs_ok
      - key
      - name
      - uses
      type: object
      properties:
        band24_40mhz_allowed:
          type: boolean
          description: Whether 40 MHz channels are allowed on the 2.4 GHz band
        band24_channels:
          type: object
          additionalProperties:
            type: array
            items:
              type: integer
              format: int32
            description: Allowed 2.4 GHz channels for this country or regulatory domain
            example:
              '20':
              - 1
              - 2
              - 3
              - 4
              - 5
              - 6
              - 7
              - 8
              - 9
              - 10
              - 11
              '40':
              - 1
              - 2
              - 3
              - 4
              - 5
              - 6
              - 7
              - 8
              - 9
              - 10
              - 11
          description: Allowed 2.4 GHz channels for this country or regulatory domain
          examples:
          - '20':
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - 7
            - 8
            - 9
            - 10
            - 11
            '40':
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - 7
            - 8
            - 9
            - 10
            - 11
        band24_enabled:
          type: boolean
          description: Whether the 2.4 GHz band is enabled for this country or regulatory domain
        band5_channels:
          type: object
          additionalProperties:
            type: array
            items:
              type: integer
              format: int32
            description: Allowed 5 GHz channels for this country or regulatory domain
            example:
              '20':
              - 36
              - 40
              - 44
              - 48
              - 52
              - 56
              - 60
              - 64
              - 100
              - 104
              - 108
              - 112
              - 116
              - 120
              - 124
              - 128
              - 132
              - 136
              - 140
              - 144
              - 149
              - 153
              - 157
              - 161
              - 165
              '40':
              - 36
              - 40
              - 44
              - 48
              - 52
              - 56
              - 60
              - 64
              - 100
              - 104
              - 108
              - 112
              - 116
              - 120
              - 124
              - 128
              - 132
              - 136
              - 140
              - 144
              - 149
              - 153
              - 157
              - 161
              '80':
              - 36
              - 40
              - 44
              - 48
              - 52
              - 56
              - 60
              - 64
              - 100
              - 104
              - 108
              - 112
              - 116
              - 120
              - 124
              - 128
              - 132
              - 136
              - 140
              - 144
              - 149
              - 153
              - 157
              - 161
              dfs:
              - 52
              - 56
              - 60
              - 64
              - 100
              - 104
              - 108
              - 112
              - 116
              - 120
              - 124
              - 128
              - 132
              - 136
              - 140
              - 144
              outdoor:
              - 36
              - 40
              - 44
              - 48
              - 52
              - 56
              - 60
              - 64
              - 100
              - 104
              - 108
              - 112
              - 116
              - 120
              - 124
              - 128
              - 132
              - 136
              - 140
              - 144
              - 149
              - 153
              - 157
              - 161
              - 165
          description: Allowed 5 GHz channels for this country or regulatory domain
          examples:
          - '20':
            - 36
            - 40
            - 44
            - 48
            - 52
            - 56
            - 60
            - 64
            - 100
            - 104
            - 108
            - 112
            - 116
            - 120
            - 124
            - 128
            - 132
            - 136
            - 140
            - 144
            - 149
            - 153
            - 157
            - 161
            - 165
            '40':
            - 36
            - 40
            - 44
            - 48
            - 52
            - 56
            - 60
            - 64
            - 100
            - 104
            - 108
            - 112
            - 116
            - 120
            - 124
            - 128
            - 132
            - 136
            - 140
            - 144
            - 149
            - 153
            - 157
            - 161
            '80':
            - 36
            - 40
            - 44
            - 48
            - 52
            - 56
            - 60
            - 64
            - 100
            - 104
            - 108
            - 112
            - 116
            - 120
            - 124
            - 128
            - 132
            - 136
            - 140
            - 144
            - 149
            - 153
            - 157
            - 161
            dfs:
            - 52
            - 56
            - 60
            - 64
            - 100
            - 104
            - 108
            - 112
            - 116
            - 120
            - 124
            - 128
            - 132
            - 136
            - 140
            - 144
            outdoor:
            - 36
            - 40
            - 44
            - 48
            - 52
            - 56
            - 60
            - 64
            - 100
            - 104
            - 108
            - 112
            - 116
            - 120
            - 124
            - 128
            - 132
            - 136
            - 140
            - 144
            - 149
            - 153
            - 157
            - 161
            - 165
        band5_enabled:
          type: boolean
          description: Whether the 5 GHz band is enabled for this country or regulatory domain
        band6_channels:
          type: object
          additionalProperties:
            type: array
            items:
              type: integer
              format: int32
            description: Allowed 6 GHz channels for this country or regulatory domain
            example:
              '160':
              - 1
              - 5
              - 9
              - 13
              - 17
              - 21
              - 25
              - 29
              - 33
              - 37
              - 41
              - 45
              - 49
              - 53
              - 57
              - 61
              - 65
              - 69
              - 73
              - 77
              - 81
              - 85
              - 89
              - 93
              - 97
              - 101
              - 105
              - 109
              - 113
              - 117
              - 121
              - 125
              - 129
              - 133
              - 137
              - 141
              - 145
              - 149
              - 153
              - 157
              - 161
              - 165
              - 169
              - 173
              - 177
              - 181
              - 185
              - 189
              - 193
              - 197
              - 201
              - 205
              - 209
              - 213
              - 217
              - 221
              '20':
              - 1
              - 5
              - 9
              - 13
              - 17
              - 21
              - 25
              - 29
              - 33
              - 37
              - 41
              - 45
              - 49
              - 53
              - 57
              - 61
              - 65
              - 69
              - 73
              - 77
              - 81
              - 85
              - 89
              - 93
              - 97
              - 101
              - 105
              - 109
              - 113
              - 117
              - 121
              - 125
              - 129
              - 133
              - 137
              - 141
              - 145
              - 149
              - 153
              - 157
              - 161
              - 165
              - 169
              - 173
              - 177
              - 181
              - 185
              - 189
              - 193
              - 197
              - 201
              - 205
              - 209
              - 213
              - 217
              - 221
              - 225
              - 229
              - 233
              '40':
              - 1
              - 5
              - 9
              - 13
              - 17
              - 21
              - 25
              - 29
              - 33
              - 37
              - 41
              - 45
              - 49
              - 53
              - 57
              - 61
              - 65
              - 69
              - 73
              - 77
              - 81
              - 85
              - 89
              - 93
              - 97
              - 101
              - 105
              - 109
              - 113
              - 117
              - 121
              - 125
              - 129
              - 133
              - 137
              - 141
              - 145
              - 149
              - 153
              - 157
              - 161
              - 165
              - 169
              - 173
              - 177
              - 181
              - 185
              - 189
              - 193
              - 197
              - 201
              - 205
              - 209
              - 213
              - 217
              - 221
              - 225
              - 229
              '80':
              - 1
              - 5
              - 9
              - 13
              - 17
              - 21
              - 25
              - 29
              - 33
              - 37
              - 41
              - 45
              - 49
              - 53
              - 57
              - 61
              - 65
              - 69
              - 73
              - 77
              - 81
              - 85
              - 89
              - 93
              - 97
              - 101
              - 105
              - 109
              - 113
              - 117
              - 121
              - 125
              - 129
              - 133
              - 137
              - 141
              - 145
              - 149
              - 153
              - 157
              - 161
              - 165
              - 169
              - 173
              - 177
              - 181
              - 185
              - 189
              - 193
              - 197
              - 201
              - 205
              - 209
              - 213
              - 217
              - 221
              psc:
              - 5
              - 21
              - 37
              - 53
              - 69
              - 85
              - 101
              - 117
              - 133
              - 149
              - 165
              - 181
              - 197
              - 213
              - 229
          description: Allowed 6 GHz channels for this country or regulatory domain
          examples:
          - '160':
            - 1
            - 5
            - 9
            - 13
            - 17
            - 21
            - 25
            - 29
            - 33
            - 37
            - 41
            - 45
            - 49
            - 53
            - 57
            - 61
            - 65
            - 69
            - 73
            - 77
            - 81
            - 85
            - 89
            - 93
            - 97
            - 101
            - 105
            - 109
            - 113
            - 117
            - 121
            - 125
            - 129
            - 133
            - 137
            - 141
            - 145
            - 149
            - 153
            - 157
            - 161
            - 165
            - 169
            - 173
            - 177
            - 181
            - 185
            - 189
            - 193
            - 197
            - 201
            - 205
            - 209
            - 213
            - 217
            - 221
            '20':
            - 1
            - 5
            - 9
            - 13
            - 17
            - 21
            - 25
            - 29
            - 33
            - 37
            - 41
            - 45
            - 49
            - 53
            - 57
            - 61
            - 65
            - 69
            - 73
            - 77
            - 81
            - 85
            - 89
            - 93
            - 97
            - 101
            - 105
            - 109
            - 113
            - 117
            - 121
            - 125
            - 129
            - 133
            - 137
            - 141
            - 145
            - 149
            - 153
            - 157
            - 161
            - 165
            - 169
            - 173
            - 177
            - 181
            - 185
            - 189
            - 193
            - 197
            - 201
            - 205
            - 209
            - 213
            - 217
            - 221
            - 225
            - 229
            - 233
            '40':
            - 1
            - 5
            - 9
            - 13
            - 17
            - 21
            - 25
            - 29
            - 33
            - 37
            - 41
            - 45
            - 49
            - 53
            - 57
            - 61
            - 65
            - 69
            - 73
            - 77
            - 81
            - 85
            - 89
            - 93
            - 97
            - 101
            - 105
            - 109
            - 113
            - 117
            - 121
            - 125
            - 129
            - 133
            - 137
            - 141
            - 145
            - 149
            - 153
            - 157
            - 161
            - 165
            - 169
            - 173
            - 177
            - 181
            - 185
            - 189
            - 193
            - 197
            - 201
            - 205
            - 209
            - 213
            - 217
            - 221
            - 225
            - 229
            '80':
            - 1
            - 5
            - 9
            - 13
            - 17
            - 21
            - 25
            - 29
            - 33
            - 37
            - 41
            - 45
            - 49
            - 53
            - 57
            - 61
            - 65
            - 69
            - 73
            - 77
            - 81
            - 85
            - 89
            - 93
            - 97
            - 101
            - 105
            - 109
            - 113
            - 117
            - 121
            - 125
            - 129
            - 133
            - 137
            - 141
            - 145
            - 149
            - 153
            - 157
            - 161
            - 165
            - 169
            - 173
            - 177
            - 181
            - 185
            - 189
            - 193
            - 197
            - 201
            - 205
            - 209
            - 213
            - 217
            - 221
            psc:
            - 5
            - 21
            - 37
            - 53
            - 69
            - 85
            - 101
            - 117
            - 133
            - 149
            - 165
            - 181
            - 197
            - 213
            - 229
        band6_enabled:
          type: boolean
          description: Whether the 6 GHz band is enabled for this country or regulatory domain
        certified:
          type: boolean
          description: Whether AP operation is certified for this country or regulatory domain
        code:
          type: integer
          description: Country code in ISO 3166-1 numeric format
          contentEncoding: int32
        dfs_ok:
          type: boolean
          description: Whether DFS channels are allowed in this country or regulatory domain
        key:
          type: string
          description: Two-character ISO 3166-1 country code
        name:
          type: string
          description: Country or regulatory-domain display name
        uses:
          type: string
          description: Regulatory ruleset used for AP channel validation
      description: Country and regulatory-domain channel capabilities for AP radios
    response_device_search:
      title: response_device_search
      required:
      - end
      - limit
      - results
      - start
      - total
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp for the end of the device search window
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of device records returned in this page
          contentEncoding: int32
        next:
          type: string
          description: Pagination cursor or URL for retrieving the next page of device records
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/response_device_search_results_items'
          description: AP, switch, or gateway records matching the device search filters
        start:
          type: integer
          description: Epoch timestamp for the start of the device search window
          contentEncoding: int32
        total:
          type: integer
          description: Number of device records matching the search filters across all pages
          contentEncoding: int32
      description: Paginated response for organization or site device search results
    response_device_upgrade:
      title: response_device_upgrade
      required:
      - status
      - timestamp
      type: object
      properties:
        status:
          allOf:
          - $ref: '#/components/schemas/upgrade_info_status2'
          - description: 'Current status of the requested device upgrade. enum: `error`, `inprogress`, `scheduled`, `starting`, `success`.'
        timestamp:
          type: number
          description: Epoch timestamp when the device upgrade status was reported
          readOnly: true
      description: Single-device upgrade status response
    response_discovered_switch_metrics:
      title: response_discovered_switch_metrics
      required:
      - end
      - limit
      - results
      - start
      - total
      type: object
      properties:
        end:
          type: number
          description: Epoch timestamp, in seconds, for the end of the metric search window
        limit:
          type: integer
          description: Maximum number of discovered switch metric records returned in this page
          contentEncoding: int32
        next:
          type: string
          description: Pagination cursor or URL for retrieving the next page of discovered switch metric records
        results:
          type: array
          items:
            $ref: '#/components/schemas/discovered_switch_metric'
          description: Discovered switch metric records matching the search filters
        start:
          type: number
          description: Epoch timestamp, in seconds, for the start of the metric search window
        total:
          type: integer
          description: Number of discovered switch metric records matching the search filters across all pages
          contentEncoding: int32
      description: Paginated response for discovered switch metric search results
    response_discovered_switches:
      title: response_discovered_switches
      required:
      - end
      - limit
      - results
      - start
      - total
      type: object
      properties:
        end:
          type: number
          description: Epoch timestamp, in seconds, for the end of the discovered switch search window
        limit:
          type: integer
          description: Maximum number of discovered switch records returned in this page
          contentEncoding: int32
        next:
          type: string
          description: Pagination cursor or URL for retrieving the next page of discovered switch records
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/discovered_switch'
          description: Discovered switch records matching the search filters
        start:
          type: number
          description: Epoch timestamp, in seconds, for the start of the discovered switch search window
        total:
          type: integer
          description: Number of discovered switch records matching the search filters across all pages
          contentEncoding: int32
      description: Paginated response for discovered switch search results
    response_dswitches_metrics:
      title: response_dswitches_metrics
      required:
      - inactive_wired_vlans
      - poe_compliance
      - switch_ap_affinity
      - version_compliance
      type: object
      properties:
        inactive_wired_vlans:
          allOf:
          - $ref: '#/components/schemas/dswitches_metrics_inactive_wired_vlans1'
          - description: Metric for inactive wired VLANs on discovered switches
        poe_compliance:
          allOf:
          - $ref: '#/components/schemas/dswitches_metrics_poe_compliance1'
          - description: Metric for PoE compliance across APs connected to discovered switches
        switch_ap_affinity:
          allOf:
          - $ref: '#/components/schemas/dswitches_metrics_switch_ap_affinity1'
          - description: Metric comparing AP counts against the switch affinity threshold
        version_compliance:
          allOf:
          - $ref: '#/components/schemas/dswitches_metrics_version_compliance1'
          - description: Metric for discovered switch software version compliance
      description: Metrics summary returned for discovered switch compliance checks
    response_events_devices:
      title: response_events_devices
      required:
      - end
      - limit
      - results
      - start
      - total
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp for the end of the device event search window
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of device event records returned in this page
          contentEncoding: int32
        next:
          type: string
          description: Pagination cursor or URL for retrieving the next page of device event records
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/device_event'
          description: Device event records matching the search filters
        start:
          type: integer
          description: Epoch timestamp for the start of the device event search window
          contentEncoding: int32
        total:
          type: integer
          description: Number of device event records matching the search filters across all pages
          contentEncoding: int32
      description: Paginated response for site device event search results
    response_events_fastroam:
      title: response_events_fastroam
      required:
      - end
      - limit
      - results
      - start
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp for the end of the roaming event search window
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of roaming event records returned in this page
          contentEncoding: int32
        next:
          type: string
          description: Pagination cursor or URL for retrieving the next page of roaming event records; null when no next page exists
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/event_fastroam'
          description: Fast roaming event records matching the search filters
        start:
          type: integer
          description: Epoch timestamp for the start of the roaming event search window
          contentEncoding: int32
      description: Paginated response for fast roaming event results
    response_events_nac_client_search:
      title: response_events_nac_client_search
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp for the end of the NAC client event search window
          contentEncoding: int32
          examples:
          - 1513176951
        limit:
          type: integer
          description: Maximum number of NAC client event records returned in this page
          contentEncoding: int32
          examples:
          - 10
        next:
          type: string
          description: Pagination cursor or URL for retrieving the next page of NAC client event records
        results:
          type: array
          items:
            $ref: '#/components/schemas/nac_client_event'
          description: NAC client event records matching the search filters
        start:
          type: integer
          description: Epoch timestamp for the start of the NAC client event search window
          contentEncoding: int32
          examples:
          - 1512572151
        total:
          type: integer
          description: Number of NAC client event records matching the search filters across all pages
          contentEncoding: int32
          examples:
          - 1
      description: Paginated response for NAC client event search results
    response_events_orgs_search:
      title: response_events_orgs_search
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp for the end of the organization event search window
          contentEncoding: int32
          examples:
          - 1688035193
        limit:
          type: integer
          description: Maximum number of organization event records returned in this page
          contentEncoding: int32
          examples:
          - 10
        next:
          type: string
          description: Pagination cursor or URL for retrieving the next page of organization event records
        results:
          type: array
          items:
            $ref: '#/components/schemas/org_event'
          description: Organization event records matching the search filters
        start:
          type: integer
          description: Epoch timestamp for the start of the organization event search window
          contentEncoding: int32
          examples:
          - 1687948793
        total:
          type: integer
          description: Number of organization event records matching the search filters across all pages
          contentEncoding: int32
      description: Paginated response for organization event search results
    response_events_other_devices_search:
      title: response_events_other_devices_search
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp for the end of the other-device event search window
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of other-device event records returned in this page
          contentEncoding: int32
        next:
          type: string
          description: Pagination cursor or URL for retrieving the next page of other-device event records
        results:
          type: array
          items:
            $ref: '#/components/schemas/event_otherdevice'
          description: list of other-device event records matching the search filters
        start:
          type: integer
          description: Epoch timestamp for the start of the other-device event search window
          contentEncoding: int32
        total:
          type: integer
          description: Number of other-device event records matching the search filters across all pages
          contentEncoding: int32
      description: Paginated response for other-device event search results
    response_events_path_search:
      title: response_events_path_search
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp for the end of the service path event search window
          contentEncoding: int32
          examples:
          - 1697096379
        limit:
          type: integer
          description: Maximum number of service path event records returned in this page
          contentEncoding: int32
          examples:
          - 10
        next:
          type: string
          description: Pagination cursor or URL for retrieving the next page of service path event records
        results:
          type: array
          items:
            $ref: '#/components/schemas/service_path_event'
          description: Service path event records matching the search filters
        start:
          type: integer
          description: Epoch timestamp for the start of the service path event search window
          contentEncoding: int32
          examples:
          - 1697009979
        total:
          type: integer
          description: Number of service path event records matching the search filters across all pages
          contentEncoding: int32
          examples:
          - 2
      description: Paginated response for service path event search results
    service_path_event:
      title: service_path_event
      type: object
      properties:
        mac:
          type: string
          description: Device MAC address that reported the service path event
          examples:
          - 90ec7734b374
        model:
          type: string
          description: Device model that reported the service path event
          examples:
          - SSR120
        org_id:
          type: string
          description: Organization identifier associated with the service path event
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        policy:
          type: string
          description: Service policy name associated with the path event
          examples:
          - INTERNET
        port_id:
          type: string
          description: Network interface associated with the service path event
          examples:
          - ge-1/0/6
        site_id:
          type: string
          description: Site identifier associated with the service path event
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        text:
          type: string
          description: Human-readable message for the service path event
          examples:
          - Peer Path Down
        timestamp:
          type: number
          description: Time when the service path event occurred, in epoch seconds
          readOnly: true
        type:
          type: string
          description: Event type for the service path change
          examples:
          - GW_SERVICE_PATH_REMOVE
        version:
          type: string
          description: Device firmware version that reported the service path event
          examples:
          - 6.1.5-14.lts
        vpn_name:
          type: string
          description: Peer name associated with the service path event
          examples:
          - Syracuse_HUB
        vpn_path:
          type: string
          description: Peer path name associated with the service path event
          examples:
          - Syracuse_HUB-Wan0
      description: Event describing a service path state change reported by a gateway or SSR device
    response_events_rogue_search:
      title: response_events_rogue_search
      required:
      - end
      - limit
      - results
      - start
      - total
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp for the end of the rogue AP event search window
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of rogue AP event records returned in this page
          contentEncoding: int32
        next:
          type: string
          description: Pagination cursor or URL for retrieving the next page of rogue AP event records
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/events_rogue'
          description: Rogue AP event records matching the search filters
        start:
          type: integer
          description: Epoch timestamp for the start of the rogue AP event search window
          contentEncoding: int32
        total:
          type: integer
          description: Number of rogue AP event records matching the search filters across all pages
          contentEncoding: int32
      description: Paginated response for rogue AP event search results
    response_events_rrm:
      title: response_events_rrm
      required:
      - end
      - limit
      - results
      - start
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp for the end of the RRM event search window
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of RRM event records returned in this page
          contentEncoding: int32
        next:
          type: string
          description: Pagination cursor or URL for retrieving the next page of RRM event records; null when no next page exists
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/rrm_event'
          description: RRM event records matching the search filters
        start:
          type: integer
          description: Epoch timestamp for the start of the RRM event search window
          contentEncoding: int32
      description: Paginated response for RRM event results
    rrm_event:
      title: rrm_event
      required:
      - ap
      - band
      - bandwidth
      - channel
      - event
      - power
      - pre_bandwidth
      - pre_channel
      - pre_power
      - pre_usage
      - timestamp
      - usage
      type: object
      properties:
        ap:
          type: string
          description: MAC address of the AP associated with the RRM event
          examples:
          - 5c5b350e0001
        band:
          allOf:
          - $ref: '#/components/schemas/dot11_band2'
          - description: 'Radio band affected by the RRM event. enum: `24`, `5`, `5-dedicated`, `5-selectable`, `6`, `6-dedicated`, `6-selectable`.'
        bandwidth:
          allOf:
          - $ref: '#/components/schemas/dot11_bandwidth3'
          - description: 'Channel width after the RRM event, in MHz. enum: `0`, `20`, `40`, `80`, `160`.'
            examples:
            - 20
        channel:
          type: integer
          description: RF channel after the RRM event
          contentEncoding: int32
        event:
          allOf:
          - $ref: '#/components/schemas/rrm_event_type2'
          - description: 'RRM event type that caused or records the change. enum: `interference-ap-co-channel`, `interference-ap-non-wifi`, `neighbor-ap-down`, `neighbor-ap-recovered`, `radar-detected`, `rrm-radar`, `scheduled-site_rrm`, `triggered-site_rrm`.'
        power:
          type: integer
          description: Transmit power after the RRM event
          contentEncoding: int32
        pre_bandwidth:
          allOf:
          - $ref: '#/components/schemas/rrm_event_pre_bandwidth2'
          - description: 'Channel width before the RRM event, in MHz. enum: `0`, `20`, `40`, `80`, `160`.'
        pre_channel:
          type: integer
          description: RF channel before the RRM event; 0 means no previous value was available
          contentEncoding: int32
        pre_power:
          type: number
          description: Transmit power before the RRM event; 0 means no previous value was available
        pre_usage:
          type: string
          description: Radio usage band before the RRM event
        timestamp:
          type: number
          description: Time when the RRM event occurred
          readOnly: true
        usage:
          type: string
          description: Radio usage band after the RRM event
      description: RRM event record for radio setting changes or RF conditions
    response_events_search:
      title: response_events_search
      required:
      - end
      - limit
      - results
      - start
      - total
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp for the end of the wireless client event search window
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of wireless client event records returned in this page
          contentEncoding: int32
        next:
          type: string
          description: Pagination cursor or URL for retrieving the next page of wireless client event records
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/events_client'
          description: Wireless client event records matching the search filters
        start:
          type: integer
          description: Epoch timestamp for the start of the wireless client event search window
          contentEncoding: int32
        total:
          type: integer
          description: Number of wireless client event records matching the search filters across all pages
          contentEncoding: int32
      description: Paginated response for wireless client event search results
    response_events_sky_atp_search:
      title: response_events_sky_atp_search
      required:
      - end
      - limit
      - results
      - start
      - total
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp for the end of the Sky ATP event search window
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of Sky ATP event records returned in this page
          contentEncoding: int32
        next:
          type: string
          description: Pagination cursor or URL for retrieving the next page of Sky ATP event records
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/events_skyatp'
          description: Sky ATP event records matching the search filters
        start:
          type: integer
          description: Epoch timestamp for the start of the Sky ATP event search window
          contentEncoding: int32
        total:
          type: integer
          description: Number of Sky ATP event records matching the search filters across all pages
          contentEncoding: int32
      description: Paginated response for Sky ATP event search results
    response_guest_search:
      title: response_guest_search
      required:
      - end
      - limit
      - results
      - start
      - total
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp for the end of the guest authorization search window
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of guest authorization records returned in this page
          contentEncoding: int32
        next:
          type: string
          description: Pagination cursor or URL for retrieving the next page of guest authorization records
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/guest'
          description: Guest authorization records matching the search filters
        start:
          type: integer
          description: Epoch timestamp for the start of the guest authorization search window
          contentEncoding: int32
        total:
          type: integer
          description: Number of guest authorization records matching the search filters across all pages
          contentEncoding: int32
      description: Paginated response for guest authorization search results
    response_http400:
      title: response_http400
      type: object
      properties:
        detail:
          type: string
          description: Human-readable explanation of the bad request error
          examples:
          - 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
      description: Standard HTTP 400 bad request error response
    response_http400_webhook:
      title: response_http400_webhook
      type: object
      properties:
        detail:
          type: string
          description: Human-readable explanation of the invalid webhook request
          examples:
          - 'invalid field: assetfilter_ids'
        reason:
          type: string
          description: Additional reason explaining why the webhook request was invalid
          examples:
          - contains duplicate uuids
      description: Webhook-specific HTTP 400 bad request error response
    response_http401:
      title: response_http401
      type: object
      properties:
        detail:
          type: string
          description: Human-readable explanation of the authentication error
          examples:
          - Authentication credentials were not provided.
      description: Standard HTTP 401 authentication error response
    response_http403:
      title: response_http403
      type: object
      properties:
        detail:
          type: string
          description: Human-readable explanation of the permission error
          examples:
          - You do not have permission to perform this action.
      description: Standard HTTP 403 permission error response
    response_http404:
      title: response_http404
      type: object
      properties:
        id:
          type: string
          description: Missing resource identifier, when the API includes one
      description: Standard HTTP 404 not found error response
    response_http429:
      title: response_http429
      type: object
      properties:
        detail:
          type: string
          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
      description: Standard HTTP 429 rate limit error response
    response_insight_rogue:
      title: response_insight_rogue
      required:
      - end
      - limit
      - results
      - start
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp for the end of the rogue AP insight window
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of rogue or neighbor AP observations returned in this page
          contentEncoding: int32
        next:
          type: string
          description: Pagination cursor or URL for retrieving the next page of rogue or neighbor AP observations; null when no next page exists
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/insight_rogue_ap'
          description: Rogue or neighbor AP observations returned for the site insight query
        start:
          type: integer
          description: Epoch timestamp for the start of the rogue AP insight window
          contentEncoding: int32
      description: Paginated response for rogue or neighbor AP insight results
    response_insight_rogue_client:
      title: response_insight_rogue_client
      required:
      - end
      - limit
      - results
      - start
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp for the end of the rogue client insight window
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of rogue client observations returned in this page
          contentEncoding: int32
        next:
          type: string
          description: Pagination cursor or URL for retrieving the next page of rogue client observations
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/insight_rogue_client'
          description: Rogue client observations returned for the site insight query
        start:
          type: integer
          description: Epoch timestamp for the start of the rogue client insight window
          contentEncoding: int32
      description: Paginated response for rogue client insight results
    response_inventory:
      title: response_inventory
      type: object
      properties:
        added:
          type: array
          items:
            type: string
          description: Claim codes accepted into organization inventory
        duplicated:
          type: array
          items:
            type: string
          description: Claim codes already present in organization inventory
        error:
          type: array
          items:
            type: string
          description: Claim codes rejected by the inventory add operation
        inventory_added:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/response_inventory_inventory_added_items'
          description: Detailed inventory records added by the claim operation
        inventory_duplicated:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/response_inventory_inventory_duplicated_items'
          description: Detailed inventory records already present during the claim operation
        reason:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Error reasons for claim codes that could not be added
      description: Result of adding device claim codes to organization inventory
    response_inventory_inventory_added_items:
      title: response_inventory_inventory_added_items
      required:
      - mac
      - magic
      - model
      - serial
      - type
      type: object
      properties:
        mac:
          type: string
          description: Device MAC address for the claimed inventory item
          examples:
          - 5c5b35000018
        magic:
          type: string
          description: Activation code or claim code associated with the inventory item
          examples:
          - 6JG8EPTFV2A9Z2N
        model:
          type: string
          description: Device model for the claimed inventory item
          examples:
          - AP41
        serial:
          type: string
          description: Device serial number for the claimed inventory item
          examples:
          - FXLH2015150025
        type:
          type: string
          description: Device type for the claimed inventory item
          examples:
          - ap
      description: Inventory device added by the claim operation
    response_inventory_inventory_duplicated_items:
      title: response_inventory_inventory_duplicated_items
      required:
      - mac
      - magic
      - model
      - serial
      - type
      type: object
      properties:
        mac:
          type: string
          description: Device MAC address for the duplicate inventory item
          examples:
          - 5c5b35000012
        magic:
          type: string
          description: Activation code or claim code associated with the duplicate inventory item
          examples:
          - DVH4VSNMSZPDXBR
        model:
          type: string
          description: Device model for the duplicate inventory item
          examples:
          - AP41
        serial:
          type: string
          description: Device serial number for the duplicate inventory item
          examples:
          - FXLH2015150027
        type:
          type: string
          description: Device type for the duplicate inventory item
          examples:
          - ap
      description: Inventory device already present during the claim operation
    response_iot_endpoints_search:
      title: response_iot_endpoints_search
      required:
      - end
      - results
      - start
      - total
      type: object
      properties:
        end:
          type: number
          description: Epoch timestamp, in seconds, for the end of the IoT endpoint search window
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/iotendpoint_stats'
          description: IoT endpoint statistics matching the search filters
        start:
          type: number
          description: Epoch timestamp, in seconds, for the start of the IoT endpoint search window
        total:
          type: integer
          description: Number of IoT endpoint records matching the search filters
          contentEncoding: int32
      description: Time-bounded response for IoT endpoint search results
    response_location_coverage:
      title: response_location_coverage
      required:
      - beams_means
      - end
      - gridsize
      - result_def
      - results
      - start
      type: object
      properties:
        beams_means:
          type: array
          items:
            type: array
            items:
              type: number
          description: Grid beam mean samples as [x, y, mean] values for the coverage view
        end:
          type: integer
          description: Epoch timestamp for the end of the coverage analysis window
          contentEncoding: int32
        gridsize:
          type: number
          description: Grid cell size in meters for coverage samples
        result_def:
          type: array
          items:
            type: string
          description: Column names describing each value position in the coverage result rows
        results:
          type: array
          items:
            type: array
            items:
              type: number
          description: Coverage result rows whose values follow the `result_def` column order
        start:
          type: integer
          description: Epoch timestamp for the start of the coverage analysis window
          contentEncoding: int32
      description: Beam coverage overview for a site location map
    response_log_search:
      title: response_log_search
      required:
      - end
      - limit
      - results
      - start
      - total
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp for the end of the audit log search window
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of audit log events returned in this page
          contentEncoding: int32
        next:
          type: string
          description: Pagination cursor or URL for retrieving the next page of audit log events
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/log_event'
          description: Audit log events matching the search filters
        start:
          type: integer
          description: Epoch timestamp for the start of the audit log search window
          contentEncoding: int32
        total:
          type: integer
          description: Number of audit log events matching the search filters across all pages
          contentEncoding: int32
      description: Paginated response for audit log search results
    response_login_failure:
      title: response_login_failure
      required:
      - detail
      type: object
      properties:
        detail:
          type: string
          description: Human-readable login failure message returned by the API
        forward_url:
          type: string
          description: SSO URL where the user should continue login, when provided
      description: Login failure response returned when authentication cannot continue locally
    response_login_lookup:
      title: response_login_lookup
      type: object
      properties:
        sso_url:
          type: string
          description: URL for SSO login when the account must authenticate through an identity provider
      description: Login lookup response indicating whether SSO is available for the account
    response_login_oauth_url:
      title: response_login_oauth_url
      required:
      - authorization_url
      - client_id
      type: object
      properties:
        authorization_url:
          type: string
          description: OAuth2 provider authorization URL to open for login
        client_id:
          type: string
          description: OAuth2 client identifier used for the authorization request
      description: OAuth2 authorization URL response for login
    response_login_success:
      title: response_login_success
      type: object
      properties:
        email:
          type: string
          description: Admin email address for a login flow that requires two-factor authentication
        two_factor_passed:
          type: boolean
          description: Whether the supplied two-factor code has been accepted for this login
        two_factor_required:
          type: boolean
          description: Whether this login requires a two-factor code before a session is established
      description: Login response body, empty on normal success or populated with two-factor state
    response_logout:
      title: response_logout
      type: object
      properties:
        forward_url:
          type: string
          description: If configured in SSO as custom_logout_url
      description: Logout response with optional SSO forwarding URL
    response_map_import:
      title: response_map_import
      required:
      - aps
      - floorplans
      - site_id
      - summary
      type: object
      properties:
        aps:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/response_map_import_ap'
          description: AP placement results produced by the map import
        floorplans:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/response_map_import_floorplan'
          description: Floorplan import results produced by the map import
        for_site:
          type: boolean
          description: Whether this map import response is scoped to a site
          readOnly: true
        site_id:
          type: string
          description: Site associated with the map import result
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        summary:
          allOf:
          - $ref: '#/components/schemas/response_map_import_summary'
          - description: Counts summarizing assignments made during the map import
      description: Result of importing map files and matching AP placements
    response_map_import_ap:
      title: response_map_import_ap
      required:
      - action
      - floorplan_id
      - mac
      - map_id
      - orientation
      type: object
      properties:
        action:
          allOf:
          - $ref: '#/components/schemas/response_map_import_ap_action2'
          - description: 'Import action applied to this AP. enum: `assigned-named-placed`, `assigned-placed`, `ignored`, `named-placed`, `placed`.'
        floorplan_id:
          type: string
          description: Floorplan identifier where the AP placement was imported
          contentEncoding: uuid
        height:
          type: number
          description: Mounting height for the AP on the imported floorplan
        mac:
          type: string
          description: AP MAC address matched from the import file
        map_id:
          type: string
          description: Map identifier associated with the imported AP placement
          contentEncoding: uuid
        orientation:
          type: integer
          description: AP orientation in degrees on the imported floorplan
          contentEncoding: int32
        reason:
          type: string
          description: Explanation of why the AP import action was not completed, when provided
      description: AP placement result from a map import
    response_map_import_ap_action:
      title: response_map_import_ap_action
      enum:
      - assigned-named-placed
      - assigned-placed
      - ignored
      - named-placed
      - placed
      type: string
      description: 'enum: `assigned-named-placed`, `assigned-placed`, `ignored`, `named-placed`, `placed`'
    response_map_import_floorplan:
      title: response_map_import_floorplan
      required:
      - action
      - id
      - map_id
      - name
      type: object
      properties:
        action:
          type: string
          description: Import action applied to this floorplan
        id:
          type: string
          description: Floorplan identifier returned by the import
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        map_id:
          type: string
          description: Map identifier associated with the imported floorplan
          contentEncoding: uuid
        name:
          type: string
          description: Floorplan name imported from the map file
        reason:
          type: string
          description: Explanation of why the floorplan import action was not completed, when provided
      description: Floorplan result from a map import
    response_map_import_summary:
      title: response_map_import_summary
      required:
      - num_ap_assigned
      - num_inv_assigned
      - num_map_assigned
      type: object
      properties:
        num_ap_assigned:
          type: integer
          description: Number of AP placements assigned during the map import
          contentEncoding: int32
        num_inv_assigned:
          type: integer
          description: Number of inventory records assigned to the site during the map import
          contentEncoding: int32
        num_map_assigned:
          type: integer
          description: Number of map floorplans assigned during the map import
          contentEncoding: int32
      description: Counts summarizing assignments made during the map import
    response_mobile_verify_secret:
      title: response_mobile_verify_secret
      required:
      - name
      - org_id
      - secret
      type: object
      properties:
        name:
          type: string
          description: Organization display name associated with the verified SDK invite
        org_id:
          type: string
          description: Organization identifier associated with the verified SDK invite
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        secret:
          type: string
          description: Device-specific secret returned for mobile SDK activation
          contentEncoding: password
      description: Mobile SDK invite verification response
    response_msp_inventory_device:
      title: response_msp_inventory_device
      required:
      - mac
      - model
      - org_id
      - serial
      - site_id
      - type
      type: object
      properties:
        for_site:
          type: boolean
          description: Whether this inventory device is associated with a site
          readOnly: true
        mac:
          type: string
          description: Device MAC address for the inventory device
          readOnly: true
        model:
          type: string
          description: Device model for the inventory device
          readOnly: true
        org_id:
          type: string
          description: Organization that owns this inventory device
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        serial:
          type: string
          description: Device serial number for the inventory device
          readOnly: true
        site_id:
          type: string
          description: Site identifier for the inventory device
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        type:
          type: string
          description: Device type for the inventory device
          readOnly: true
      description: Inventory device record returned by MSP device MAC lookup
    response_mxedge_events_search:
      title: response_mxedge_events_search
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp for the end of the Mist Edge event search window
          contentEncoding: int32
          examples:
          - 1694708579
        limit:
          type: integer
          description: Maximum number of Mist Edge event records returned in this page
          contentEncoding: int32
          examples:
          - 10
        next:
          type: string
          description: Pagination cursor or URL for retrieving the next page of Mist Edge event records
        page:
          type: integer
          description: Returned page number for Mist Edge event records
          contentEncoding: int32
          examples:
          - 3
        results:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/mxedge_event'
          description: Mist Edge event records matching the search filters
        start:
          type: integer
          description: Epoch timestamp for the start of the Mist Edge event search window
          contentEncoding: int32
          examples:
          - 1694622179
      description: Search response for Mist Edge event records
    response_mxedge_search:
      title: response_mxedge_search
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp for the end of the Mist Edge search window
          contentEncoding: int32
          examples:
          - 1694708579
        limit:
          type: integer
          description: Maximum number of Mist Edge records returned in this page
          contentEncoding: int32
          examples:
          - 10
        next:
          type: string
          description: Pagination cursor or URL for retrieving the next page of Mist Edge records
        results:
          type: array
          items:
            $ref: '#/components/schemas/search_mxedge'
          description: Mist Edge records matching the search filters
        start:
          type: integer
          description: Epoch timestamp for the start of the Mist Edge search window
          contentEncoding: int32
          examples:
          - 1694622179
        total:
          type: integer
          description: Number of Mist Edge records matching the search filters across all pages
          contentEncoding: int32
          examples:
          - 2
      description: Search response for Mist Edge records
    search_mxedge:
      title: search_mxedge
      type: object
      properties:
        distro:
          type: string
          description: Linux distribution codename running on the Mist Edge
        last_seen:
          type: number
          description: Time when the Mist Edge was last observed, in epoch seconds
        model:
          type: string
          description: Mist Edge hardware or VM model
          examples:
          - ME-VM
        mxcluster_id:
          type: string
          description: Cluster identifier associated with the Mist Edge
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        mxedge_id:
          type: string
          description: Mist Edge identifier for the search record
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        name:
          type: string
          description: Display name of the Mist Edge
          examples:
          - me-vm-1
        org_id:
          type: string
          description: Organization identifier associated with the Mist Edge
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        site_id:
          type: string
          description: Site identifier associated with the Mist Edge, when assigned to a site
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        tunterm_version:
          type: string
          description: Tunnel termination service version running on the Mist Edge
        uptime:
          type: integer
          description: Number of seconds the Mist Edge has been running since last boot
          contentEncoding: int32
      description: Mist Edge record returned by search APIs
    response_mxedge_upgrade:
      title: response_mxedge_upgrade
      required:
      - channel
      - counts
      - id
      - status
      - strategy
      - versions
      type: object
      properties:
        channel:
          minLength: 1
          type: string
          description: Upgrade channel used to select Mist Edge package versions
        counts:
          allOf:
          - $ref: '#/components/schemas/mxedge_upgrade_response_counts1'
          - description: Per-status counts of Mist Edge targets in this upgrade
        id:
          type: string
          description: Upgrade identifier for this Mist Edge upgrade request
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        status:
          minLength: 1
          type: string
          description: Current status of the Mist Edge upgrade
        strategy:
          minLength: 1
          type: string
          description: Rollout strategy used for the Mist Edge upgrade
        versions:
          type: object
          description: Per-service target versions for this Mist Edge upgrade
      description: Mist Edge upgrade details response
    response_mxtunnels_preempt_aps:
      title: response_mxtunnels_preempt_aps
      required:
      - preempted_aps
      type: object
      properties:
        preempted_aps:
          uniqueItems: true
          type: array
          items:
            type: string
          description: AP identifiers moved to the preferred MxTunnel peer
      description: Result of preempting APs onto preferred MxTunnel peers
    response_nac_crl_files:
      title: response_nac_crl_files
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/nac_crl_file'
          description: Uploaded NAC CRL files for the organization
      description: Response containing uploaded NAC CRL file metadata
    response_org_devices:
      title: response_org_devices
      required:
      - results
      type: object
      properties:
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/org_device'
          description: Device records returned by the organization device list operation
      description: Response containing organization device records
    response_org_devices_summary:
      title: response_org_devices_summary
      type: object
      properties:
        num_aps:
          type: integer
          description: Number of APs in the organization
          contentEncoding: int32
          readOnly: true
        num_gateways:
          type: integer
          description: Number of gateways in the organization
          contentEncoding: int32
          readOnly: true
        num_mxedges:
          type: integer
          description: Number of Mist Edges in the organization
          contentEncoding: int32
          readOnly: true
        num_switches:
          type: integer
          description: Number of switches in the organization
          contentEncoding: int32
          readOnly: true
        num_unassigned_aps:
          type: integer
          description: Number of APs in organization inventory that are not assigned to a site
          contentEncoding: int32
          readOnly: true
        num_unassigned_gateways:
          type: integer
          description: Number of gateways in organization inventory that are not assigned to a site
          contentEncoding: int32
          readOnly: true
        num_unassigned_switches:
          type: integer
          description: Number of switches in organization inventory that are not assigned to a site
          contentEncoding: int32
          readOnly: true
      description: Organization device count summary
    response_org_inventory_change:
      title: response_org_inventory_change
      required:
      - error
      - op
      - reason
      - success
      type: object
      properties:
        error:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Device identifiers that failed during the inventory operation
        op:
          allOf:
          - $ref: '#/components/schemas/response_org_inventory_change_op2'
          - description: 'Inventory operation applied to the requested device identifiers. enum: `assign`, `delete`, `downgrade_to_jsi`, `unassign`, `upgrade_to_mist`.'
        reason:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Failure reasons corresponding to entries in the error list
        success:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Device identifiers successfully processed by the inventory operation
      description: Result of an organization inventory assignment or deletion operation
    response_org_inventory_change_op:
      title: response_org_inventory_change_op
      enum:
      - assign
      - delete
      - downgrade_to_jsi
      - unassign
      - upgrade_to_mist
      type: string
      description: 'enum: `assign`, `delete`, `downgrade_to_jsi`, `unassign`, `upgrade_to_mist`'
    response_org_search:
      title: response_org_search
      required:
      - end
      - limit
      - results
      - start
      - total
      type: object
      properties:
        end:
          type: number
          description: Epoch timestamp, in seconds, for the end of the organization search window
          readOnly: true
        limit:
          type: integer
          description: Maximum number of organization records returned in this page
          contentEncoding: int32
          readOnly: true
        next:
          type: string
          description: URL for retrieving the next page of organization search results
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/response_org_search_item'
          description: Organization records matching the MSP search filters
        start:
          type: number
          description: Epoch timestamp, in seconds, for the start of the organization search window
          readOnly: true
        total:
          type: integer
          description: Number of organization records matching the search filters across all pages
          contentEncoding: int32
          readOnly: true
      description: Paginated response for MSP organization search results
    response_org_search_item:
      title: response_org_search_item
      type: object
      properties:
        msp_id:
          type: string
          description: MSP that owns or manages this organization
          contentEncoding: uuid
          readOnly: true
          examples:
          - b9d42c2e-88ee-41f8-b798-f009ce7fe909
        name:
          type: string
          description: Display name of the organization
          readOnly: true
        num_aps:
          type: integer
          description: Number of APs in the organization
          contentEncoding: int32
          readOnly: true
        num_gateways:
          type: integer
          description: Number of gateways in the organization
          contentEncoding: int32
          readOnly: true
        num_sites:
          type: integer
          description: Number of sites in the organization
          contentEncoding: int32
          readOnly: true
        num_switches:
          type: integer
          description: Number of switches in the organization
          contentEncoding: int32
          readOnly: true
        num_unassigned_aps:
          type: integer
          description: Number of APs in organization inventory that are not assigned to a site
          contentEncoding: int32
          readOnly: true
        org_id:
          type: string
          description: Organization identifier for this search result
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        sub_ana_entitled:
          type: integer
          description: Number of SUB-ANA subscriptions entitled for the organization
          contentEncoding: int32
          readOnly: true
        sub_ana_required:
          type: integer
          description: Number of SUB-ANA subscriptions required by the organization
          contentEncoding: int32
          readOnly: true
        sub_ast_entitled:
          type: integer
          description: Number of SUB-AST subscriptions entitled for the organization
          contentEncoding: int32
          readOnly: true
        sub_ast_required:
          type: integer
          description: Number of SUB-AST subscriptions required by the organization
          contentEncoding: int32
          readOnly: true
        sub_eng_entitled:
          type: integer
          description: Number of SUB-ENG subscriptions entitled for the organization
          contentEncoding: int32
          readOnly: true
        sub_eng_required:
          type: integer
          description: Number of SUB-ENG subscriptions required by the organization
          contentEncoding: int32
          readOnly: true
        sub_ex12_required:
          type: integer
          description: Number of SUB-EX12 subscriptions required by the organization
          contentEncoding: int32
          readOnly: true
        sub_insufficient:
          type: boolean
          description: If this org has sufficient subscription
          readOnly: true
        sub_man_entitled:
          type: integer
          description: Number of SUB-MAN subscriptions entitled for the organization
          contentEncoding: int32
          readOnly: true
        sub_man_required:
          type: integer
          description: Number of SUB-MAN subscriptions required by the organization
          contentEncoding: int32
          readOnly: true
        sub_me_entitled:
          type: integer
          description: Number of SUB-ME subscriptions entitled for the organization
          contentEncoding: int32
          readOnly: true
        sub_vna_entitled:
          type: integer
          description: Number of SUB-VNA subscriptions entitled for the organization
          contentEncoding: int32
          readOnly: true
        sub_vna_required:
          type: integer
          description: Number of SUB-VNA subscriptions required by the organization
          contentEncoding: int32
          readOnly: true
        timestamp:
          type: number
          description: Epoch timestamp, in seconds, when the organization search data was sampled
          readOnly: true
        trial_enabled:
          type: boolean
          description: If this org is under trial period
          readOnly: true
        usage_types:
          type: array
          items:
            type: string
          description: Subscription usage types enabled for the organization
          readOnly: true
      description: Organization record returned by MSP organization search
    response_org_suppress_alarm:
      title: response_org_suppress_alarm
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/response_org_suppress_alarm_item'
          description: Suppressed alarm entries currently configured for the organization
      description: Response containing currently suppressed organization alarm entries
    response_org_suppress_alarm_item:
      title: response_org_suppress_alarm_item
      type: object
      properties:
        duration:
          type: integer
          description: Number of seconds that alarms remain suppressed. Maximum duration is 86400 * 14 (14 days). Use 0 to remove suppression.
          contentEncoding: int32
        expire_time:
          type: integer
          description: Epoch timestamp, in seconds, when the alarm suppression expires
          contentEncoding: int32
        scheduled_time:
          type: integer
          description: Epoch timestamp, in seconds, when the alarm suppression starts
          contentEncoding: int32
        scope:
          allOf:
          - $ref: '#/components/schemas/suppressed_alarm_scope3'
          - description: 'Alarm suppression scope, either organization-wide or site-specific. enum: `org`, `site`.'
        site_id:
          type: string
          description: Site identifier for a site-scoped alarm suppression entry
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
      description: Suppressed alarm entry for an organization or site alarm scope
    response_org_system_events_search:
      title: response_org_system_events_search
      required:
      - end
      - limit
      - results
      - start
      - total
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp, in seconds, for the end of the system event search window
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of system event records returned in this page
          contentEncoding: int32
        next:
          type: string
          description: URL for retrieving the next page of system event search results
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/org_system_event'
          description: Organization system event records matching the search filters
        start:
          type: integer
          description: Epoch timestamp, in seconds, for the start of the system event search window
          contentEncoding: int32
        total:
          type: integer
          description: Number of system event records matching the search filters across all pages
          contentEncoding: int32
      description: Paginated response for organization system event search results
    response_past_spectrum_analysis:
      title: response_past_spectrum_analysis
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp, in seconds, for the end of the spectrum analysis query window
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of spectrum analysis records returned in this page
          contentEncoding: int32
        page:
          type: integer
          description: Current page number returned for the spectrum analysis results
          contentEncoding: int32
        results:
          type: array
          items:
            $ref: '#/components/schemas/response_past_spectrum_analysis_result'
          description: Spectrum analysis records for the requested site and time window
        start:
          type: integer
          description: Epoch timestamp, in seconds, for the start of the spectrum analysis query window
          contentEncoding: int32
        total:
          type: integer
          description: Number of spectrum analysis records available for the given time range
          contentEncoding: int32
      description: Paginated response for past site spectrum analysis records
    response_past_spectrum_analysis_channel_usage:
      title: response_past_spectrum_analysis_channel_usage
      type: object
      properties:
        channel:
          type: integer
          description: Radio channel measured by this channel usage sample
          contentEncoding: int32
          examples:
          - 36
        noise:
          type: number
          description: Measured noise floor, in dBm, for the channel
          examples:
          - -90
        non_wifi:
          type: number
          description: Percentage of channel usage by non-WiFi signals in the range [0, 1]
          examples:
          - 0.87
        wifi:
          type: number
          description: Percentage of channel usage by WiFi in the range [0, 1]
          examples:
          - 0.13
      description: Channel usage data for a specific channel
    response_past_spectrum_analysis_fft_sample:
      title: response_past_spectrum_analysis_fft_sample
      type: object
      properties:
        frequency:
          type: number
          description: Sample frequency, in MHz, for this FFT point
          examples:
          - 2437
        rssi:
          type: number
          description: Received signal strength, in dBm, for this FFT sample
          examples:
          - -70
        signal7:
          type: number
          description: Additional signal level, in dBm, reported for this FFT sample
          examples:
          - -70
      description: FFT sample data for a specific frequency
    response_past_spectrum_analysis_result:
      title: response_past_spectrum_analysis_result
      type: object
      properties:
        band:
          type: string
          description: Radio band on which the spectrum analysis was run (for example, 24, 5, or 6)
        channel_usage:
          type: array
          items:
            $ref: '#/components/schemas/response_past_spectrum_analysis_channel_usage'
          description: Per-channel utilization measurements captured during the analysis
        fft_samples:
          type: array
          items:
            $ref: '#/components/schemas/response_past_spectrum_analysis_fft_sample'
          description: FFT signal samples captured during the analysis
        mac:
          type: string
          description: AP MAC address for the access point that ran the spectrum analysis
        org_id:
          type: string
          description: Organization that owns the site where the spectrum analysis was run
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        spectrogram_url:
          type: string
          description: URL to the generated spectrogram image for the spectrum analysis
        timestamp:
          type: integer
          description: Epoch timestamp, in seconds, when the spectrum analysis was run
          contentEncoding: int32
      description: Result of a past spectrum analysis
    response_pcap_ap:
      title: response_pcap_ap
      type: object
      properties:
        band:
          type: integer
          description: Radio band used for the AP packet capture
          contentEncoding: int32
        bandwidth:
          type: integer
          description: Channel bandwidth used for the AP packet capture, in MHz
          contentEncoding: int32
        channel:
          type: integer
          description: Radio channel used for the AP packet capture
          contentEncoding: int32
        tcpdump_expression:
          type:
          - string
          - 'null'
          description: Tcpdump filter expression applied to the AP packet capture, or null when no filter is applied
      description: AP radio settings used for a packet capture
    response_pcap_bucket_config:
      title: response_pcap_bucket_config
      type: object
      properties:
        bucket:
          type: string
          description: Custom bucket name used for packet capture storage
        detail:
          type: string
          description: Status or error detail returned for the bucket operation
      description: Result of a custom packet capture bucket setup or verification operation
    response_pcap_search:
      title: response_pcap_search
      required:
      - end
      - limit
      - results
      - start
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp, in seconds, for the end of the packet capture search window
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of packet capture records returned in this page
          contentEncoding: int32
        next:
          type: string
          description: URL for retrieving the next page of packet capture search results
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/response_pcap_search_item'
          description: Packet capture records matching the search filters
        start:
          type: integer
          description: Epoch timestamp, in seconds, for the start of the packet capture search window
          contentEncoding: int32
        total:
          type: integer
          description: Number of packet capture records matching the search filters across all pages
          contentEncoding: int32
      description: Paginated response for packet capture search results
    response_pcap_search_item:
      title: response_pcap_search_item
      required:
      - timestamp
      - type
      - url
      type: object
      properties:
        ap_macs:
          uniqueItems: true
          type: array
          items:
            type: string
          description: AP MAC addresses associated with the packet capture
        aps:
          type: array
          items:
            type: string
          description: AP MAC addresses included in the packet capture
        duration:
          type: number
          description: Packet capture duration in seconds
          examples:
          - 600
        format:
          type: string
          description: Output format requested for the packet capture
          examples:
          - stream
        id:
          type: string
          description: Unique identifier for the packet capture
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        last_seen:
          type: number
          description: Last seen timestamp of the capture
          examples:
          - 1693482149.417
        max_num_packets:
          type: number
          description: Maximum number of packets requested for the capture
          examples:
          - 1024
        mxedges:
          type: array
          items:
            type: string
          description: List of Mist Edge IDs included in the capture
        org_id:
          type: string
          description: Organization associated with the packet capture
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        pcap_aps:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/response_pcap_search_item_pcap_aps_item'
          description: Per-AP radio capture settings keyed by AP MAC address
          examples:
          - 5c5b35000010:
              band: '6'
              bandwidth: '20'
              channel: 133
              tcpdump_expression: null
        pcap_url:
          type: string
          description: URL for downloading the generated PCAP file
        site_id:
          type:
          - string
          - 'null'
          description: Site associated with the packet capture, when the capture is site-scoped
          contentEncoding: uuid
        termination_reason:
          type: string
          description: Reason the packet capture session ended
          examples:
          - default
        timestamp:
          type: number
          description: Epoch timestamp, in seconds, when the packet capture record was created
          readOnly: true
        type:
          type: string
          description: Packet capture type represented by this record
        url:
          type: string
          description: Link for accessing the packet capture output or stream
      description: Packet capture record returned by organization or site packet capture search
    response_pcap_search_item_pcap_aps_item:
      title: response_pcap_search_item_pcap_aps_item
      type: object
      properties:
        band:
          type: string
          description: Radio band used for this AP capture
        bandwidth:
          type: string
          description: Channel bandwidth used for this AP capture, in MHz
        channel:
          type: integer
          description: Radio channel used for this AP capture
          contentEncoding: int32
        tcpdump_expression:
          type:
          - string
          - 'null'
          description: Tcpdump filter expression applied to this AP capture, or null when no filter is applied
      description: AP radio settings captured for a packet capture record
    response_pcap_start:
      title: response_pcap_start
      required:
      - id
      - org_id
      - site_id
      - timestamp
      - type
      type: object
      properties:
        ap_count:
          type: integer
          description: Number of APs targeted by the packet capture
          contentEncoding: int32
        aps:
          uniqueItems: true
          type: array
          items:
            type: string
          description: AP MAC addresses targeted by the packet capture
        client_mac:
          type:
          - string
          - 'null'
          description: Client MAC address filter applied to the packet capture, or null when no client filter is used
        duration:
          type: number
          description: Packet capture duration in seconds
        enabled:
          type: boolean
          description: Whether the packet capture session is enabled after the start request
        expiry:
          type: number
          description: Epoch timestamp, in seconds, when the capture session expires
        format:
          type: string
          description: Output format for packet capture data
        id:
          type: string
          description: Unique identifier for the packet capture session
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        include_mcast:
          type: boolean
          description: Whether multicast traffic is included in the packet capture
        max_pkt_len:
          type: integer
          description: Maximum number of bytes captured from each packet
          contentEncoding: int32
        num_packets:
          type: integer
          description: Maximum number of packets to capture; use 0 for unlimited
          contentEncoding: int32
        org_id:
          type: string
          description: Organization associated with the packet capture session
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        raw:
          type: boolean
          description: Whether raw packet data is included in the capture output
        site_id:
          type:
          - string
          - 'null'
          description: Site associated with the packet capture session, when site-scoped
          contentEncoding: uuid
        ssid:
          type:
          - string
          - 'null'
          description: Wireless network SSID filter applied to the packet capture, or null when no SSID filter is used
        tcpdump_parser_expression:
          type:
          - string
          - 'null'
          description: Tcpdump parser expression applied to the packet capture, or null when no parser expression is used
        timestamp:
          type: number
          description: Epoch timestamp, in seconds, when the packet capture session was created
          readOnly: true
        type:
          type: string
          description: Packet capture type requested by the start operation
      description: Packet capture session created by a start request
    response_pcap_status:
      title: response_pcap_status
      required:
      - id
      - type
      type: object
      properties:
        ap_mac:
          type:
          - string
          - 'null'
          description: AP MAC address targeted by the packet capture, or null when no single AP filter is set
        aps:
          type: array
          items:
            type: string
          description: AP MAC addresses targeted by the packet capture
        client_mac:
          type:
          - string
          - 'null'
          description: Client MAC address filter applied to the packet capture, or null when no client filter is used
          examples:
          - 60a10a773412
        duration:
          type: integer
          description: Configured packet capture duration, in seconds
          contentEncoding: int32
          examples:
          - 300
        enabled:
          type: boolean
          description: Whether the packet capture session is currently enabled
        expiry:
          type: number
          description: Epoch timestamp, in seconds, when the capture session expires
          examples:
          - 1695838060.309526
        failed:
          type: array
          items:
            type: string
          description: AP MAC addresses where capture configuration failed
        format:
          allOf:
          - $ref: '#/components/schemas/capture_mxedge_format2'
          - description: 'Output format for packet capture data. enum: `stream`, `tzsp`.'
        gateways:
          type: array
          items:
            type: string
          description: Gateway devices included in the packet capture session
        id:
          type: string
          description: Unique identifier for the packet capture session
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        includes_mcast:
          type: boolean
          description: Whether multicast traffic is included in the packet capture
        invalid_mxedges:
          type: object
          description: Map of Mist Edge IDs that could not be configured for capture
        max_num_packets:
          type: integer
          description: Max number of packets configured by user
          contentEncoding: int32
          examples:
          - 1000
        max_pkt_len:
          type: integer
          description: Maximum number of bytes captured from each packet
          contentEncoding: int32
          examples:
          - 512
        mxedge_count:
          type: integer
          description: Number of Mist Edges in the capture session
          contentEncoding: int32
        mxedges:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/response_pcap_status_mxedges_item'
          description: Mist Edge capture settings keyed by Mist Edge ID
        num_packets:
          type: integer
          description: total number of packets captured by all AP, not applicable for type [client, new_assoc]
          contentEncoding: int32
        ok:
          type: array
          items:
            type: string
          description: AP MAC addresses successfully configured for packet capture
        org_id:
          type: string
          description: Organization associated with the packet capture session
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        pcap_aps:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/response_pcap_ap'
          description: Per-AP radio capture settings keyed by AP MAC address
          examples:
          - 5c5b35000010:
              band: 6
              bandwidth: 20
              channel: 133
              tcpdump_expression: null
        radiotap_tcpdump_expression:
          type: string
          description: When `type`==`radiotap`, radiotap_tcpdump_expression expression provided by the user
        raw:
          type: boolean
          description: Whether raw packet data is included in the capture output
        scan_tcpdump_expression:
          type: string
          description: When `type`==`scan`, scan_tcpdump_expression provided by the user
        site_id:
          type: string
          description: Site associated with the packet capture session, when site-scoped
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        ssid:
          type:
          - string
          - 'null'
          description: Wireless network SSID filter applied to the packet capture, or null when no SSID filter is used
        started_time:
          type: integer
          description: Epoch timestamp, in seconds, when the capture session started
          contentEncoding: int32
          examples:
          - 1435080709
        switches:
          type: array
          items:
            type: string
          description: Switch devices included in the packet capture session
        tcpdump_expression:
          type: string
          description: tcpdump expression provided by the user (common)
        timestamp:
          type: number
          description: Epoch timestamp, in seconds, when the packet capture status was reported
          readOnly: true
        type:
          allOf:
          - $ref: '#/components/schemas/pcap_type1'
          - description: 'Packet capture type for the current session. enum: `client`, `gateway`, `new_assoc`, `radiotap`, `radiotap,wired`, `wired`, `wireless`.'
            examples:
            - client
        tzsp_host:
          type: string
          description: Required if `format`==`tzsp`. Remote host accessible to Mist Edges over the network for receiving the captured packets.
          examples:
          - 192.168.1.2
        tzsp_port:
          maximum: 65535
          minimum: 1
          type: integer
          description: If `format`==`tzsp`. Port on remote host for receiving the captured packets
          contentEncoding: int32
        wired_tcpdump_expression:
          type: string
          description: When `type`==`wired`, wired_tcpdump_expression provided by the user
        wireless_tcpdump_expression:
          type: string
          description: When `type`==`‘wireless’`, wireless_tcpdump_expression provided by the user
      description: Current status of a packet capture session
    response_pcap_status_mxedges_item:
      title: response_pcap_status_mxedges_item
      type: object
      properties:
        interfaces:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/capture_mxedge_mxedges_interfaces'
          description: Dict of interfaces to capture on, property key is the port name
      description: Mist Edge interface settings for a packet capture
    response_port_stats_search:
      title: response_port_stats_search
      required:
      - limit
      - results
      - total
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp, in seconds, for the end of the port statistics reporting window
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of port statistics records returned in this page
          contentEncoding: int32
        next:
          type: string
          description: URL for retrieving the next page of port statistics search results
        results:
          type: array
          items:
            $ref: '#/components/schemas/stats_switch_port'
          description: Switch and gateway port statistics records matching the search filters
        start:
          type: integer
          description: Epoch timestamp, in seconds, for the start of the port statistics reporting window
          contentEncoding: int32
        total:
          type: integer
          description: Number of port statistics records matching the search filters across all pages
          contentEncoding: int32
      description: Paginated response for switch and gateway port statistics search results
    response_psk_portal_logs_search:
      title: response_psk_portal_logs_search
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp, in seconds, for the end of the PSK Portal log search window
          contentEncoding: int32
          examples:
          - 1428954000
        limit:
          type: integer
          description: Maximum number of PSK Portal log entries returned in this page
          contentEncoding: int32
          examples:
          - 100
        next:
          type: string
          description: URL for retrieving the next page of PSK Portal log search results
        results:
          type: array
          items:
            $ref: '#/components/schemas/response_psk_portal_logs_search_item'
          description: PSK Portal log entries matching the search filters
        start:
          type: integer
          description: Epoch timestamp, in seconds, for the start of the PSK Portal log search window
          contentEncoding: int32
          examples:
          - 1428939600
        total:
          type: integer
          description: Number of PSK Portal log entries matching the search filters across all pages
          contentEncoding: int32
          examples:
          - 135
      description: Paginated response for organization PSK Portal log search results
    response_psk_portal_logs_search_item:
      title: response_psk_portal_logs_search_item
      type: object
      properties:
        id:
          type: string
          description: Audit log identifier for this PSK Portal log entry
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        message:
          type: string
          description: Human-readable message describing the PSK Portal action
          examples:
          - Rotate PSK test@mist.com
        name_id:
          type: string
          description: SSO NameID value associated with the PSK Portal action
          examples:
          - test@mist.com
        org_id:
          type: string
          description: Organization associated with the PSK Portal log entry
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        psk_id:
          type: string
          description: Identifier of the PSK associated with the log entry
          contentEncoding: uuid
          examples:
          - 608fe603-f9f0-4ce9-9473-04ef6c6ea749
        psk_name:
          type: string
          description: Display name of the PSK associated with the log entry
          examples:
          - test@mist.com
        pskportal_id:
          type: string
          description: Identifier of the PSK Portal associated with the log entry
          contentEncoding: uuid
          examples:
          - c1742c09-af35-4161-96ef-7dc65c6d5674
        timestamp:
          type: number
          description: Epoch timestamp, in seconds, when the PSK Portal log entry was recorded
          readOnly: true
      description: PSK Portal log entry returned by organization log search
    response_router_ssr_register_cmd:
      title: response_router_ssr_register_cmd
      type: object
      properties:
        conductor_cmd:
          type: string
          description: Command to run in the SSR conductor CLI for Mist registration
        registration_code:
          type: string
          description: Registration token used by the SSR registration commands
        router_shell_cmd:
          type: string
          description: Shell command to run on the SSR router for Mist registration
      description: SSR registration token and commands used to register the router with Mist
    response_rrm_channel_scores:
      title: response_rrm_channel_scores
      required:
      - results
      type: object
      properties:
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/rrm_channel_score'
          description: Per-channel RRM score records for the requested band
      description: Response containing RRM channel score records
    rrm_channel_score:
      title: rrm_channel_score
      required:
      - channel
      - util_score
      - util_score_noise_floor
      - util_score_non_wifi
      - util_score_other
      - util_score_radar
      - util_score_undecodable_wifi
      - util_score_unknown_wifi
      type: object
      properties:
        channel:
          type: integer
          description: RF channel number represented by this score record
          contentEncoding: int32
        util_score:
          type: number
          description: Utilization score for the channel, 0-1, lower means cleaner RF
        util_score_noise_floor:
          type: number
          description: Score contribution from noise, 0-1, lower means cleaner RF
        util_score_non_wifi:
          type: number
          description: Score contribution from non-wifi utilization, 0-1, lower means cleaner RF
        util_score_other:
          type: number
          description: Score contribution from RxOtherBss utilization (wifi packets destined for other radios), 0-1, lower means cleaner RF
        util_score_radar:
          type: number
          description: Score contribution from radar detections, 0-1, lower means cleaner RF
        util_score_undecodable_wifi:
          type: number
          description: Score contribution from undecodable wifi utilization (wifi packets which can't be decoded), 0-1, lower means cleaner RF
        util_score_unknown_wifi:
          type: number
          description: Score contribution from unknown wifi utilization (wifi packets of unknown type), 0-1, lower means cleaner RF
      description: RRM utilization score for a channel
    response_rrm_consideration:
      title: response_rrm_consideration
      required:
      - results
      type: object
      properties:
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/rrm_consideration'
          description: Channel consideration metrics used by RRM for the AP radio band
      description: Response containing current RRM considerations for an AP radio band
    rrm_consideration:
      title: rrm_consideration
      required:
      - channel
      - noise
      - util_score
      - util_score_non_wifi
      - util_score_other
      type: object
      properties:
        channel:
          type: integer
          description: Candidate RF channel evaluated by RRM
          contentEncoding: int32
        noise:
          type: number
          description: Observed noise floor for the candidate channel, in dBm
        other_rssi:
          type: number
          description: Avg RSSI heard from other APs (that does NOT belongs to the same site)
        other_ssid:
          type: string
          description: SSID from other AP that we heard from with the max RSSI
        rssi:
          type: number
          description: Avg RSSI heard from APs (that belongs to the same site)
        util_score:
          type: number
          description: utilization score, 0-1, lower means less utilization (cleaner RF)
        util_score_non_wifi:
          type: number
          description: non-Wi-Fi utilization score, 0-1, lower means less utilization (cleaner RF)
        util_score_other:
          type: number
          description: other utilization score, 0-1, lower means less utilization (cleaner RF)
      description: RRM consideration metrics for one candidate channel
    response_rrm_neighbors:
      title: response_rrm_neighbors
      required:
      - end
      - limit
      - results
      - start
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp, in seconds, for the end of the RRM neighbor observation window
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of RRM neighbor records returned in this page
          contentEncoding: int32
        next:
          type: string
          description: Link to query next set of results. value is null if no next page exists.
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/rrm_neighbors'
          description: RRM neighbor records observed for the requested site and band
        start:
          type: integer
          description: Epoch timestamp, in seconds, for the start of the RRM neighbor observation window
          contentEncoding: int32
      description: Paginated response for current RRM neighbor observations
    rrm_neighbors:
      title: rrm_neighbors
      type: object
      properties:
        mac:
          type: string
          description: AP MAC address whose neighbors are reported
          examples:
          - 5c5b35000001
        neighbors:
          type: array
          items:
            $ref: '#/components/schemas/rrm_neighbors_neighbor'
          description: Neighbor AP observations heard by this AP
      description: RRM neighbor observations for one AP
    response_running_spectrum_analysis:
      title: response_running_spectrum_analysis
      type: object
      properties:
        band:
          type: string
          description: Radio band currently being scanned by spectrum analysis, such as 24, 5, or 6
        channels:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: List of channels being scanned in the spectrum analysis
        device_id:
          type: string
          description: Device ID of the AP that is running spectrum analysis
          contentEncoding: uuid
        duration:
          type: integer
          description: Length of the running spectrum analysis session, in seconds
          contentEncoding: int32
        format:
          type: string
          description: Output format for the running spectrum analysis data, such as json or stream
        started_time:
          type: integer
          description: Timestamp when the spectrum analysis was started
          contentEncoding: int32
        width:
          type: integer
          description: Channel width used during the spectrum analysis scan, in MHz
          contentEncoding: int32
      description: Running spectrum analysis session for a site
    response_search:
      title: response_search
      required:
      - limit
      - page
      - results
      - total
      type: object
      properties:
        limit:
          type: integer
          description: Maximum number of MSP search results returned in this page
          contentEncoding: int32
        next:
          type: string
          description: URL for retrieving the next page of MSP search results
        page:
          type: integer
          description: Current page number returned for the MSP search results
          contentEncoding: int32
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/response_search_item'
          description: MSP search result entries matching the query
        total:
          type: integer
          description: Number of MSP search results matching the query across all pages
          contentEncoding: int32
      description: Paginated response for MSP organization search results
    response_search_bgps:
      title: response_search_bgps
      type: object
      properties:
        end:
          type: number
          description: Epoch timestamp, in seconds, for the end of the BGP statistics search window
        limit:
          type: integer
          description: Maximum number of BGP peer statistics records returned in this page
          contentEncoding: int32
        next:
          type: string
          description: URL for retrieving the next page of BGP peer statistics results
        results:
          type: array
          items:
            $ref: '#/components/schemas/bgp_stats'
          description: BGP peer statistics records matching the search filters
        start:
          type: number
          description: Epoch timestamp, in seconds, for the start of the BGP statistics search window
        total:
          type: integer
          description: Number of BGP peer statistics records matching the search filters across all pages
          contentEncoding: int32
      description: Paginated response for BGP peer statistics search results
    response_search_item:
      title: response_search_item
      required:
      - id
      - text
      - type
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the matching MSP search result
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        text:
          type: string
          description: Display text for the MSP search result
        type:
          type: string
          description: Category of MSP search result, such as `orgs`
      description: MSP search result entry
    response_search_var:
      title: response_search_var
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp, in seconds, for the end of the variable search window
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of variable records returned in this page
          contentEncoding: int32
        next:
          type: string
          description: URL for retrieving the next page of variable search results
        results:
          type: array
          items:
            $ref: '#/components/schemas/response_search_var_item'
          description: Organization variable records matching the search filters
        start:
          type: integer
          description: Epoch timestamp, in seconds, for the start of the variable search window
          contentEncoding: int32
        total:
          type: integer
          description: Number of variable records matching the search filters across all pages
          contentEncoding: int32
      description: Paginated response for organization variable search results
    response_search_var_item:
      title: response_search_var_item
      type: object
      properties:
        created_time:
          type: number
          description: Timestamp when the organization variable was created
          readOnly: true
        modified_time:
          type: number
          description: Timestamp when the organization variable was last modified
          readOnly: true
        org_id:
          type: string
          description: Organization associated with the variable
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        site_id:
          type: string
          description: Site associated with the variable, when the source is site-scoped
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        src:
          type: string
          description: Source scope for the variable, such as `site` or `deviceprofile`
        var:
          type: string
          description: Name of the variable matched by the search
      description: Organization variable record returned by search
    response_self_audit_logs:
      title: response_self_audit_logs
      required:
      - end
      - limit
      - page
      - results
      - start
      - total
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp, in seconds, for the end of the self audit log search window
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of self audit log entries returned in this page
          contentEncoding: int32
        page:
          type: integer
          description: Current page number returned for self audit log results
          contentEncoding: int32
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/audit_log'
          description: Audit log entries for the current admin matching the filters
        start:
          type: integer
          description: Epoch timestamp, in seconds, for the start of the self audit log search window
          contentEncoding: int32
        total:
          type: integer
          description: Number of self audit log entries matching the filters across all pages
          contentEncoding: int32
      description: Paginated response for audit logs for the current admin across organizations
    response_self_oauth_link_failure:
      title: response_self_oauth_link_failure
      required:
      - error
      - error_description
      type: object
      properties:
        error:
          type: string
          description: OAuth2 error code returned during account linking
        error_description:
          type: string
          description: Human-readable description of the OAuth2 account-linking failure
      description: OAuth2 account-linking failure response
    response_self_oauth_link_success:
      title: response_self_oauth_link_success
      required:
      - action
      - id
      type: object
      properties:
        action:
          type: string
          description: Completed OAuth2 account-linking action
        id:
          type: string
          description: Linked OAuth2 account identifier returned by the provider
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
      description: OAuth2 account-linking success response
    response_self_oauth_url:
      title: response_self_oauth_url
      required:
      - authorization_url
      - linked
      type: object
      properties:
        authorization_url:
          type: string
          description: OAuth2 provider authorization URL used to link the Mist account
        linked:
          type: boolean
          description: Whether the Mist account is already linked with this OAuth2 provider
      description: OAuth2 authorization URL response for linking the current Mist account
    response_self_subscription:
      title: response_self_subscription
      required:
      - org_id
      type: object
      properties:
        org_id:
          type: string
          description: Organization associated with this subscription record
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
      description: Subscription record visible to the current account
    response_set_devices_map:
      title: response_set_devices_map
      type: object
      properties:
        locked:
          type: array
          items:
            type: string
          description: AP MAC addresses that were locked and not moved to the requested map
        moved:
          type: array
          items:
            type: string
          description: AP MAC addresses successfully associated with the requested map
      description: Result of assigning APs to a site map
    response_site_device_upgrade:
      title: response_site_device_upgrade
      required:
      - id
      type: object
      properties:
        canary_phases:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: Canary deployment phase percentages configured for the upgrade
          default:
          - 1
          - 10
          - 50
          - 100
        current_phase:
          type: integer
          description: Current canary or rrm phase in progress
          contentEncoding: int32
        enable_p2p:
          type: boolean
          description: Whether to allow local AP-to-AP FW upgrade
          default: false
        force:
          type: boolean
          description: Whether to force upgrade when requested version is same as running version
        id:
          type: string
          description: Unique identifier for the site device upgrade job
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        max_failure_percentage:
          type: integer
          description: Percentage of failures allowed
          contentEncoding: int32
        max_failures:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: Per-phase failure thresholds configured for a canary upgrade
        p2p_cluster_size:
          type: integer
          description: size to split the devices for p2p
          contentEncoding: int32
          default: 10
        p2p_parallelism:
          type: integer
          description: number of parallel p2p download batches to create
          contentEncoding: int32
          default: 1
        reboot_at:
          type: integer
          description: reboot start time in epoch
          contentEncoding: int32
        start_time:
          type: integer
          description: Firmware download start time in epoch
          contentEncoding: int32
        status:
          allOf:
          - $ref: '#/components/schemas/upgrade_device_status1'
          - description: 'Current status of the site device upgrade job. enum: `cancelled`, `completed`, `created`, `downloaded`, `downloading`, `failed`, `queued`, `upgrading`.'
        strategy:
          allOf:
          - $ref: '#/components/schemas/upgrade_device_strategy1'
          - description: 'Device upgrade strategy used by this job. enum: `big_bang`, `canary`, `rrm`, `serial`.'
        target_version:
          minLength: 1
          type: string
          description: Version to upgrade to
        targets:
          allOf:
          - $ref: '#/components/schemas/upgrade_devices_targets3'
          - description: Device targets grouped by upgrade and download status
          readOnly: true
        upgrade_plan:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
            description: Phase-to-device upgrade plan for non-big-bang strategies
          description: Phase-to-device upgrade plan for non-big-bang strategies
      description: Site device upgrade job details
    response_site_device_upgrades_item:
      title: response_site_device_upgrades_item
      required:
      - id
      type: object
      properties:
        counts:
          allOf:
          - $ref: '#/components/schemas/upgrade_site_devices_counts2'
          - description: Device counts grouped by upgrade status for this job
          readOnly: true
        current_phase:
          type: integer
          description: Current canary or rrm phase in progress
          contentEncoding: int32
        enable_p2p:
          type: boolean
          description: Whether to allow local AP-to-AP FW upgrade
        force:
          type: boolean
          description: Whether to force upgrade when requested version is same as running version
        id:
          type: string
          description: Unique identifier for the site device upgrade job
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        max_failure_percentage:
          type: integer
          description: Percentage of failures allowed
          contentEncoding: int32
        max_failures:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: Per-phase failure thresholds configured for a canary upgrade
        reboot_at:
          type: integer
          description: reboot start time in epoch
          contentEncoding: int32
        start_time:
          type: integer
          description: Firmware download start time in epoch
          contentEncoding: int32
        status:
          allOf:
          - $ref: '#/components/schemas/upgrade_device_status1'
          - description: 'Current status of the site device upgrade job. enum: `cancelled`, `completed`, `created`, `downloaded`, `downloading`, `failed`, `queued`, `upgrading`.'
        strategy:
          allOf:
          - $ref: '#/components/schemas/upgrade_device_strategy1'
          - description: 'Device upgrade strategy used by this job. enum: `big_bang`, `canary`, `rrm`, `serial`.'
        target_version:
          minLength: 1
          type: string
          description: Version to upgrade to
        upgrade_plan:
          type: object
          description: a dictionary of rrm phase number to devices part of that phase
      description: Site device upgrade job summary
    response_site_search:
      title: response_site_search
      required:
      - end
      - limit
      - results
      - start
      - total
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp, in seconds, for the end of the site search window
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of site records returned in this page
          contentEncoding: int32
        next:
          type: string
          description: URL for retrieving the next page of site search results
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/response_site_search_item'
          description: Site records matching the organization search filters
        start:
          type: integer
          description: Epoch timestamp, in seconds, for the start of the site search window
          contentEncoding: int32
        total:
          type: integer
          description: Number of site records matching the search filters across all pages
          contentEncoding: int32
      description: Paginated response for organization site search results
    response_site_search_item:
      title: response_site_search_item
      required:
      - auto_upgrade_enabled
      - auto_upgrade_version
      - honeypot_enabled
      - id
      - name
      - org_id
      - site_id
      - timestamp
      - timezone
      - vna_enabled
      - wifi_enabled
      type: object
      properties:
        auto_upgrade_enabled:
          type: boolean
          description: Whether automatic firmware upgrade is enabled for the site
        auto_upgrade_version:
          type: string
          description: Desired automatic firmware upgrade version track for the site
          readOnly: true
        country_code:
          type:
          - string
          - 'null'
          description: Country code configured for the site, or null if unset
          readOnly: true
        honeypot_enabled:
          type: boolean
          description: Whether honeypot detection is enabled for the site
        id:
          type: string
          description: Unique identifier for the site search result
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        name:
          type: string
          description: Display name of the site
          readOnly: true
        org_id:
          type: string
          description: Organization that owns the site
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        site_id:
          type: string
          description: Site identifier for this search result
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        timestamp:
          type: number
          description: Epoch timestamp, in seconds, for this site search result
          readOnly: true
        timezone:
          type: string
          description: Time zone configured for the site
          readOnly: true
        vna_enabled:
          type: boolean
          description: Whether Virtual Network Assistant is enabled for the site
        wifi_enabled:
          type: boolean
          description: Whether Wi-Fi service is enabled for the site
      description: Site record returned by organization site search
    response_sso_failure_search:
      title: response_sso_failure_search
      required:
      - results
      type: object
      properties:
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/response_sso_failure_search_item'
          description: SSO authentication failure records returned by the request
      description: Response containing recent SSO authentication failure records
    response_sso_failure_search_item:
      title: response_sso_failure_search_item
      required:
      - detail
      - saml_assertion_xml
      - timestamp
      type: object
      properties:
        detail:
          type: string
          description: Failure details reported for the SSO authentication attempt
        saml_assertion_xml:
          type: string
          description: SAML assertion XML captured for the failed SSO authentication attempt
        timestamp:
          type: number
          description: Epoch timestamp, in seconds, when the SSO authentication failure occurred
          readOnly: true
      description: SSO authentication failure record
    response_ssr_export_id_tokens:
      title: response_ssr_export_id_tokens
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/response_ssr_export_id_tokens_results_item'
          description: Exported SSR ID token records for the requested devices
      description: Response containing SSR ID tokens exported for device onboarding
    response_ssr_export_id_tokens_results_item:
      title: response_ssr_export_id_tokens_results_item
      type: object
      properties:
        mac:
          type: string
          description: SSR device MAC address for the exported ID token
        token:
          type: string
          description: ID token to import into Conductor for SSR device onboarding
      description: SSR ID token record for a device
    response_ssr_upgrade:
      title: response_ssr_upgrade
      required:
      - channel
      - counts
      - device_type
      - id
      - status
      - strategy
      - versions
      type: object
      properties:
        channel:
          minLength: 1
          type: string
          description: Firmware release channel used for the SSR upgrade
        counts:
          allOf:
          - $ref: '#/components/schemas/response_ssr_upgrade_counts'
          - description: Device counts grouped by SSR upgrade status
        device_type:
          type: string
          description: Type of devices targeted by the SSR upgrade
        force:
          type: boolean
          description: Whether the upgrade was forced even when the requested version matched the running version
          default: false
        id:
          type: string
          description: Unique identifier for the SSR upgrade job
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        status:
          minLength: 1
          type: string
          description: Current status of the SSR upgrade job
        strategy:
          minLength: 1
          type: string
          description: Upgrade strategy used by the SSR upgrade job
        versions:
          type: object
          additionalProperties:
            type: string
          description: SSR firmware versions included in the upgrade job
      description: SSR firmware upgrade job summary
    response_ssr_upgrade_counts:
      title: response_ssr_upgrade_counts
      required:
      - failed
      - queued
      - success
      - upgrading
      type: object
      properties:
        failed:
          type: integer
          description: Number of SSR devices that failed the upgrade
          contentEncoding: int32
        queued:
          type: integer
          description: Number of SSR devices queued for upgrade
          contentEncoding: int32
        success:
          type: integer
          description: Number of SSR devices successfully upgraded
          contentEncoding: int32
        upgrading:
          type: integer
          description: Number of SSR devices currently upgrading
          contentEncoding: int32
      description: Device counts grouped by SSR upgrade status
    response_ssr_upgrade_status:
      title: response_ssr_upgrade_status
      required:
      - channel
      - id
      - status
      - targets
      - versions
      type: object
      properties:
        channel:
          minLength: 1
          type: string
          description: Firmware release channel used for the SSR upgrade
        device_type:
          type: string
          description: Type of devices targeted by the SSR upgrade
        force:
          type: boolean
          description: Whether the upgrade was forced even when the requested version matched the running version
          default: false
        id:
          type: string
          description: Unique identifier for the SSR upgrade job
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        status:
          minLength: 1
          type: string
          description: Current status of the SSR upgrade job
        strategy:
          minLength: 1
          type: string
          description: Upgrade strategy used by the SSR upgrade job
        targets:
          allOf:
          - $ref: '#/components/schemas/response_ssr_upgrade_status_targets'
          - description: SSR device IDs grouped by upgrade status
        versions:
          type: object
          description: SSR firmware versions included in the upgrade job
      description: Detailed status for an SSR firmware upgrade job
    response_ssr_upgrade_status_targets:
      title: response_ssr_upgrade_status_targets
      required:
      - failed
      - queued
      - success
      - upgrading
      type: object
      properties:
        failed:
          uniqueItems: true
          type: array
          items:
            type: string
          description: SSR device IDs that failed the upgrade
        queued:
          uniqueItems: true
          type: array
          items:
            type: string
          description: SSR device IDs queued for upgrade
        success:
          uniqueItems: true
          type: array
          items:
            type: string
          description: SSR device IDs successfully upgraded
        upgrading:
          uniqueItems: true
          type: array
          items:
            type: string
          description: SSR device IDs currently upgrading
      description: SSR device IDs grouped by upgrade status
    response_stats_assets:
      title: response_stats_assets
      required:
      - end
      - limit
      - results
      - start
      - total
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp, in seconds, for the end of the asset statistics search window
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of asset statistics records returned in this page
          contentEncoding: int32
        next:
          type: string
          description: URL for retrieving the next page of asset statistics results
        results:
          type: array
          items:
            $ref: '#/components/schemas/stats_asset'
          description: Asset statistics records matching the search filters
        start:
          type: integer
          description: Epoch timestamp, in seconds, for the start of the asset statistics search window
          contentEncoding: int32
        total:
          type: integer
          description: Number of asset statistics records matching the search filters across all pages
          contentEncoding: int32
      description: Paginated response for asset statistics search results
    response_stats_calls:
      title: response_stats_calls
      type: object
      properties:
        end:
          type: number
          description: Epoch timestamp, in seconds, for the end of the call statistics search window
        limit:
          type: integer
          description: Maximum number of call statistics records returned in this page
          contentEncoding: int32
        next:
          type: string
          description: URL for retrieving the next page of call statistics results
        results:
          type: array
          items:
            $ref: '#/components/schemas/stats_call'
          description: Call statistics records matching the search filters
        start:
          type: number
          description: Epoch timestamp, in seconds, for the start of the call statistics search window
        total:
          type: integer
          description: Number of call statistics records matching the search filters across all pages
          contentEncoding: int32
      description: Paginated response for site call statistics search results
    response_stats_calls_summary:
      title: response_stats_calls_summary
      type: object
      properties:
        bad_minutes:
          type: number
          description: Total call minutes classified as bad across all quality categories
          examples:
          - 5566
        bad_minutes_client:
          type: number
          description: Call minutes classified as bad due to client-side issues
          examples:
          - 526
        bad_minutes_site_wan:
          type: number
          description: Call minutes classified as bad due to site WAN issues
          examples:
          - 3612
        bad_minutes_wireless:
          type: number
          description: Call minutes classified as bad due to wireless issues
          examples:
          - 1428
        num_aps:
          type: integer
          description: Number of APs represented in the call statistics summary
          contentEncoding: int32
          examples:
          - 1
        num_users:
          type: integer
          description: Number of users represented in the call statistics summary
          contentEncoding: int32
          examples:
          - 3
        total_minutes:
          type: number
          description: Total call minutes represented in the summary
          examples:
          - 5566
      description: Aggregated site call statistics summary
    response_switch_metrics:
      title: response_switch_metrics
      type: object
      properties:
        active_ports_summary:
          allOf:
          - $ref: '#/components/schemas/response_switch_metrics_active_ports_summary2'
          - description: Summary metric for active switch ports
        config_success:
          allOf:
          - $ref: '#/components/schemas/response_switch_metrics_config_success'
          - description: Configuration success metric for switches in the requested scope
        version_compliance:
          allOf:
          - $ref: '#/components/schemas/response_switch_metrics_version_compliance2'
          - description: Software version compliance metric for switches in the requested scope
      description: Switch metrics returned for the requested site or switch scope
    response_switch_metrics_active_ports_summary:
      title: response_switch_metrics_active_ports_summary
      type: object
      properties:
        details:
          allOf:
          - $ref: '#/components/schemas/switch_metrics_active_ports_summary_details2'
          - description: Port counts used to calculate the active-port summary metric
        score:
          type: integer
          description: Reported metric score for active switch ports
          contentEncoding: int32
        total_switch_count:
          type: integer
          description: Number of switches included in the active-port summary metric
          contentEncoding: int32
      description: Active-port summary metric for switches in the requested scope
    response_switch_metrics_config_success:
      title: response_switch_metrics_config_success
      type: object
      properties:
        details:
          allOf:
          - $ref: '#/components/schemas/response_switch_metrics_config_success_details2'
          - description: Configuration success counts used to calculate the metric
        score:
          type: integer
          description: Reported metric score for switch configuration success
          contentEncoding: int32
        total_switch_count:
          type: integer
          description: Number of switches included in the configuration success metric
          contentEncoding: int32
      description: Configuration success metric for switches in the requested scope
    response_switch_metrics_config_success_details:
      title: response_switch_metrics_config_success_details
      type: object
      properties:
        config_success_count:
          type: integer
          description: Number of switches with successful configuration status
          contentEncoding: int32
      description: Detail values for the switch configuration success metric
    response_switch_metrics_version_compliance:
      title: response_switch_metrics_version_compliance
      type: object
      properties:
        details:
          allOf:
          - $ref: '#/components/schemas/response_switch_metrics_version_compliance_details2'
          - description: Version groupings used to calculate the compliance metric
        score:
          type: integer
          description: Reported metric score for switch software version compliance
          contentEncoding: int32
        total_switch_count:
          type: integer
          description: Number of switches included in the version compliance metric
          contentEncoding: int32
      description: Version compliance metric for switches in the requested scope
    response_switch_metrics_version_compliance_details:
      title: response_switch_metrics_version_compliance_details
      type: object
      properties:
        major_versions:
          type: array
          items:
            $ref: '#/components/schemas/switch_metrics_compliance_major_version'
          description: Software version groupings found among the evaluated switches
      description: Detail values for the switch software version compliance metric
    response_switch_port_search:
      title: response_switch_port_search
      required:
      - limit
      - results
      - total
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp, in seconds, for the end of the port statistics reporting window
          contentEncoding: int32
          examples:
          - 1513177200
        limit:
          type: integer
          description: Maximum number of port statistics records returned in this page
          contentEncoding: int32
          examples:
          - 10
        next:
          type: string
          description: URL for retrieving the next page of switch and gateway port statistics results
        results:
          type: array
          items:
            $ref: '#/components/schemas/stats_switch_port'
          description: Switch and gateway port statistics records matching the search filters
        start:
          type: integer
          description: Epoch timestamp, in seconds, for the start of the port statistics reporting window
          contentEncoding: int32
          examples:
          - 1511967600
        total:
          type: integer
          description: Number of port statistics records matching the search filters across all pages
          contentEncoding: int32
          examples:
          - 100
      description: Paginated response for switch and gateway port statistics search results
    stats_switch_port:
      title: stats_switch_port
      required:
      - mac
      - org_id
      - port_id
      - site_id
      type: object
      properties:
        active:
          type: boolean
          description: Indicates if interface is active/inactive
          readOnly: true
        auth_state:
          allOf:
          - $ref: '#/components/schemas/port_auth_state1'
          - description: 'Authentication state of the port. enum: ``, `authenticated`, `authenticating`, `held`, `init`.'
        disabled:
          type: boolean
          description: Indicates if interface is disabled
          readOnly: true
        for_site:
          type: boolean
          description: Whether the reporting device is scoped to a specific site
          readOnly: true
        full_duplex:
          type: boolean
          description: Indicates full or half duplex
          examples:
          - true
        jitter:
          type: number
          description: Last sampled jitter of the interface
          readOnly: true
        last_flapped:
          type: number
          description: Indicates when the port was last flapped
          readOnly: true
        latency:
          type: number
          description: Last sampled latency of the interface
          readOnly: true
        loss:
          type: number
          description: Last sampled loss of the interface
          readOnly: true
        lte_iccid:
          type:
          - string
          - 'null'
          description: LTE ICCID value, Check for null/empty
        lte_imei:
          type:
          - string
          - 'null'
          description: LTE IMEI value, Check for null/empty
        lte_imsi:
          type:
          - string
          - 'null'
          description: LTE IMSI value, Check for null/empty
        mac:
          type: string
          description: Switch MAC address that reported these port statistics
          readOnly: true
          examples:
          - 5c4527a96580
        mac_count:
          type: integer
          description: Number of MAC addresses in the forwarding table
          contentEncoding: int32
          readOnly: true
        mac_limit:
          minimum: 0
          type: integer
          description: Limit on number of dynamically learned macs
          contentEncoding: int32
          readOnly: true
        neighbor_mac:
          type: string
          description: chassis identifier of the chassis type listed
          readOnly: true
          examples:
          - 64d814353400
        neighbor_port_desc:
          type: string
          description: Description supplied by the system on the interface E.g. "GigabitEthernet2/0/39"
          readOnly: true
          examples:
          - GigabitEthernet1/0/21
        neighbor_system_name:
          type: string
          description: Name supplied by the system on the interface E.g. neighbor system name E.g. "Kumar-Acc-SW.mist.local"
          readOnly: true
          examples:
          - CORP-D-SW-2
        org_id:
          type: string
          description: Organization identifier of the reporting switch
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        poe_disabled:
          type: boolean
          description: Is the POE disabled
          readOnly: true
        poe_mode:
          allOf:
          - $ref: '#/components/schemas/stats_switch_port_poe_mode1'
          - description: 'PoE mode reported for the port. enum: `802.3af`, `802.3at`, `802.3bt`.'
        poe_on:
          type: boolean
          description: Is the device attached to POE
          readOnly: true
        poe_priority:
          allOf:
          - $ref: '#/components/schemas/poe_priority2'
          - description: 'PoE priority configured for the port. enum: `low`, `high`.'
        port_id:
          type: string
          description: Identifier of the port reporting these statistics
          readOnly: true
          examples:
          - ge-0/0/0
        port_mac:
          type: string
          description: MAC address assigned to the interface
          readOnly: true
          examples:
          - 5c4527a96580
        port_usage:
          type: string
          description: Logical usage assigned to the port
          examples:
          - lan
        power_draw:
          type: number
          description: Amount of power being used by the interface at the time the command is executed. Unit in watts.
          readOnly: true
        rx_bcast_pkts:
          type: integer
          description: Number of broadcast packets received on the interface
          contentEncoding: int32
          readOnly: true
        rx_bps:
          type:
          - integer
          - 'null'
          description: Receive throughput of the port, in bits per second
          contentEncoding: int64
          readOnly: true
          examples:
          - 60003
        rx_bytes:
          type:
          - integer
          - 'null'
          description: Total bytes received on the port
          contentEncoding: int64
          readOnly: true
          examples:
          - 8515104416
        rx_errors:
          type: integer
          description: Number of receive errors observed on the interface
          contentEncoding: int32
          readOnly: true
        rx_mcast_pkts:
          type: integer
          description: Number of multicast packets received on the interface
          contentEncoding: int32
          readOnly: true
        rx_pkts:
          type:
          - integer
          - 'null'
          description: Total packets received on the port
          contentEncoding: int64
          readOnly: true
          examples:
          - 57770567
        site_id:
          type: string
          description: Site identifier of the reporting switch
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        speed:
          type: integer
          description: Current link speed of the port, in Mbps
          contentEncoding: int32
          readOnly: true
          examples:
          - 1000
        stp_role:
          allOf:
          - $ref: '#/components/schemas/port_stp_role1'
          - description: 'Current spanning tree role of the port. enum: ``, `alternate`, `backup`, `designated`, `disabled`, `root`, `root-prevented`.'
        stp_state:
          allOf:
          - $ref: '#/components/schemas/port_stp_state1'
          - description: 'Current spanning tree state of the port. enum: ``, `blocking`, `disabled`, `forwarding`, `learning`, `listening`.'
        tx_bcast_pkts:
          type: integer
          description: Number of broadcast packets transmitted on the interface
          contentEncoding: int32
          readOnly: true
        tx_bps:
          type:
          - integer
          - 'null'
          description: Transmit throughput of the port, in bits per second
          contentEncoding: int64
          readOnly: true
          examples:
          - 634301
        tx_bytes:
          type:
          - integer
          - 'null'
          description: Total bytes transmitted on the port
          contentEncoding: int64
          readOnly: true
          examples:
          - 211217389682
        tx_errors:
          type: integer
          description: Number of transmit errors observed on the interface
          contentEncoding: int32
          readOnly: true
        tx_mcast_pkts:
          type: integer
          description: Number of multicast packets transmitted on the interface
          contentEncoding: int32
          readOnly: true
        tx_pkts:
          type:
          - integer
          - 'null'
          description: Total packets transmitted on the port
          contentEncoding: int64
          readOnly: true
          examples:
          - 812204062
        type:
          allOf:
          - $ref: '#/components/schemas/stats_switch_port_type1'
          - description: 'Detected device category connected to the port, when available. enum: `ap`, `ble`, `gateway`, `mxedge`, `nac`, `switch`.'
            examples:
            - gateway
        unconfigured:
          type: boolean
          description: Indicates if interface is unconfigured
          readOnly: true
        up:
          type: boolean
          description: Indicates if interface is up
          readOnly: true
        uplink:
          type: boolean
          description: Indicates if interface is an uplink port
          readOnly: true
        xcvr_model:
          type: string
          description: Optic Slot ModelName, Check for null/empty
          readOnly: true
          examples:
          - SFP+-10G-SR
        xcvr_part_number:
          type: string
          description: Optic Slot Partnumber, Check for null/empty
          readOnly: true
          examples:
          - 740-021487
        xcvr_serial:
          type: string
          description: Optic Slot SerialNumber, Check for null/empty
          readOnly: true
          examples:
          - N6AA9HT
      description: Switch port statistics record returned by stats APIs
    response_synthetictest:
      title: response_synthetictest
      type: object
      properties:
        id:
          type: string
          description: Unique value for the queued synthetic test request
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        message:
          type: string
          description: Human-readable queuing result returned by the API
          examples:
          - Successfully queued synthetic test for the site.
        status:
          type: string
          description: Queue status for the synthetic test request
          examples:
          - success
      description: Result returned after a site synthetic test is queued
    response_synthetictest_search:
      title: response_synthetictest_search
      required:
      - end
      - limit
      - results
      - start
      - total
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp, in seconds, for the end of the synthetic test search window
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of synthetic test results returned in this page
          contentEncoding: int32
        next:
          type: string
          description: URL for retrieving the next page of synthetic test results
        results:
          type: array
          items:
            $ref: '#/components/schemas/synthetictest_info'
          description: Synthetic test result records matching the search filters
        start:
          type: integer
          description: Epoch timestamp, in seconds, for the start of the synthetic test search window
          contentEncoding: int32
        total:
          type: integer
          description: Number of synthetic test results matching the search filters across all pages
          contentEncoding: int32
      description: Paginated response for site synthetic test search results
    synthetictest_info:
      title: synthetictest_info
      type: object
      properties:
        by:
          type: string
          description: Actor that triggered the synthetic test
          examples:
          - user
        device_type:
          allOf:
          - $ref: '#/components/schemas/device_type4'
          - description: 'Device category that ran the synthetic test. enum: `ap`, `gateway`, `switch`.'
        failed:
          type: boolean
          description: Whether the synthetic test failed
          examples:
          - false
        latency:
          type: integer
          description: Measured latency for the synthetic test, in milliseconds
          contentEncoding: int32
          examples:
          - 40
        mac:
          type: string
          description: Device MAC address that ran the synthetic test
        port_id:
          type: string
          description: Interface identifier used to run the synthetic test
          examples:
          - ge-0/0/2
        reason:
          type: string
          description: Failure reason reported for the synthetic test, when available
          examples:
          - interface not ready to perform test
        rx_mbps:
          type: integer
          description: Receive throughput measured by the synthetic speed test, in Mbps
          contentEncoding: int32
          examples:
          - 322
        start_time:
          type: integer
          description: Epoch timestamp, in seconds, when the synthetic test started
          contentEncoding: int32
          examples:
          - 1675718807
        status:
          type: string
          description: Current execution status of the synthetic test
        timestamp:
          type: number
          description: Time when the synthetic test result was recorded
          readOnly: true
        tx_mbps:
          type: integer
          description: Transmit throughput measured by the synthetic speed test, in Mbps
          contentEncoding: int32
          examples:
          - 199
        type:
          allOf:
          - $ref: '#/components/schemas/synthetictest_type3'
          - description: 'Synthetic test type for this result. enum: `arp`, `curl`, `dhcp`, `dhcp6`, `dns`, `lan_connectivity`, `radius`, `speedtest`.'
        vlan_id:
          type: integer
          description: Identifier of the VLAN used by the synthetic test
          contentEncoding: int32
          examples:
          - 20
      description: Synthetic test status or result record
    response_troubleshoot:
      title: response_troubleshoot
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp, in seconds, for the end of the troubleshooting window
          contentEncoding: int32
          examples:
          - 1655151856
        results:
          type: array
          items:
            $ref: '#/components/schemas/response_troubleshoot_item'
          description: Troubleshooting findings returned for the requested target and window
        start:
          type: integer
          description: Epoch timestamp, in seconds, for the start of the troubleshooting window
          contentEncoding: int32
          examples:
          - 1655065456
      description: Organization troubleshooting response for the requested time window
    response_troubleshoot_item:
      title: response_troubleshoot_item
      type: object
      properties:
        category:
          type: string
          description: Entity category associated with the troubleshooting finding
          examples:
          - client
        reason:
          type: string
          description: Issue reason identified by the troubleshooting analysis
          examples:
          - slow association
        recommendation:
          type: string
          description: Recommended remediation guidance for the troubleshooting finding
          examples:
          - Ensure the IP helper-address is configured on the VLAN interface.
        text:
          type: string
          description: Human-readable explanation of the troubleshooting finding
          examples:
          - Clients of the AP had slow association 8% of the time on Bhavabhi and 5 GHz. ...
      description: Troubleshooting finding with reason and remediation guidance
    response_tunnel_search:
      title: response_tunnel_search
      required:
      - end
      - limit
      - results
      - start
      - total
      type: object
      properties:
        end:
          type: integer
          description: Epoch timestamp, in seconds, for the end of the tunnel statistics search window
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of tunnel statistics records returned in this page
          contentEncoding: int32
        next:
          type: string
          description: URL for retrieving the next page of tunnel statistics results
        results:
          type: array
          items:
            $ref: '#/components/schemas/response_tunnel_search_item'
          description: Tunnel statistics records matching the search filters
        start:
          type: integer
          description: Epoch timestamp, in seconds, for the start of the tunnel statistics search window
          contentEncoding: int32
        total:
          type: integer
          description: Number of tunnel statistics records matching the search filters across all pages
          contentEncoding: int32
      description: Paginated response for organization tunnel statistics search results
    response_two_factor_json:
      title: response_two_factor_json
      type: object
      properties:
        two_factor_secret:
          type: string
          description: Generated secret key used to enroll a two-factor authentication app
          contentEncoding: password
          examples:
          - NRMTSTRWNBVECY3GJVYEY3DDJFRGSNCZGJUDO4RVN5FDM3DUMJSA
      description: Response body containing a generated two-factor authentication secret
    response_upgrade_id:
      title: response_upgrade_id
      required:
      - upgrade_id
      type: object
      properties:
        upgrade_id:
          type: string
          description: Unique value identifying the queued upgrade job
          contentEncoding: uuid
          examples:
          - 4316c116-0acb-4c43-8f06-6723154e741e
      description: Response containing an upgrade job identifier
    response_upgrade_org_devices:
      title: response_upgrade_org_devices
      type: object
      properties:
        enable_p2p:
          type: boolean
          description: Whether to allow local AP-to-AP FW upgrade
        force:
          type: boolean
          description: Whether to force upgrade when requested version is same as running version
        id:
          type: string
          description: Unique value identifying the organization upgrade job
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        strategy:
          allOf:
          - $ref: '#/components/schemas/upgrade_device_strategy2'
          - description: 'Execution strategy used for the organization upgrade job. enum: `big_bang`, `canary`, `rrm`, `serial`.'
        target_version:
          type: string
          description: Firmware version targeted by the organization AP upgrade
          examples:
          - 0.14.29411
        upgrades:
          type: array
          items:
            $ref: '#/components/schemas/upgrade_org_devices_upgrade'
          description: Per-site upgrade jobs created for the organization upgrade
      description: Organization AP upgrade job details
    response_verify_token_success:
      title: response_verify_token_success
      type: object
      properties:
        detail:
          type: string
          description: Result message returned with the verification response
        invite_not_applied:
          type: boolean
          description: Whether the invitation was verified but not applied automatically
        min_length:
          type: integer
          description: Required minimum password length from the applicable password policy
          contentEncoding: int32
        return_to:
          type: string
          description: URL to redirect the user to after successful registration verification
      description: Successful registration token verification response
    response_virtual_chassis_config:
      title: response_virtual_chassis_config
      type: object
      properties:
        config_type:
          type: string
          description: Provisioning mode of the virtual chassis configuration
          readOnly: true
        id:
          type: string
          description: Unique value identifying the virtual chassis device record
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        locating:
          type: boolean
          description: Whether locate mode is active for the virtual chassis device
          readOnly: true
        mac:
          type: string
          description: Device MAC address for the virtual chassis device record
        members:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/stats_switch_module_stat_item'
          description: Virtual chassis member module statistics and topology details
        model:
          type: string
          description: Switch model for the virtual chassis device record
          readOnly: true
        num_routing_engines:
          type: integer
          description: Number of routing engines in the virtual chassis
          contentEncoding: int32
          examples:
          - 1
        org_id:
          type: string
          description: Organization identifier for the virtual chassis device
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        serial:
          type: string
          description: Device serial number reported for the virtual chassis
          readOnly: true
        site_id:
          type: string
          description: Identifier of the site containing the virtual chassis
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        status:
          type: string
          description: Connection status of the virtual chassis device
          readOnly: true
        type:
          type: string
          description: Device type for the virtual chassis record
        vc_mac:
          type: string
          description: Virtual Chassis MAC address used to identify the VC device
          readOnly: true
      description: Combined virtual chassis status, topology, and member statistics
    response_wired_coa:
      title: response_wired_coa
      type: object
      properties:
        device_mac:
          type: string
          description: MAC address of the switch or gateway hosting the wired client session
          examples:
          - 5c5b35000002
        port_id:
          type: string
          description: Interface identifier for the wired client session
          examples:
          - ge-0/0/0
        session:
          type: string
          description: RADIUS session identifier used for the CoA request
          contentEncoding: uuid
          examples:
          - 0a2a11b8-4b30-40d8-a6d1-e91ea540d86f
      description: Response returned after triggering wired client CoA reauthentication
    response_zone_search:
      title: response_zone_search
      type: object
      properties:
        end:
          type: number
          description: Epoch timestamp, in seconds, for the end of the zone visit search window
          examples:
          - 1541705289.769911
        limit:
          type: integer
          description: Maximum number of zone visit records returned in this page
          contentEncoding: int32
          examples:
          - 1
        next:
          type: string
          description: URL for retrieving the next page of zone visit search results
          examples:
          - /api/v1/sites/67970e46-4e12-11e6-9188-0242ac110007/zones/visits/search?limit=2&end=1541705247.000&scope_id=85fbba9e-4e12-11e6-9188-0242ac110007&user_type=asset&start=1541618889.77
        results:
          type: array
          items:
            $ref: '#/components/schemas/response_zone_search_item'
          description: Zone visit records matching the search filters
        start:
          type: number
          description: Epoch timestamp, in seconds, for the start of the zone visit search window
          examples:
          - 1541618889.769886
        total:
          type: integer
          description: Number of zone visit records matching the search filters across all pages
          contentEncoding: int32
          examples:
          - 5892
      description: Paginated response for site zone visit search results
    response_zone_search_item:
      title: response_zone_search_item
      type: object
      properties:
        enter:
          type: integer
          description: Epoch timestamp, in seconds, when the zone visit started
          contentEncoding: int32
          examples:
          - 1541705254
        scope:
          type: string
          description: Zone scope represented by this visit record
          examples:
          - map
        timestamp:
          type: number
          description: Time when the zone visit event was recorded
          readOnly: true
        user:
          type: string
          description: Client, asset, or SDK client identifier for the visit
          examples:
          - c4b301c81166
      description: Zone visit record for a client, asset, or SDK client
    rf_client_type:
      title: rf_client_type
      enum:
      - asset
      - client
      - sdkclient
      type: string
      description: 'enum: `asset`, `client`, `sdkclient`'
    rf_diag:
      title: rf_diag
      required:
      - name
      - type
      type: object
      properties:
        duration:
          maximum: 180
          type: integer
          description: Recording length, in seconds; maximum and default are 180
          contentEncoding: int32
          default: 180
        mac:
          type: string
          description: If `type`==`client` or `asset`, MAC address of the device being recorded
        name:
          type: string
          description: Recording name; the SDK client name is a good default for SDK-client recordings
        sdkclient_id:
          type: string
          description: If `type`==`sdkclient`, SDK client identifier for this recording
          contentEncoding: uuid
        type:
          allOf:
          - $ref: '#/components/schemas/rf_client_type1'
          - description: 'Target device category for the RF diagnostic recording. enum: `asset`, `client`, `sdkclient`.'
      description: RF diagnostic recording request
    rf_diag_info_item:
      title: rf_diag_info_item
      required:
      - duration
      - end_time
      - frame_count
      - map_id
      - name
      - raw_events
      - ready
      - start_time
      - type
      - url
      type: object
      properties:
        asset_id:
          type: string
          description: If `type`==`asset`, id of the asset
          contentEncoding: uuid
        asset_name:
          type: string
          description: If `type`==`asset`, name of the asset
        client_name:
          type: string
          description: If `type`==`client`, hostname of the client
        duration:
          type: integer
          description: recording length in seconds, max is 120
          contentEncoding: int32
        end_time:
          type: integer
          description: Timestamp of end of recording
          contentEncoding: int32
        frame_count:
          type: integer
          description: Number of frames in the output
          contentEncoding: int32
        id:
          type: string
          description: Unique value identifying the RF diagnostic recording
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        mac:
          type: string
          description: If `type`==`client` or `asset`, MAC address of the recorded device
        map_id:
          type: string
          description: Map identifier associated with the recording
          contentEncoding: uuid
        name:
          type: string
          description: Recording name returned for the RF diagnostic recording
        next:
          type: string
          description: Optional. id of the next recoding if present. Only valid for site survey.
        raw_events:
          type: string
          description: URL to a JSON file that contains array of raw location diag events
        ready:
          type: boolean
          description: Whether it’s ready for playback
        sdkclient_id:
          type: string
          description: If `type`==`sdkclient`, sdkclient_id of this recording
          contentEncoding: uuid
        sdkclient_name:
          type: string
          description: If `type`==`sdkclient`, name of the sdkclient
        sdkclient_uuid:
          type: string
          description: If `type`==`sdkclient`, device_id of sdkclient
          contentEncoding: uuid
        start_time:
          type: integer
          description: Timestamp of the recording (the start)
          contentEncoding: int32
        type:
          allOf:
          - $ref: '#/components/schemas/rf_client_type2'
          - description: 'Target device category for the recording. enum: `asset`, `client`, `sdkclient`.'
        url:
          type: string
          description: JSON file URL for frame data captured by the recording
      description: RF diagnostic recording metadata and output links
    rf_template:
      title: rf_template
      required:
      - name
      type: object
      properties:
        ant_gain_24:
          type: integer
          description: External antenna gain for the 2.4 GHz radio
          contentEncoding: int32
        ant_gain_5:
          type: integer
          description: External antenna gain for the 5 GHz radio
          contentEncoding: int32
        ant_gain_6:
          type: integer
          description: External antenna gain for the 6 GHz radio
          contentEncoding: int32
        band_24:
          allOf:
          - $ref: '#/components/schemas/rftemplate_radio_band243'
          - description: 2.4 GHz radio settings in this RF template
        band_24_usage:
          allOf:
          - $ref: '#/components/schemas/radio_band_24_usage2'
          - description: 'Radio usage mode for the 2.4 GHz-capable radio in this RF template. enum: `24`, `5`, `6`, `auto`.'
        band_5:
          allOf:
          - $ref: '#/components/schemas/rftemplate_radio_band55'
          - description: 5 GHz radio settings in this RF template
        band_5_on_24_radio:
          allOf:
          - $ref: '#/components/schemas/rftemplate_radio_band51'
          - description: 5 GHz settings used when the 2.4 GHz radio operates in 5 GHz mode
        band_6:
          allOf:
          - $ref: '#/components/schemas/rftemplate_radio_band63'
          - description: 6 GHz radio settings in this RF template
        country_code:
          type: string
          description: Optional, country code to use. If specified, this gets applied to all sites using the RF Template
        created_time:
          type: number
          description: Timestamp when the RF template was created
          readOnly: true
        enable_unii_4:
          type: boolean
          description: Whether U-NII-4 channels (169, 173, 177) are enabled
          default: false
        for_site:
          type: boolean
          description: Whether the RF template is scoped to a site rather than the organization
          readOnly: true
        id:
          type: string
          description: Unique identifier of the RF template
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        model_specific:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/rf_template_model_specific_property'
          description: overwrites for a specific model. If a band is specified, it will shadow the default. Property key is the model name (e.g. "AP63")
        modified_time:
          type: number
          description: Timestamp when the RF template was last modified
          readOnly: true
        name:
          type: string
          description: The name of the RF template
        org_id:
          type: string
          description: Organization that owns this RF template
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        scanning_enabled:
          type: boolean
          description: Whether scanning radio is enabled
      description: RF template used by the current RRM calculation
    rf_template_model_specific_property:
      title: rf_template_model_specific_property
      type: object
      properties:
        ant_gain_24:
          type: integer
          description: Model-specific external antenna gain for the 2.4 GHz radio
          contentEncoding: int32
          default: 0
        ant_gain_5:
          type: integer
          description: Model-specific external antenna gain for the 5 GHz radio
          contentEncoding: int32
          default: 0
        ant_gain_6:
          type: integer
          description: Model-specific external antenna gain for the 6 GHz radio
          contentEncoding: int32
          default: 0
        band_24:
          allOf:
          - $ref: '#/components/schemas/rftemplate_radio_band241'
          - description: Model-specific 2.4 GHz radio settings that override RF template defaults
        band_24_usage:
          allOf:
          - $ref: '#/components/schemas/radio_band_24_usage3'
          - description: 'Model-specific radio usage mode for the 2.4 GHz-capable radio. enum: `24`, `5`, `6`, `auto`.'
        band_5:
          allOf:
          - $ref: '#/components/schemas/rftemplate_radio_band52'
          - description: Model-specific 5 GHz radio settings that override RF template defaults
        band_5_on_24_radio:
          allOf:
          - $ref: '#/components/schemas/rftemplate_radio_band53'
          - description: Model-specific 5 GHz settings used when the 2.4 GHz radio operates in 5 GHz mode
        band_6:
          allOf:
          - $ref: '#/components/schemas/rftemplate_radio_band61'
          - description: Model-specific 6 GHz radio settings that override RF template defaults
      description: AP model-specific RF overrides for an RF template
    rftemplate_radio_band24:
      title: rftemplate_radio_band24
      type: object
      properties:
        allow_rrm_disable:
          type: boolean
          description: Whether RRM may disable the 2.4 GHz radio when optimizing RF settings
          default: false
        ant_gain:
          maximum: 10
          minimum: 0
          type:
          - integer
          - 'null'
          description: External antenna gain for the 2.4 GHz radio
          contentEncoding: int32
          default: 0
        antenna_mode:
          allOf:
          - $ref: '#/components/schemas/radio_band_antenna_mode4'
          - description: 'Radio chain mode for the 2.4 GHz radio. enum: `1x1`, `2x2`, `3x3`, `4x4`, `default`.'
            examples:
            - default
        bandwidth:
          allOf:
          - $ref: '#/components/schemas/dot11_bandwidth242'
          - description: 'Channel width configured for the 2.4 GHz radio. enum: `0`, `20`, `40`.'
            examples:
            - 20
        channels:
          type:
          - array
          - 'null'
          items:
            type: integer
            contentEncoding: int32
          description: Allowed channel list for the 2.4 GHz radio; null or an empty array uses automatic selection
          default: []
        disabled:
          type: boolean
          description: Whether to disable the radio
          default: false
        power:
          maximum: 25
          minimum: 0
          type:
          - integer
          - 'null'
          description: Radio Tx power, in dBm. Can be an integer 0-25 for static power configuration, or `null` or unset for auto power mode
          contentEncoding: int32
          examples:
          - 3
        power_max:
          maximum: 18
          minimum: 3
          type:
          - integer
          - 'null'
          description: When power=null/unset, max tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        power_min:
          maximum: 18
          minimum: 3
          type:
          - integer
          - 'null'
          description: When power=null/unset, min tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        preamble:
          allOf:
          - $ref: '#/components/schemas/radio_band_preamble4'
          - description: '802.11 preamble mode used by the 2.4 GHz radio. enum: `auto`, `long`, `short`.'
      description: Radio Band AP settings
    rftemplate_radio_band5:
      title: rftemplate_radio_band5
      type: object
      properties:
        allow_rrm_disable:
          type: boolean
          description: Whether RRM may disable the 5 GHz radio when optimizing RF settings
          default: false
        ant_gain:
          maximum: 10
          minimum: 0
          type:
          - integer
          - 'null'
          description: External antenna gain for the 5 GHz radio
          contentEncoding: int32
          default: 0
        antenna_mode:
          allOf:
          - $ref: '#/components/schemas/radio_band_antenna_mode1'
          - description: 'Radio chain mode for the 5 GHz radio. enum: `1x1`, `2x2`, `3x3`, `4x4`, `default`.'
            examples:
            - default
        bandwidth:
          allOf:
          - $ref: '#/components/schemas/dot11_bandwidth52'
          - description: 'Channel width configured for the 5 GHz radio. enum: `0`, `20`, `40`, `80`.'
            examples:
            - 40
        channels:
          type:
          - array
          - 'null'
          items:
            type: integer
            contentEncoding: int32
          description: Allowed channel list for the 5 GHz radio; null or an empty array uses automatic selection
          default: []
        disabled:
          type: boolean
          description: Whether to disable the radio
          default: false
        power:
          maximum: 25
          minimum: 0
          type:
          - integer
          - 'null'
          description: Radio Tx power, in dBm. Can be an integer 0-25 for static power configuration, or `null` or unset for auto power mode
          contentEncoding: int32
          examples:
          - 6
        power_max:
          maximum: 17
          minimum: 5
          type:
          - integer
          - 'null'
          description: When power=null/unset, max tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        power_min:
          maximum: 17
          minimum: 5
          type:
          - integer
          - 'null'
          description: When power=null/unset, min tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        preamble:
          allOf:
          - $ref: '#/components/schemas/radio_band_preamble1'
          - description: '802.11 preamble mode used by the 5 GHz radio. enum: `auto`, `long`, `short`.'
      description: Radio Band AP settings
    rftemplate_radio_band6:
      title: rftemplate_radio_band6
      type: object
      properties:
        allow_rrm_disable:
          type: boolean
          description: Whether RRM may disable the 6 GHz radio when optimizing RF settings
          default: false
        ant_gain:
          maximum: 10
          minimum: 0
          type:
          - integer
          - 'null'
          description: External antenna gain for the 6 GHz radio
          contentEncoding: int32
          default: 0
        antenna_mode:
          allOf:
          - $ref: '#/components/schemas/radio_band_antenna_mode2'
          - description: 'Radio chain mode for the 6 GHz radio. enum: `1x1`, `2x2`, `3x3`, `4x4`, `default`.'
            examples:
            - default
        bandwidth:
          allOf:
          - $ref: '#/components/schemas/dot11_bandwidth62'
          - description: 'Channel width configured for the 6 GHz radio. enum: `0`, `20`, `40`, `80`, `160`.'
            examples:
            - 80
        channels:
          type:
          - array
          - 'null'
          items:
            type: integer
            contentEncoding: int32
          description: Allowed channel list for the 6 GHz radio; null or an empty array uses automatic selection
          default: []
        disabled:
          type: boolean
          description: Whether to disable the radio
          default: false
        power:
          maximum: 25
          minimum: 0
          type:
          - integer
          - 'null'
          description: Radio Tx power, in dBm. Can be an integer 0-25 for static power configuration, or `null` or unset for auto power mode
          contentEncoding: int32
          examples:
          - 7
        power_max:
          maximum: 17
          minimum: 5
          type:
          - integer
          - 'null'
          description: When power=null/unset, max tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        power_min:
          maximum: 18
          minimum: 5
          type:
          - integer
          - 'null'
          description: When power=null/unset, min tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        preamble:
          allOf:
          - $ref: '#/components/schemas/radio_band_preamble2'
          - description: '802.11 preamble mode used by the 6 GHz radio. enum: `auto`, `long`, `short`.'
        standard_power:
          type: boolean
          description: For 6GHz Only, standard-power operation, AFC (Automatic Frequency Coordination) will be performed, and we'll fall back to Low Power Indoor if AFC failed
          default: false
      description: Radio Band AP settings
    rogue_details:
      title: rogue_details
      required:
      - manufacture
      - seen_as_client
      type: object
      properties:
        manufacture:
          type: string
          description: Vendor or manufacturer name reported for the rogue AP
        seen_as_client:
          type: boolean
          description: Whether this rogue AP was also observed as a client
      description: Rogue AP detail response
    rogue_type:
      title: rogue_type
      enum:
      - honeypot
      - lan
      - others
      - spoof
      type: string
      description: 'enum: `honeypot`, `lan`, `others`, `spoof`'
    root_password_string:
      title: root_password_string
      required:
      - root_password
      type: object
      properties:
        root_password:
          minLength: 1
          type: string
          description: Temporary root password returned for ZTP recovery
          contentEncoding: password
      description: Temporary root password response for device ZTP recovery
    route_summary_stats:
      title: route_summary_stats
      type: object
      properties:
        fib_routes:
          type: integer
          description: Number of routes installed in the forwarding information base
          contentEncoding: int32
        max_unicast_routes_supported:
          type: integer
          description: Supported maximum number of unicast routes
          contentEncoding: int32
        rib_routes:
          type: integer
          description: Number of routes present in the routing information base
          contentEncoding: int32
        total_routes:
          type: integer
          description: Aggregate number of routes reported by the device
          contentEncoding: int32
      description: Route table capacity and usage summary
    rrm:
      title: rrm
      required:
      - band_24
      - band_24_metric
      - band_5
      - band_5_metric
      - rftemplate
      - rftemplate_id
      - rftemplate_name
      - status
      - timestamp
      type: object
      properties:
        band_24:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/rrm_band'
          description: RRM proposed channel, power, and usage settings for 2.4 GHz radios; property key is AP ID
        band_24_metric:
          allOf:
          - $ref: '#/components/schemas/rrm_band_metric4'
          - description: Aggregate RRM metrics for the 2.4 GHz band
        band_5:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/rrm_band'
          description: RRM proposed channel, power, and usage settings for 5 GHz radios; property key is AP ID
        band_5_metric:
          allOf:
          - $ref: '#/components/schemas/rrm_band_metric1'
          - description: Aggregate RRM metrics for the 5 GHz band
        band_6:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/rrm_band'
          description: RRM proposed channel, power, and usage settings for 6 GHz radios; property key is AP ID
        band_6_metric:
          allOf:
          - $ref: '#/components/schemas/rrm_band_metric2'
          - description: Aggregate RRM metrics for the 6 GHz band
        rftemplate:
          allOf:
          - $ref: '#/components/schemas/rf_template'
          - description: RF template used by the current RRM calculation
        rftemplate_id:
          type: string
          description: RF template identifier used by the current RRM calculation
          contentEncoding: uuid
        rftemplate_name:
          type: string
          description: RF template name used by the current RRM calculation
        status:
          allOf:
          - $ref: '#/components/schemas/rrm_status2'
          - description: 'Current RRM calculation status. enum: `ready`, `unknown`, `updating`.'
        timestamp:
          type: number
          description: Time when the current RRM data was generated
          readOnly: true
      description: Current RRM channel-planning state for a site
    rrm_band:
      title: rrm_band
      type: object
      properties:
        bandwidth:
          allOf:
          - $ref: '#/components/schemas/dot11_bandwidth4'
          - description: 'Proposed channel width for the radio band, in MHz. enum: `0`, `20`, `40`, `80`, `160`.'
            examples:
            - 20
        channel:
          type: integer
          description: Proposed RF channel for the radio band
          contentEncoding: int32
        curr_bandwidth:
          allOf:
          - $ref: '#/components/schemas/dot11_bandwidth7'
          - description: 'Current channel width for the radio band, in MHz. enum: `0`, `20`, `40`, `80`, `160`.'
            examples:
            - 20
        curr_channel:
          type: integer
          description: Current RF channel for the radio band
          contentEncoding: int32
        curr_power:
          type: integer
          description: Current transmit power for the radio band
          contentEncoding: int32
        curr_usage:
          minLength: 1
          type: string
          description: Current radio usage band for the AP radio
        power:
          type: integer
          description: Proposed transmit power for the radio band
          contentEncoding: int32
        usage:
          minLength: 1
          type: string
          description: Proposed radio usage band for the AP radio
      description: RRM proposed and current radio settings for an AP band
    rrm_band_metric:
      title: rrm_band_metric
      required:
      - cochannel_neighbors
      - density
      - neighbors
      - noise
      type: object
      properties:
        avg_aps_per_channel:
          type: number
          description: Average number of APs per channel
        channel_distribution_uniformity:
          type: number
          description: Distribution of channel across the Access Points
        cochannel_neighbors:
          type: number
          description: Average number of co-channel neighbors
        density:
          maximum: 1
          minimum: 0
          type: number
          description: defined by how APs can hear from one and another, 0 - 1 (everyone can hear everyone)
        interferences:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/rrm_band_metric_interference'
          description: Property key is the channel number
          examples:
          - '149':
              radar: 0.3
            '153':
              radar: 0.2
        naps_by_channel:
          type: object
          additionalProperties:
            type: number
          description: Number of APs grouped by channel for this band
        naps_by_power:
          type: object
          additionalProperties:
            type: number
          description: Number of APs grouped by transmit power for this band
        neighbors:
          type: number
          description: Average number of neighbors
        noise:
          type: number
          description: Average noise in dBm
      description: Aggregate RRM metrics for a radio band
    rrm_band_metric_interference:
      title: rrm_band_metric_interference
      type: object
      properties:
        radar:
          type: number
          description: Interference value attributed to radar on the channel
      description: Interference metrics observed for one channel
    rrm_event_pre_bandwidth:
      title: rrm_event_pre_bandwidth
      enum:
      - 0
      - 20
      - 40
      - 80
      - 160
      type: integer
      description: '(previously) channel width for the band , 0 means no previously available. enum: `0`, `20`, `40`, `80`, `160`'
    rrm_event_type:
      title: rrm_event_type
      enum:
      - interference-ap-co-channel
      - interference-ap-non-wifi
      - neighbor-ap-down
      - neighbor-ap-recovered
      - radar-detected
      - rrm-radar
      - scheduled-site_rrm
      - triggered-site_rrm
      type: string
      description: 'enum: `interference-ap-co-channel`, `interference-ap-non-wifi`, `neighbor-ap-down`, `neighbor-ap-recovered`, `radar-detected`, `rrm-radar`, `scheduled-site_rrm`, `triggered-site_rrm`'
    rrm_neighbors_neighbor:
      title: rrm_neighbors_neighbor
      type: object
      properties:
        mac:
          type: string
          description: Neighbor AP MAC address observed by RRM
          examples:
          - 5c5b35000311
        rssi:
          type: integer
          description: Observed RSSI for the neighbor AP, in dBm
          contentEncoding: int32
          examples:
          - -66
      description: Neighbor AP observed by RRM
    rrm_status:
      title: rrm_status
      enum:
      - ready
      - unknown
      - updating
      type: string
      description: 'enum: `ready`, `unknown`, `updating`'
    rssi_zone:
      title: rssi_zone
      required:
      - devices
      type: object
      properties:
        created_time:
          type: number
          description: Timestamp when the RSSI zone was created
          readOnly: true
        devices:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/rssi_zone_device'
          description: AP devices and RSSI thresholds that define the zone
        for_site:
          type: boolean
          description: Whether the RSSI zone is scoped to a site
          readOnly: true
        id:
          type: string
          description: Unique value identifying the RSSI zone
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        modified_time:
          type: number
          description: Timestamp when the RSSI zone was last modified
          readOnly: true
        name:
          type: string
          description: Display name of the RSSI zone
          examples:
          - zone name
        org_id:
          type: string
          description: Organization identifier for the RSSI zone
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        site_id:
          type: string
          description: Identifier of the site containing the RSSI zone
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
      description: RSSI-based zone configuration for a site
    rssi_zone_device:
      title: rssi_zone_device
      required:
      - device_id
      - rssi
      type: object
      properties:
        device_id:
          type: string
          description: Identifier of the AP device used by this RSSI zone
          contentEncoding: uuid
          readOnly: true
          examples:
          - 00000000-0000-0000-1000-d8695a0f9e61
        rssi:
          type: integer
          description: Minimum RSSI threshold for considering the device inside the zone
          contentEncoding: int32
          examples:
          - 0
      description: AP device and RSSI threshold used by an RSSI zone
    saml_metadata:
      title: saml_metadata
      type: object
      properties:
        acs_url:
          type: string
          description: If `idp_type`==`saml`, Assertion Consumer Service URL that receives SAML responses for this Mist SSO configuration
          readOnly: true
          examples:
          - https://api.mist.com/api/v1/saml/llDfa13f/login
        entity_id:
          type: string
          description: If `idp_type`==`saml`, service provider entity ID for this Mist SSO configuration
          readOnly: true
          examples:
          - https://api.mist.com/api/v1/saml/llDfa13f/login
        logout_url:
          type: string
          description: If `idp_type`==`saml`, Single Logout URL used by the identity provider to end the Mist SSO session
          readOnly: true
          examples:
          - https://api.mist.com/api/v1/saml/llDfa13f/logout
        metadata:
          type: string
          description: If `idp_type`==`saml`, service provider metadata XML for configuring the identity provider
          readOnly: true
          examples:
          - <?xml version="1.0" encoding="UTF-8"?><md:EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" entityID="https://api.mist.com/api/v1/saml/llDfa13f/login" validUntil="2027-10-12T21:59:01Z" xmlns:ds="http://www.w3.org/2000/09/xmldsig#"><md:SPSSODescriptor AuthnRequestsSigned="false" WantAssertionsSigned="true" protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol"><md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</md:NameIDFormat><md:AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://api.mist.com/api/v1/saml/llDfa13f/login" index="0" isDefault="true"/></md:SPSSODescriptor></md:EntityDescriptor>
        scim_base_url:
          type: string
          description: If `idp_type`==`oauth` and `scim_enabled`==`true`, SCIM base URL that the identity provider uses to send provisioning requests to Mist
          examples:
          - https://scim.nac-staging.mistsys.com/S_41b2525a-e8b8-4809-8168-f1d8dcbe9735/azure/4d72b1dc-7503-4717-81ea-80d0125b886e
      description: Read-only SAML and SCIM metadata generated for an SSO configuration
    scan_data_item_band:
      title: scan_data_item_band
      enum:
      - '2.4'
      - '5'
      type: string
      description: '5GHz or 2.4GHz band, associated with the BSSID scanned. enum: `2.4`, `5`'
    sdk_invite_sms:
      title: sdk_invite_sms
      required:
      - number
      type: object
      properties:
        number:
          type: string
          description: Destination phone number for the SDK invite SMS
      description: Request body for sending an SDK invite by SMS
    sdkinvite:
      title: sdkinvite
      required:
      - name
      type: object
      properties:
        created_time:
          type: number
          description: Timestamp when the SDK invite was created, in epoch seconds
          readOnly: true
        enabled:
          type: boolean
          description: Whether the SDK invite can currently be used
          default: true
        expire_time:
          type: integer
          description: Expiration time for the SDK invite, in epoch seconds
          contentEncoding: int32
        id:
          type: string
          description: Unique value identifying the SDK invite
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        modified_time:
          type: number
          description: Timestamp when the SDK invite was last modified, in epoch seconds
          readOnly: true
        name:
          type: string
          description: Display name shown for the SDK invite in the mobile experience
        org_id:
          type: string
          description: Organization identifier associated with the SDK invite
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        quota:
          type: integer
          description: Number of times this SDK invite can be used
          contentEncoding: int32
        quota_limited:
          type: boolean
          description: Whether use of the SDK invite is limited by the quota value
          default: false
        site_id:
          type: string
          description: Site identifier associated with the SDK invite, when scoped to a site
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
      description: SDK invite configuration used to onboard mobile SDK clients to an organization
    sdkstats_wireless_client:
      title: sdkstats_wireless_client
      required:
      - id
      - uuid
      type: object
      properties:
        id:
          type: string
          description: Unique value identifying the SDK client
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        last_seen:
          type:
          - number
          - 'null'
          description: Time when the SDK client was last observed, in epoch seconds
          readOnly: true
          examples:
          - 1470417522
        map_id:
          type:
          - string
          - 'null'
          description: Map identifier for the SDK client's location, if known
          contentEncoding: uuid
        name:
          type: string
          description: Display name provided for the SDK client
        network_connection:
          allOf:
          - $ref: '#/components/schemas/stats_sdkclient_network_connection1'
          - description: Current network connection details for the SDK client
        uuid:
          type: string
          description: Application UUID for the SDK client
          contentEncoding: uuid
        vbeacons:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/sdkstats_wireless_client_vbeacon'
          description: Virtual beacons currently associated with the SDK client and when each association began
        x:
          type: number
          description: Horizontal map coordinate of the SDK client location, in pixels, if known
        y:
          type: number
          description: Vertical map coordinate of the SDK client location, in pixels, if known
        zones:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/sdkstats_wireless_client_zone'
          description: Current zone memberships for the SDK client and when the client entered each zone
      description: Detailed statistics for an individual SDK client
    sdkstats_wireless_client_vbeacon:
      title: sdkstats_wireless_client_vbeacon
      required:
      - id
      - since
      type: object
      properties:
        id:
          type: string
          description: Virtual beacon identifier currently associated with the SDK client
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        since:
          type: number
          description: Time when the SDK client began matching the virtual beacon, in epoch seconds
      description: Virtual beacon currently associated with an SDK client
    sdkstats_wireless_client_zone:
      title: sdkstats_wireless_client_zone
      required:
      - id
      - since
      type: object
      properties:
        id:
          type: string
          description: Zone identifier that currently contains the SDK client
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        since:
          type: number
          description: Time when the SDK client entered the zone, in epoch seconds
      description: Zone currently containing an SDK client
    sdktemplate:
      title: sdktemplate
      required:
      - name
      type: object
      properties:
        bg_image:
          type: string
          description: Background image URL displayed by the SDK template
        btn_flr_bgcolor:
          type: string
          description: Floor button background color used by the SDK template, as a hex color
        created_time:
          type: number
          description: Timestamp when the SDK template was created, in epoch seconds
          readOnly: true
        default:
          type: boolean
          description: Whether this template is the default among available SDK templates
        for_site:
          type: boolean
          description: Whether the SDK template is scoped to a site
          readOnly: true
        header_txt:
          type: string
          description: Header text displayed by the SDK template
        id:
          type: string
          description: Unique value identifying the SDK template
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        modified_time:
          type: number
          description: Timestamp when the SDK template was last modified, in epoch seconds
          readOnly: true
        name:
          type: string
          description: Display name used to identify the SDK template
        org_id:
          type: string
          description: Organization identifier associated with the SDK template
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        search_txtcolor:
          type: string
          description: Text color used for search controls in the SDK template, as a hex color
        site_id:
          type: string
          description: Site identifier associated with the SDK template, when scoped to a site
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        welcome_msg:
          type: string
          description: Welcome message displayed by the SDK template
      description: Visual customization template for the mobile SDK experience
    search_events_wan_client:
      title: search_events_wan_client
      type: object
      properties:
        end:
          type: integer
          description: Upper bound timestamp of the WAN client event search window, in epoch seconds
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of WAN client event results returned by this page
          contentEncoding: int32
        next:
          type: string
          description: URL for the next page of WAN client event results, when more results are available
        results:
          type: array
          items:
            $ref: '#/components/schemas/events_client_wan'
          description: List of WAN client event result data returned by the search response
        start:
          type: integer
          description: Lower bound timestamp of the WAN client event search window, in epoch seconds
          contentEncoding: int32
        total:
          type: integer
          description: Count of WAN client event results matching the search
          contentEncoding: int32
      description: Paginated response for WAN client event searches
    search_org_devices_mxtunnel_status:
      title: search_org_devices_mxtunnel_status
      enum:
      - down
      - up
      type: string
      description: 'Mist Tunnel status filter for organization device search. enum: `down`, `up`'
    search_org_sw_or_gw_ports_type:
      title: search_org_sw_or_gw_ports_type
      enum:
      - switch
      - gateway
      - all
      type: string
      description: 'enum: `switch`, `gateway`, `all`'
    search_site_devices_desc_sort:
      title: search_site_devices_desc_sort
      enum:
      - mac
      - model
      - sku
      - timestamp
      type: string
      description: 'enum: `mac`, `model`, `sku`, `timestamp`'
    search_site_devices_mxtunnel_status:
      title: search_site_devices_mxtunnel_status
      enum:
      - down
      - up
      type: string
      description: 'Mist Tunnel status filter for site device search. enum: `down`, `up`'
    search_site_devices_sort:
      title: search_site_devices_sort
      enum:
      - mac
      - model
      - sku
      - timestamp
      type: string
      description: 'enum: `mac`, `model`, `sku`, `timestamp`'
    search_wan_client:
      title: search_wan_client
      type: object
      properties:
        end:
          type: integer
          description: Upper bound timestamp of the WAN client search window, in epoch seconds
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of WAN client records returned by this page
          contentEncoding: int32
        next:
          type: string
          description: URL for the next page of WAN client records, when more results are available
        results:
          type: array
          items:
            $ref: '#/components/schemas/stats_wan_client'
          description: WAN client records returned by the search response
        start:
          type: integer
          description: Lower bound timestamp of the WAN client search window, in epoch seconds
          contentEncoding: int32
        total:
          type: integer
          description: Count of WAN client records matching the search
          contentEncoding: int32
      description: Paginated response for WAN client searches
    search_wan_usage:
      title: search_wan_usage
      type: object
      properties:
        end:
          type: number
          description: Upper bound timestamp of the WAN usage search window, in epoch seconds
        limit:
          type: integer
          description: Maximum number of WAN usage records returned by this page
          contentEncoding: int32
        results:
          type: array
          items:
            $ref: '#/components/schemas/wan_usages'
          description: WAN usage records returned by the search response
        start:
          type: number
          description: Lower bound timestamp of the WAN usage search window, in epoch seconds
      description: Paginated response for WAN usage searches
    wan_usages:
      title: wan_usages
      type: object
      properties:
        mac:
          type: string
          description: Local router MAC address for the WAN usage record
          examples:
          - 5c5b35000001
        path_type:
          type: string
          description: WAN path type used by this usage record
          examples:
          - vpn
        path_weight:
          type: integer
          description: Configured weight for the WAN path
          contentEncoding: int32
          examples:
          - 10
        peer_mac:
          type: string
          description: Remote peer MAC address for the WAN path
          examples:
          - 0200018c95e1
        peer_port_id:
          type: string
          description: Remote peer interface identifier for the WAN path
          examples:
          - ge-0/0/3
        policy:
          type: string
          description: WAN path policy that selected this path
          examples:
          - policy1
        port_id:
          type: string
          description: Local router interface identifier for the WAN path
          examples:
          - ge-0/0/0.0
        tenant:
          type: string
          description: Network tenant context for the WAN usage record
          examples:
          - tenant1
      description: WAN usage record returned by site WAN usage searches
    search_webhook_delivery:
      title: search_webhook_delivery
      type: object
      properties:
        end:
          type: integer
          description: Upper bound timestamp of the webhook delivery search window, in epoch seconds
          contentEncoding: int32
          examples:
          - 1688035193
        limit:
          type: integer
          description: Maximum number of webhook delivery records returned by this page
          contentEncoding: int32
          examples:
          - 10
        next:
          type: string
          description: URL for the next page of webhook delivery records, when more results are available
        results:
          type: array
          items:
            $ref: '#/components/schemas/webhook_delivery'
          description: Webhook delivery records returned by the search response
        start:
          type: integer
          description: Lower bound timestamp of the webhook delivery search window, in epoch seconds
          contentEncoding: int32
          examples:
          - 1687948793
        total:
          type: integer
          description: Count of webhook delivery records matching the search
          contentEncoding: int32
      description: Paginated response for webhook delivery searches
    webhook_delivery:
      title: webhook_delivery
      type: object
      properties:
        error:
          type: string
          description: Message returned for a failed delivery attempt, when available
        id:
          type: string
          description: Unique identifier of the webhook delivery attempt
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        org_id:
          type: string
          description: Organization associated with the webhook delivery attempt
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        req_headers:
          type: string
          description: HTTP headers sent with the webhook delivery request
          examples:
          - '{\"Content-Type\":[\"application/json\"],\"User-Agent\":[\"Mist-webhook\"]}'
        req_payload:
          type: string
          description: JSON payload sent in the webhook delivery request
          examples:
          - '{\"topic\":\"audits\",\"events\":[{\"admin_name\":\"John Doe john.doe@juniper.net\",\"after\":\"{\\"radio_config\\": {\\"band_24\\": {\\"disabled\\": false, \\"allow_rrm_disable\\": false, \\"power_min\\": null, \\"power_max\\": null, \\"power\\": 10, \\"preamble\\": \\"short\\", \\"channels\\": [1, 10], \\"bandwidth\\": 20}}}\",\"before\":\"{\\"radio_config\\": {\\"band_24\\": {\\"disabled\\": false, \\"allow_rrm_disable\\": false, \\"power_min\\": 8, \\"power_max\\": 18, \\"power\\": null, \\"preamble\\": \\"long\\", \\"channels\\": [1, 10], \\"bandwidth\\": 20}}}\",\"id\":\"737909a2-04ff-4aeb-b9da-cc924e74a4dd\",\"message\":\"Update Site Settings\",\"org_id\":\"fc7e2967-e7ef-41e6-b007-1217713de05a\",\"site_id\":\"256c3a35-9cb7-436e-bc6d-314972645d95\",\"site_name\":\"Test Site\",\"src_ip\":\"1.2.3.4\",\"timestamp\":1685956576.923601,\"user_agent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/112.0.0.0 Safari/537.36\"}]}'
        req_url:
          type: string
          description: Destination URL used for the webhook delivery request
          examples:
          - https://example.com
        resp_body:
          type: string
          description: Response body returned by the webhook destination
          examples:
          - Ok
        resp_headers:
          type: string
          description: Response headers returned by the webhook destination
        site_id:
          type: string
          description: Site associated with the webhook delivery attempt, when applicable
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        status:
          allOf:
          - $ref: '#/components/schemas/webhook_delivery_status2'
          - description: 'Delivery result for the webhook request. enum: `failure`, `success`.'
            examples:
            - failure
        status_code:
          type: integer
          description: HTTP status code returned by the webhook destination
          contentEncoding: int32
          examples:
          - 200
        timestamp:
          type: number
          description: Time when the webhook delivery attempt occurred, in epoch seconds
          readOnly: true
        topic:
          allOf:
          - $ref: '#/components/schemas/webhook_delivery_topic2'
          - description: 'Webhook topic delivered in this request. enum: `alarms`, `audits`, `device-updowns`, `occupancy-alerts`, `ping`.'
            examples:
            - audits
        webhook_id:
          type: string
          description: Unique identifier of the configured webhook used for this delivery attempt
          contentEncoding: uuid
          examples:
          - 7a11b901-f719-4c91-8aef-deb8699a6364
      description: Record of a webhook delivery attempt and the destination response
    search_wired_client:
      title: search_wired_client
      required:
      - end
      - limit
      - results
      - start
      - total
      type: object
      properties:
        end:
          type: number
          description: Upper bound timestamp of the wired client search window, in epoch seconds
        limit:
          type: integer
          description: Maximum number of wired client records returned by this page
          contentEncoding: int32
        next:
          type: string
          description: URL for the next page of wired client records, when more results are available
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/wired_client_response'
          description: Wired client records returned by the search response
        start:
          type: number
          description: Lower bound timestamp of the wired client search window, in epoch seconds
        total:
          type: integer
          description: Count of wired client records matching the search
          contentEncoding: int32
      description: Paginated response for wired client searches
    wired_client_response:
      title: wired_client_response
      type: object
      properties:
        auth_method:
          type: string
          description: Method used to authenticate the wired client
          examples:
          - mac_auth
        auth_state:
          type: string
          description: State reported for wired client authentication
          examples:
          - authenticated
        device_mac:
          type: array
          items:
            type: string
          description: MAC addresses of switches or gateways where the wired client was observed
          readOnly: true
        device_mac_port:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/wired_client_response_device_mac_port_item'
          description: Per-port switch or gateway observations for the wired client
          readOnly: true
        dhcp_client_identifier:
          type: string
          description: Identifier value reported by the wired client in DHCP
          examples:
          - MAC address 00155df6d500
        dhcp_client_options:
          type: array
          items:
            $ref: '#/components/schemas/dhcp_client_option'
          description: DHCP options observed from the wired client
        dhcp_fqdn:
          type: string
          description: Fully qualified domain name reported by the wired client through DHCP
          examples:
          - ITS-VMMT0-D1N02.mgthub.local
        dhcp_hostname:
          type: string
          description: Hostname reported by the wired client through DHCP
          examples:
          - ITS-VMMT0-D1N02
        dhcp_request_params:
          type: string
          description: Parameter request list advertised by the wired client in DHCP
          examples:
          - 1 3 6 15 31 33 43 44 46 47 119 121 249 252
        dhcp_vendor_class_identifier:
          type: string
          description: Vendor class identifier reported by the wired client in DHCP
          examples:
          - MSFT 5.0
        ip:
          type: array
          items:
            type: string
          description: Client IP addresses observed for the wired client
          readOnly: true
        mac:
          type: string
          description: Client MAC address for the wired client record
          readOnly: true
        org_id:
          type: string
          description: Owning organization associated with the wired client record
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        port_id:
          type: array
          items:
            type: string
          description: Switch or gateway port identifiers where the wired client was observed
          readOnly: true
        site_id:
          type: string
          description: Mist site associated with the wired client record
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        timestamp:
          type: number
          description: Time when the wired client record was observed, in epoch seconds
          readOnly: true
        vlan:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: Client VLAN identifiers observed for the wired client
          readOnly: true
      description: Wired client record returned by a wired client search
    search_wireless_client_session:
      title: search_wireless_client_session
      required:
      - end
      - limit
      - results
      - start
      - total
      type: object
      properties:
        end:
          type: number
          description: Upper bound timestamp of the wireless client session search window, in epoch seconds
        limit:
          type: integer
          description: Maximum number of wireless client session records returned by this page
          contentEncoding: int32
        next:
          type: string
          description: URL for the next page of wireless client session records, when more results are available
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/wireless_client_session'
          description: Wireless client session records returned by the search response
        start:
          type: number
          description: Lower bound timestamp of the wireless client session search window, in epoch seconds
        total:
          type: integer
          description: Count of wireless client session records matching the search
          contentEncoding: int32
      description: Paginated response for wireless client session searches
    wireless_client_session:
      title: wireless_client_session
      required:
      - ap
      - band
      - connect
      - disconnect
      - duration
      - mac
      - org_id
      - site_id
      - ssid
      - timestamp
      - wlan_id
      type: object
      properties:
        ap:
          type: string
          description: MAC address of the access point associated with the client session
          readOnly: true
        band:
          type: string
          description: Radio band used by the client session
          readOnly: true
        client_manufacture:
          type:
          - string
          - 'null'
          description: Manufacturer reported for the client device, when available
          readOnly: true
        connect:
          type: integer
          description: Time when the client session connected, in epoch seconds
          contentEncoding: int32
          readOnly: true
        disconnect:
          type: integer
          description: Time when the client session disconnected, in epoch seconds
          contentEncoding: int32
          readOnly: true
        duration:
          type: number
          description: Length of the client session, in seconds
          readOnly: true
        for_site:
          type: boolean
          description: Whether this client session record is scoped to a site
          readOnly: true
        mac:
          type: string
          description: Client MAC address for the session
          readOnly: true
        org_id:
          type: string
          description: Organization associated with the client session
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        site_id:
          type: string
          description: Site associated with the client session
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        ssid:
          type: string
          description: WLAN SSID used by the client session
          readOnly: true
        tags:
          type: array
          items:
            type: string
          description: Event or classification tags attached to the client session
          readOnly: true
        timestamp:
          type: number
          description: Time when the client session record was observed, in epoch seconds
          readOnly: true
        wlan_id:
          type: string
          description: Identifier of the WLAN associated with the client session
          contentEncoding: uuid
          readOnly: true
      description: Wireless client session record returned by a session search
    search_wxtag_apps_item:
      title: search_wxtag_apps_item
      required:
      - group
      - key
      - name
      type: object
      properties:
        group:
          type: string
          description: Application category group containing this WxTag app
          examples:
          - Emails
        key:
          type: string
          description: Stable application key used in WxTag configuration
          examples:
          - gmail
        name:
          type: string
          description: Display name of the application
          examples:
          - Gmail - web/app
      description: Application metadata available for WxTag matching
    secintel_profile:
      title: secintel_profile
      type: object
      properties:
        name:
          type: string
          description: Display name of the SecIntel profile
          examples:
          - secintel-custom
        profiles:
          type: array
          items:
            $ref: '#/components/schemas/secintel_profile_profile'
          description: Category-specific SecIntel action settings included in this profile
      description: SecIntel profile containing category-specific threat intelligence actions
    secintel_profile_profile:
      title: secintel_profile_profile
      type: object
      properties:
        action:
          allOf:
          - $ref: '#/components/schemas/secintel_profile_profile_action2'
          - description: 'Protection level applied to the SecIntel category. enum: `default`, `standard`, `strict`.'
        category:
          allOf:
          - $ref: '#/components/schemas/secintel_profile_profile_category2'
          - description: 'SecIntel feed category configured by this profile entry. enum: `CC`, `DNS`, `IH`.'
      description: SecIntel action setting for a specific feed category
    secintel_profile_profile_action:
      title: secintel_profile_profile_action
      enum:
      - default
      - standard
      - strict
      type: string
      description: 'enum: `default`, `standard`, `strict`'
    secintel_profile_profile_category:
      title: secintel_profile_profile_category
      enum:
      - CC
      - DNS
      - IH
      type: string
      description: 'enum: `CC`, `IH` (Infected Host), `DNS`'
    secpolicy:
      title: secpolicy
      type: object
      properties:
        created_time:
          type: number
          description: Timestamp when the security policy was created, in epoch seconds
          readOnly: true
        id:
          type: string
          description: Unique value identifying the security policy
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        modified_time:
          type: number
          description: Timestamp when the security policy was last modified, in epoch seconds
          readOnly: true
        name:
          type: string
          description: Display name of the security policy
        org_id:
          type: string
          description: Organization identifier associated with the security policy
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        site_id:
          type: string
          description: Site identifier associated with the security policy, when scoped to a site
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        wlans:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/wlan'
          description: WLAN configurations audited by this security policy
      description: Security Policy is designed to audit / catch discrepancies between "what’s intended to be running" versus "what’s actually running" in a network. Many big organizations have separated Security and IT team (for good reasons). Each site can be assigned a security policy. Whenever an AP is provisioned, the configuration will be checked against the security policy. Any violations will be flagged in Device Config History where you can search for the when and where the violation occurs.
    wlan:
      title: wlan
      required:
      - ssid
      type: object
      properties:
        acct_immediate_update:
          type: boolean
          description: Enable coa-immediate-update and address-change-immediate-update on the access profile.
          default: false
        acct_interim_interval:
          maximum: 65535
          minimum: 0
          type: integer
          description: How frequently should interim accounting be reported, 60-65535. default is 0 (use one specified in Access-Accept request from RADIUS Server). Very frequent messages can affect the performance of the RADIUS server, 600 and up is recommended when enabled
          contentEncoding: int32
          default: 0
          examples:
          - 0
        acct_servers:
          type: array
          items:
            $ref: '#/components/schemas/radius_acct_server'
          description: RADIUS accounting servers used by this WLAN
        airwatch:
          allOf:
          - $ref: '#/components/schemas/wlan_airwatch2'
          - description: Integration settings for AirWatch device compliance on this WLAN
        allow_ipv6_ndp:
          type: boolean
          description: Only applicable when `limit_bcast`==`true`, which allows or disallows ipv6 Neighbor Discovery packets to go through
          default: true
        allow_mdns:
          type: boolean
          description: Only applicable when `limit_bcast`==`true`, which allows mDNS / Bonjour packets to go through
          default: false
        allow_ssdp:
          type: boolean
          description: Only applicable when `limit_bcast`==`true`, which allows SSDP
          default: false
        ap_ids:
          type:
          - array
          - 'null'
          items:
            type: string
            contentEncoding: uuid
          description: Access point identifiers used when `apply_to`==`aps`
        app_limit:
          allOf:
          - $ref: '#/components/schemas/wlan_app_limit2'
          - description: Bandwidth limits for applications on this WLAN
        app_qos:
          allOf:
          - $ref: '#/components/schemas/wlan_app_qos2'
          - description: QoS rules for application traffic on this WLAN
        apply_to:
          allOf:
          - $ref: '#/components/schemas/wlan_apply_to2'
          - description: 'Scope that determines where this WLAN is applied. enum: `aps`, `site`, `wxtags`.'
        arp_filter:
          type: boolean
          description: Whether to enable smart arp filter
          default: false
        auth:
          allOf:
          - $ref: '#/components/schemas/wlan_auth2'
          - description: Settings that control client authentication for this WLAN
        auth_server_selection:
          allOf:
          - $ref: '#/components/schemas/wlan_auth_server_selection2'
          - description: 'RADIUS authentication server selection behavior for this WLAN. enum: `ordered`, `unordered`.'
            examples:
            - ordered
        auth_servers:
          type: array
          items:
            $ref: '#/components/schemas/radius_auth_server'
          description: RADIUS authentication servers used by this WLAN. Required when `auth.type`==`eap`
        auth_servers_nas_id:
          type:
          - string
          - 'null'
          description: Optional, up to 48 bytes, will be dynamically generated if not provided. used only for authentication servers
          examples:
          - 5c5b350e0101-nas
        auth_servers_nas_ip:
          type:
          - string
          - 'null'
          description: Optional, NAS-IP-ADDRESS to use
          examples:
          - 15.3.1.5
        auth_servers_retries:
          type: integer
          description: RADIUS auth session retries. Following fast timers are set if "fast_dot1x_timers" knob is enabled. ‘retries’ are set to value of auth_servers_retries. ‘max-requests’ is also set when setting auth_servers_retries and is set to default value to 3.
          contentEncoding: int32
          default: 2
          examples:
          - 5
        auth_servers_timeout:
          type: integer
          description: RADIUS auth session timeout. Following fast timers are set if "fast_dot1x_timers" knob is enabled. ‘quite-period’  and ‘transmit-period’ are set to half the value of auth_servers_timeout. ‘supplicant-timeout’ is also set when setting auth_servers_timeout and is set to default value of 10.
          contentEncoding: int32
          default: 5
        band:
          type: string
          description: '`band` is deprecated and kept for backward compatibility. Use `bands` instead'
          deprecated: true
        band_steer:
          type: boolean
          description: Whether to enable band_steering, this works only when band==both
          default: false
        band_steer_force_band5:
          type: boolean
          description: Force dual_band capable client to connect to 5G
          default: false
        bands:
          type: array
          items:
            $ref: '#/components/schemas/dot11_band'
          description: Radio bands on which this WLAN is broadcast
        block_blacklist_clients:
          type: boolean
          description: Whether to block the clients in the blacklist (up to first 256 macs)
          default: false
        bonjour:
          allOf:
          - $ref: '#/components/schemas/wlan_bonjour2'
          - description: Service discovery gateway settings for Bonjour traffic on this WLAN
        cisco_cwa:
          allOf:
          - $ref: '#/components/schemas/wlan_cisco_cwa2'
          - description: Central web authentication settings for Cisco CWA on this WLAN
        client_limit_down:
          anyOf:
          - maximum: 999000
            minimum: 1
            type: integer
            contentEncoding: int32
          - type: string
          description: Downlink bandwidth limit applied per client
        client_limit_down_enabled:
          type: boolean
          description: If downlink limiting per-client is enabled
          default: false
        client_limit_up:
          anyOf:
          - maximum: 999000
            minimum: 1
            type: integer
            contentEncoding: int32
          - type: string
          description: Uplink bandwidth limit applied per client
        client_limit_up_enabled:
          type: boolean
          description: If uplink limiting per-client is enabled
          default: false
        coa_servers:
          type: array
          items:
            $ref: '#/components/schemas/coa_server'
          description: RADIUS Change of Authorization servers available to this WLAN
        created_time:
          type: number
          description: Time when this WLAN was created, in epoch seconds
          readOnly: true
        disable_11ax:
          type: boolean
          description: Some old WLAN drivers may not be compatible
          default: false
        disable_11be:
          type: boolean
          description: To disable Wi-Fi 7 EHT IEs
          default: false
        disable_ht_vht_rates:
          type: boolean
          description: To disable ht or vht rates
          default: false
        disable_message_authenticator_check:
          type: boolean
          description: whether to disable Message-Authenticator Check, which is used to verify the integrity of RADIUS messages, default is false (i.e. for better security)
          default: false
        disable_uapsd:
          type: boolean
          description: Whether to disable U-APSD
          default: false
        disable_v1_roam_notify:
          type: boolean
          description: Disable sending v2 roam notification messages
          default: false
        disable_v2_roam_notify:
          type: boolean
          description: Disable sending v2 roam notification messages
          default: false
        disable_when_gateway_unreachable:
          type: boolean
          description: >-
            When any of the following is true, this WLAN will be disabled
               * cannot get IP
               * cannot obtain default gateway
               * cannot reach default gateway
          default: false
        disable_when_mxtunnel_down:
          type: boolean
          description: Whether to disable this WLAN when the configured Mist tunnel is down
          default: false
        disable_wmm:
          type: boolean
          description: Whether to disable WMM
          default: false
        dns_server_rewrite:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/wlan_dns_server_rewrite2'
          - description: RADIUS group based DNS server rewrite settings for this WLAN
        dtim:
          type: integer
          description: Delivery Traffic Indication Message interval for this WLAN
          contentEncoding: int32
          default: 2
        dynamic_psk:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/wlan_dynamic_psk2'
          - description: Per-user PSK selection settings for this WLAN
        dynamic_vlan:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/wlan_dynamic_vlan2'
          - description: VLAN assignment settings for 802.1X dynamic VLANs
        enable_ftm:
          type: boolean
          description: Enable FTM (Fine-Time Measurement, 802.11mc); configures the AP as an FTM Responder (target), allowing clients to perform ranging requests against it
          default: false
        enable_local_keycaching:
          type: boolean
          description: Enable AP-AP keycaching via multicast
          default: false
        enable_wireless_bridging:
          type: boolean
          description: By default, we'd inspect all DHCP packets and drop those unrelated to the wireless client itself in the case where client is a wireless bridge (DHCP packets for other MACs will need to be forwarded), wireless_bridging can be enabled
          default: false
        enable_wireless_bridging_dhcp_tracking:
          type: boolean
          description: If the client bridge is doing DHCP on behalf of other devices (L2-NAT), enable dhcp_tracking will cut down DHCP response packets to be forwarded to wireless
          default: false
        enabled:
          type: boolean
          description: If this wlan is enabled
          default: true
        fast_dot1x_timers:
          type: boolean
          description: If set to true, sets default fast-timers with values calculated from ‘auth_servers_timeout’ and ‘auth_server_retries’ .
          default: false
        for_site:
          type: boolean
          description: Whether this WLAN record is scoped to a site
          readOnly: true
        hide_ssid:
          type: boolean
          description: Whether to hide SSID in beacon
          default: false
        hostname_ie:
          type: boolean
          description: Include hostname inside IE in AP beacons / probe responses
          default: false
        hotspot20:
          allOf:
          - $ref: '#/components/schemas/wlan_hotspot_202'
          - description: Passpoint and Hotspot 2.0 settings for this WLAN
        id:
          type: string
          description: Unique identifier for this WLAN
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        inject_dhcp_option_82:
          allOf:
          - $ref: '#/components/schemas/wlan_inject_dhcp_option_822'
          - description: DHCP Option 82 insertion settings for this WLAN
        interface:
          allOf:
          - $ref: '#/components/schemas/wlan_interface2'
          - description: 'Network interface or tunnel where this WLAN bridges client traffic. enum: `all`, `eth0`, `eth1`, `eth2`, `eth3`, `mxtunnel`, `site_mxedge`, `wxtunnel`.'
            examples:
            - all
        isolation:
          type: boolean
          description: Whether to stop clients to talk to each other
          default: false
        l2_isolation:
          type: boolean
          description: If isolation is enabled, whether to deny clients to talk to L2 on the LAN
          default: false
        legacy_overds:
          type: boolean
          description: Legacy devices requires the Over-DS (for Fast BSS Transition) bit set (while our chip doesn’t support it). Warning! Enabling this will cause problem for iOS devices.
          default: false
        limit_bcast:
          type: boolean
          description: Whether to limit broadcast packets going to wireless (i.e. only allow certain bcast packets to go through)
          default: false
        limit_probe_response:
          type: boolean
          description: Limit probe response base on some heuristic rules
          default: false
        max_idletime:
          maximum: 86400
          minimum: 60
          type: integer
          description: Max idle time in seconds
          contentEncoding: int32
          default: 1800
          examples:
          - 1800
        max_num_clients:
          maximum: 128
          minimum: 0
          type: integer
          description: Maximum number of client connected to the SSID. `0` means unlimited
          contentEncoding: int32
          default: 0
        mist_nac:
          allOf:
          - $ref: '#/components/schemas/wlan_mist_nac1'
          - description: Juniper Mist NAC settings used by this WLAN
        modified_time:
          type: number
          description: Time when this WLAN was last modified, in epoch seconds
          readOnly: true
        msp_id:
          type: string
          description: Managed service provider identifier associated with this WLAN
          contentEncoding: uuid
          readOnly: true
          examples:
          - b9d42c2e-88ee-41f8-b798-f009ce7fe909
        mxtunnel_id:
          type: string
          description: (deprecated, use mxtunnel_ids instead) when `interface`==`mxtunnel`, id of the Mist Tunnel
          contentEncoding: uuid
          deprecated: true
        mxtunnel_ids:
          type: array
          items:
            type: string
          description: Mist Tunnel identifiers used when `interface`==`mxtunnel`
        mxtunnel_name:
          type: array
          items:
            type: string
          description: Mist Tunnel names used when `interface`==`site_mxedge`
        no_static_dns:
          type: boolean
          description: Whether to only allow client to use DNS that we’ve learned from DHCP response
          default: false
        no_static_ip:
          type: boolean
          description: Whether to only allow client that we’ve learned from DHCP exchange to talk
          default: false
        org_id:
          type: string
          description: Owning organization associated with this WLAN
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        portal:
          allOf:
          - $ref: '#/components/schemas/wlan_portal2'
          - description: Guest portal settings for this WLAN
        portal_allowed_hostnames:
          type: array
          items:
            type: string
          description: Guest portal hostnames that clients may reach before authorization
          default: []
          examples:
          - - snapchat.com
            - ibm.com
        portal_allowed_subnets:
          type: array
          items:
            type: string
          description: Guest portal CIDR subnets that clients may reach before authorization
          default: []
          examples:
          - - 63.5.3.0/24
        portal_api_secret:
          type:
          - string
          - 'null'
          description: API secret (auto-generated) that can be used to sign guest authorization requests, only generated when auth is set to `external`
          examples:
          - EIfPMOykI3lMlDdNPub2WcbqT6dNOtWwmYHAd6bY
        portal_denied_hostnames:
          type: array
          items:
            type: string
          description: Guest portal hostnames denied before authorization, taking precedence over allowed hostnames
          default: []
          examples:
          - - msg.snapchat.com
        portal_image:
          type:
          - string
          - 'null'
          description: Url of portal background image
          contentEncoding: uri
          readOnly: true
          examples:
          - https://url/to/image.png
        portal_sso_url:
          type:
          - string
          - 'null'
          description: URL used in the SSO process, auto-generated when auth is set to `sso`
          readOnly: true
        portal_template_url:
          type:
          - string
          - 'null'
          description: N.B portal_template will be forked out of wlan objects soon. To fetch portal_template, please query portal_template_url. To update portal_template, use Wlan Portal Template.
          readOnly: true
        qos:
          allOf:
          - $ref: '#/components/schemas/wlan_qos2'
          - description: Quality-of-service settings for WLAN client traffic
        radsec:
          allOf:
          - $ref: '#/components/schemas/radsec2'
          - description: TLS-secured RADIUS transport settings for this WLAN
        rateset:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/wlan_datarates'
          description: Data rate settings by RF band for this WLAN
        reconnect_clients_when_roaming_mxcluster:
          type: boolean
          description: When different mxcluster is on different subnet, we'd want to disconnect clients (so they'll reconnect and get new IPs)
          default: false
        roam_mode:
          allOf:
          - $ref: '#/components/schemas/wlan_roam_mode2'
          - description: 'Fast roaming mode configured for this WLAN. enum: `11r`, `NONE`, `OKC`.'
            examples:
            - NONE
        schedule:
          allOf:
          - $ref: '#/components/schemas/wlan_schedule2'
          - description: Operating schedule controlling when this WLAN is active
        site_id:
          type: string
          description: Mist site associated with this WLAN, when site-scoped
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        sle_excluded:
          type: boolean
          description: Whether to exclude this WLAN from SLE metrics
          default: false
        ssid:
          type: string
          description: Name of the SSID
          examples:
          - corporate
        template_id:
          type:
          - string
          - 'null'
          description: Identifier of the WLAN template associated with this WLAN
          contentEncoding: uuid
        thumbnail:
          type:
          - string
          - 'null'
          description: Url of portal background image thumbnail
          contentEncoding: uri
          readOnly: true
        use_eapol_v1:
          type: boolean
          description: If `auth.type`==`eap` or `auth.type`==`psk`, should only be set for legacy client, such as pre-2004, 802.11b devices
          default: false
        vlan_enabled:
          type: boolean
          description: If vlan tagging is enabled
          default: false
        vlan_id:
          oneOf:
          - type: string
          - maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
          - {}
          description: Default VLAN ID, range, or variable used when `vlan_enabled`==`true`
        vlan_ids:
          oneOf:
          - type: string
            examples:
            - 1,2
          - type: array
            items:
              $ref: '#/components/schemas/vlan_id_with_variable'
            examples:
            - - 3
              - 4
              - 5
          description: Pool of VLAN IDs used when `vlan_enabled`==`true` and `vlan_pooling`==`true`
        vlan_pooling:
          type: boolean
          description: Requires `vlan_enabled`==`true` to be set to `true`. Vlan pooling allows AP to place client on different VLAN using a deterministic algorithm
          default: false
        wlan_limit_down:
          anyOf:
          - maximum: 999000
            minimum: 1
            type: integer
            contentEncoding: int32
          - type: string
          description: Downlink bandwidth limit applied to the whole WLAN
        wlan_limit_down_enabled:
          type: boolean
          description: If downlink limiting for whole wlan is enabled
          default: false
        wlan_limit_up:
          anyOf:
          - maximum: 999000
            minimum: 1
            type: integer
            contentEncoding: int32
          - type: string
          description: Uplink bandwidth limit applied to the whole WLAN
        wlan_limit_up_enabled:
          type: boolean
          description: If uplink limiting for whole wlan is enabled
          default: false
        wxtag_ids:
          type:
          - array
          - 'null'
          items:
            type: string
            contentEncoding: uuid
          description: Identifiers of WxLAN tags used when `apply_to`==`wxtags`
        wxtunnel_id:
          type:
          - string
          - 'null'
          description: When `interface`=`wxtunnel`, id of the WXLAN Tunnel
        wxtunnel_remote_id:
          type:
          - string
          - 'null'
          description: When `interface`=`wxtunnel`, remote tunnel identifier
      description: '**Note**: portal_template will be forked out of wlan objects soon. To fetch portal_template, please query portal_template_url. To update portal_template, use Wlan Portal Template.'
    service:
      title: service
      type: object
      properties:
        addresses:
          type: array
          items:
            type: string
          description: Custom IPv4 or IPv6 subnets matched by this service when `type`==`custom`
          examples:
          - - 10.0.0.0/8
            - 172.21.0.0/16
            - 2001:db8:abcd:12::/64
            - fd28::/128
        app_categories:
          type: array
          items:
            type: string
          description: Categories of applications matched by this service when `type`==`app_categories`
          examples:
          - - Sports
        app_subcategories:
          type: array
          items:
            type: string
          description: Application subcategories matched by this service when `type`==`app_categories`
          examples:
          - - Shopping
        apps:
          type: array
          items:
            type: string
          description: Application identifiers matched by this service when `type`==`apps`
          examples:
          - - office365
            - okta
        client_limit_down:
          maximum: 107374182
          minimum: 0
          type: integer
          description: 0 means unlimited, value from 0 to 107374182
          contentEncoding: int32
          default: 0
          examples:
          - 300000
        client_limit_up:
          maximum: 107374182
          minimum: 0
          type: integer
          description: 0 means unlimited, value from 0 to 107374182
          contentEncoding: int32
          default: 0
          examples:
          - 300000
        created_time:
          type: number
          description: Timestamp when the service definition was created, in epoch seconds
          readOnly: true
        description:
          type: string
          description: Free-form description of the service definition
        dscp:
          oneOf:
          - type: string
          - maximum: 63
            minimum: 0
            type: integer
            contentEncoding: int32
          description: QoS DSCP value used for custom SSR traffic classification
        failover_policy:
          allOf:
          - $ref: '#/components/schemas/service_failover_policy2'
          - description: 'Failover behavior for traffic matched by this service. enum: `non_revertible`, `none`, `revertible`.'
        hostnames:
          type: array
          items:
            type: string
          description: Domain hostnames matched by this custom service for web filtering
        id:
          type: string
          description: Unique value identifying the service definition
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        max_jitter:
          oneOf:
          - type: string
          - maximum: 2147483647
            minimum: 0
            type: integer
            contentEncoding: int32
          description: Maximum jitter threshold used for SSR uplink selection when `traffic_type`==`custom`
        max_latency:
          oneOf:
          - type: string
          - maximum: 2147483647
            minimum: 0
            type: integer
            contentEncoding: int32
          description: Maximum latency threshold used for SSR uplink selection when `traffic_type`==`custom`
        max_loss:
          oneOf:
          - type: string
          - maximum: 100
            minimum: 0
            type: integer
            contentEncoding: int32
          description: Maximum packet loss threshold used for SSR uplink selection when `traffic_type`==`custom`
        modified_time:
          type: number
          description: Timestamp when the service definition was last modified, in epoch seconds
          readOnly: true
        name:
          type: string
          description: Display name of the service definition
        org_id:
          type: string
          description: Organization identifier associated with the service definition
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        service_limit_down:
          maximum: 107374182
          minimum: 0
          type: integer
          description: 0 means unlimited, value from 0 to 107374182
          contentEncoding: int32
          default: 0
          examples:
          - 300000
        service_limit_up:
          maximum: 107374182
          minimum: 0
          type: integer
          description: 0 means unlimited, value from 0 to 107374182
          contentEncoding: int32
          default: 0
          examples:
          - 300000
        sle_enabled:
          type: boolean
          description: Whether to enable measure SLE
          default: false
        specs:
          type: array
          items:
            $ref: '#/components/schemas/service_spec'
          description: Protocol and port match rules used when `type`==`custom`
        ssr_relaxed_tcp_state_enforcement:
          type: boolean
          description: Whether SSR relaxes TCP state enforcement for this service
          default: false
        traffic_class:
          allOf:
          - $ref: '#/components/schemas/service_traffic_class2'
          - description: 'Traffic class applied when `traffic_type`==`custom`. enum: `best_effort`, `high`, `low`, `medium`.'
        traffic_type:
          type: string
          description: values from [List Traffic Types]($e/Constants%20Definitions/listTrafficTypes)
          default: data_best_effort
        type:
          allOf:
          - $ref: '#/components/schemas/service_type2'
          - description: 'Matching mode that determines which app, URL, or custom fields are used. enum: `app_categories`, `apps`, `custom`, `urls`.'
        urls:
          type: array
          items:
            type: string
          description: URL patterns matched by this service when `type`==`urls`
      description: Traffic service definition for applications or destinations used by gateway and SSR policies
    service_failover_policy:
      title: service_failover_policy
      enum:
      - non_revertible
      - none
      - revertible
      type: string
      description: 'enum: `non_revertible`, `none`, `revertible`'
    service_packet:
      title: service_packet
      type: object
      properties:
        service_data:
          type: string
          description: ata from service data
        service_uuid:
          type: string
          description: UUID from service data
      description: Service data packet observed from an asset or beacon
    service_policy:
      title: service_policy
      type: object
      properties:
        action:
          allOf:
          - $ref: '#/components/schemas/allow_deny2'
          - description: Allow or deny action for traffic matched by this service policy
        antivirus:
          allOf:
          - $ref: '#/components/schemas/service_policy_antivirus1'
          - description: Malware and virus inspection settings applied by this service policy
        appqoe:
          allOf:
          - $ref: '#/components/schemas/service_policy_appqoe1'
          - description: Application QoE settings applied by this service policy
        ewf:
          type: array
          items:
            $ref: '#/components/schemas/service_policy_ewf_rule'
          description: Enhanced web filtering rules applied by this service policy
        idp:
          allOf:
          - $ref: '#/components/schemas/idp_config2'
          - description: Intrusion detection and prevention settings applied by this service policy
        local_routing:
          type: boolean
          description: Whether the policy permits access within the same VRF
        name:
          type: string
          description: Display name of the service policy
        path_preference:
          type: string
          description: By default, we derive all paths available and use them. Optionally, you can customize by using `path_preference`
        secintel:
          allOf:
          - $ref: '#/components/schemas/service_policy_secintel3'
          - description: Threat intelligence settings applied by this service policy
        servicepolicy_id:
          type: string
          description: Organization-level service policy identifier used to link and override selected attributes
          contentEncoding: uuid
        services:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Application services or service groups matched by this policy
        skyatp:
          allOf:
          - $ref: '#/components/schemas/service_policy_skyatp2'
          - description: Threat inspection settings provided by Sky ATP for this service policy
        ssl_proxy:
          allOf:
          - $ref: '#/components/schemas/service_policy_ssl_proxy3'
          - description: TLS inspection settings applied by this service policy
        syslog:
          allOf:
          - $ref: '#/components/schemas/service_policy_syslog2'
          - description: Remote logging settings applied by this service policy
        tenants:
          uniqueItems: true
          type: array
          items:
            type: string
          description: User or network tenants matched by this service policy
      description: Site-level service policy that allows or denies traffic for tenants and services
    service_policy_aamw:
      title: service_policy_aamw
      type: object
      properties:
        aamwprofile_id:
          type: string
          description: Organization-level advanced anti-malware profile ID; takes precedence over inline `profile` settings
          contentEncoding: uuid
        enabled:
          type: boolean
          description: Whether advanced anti-malware inspection is enabled for the service policy
          default: false
        profile:
          allOf:
          - $ref: '#/components/schemas/service_policy_aamw_profile2'
          - description: 'Built-in advanced anti-malware inspection profile to apply. enum: `docsonly`, `executables`, `standard`.'
      description: SRX advanced anti-malware settings for a service policy
    service_policy_aamw_profile:
      title: service_policy_aamw_profile
      enum:
      - docsonly
      - executables
      - standard
      type: string
      description: 'enum: `docsonly`, `executables`, `standard`'
    service_policy_antivirus:
      title: service_policy_antivirus
      type: object
      properties:
        avprofile_id:
          type: string
          description: Organization-level antivirus profile ID; takes precedence over inline `profile` settings
          contentEncoding: uuid
        enabled:
          type: boolean
          description: Whether antivirus inspection is enabled for the service policy
          default: false
        profile:
          type: string
          description: Antivirus profile name to apply, such as `default`, `noftp`, `httponly`, or an AV profile key
      description: SRX antivirus inspection settings for a service policy
    service_policy_appqoe:
      title: service_policy_appqoe
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether application QoE is enabled for the service policy
          default: false
      description: SRX application QoE settings for a service policy
    service_policy_ewf_rule:
      title: service_policy_ewf_rule
      type: object
      properties:
        alert_only:
          type: boolean
          description: Whether matching enhanced web filtering traffic is logged without being blocked
        block_message:
          type: string
          description: Message returned when enhanced web filtering blocks a request
          examples:
          - Access to this URL Category has been blocked
        enabled:
          type: boolean
          description: Whether this enhanced web filtering rule is enabled
          default: false
        profile:
          allOf:
          - $ref: '#/components/schemas/service_policy_ewf_rule_profile2'
          - description: 'Enhanced web filtering profile applied by this rule. enum: `critical`, `standard`, `strict`.'
      description: Enhanced web filtering rule applied by a service policy
    service_policy_ewf_rule_profile:
      title: service_policy_ewf_rule_profile
      enum:
      - critical
      - standard
      - strict
      type: string
      description: 'enum: `critical`, `standard`, `strict`'
    service_policy_secintel:
      title: service_policy_secintel
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether SecIntel inspection is enabled for the service policy
          default: false
        profile:
          allOf:
          - $ref: '#/components/schemas/service_policy_secintel_profile2'
          - description: 'Protection level applied by SecIntel inspection. enum: `default`, `standard`, `strict`.'
        secintelprofile_id:
          type: string
          description: Organization-level SecIntel profile ID; takes precedence over inline `profile` settings
      description: SRX SecIntel settings for a service policy
    service_policy_secintel_profile:
      title: service_policy_secintel_profile
      enum:
      - default
      - standard
      - strict
      type: string
      description: 'enum: `default`, `standard`, `strict`'
    service_policy_skyatp:
      title: service_policy_skyatp
      type: object
      properties:
        dns_dga_detection:
          allOf:
          - $ref: '#/components/schemas/service_policy_skyatp_dns_dga_detection2'
          - description: Detection settings for DNS DGA threats provided by Sky ATP
        dns_tunnel_detection:
          allOf:
          - $ref: '#/components/schemas/service_policy_skyatp_dns_tunnel_detection2'
          - description: Detection settings for DNS tunneling threats provided by Sky ATP
        http_inspection:
          allOf:
          - $ref: '#/components/schemas/service_policy_skyatp_http_inspection2'
          - description: Web traffic inspection settings provided by Sky ATP
        iot_device_policy:
          allOf:
          - $ref: '#/components/schemas/service_policy_skyatp_iot_device_policy2'
          - description: Device threat policy settings provided by Sky ATP for IoT clients
      description: SRX Sky ATP threat inspection settings for a service policy
    service_policy_skyatp_dns_dga_detection:
      title: service_policy_skyatp_dns_dga_detection
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether Sky ATP DNS DGA detection is enabled
        profile:
          allOf:
          - $ref: '#/components/schemas/service_policy_skyatp_dns_dga_detection_profile2'
          - description: 'Sky ATP DNS DGA detection profile to apply. enum: `default`, `standard`, `strict`.'
      description: Sky ATP DNS DGA detection settings
    service_policy_skyatp_dns_dga_detection_profile:
      title: service_policy_skyatp_dns_dga_detection_profile
      enum:
      - default
      - standard
      - strict
      type: string
      description: 'enum: `default`, `standard`, `strict`'
    service_policy_skyatp_dns_tunnel_detection:
      title: service_policy_skyatp_dns_tunnel_detection
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether Sky ATP DNS tunneling detection is enabled
        profile:
          allOf:
          - $ref: '#/components/schemas/service_policy_skyatp_dns_tunnel_detection_profile2'
          - description: 'Sky ATP DNS tunneling detection profile to apply. enum: `default`, `standard`, `strict`.'
      description: Sky ATP DNS tunneling detection settings
    service_policy_skyatp_dns_tunnel_detection_profile:
      title: service_policy_skyatp_dns_tunnel_detection_profile
      enum:
      - default
      - standard
      - strict
      type: string
      description: 'enum: `default`, `standard`, `strict`'
    service_policy_skyatp_http_inspection:
      title: service_policy_skyatp_http_inspection
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether Sky ATP HTTP inspection is enabled
        profile:
          allOf:
          - $ref: '#/components/schemas/service_policy_skyatp_http_inspection_profile2'
          - description: 'Sky ATP HTTP inspection profile to apply. enum: `standard`, `strict`.'
      description: Sky ATP HTTP inspection settings
    service_policy_skyatp_http_inspection_profile:
      title: service_policy_skyatp_http_inspection_profile
      enum:
      - standard
      - strict
      type: string
      description: 'Sky ATP HTTP inspection profile to apply. enum: `standard`, `strict`'
    service_policy_skyatp_iot_device_policy:
      title: service_policy_skyatp_iot_device_policy
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether Sky ATP IoT device policy inspection is enabled
      description: Sky ATP IoT device policy settings
    service_policy_ssl_proxy:
      title: service_policy_ssl_proxy
      type: object
      properties:
        ciphers_category:
          allOf:
          - $ref: '#/components/schemas/ssl_proxy_ciphers_category2'
          - description: 'Allowed cipher strength category for SSL proxy inspection. enum: `medium`, `strong`, `weak`.'
        enabled:
          type: boolean
          description: Whether SSL proxy inspection is enabled for the service policy
          default: false
      description: SRX SSL proxy inspection settings for a service policy
    service_policy_syslog:
      title: service_policy_syslog
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether syslog logging is enabled for the service policy
          default: false
        server_names:
          type: array
          items:
            type: string
          description: Names of syslog servers that receive logs for this service policy
          examples:
          - - dc_syslog_server
      description: Syslog logging settings for a service policy
    service_spec:
      title: service_spec
      type: object
      properties:
        port_range:
          type: string
          description: Port number, port range, or variable
          examples:
          - 8080,8443
        protocol:
          type: string
          description: '`https`/ `tcp` / `udp` / `icmp` / `gre` / `any` / `:protocol_number`, `protocol_number` is between 1-254'
          default: any
          examples:
          - tcp
      description: Protocol and port match rule for a custom service
    service_stat_property:
      title: service_stat_property
      type: object
      properties:
        ash_version:
          type: string
          description: Version of the ASH service package
        cia_version:
          type: string
          description: Version of the CIA service package
        ember_version:
          type: string
          description: Version of the Ember service package
        ipsec_client_version:
          type: string
          description: Version of the IPsec client package
        mist_agent_version:
          type: string
          description: Version of the Mist agent package
        package_version:
          type: string
          description: Version of the service package
        testing_tools_version:
          type: string
          description: Version of the testing tools package
        wheeljack_version:
          type: string
          description: Version of the Wheeljack service package
      description: Version information for gateway service packages
    service_traffic_class:
      title: service_traffic_class
      enum:
      - best_effort
      - high
      - low
      - medium
      type: string
      description: 'when `traffic_type`==`custom`. enum: `best_effort`, `high`, `low`, `medium`'
    service_type:
      title: service_type
      enum:
      - app_categories
      - apps
      - custom
      - urls
      type: string
      description: 'enum: `app_categories`, `apps`, `custom`, `urls`'
    setting_ssr:
      title: setting_ssr
      type: object
      properties:
        auto_upgrade:
          allOf:
          - $ref: '#/components/schemas/setting_ssr_auto_upgrade2'
          - description: Automatic SSR firmware upgrade settings for newly onboarded devices
        conductor_hosts:
          type: array
          items:
            type: string
          description: IP addresses or hostnames of conductors used by SSR devices
        conductor_token:
          type: string
          description: Registration token used by SSR devices to connect to the conductor
        disable_stats:
          type: boolean
          description: Whether stats collection is disabled on SSR devices
        proxy:
          allOf:
          - $ref: '#/components/schemas/ssr_proxy2'
          - description: Network proxy settings used by SSR devices to reach Mist
      description: SSR management settings for device onboarding and connectivity
    setting_ssr_auto_upgrade:
      title: setting_ssr_auto_upgrade
      type: object
      properties:
        channel:
          allOf:
          - $ref: '#/components/schemas/ssr_upgrade_channel4'
          - description: 'Firmware release channel used for SSR auto-upgrade. enum: `alpha`, `beta`, `stable`.'
        custom_versions:
          type: object
          additionalProperties:
            type: string
          description: Per-model SSR firmware versions used for auto-upgrade
        enabled:
          type: boolean
          description: Whether SSR auto-upgrade is enabled for newly onboarded devices
          default: false
        version:
          type: string
          description: Firmware version to deploy (e.g. 6.3.0-107.r1). Optional, used when custom_versions not specified
          examples:
          - 6.3.0-107.r1
      description: Automatic firmware upgrade settings applied when an SSR device is first onboarded
    shell_node:
      title: shell_node
      type: object
      properties:
        node:
          allOf:
          - $ref: '#/components/schemas/ha_cluster_node_enum2'
          - description: 'HA cluster node on which to create the shell session. enum: `node0`, `node1`.'
      description: Request body for creating a shell session on a specific HA node
    simple_alert:
      title: simple_alert
      type: object
      properties:
        arp_failure:
          allOf:
          - $ref: '#/components/schemas/simple_alert_arp_failure'
          - description: Thresholds for ARP failure heuristic alerts
        dhcp_failure:
          allOf:
          - $ref: '#/components/schemas/simple_alert_dhcp_failure'
          - description: Thresholds for DHCP failure heuristic alerts
        dns_failure:
          allOf:
          - $ref: '#/components/schemas/simple_alert_dns_failure'
          - description: Thresholds for DNS failure heuristic alerts
      description: Heuristic alert thresholds used when a Marvis subscription is unavailable
    simple_alert_arp_failure:
      title: simple_alert_arp_failure
      type: object
      properties:
        client_count:
          type: integer
          description: Number of distinct clients that must encounter ARP failures before alerting
          contentEncoding: int32
          default: 10
        duration:
          maximum: 60
          minimum: 5
          type: integer
          description: Time window in minutes for evaluating ARP failures
          contentEncoding: int32
          default: 20
        incident_count:
          type: integer
          description: Number of ARP failure incidents required within the duration window
          contentEncoding: int32
          default: 10
      description: Thresholds for ARP failure heuristic alerts
    simple_alert_dhcp_failure:
      title: simple_alert_dhcp_failure
      type: object
      properties:
        client_count:
          type: integer
          description: Number of distinct clients that must encounter DHCP failures before alerting
          contentEncoding: int32
          default: 10
        duration:
          maximum: 60
          minimum: 5
          type: integer
          description: Time window in minutes for evaluating DHCP failures
          contentEncoding: int32
          default: 10
        incident_count:
          type: integer
          description: Number of DHCP failure incidents required within the duration window
          contentEncoding: int32
          default: 20
      description: Thresholds for DHCP failure heuristic alerts
    simple_alert_dns_failure:
      title: simple_alert_dns_failure
      type: object
      properties:
        client_count:
          type: integer
          description: Number of distinct clients that must encounter DNS failures before alerting
          contentEncoding: int32
          default: 20
        duration:
          maximum: 60
          minimum: 5
          type: integer
          description: Time window in minutes for evaluating DNS failures
          contentEncoding: int32
          default: 10
        incident_count:
          type: integer
          description: Number of DNS failure incidents required within the duration window
          contentEncoding: int32
          default: 30
      description: Thresholds for DNS failure heuristic alerts
    site:
      title: site
      required:
      - name
      type: object
      properties:
        address:
          type:
          - string
          - 'null'
          description: full address of the site
          examples:
          - 1601 S. Deanza Blvd., Cupertino, CA, 95014
        alarmtemplate_id:
          type:
          - string
          - 'null'
          description: Alarm Template ID, this takes precedence over the Org-level alarmtemplate_id
          contentEncoding: uuid
          examples:
          - 684dfc5c-fe77-2290-eb1d-ef3d677fe168
        aptemplate_id:
          type:
          - string
          - 'null'
          description: AP Template ID, used by APs
          contentEncoding: uuid
          examples:
          - 16bdf952-ade2-4491-80b0-85ce506c760b
        country_code:
          type: string
          description: Country code for the site (for AP config generation), in two-character
          examples:
          - US
        created_time:
          type: number
          description: Timestamp when the site was created, in epoch seconds
          readOnly: true
        gatewaytemplate_id:
          type:
          - string
          - 'null'
          description: Gateway Template ID, used by gateways
          contentEncoding: uuid
          examples:
          - 6f9b2e75-9b2f-b5ae-81e3-e14c76f1a90f
        id:
          type: string
          description: Unique value identifying the site
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        latlng:
          allOf:
          - $ref: '#/components/schemas/lat_lng2'
          - description: Latitude and longitude for the site location
        modified_time:
          type: number
          description: Timestamp when the site was last modified, in epoch seconds
          readOnly: true
        name:
          type: string
          description: Display name of the site
          examples:
          - Mist Office
        networktemplate_id:
          type:
          - string
          - 'null'
          description: Network Template ID, this takes precedence over Site Settings
          contentEncoding: uuid
          examples:
          - 12ae9bd2-e0ab-107b-72e8-a7a005565ec2
        notes:
          type:
          - string
          - 'null'
          description: Optional, any notes about the site
        org_id:
          type: string
          description: Organization identifier associated with the site
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        rftemplate_id:
          type:
          - string
          - 'null'
          description: RF Template ID, this takes precedence over Site Settings
          contentEncoding: uuid
          examples:
          - bb8a9017-1e36-5d6c-6f2b-551abe8a76a2
        routertemplate_id:
          type:
          - string
          - 'null'
          description: Router Template ID, used by gateways
          contentEncoding: uuid
          examples:
          - 6f9b2e75-9b2f-b5ae-81e3-e14c76f1a90f
        secpolicy_id:
          type:
          - string
          - 'null'
          description: Security policy identifier applied to this site
          contentEncoding: uuid
          examples:
          - 3bcd0beb-5d0a-4cbd-92c1-14aea91e98ef
        sitegroup_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Site group identifiers for groups that include this site
        sitetemplate_id:
          type:
          - string
          - 'null'
          description: Site template identifier applied to this site
          contentEncoding: uuid
        timezone:
          type: string
          description: IANA time zone name for the site
          default: UTC
          examples:
          - America/Los_Angeles
        tzoffset:
          type: integer
          description: Time zone offset value derived from the site's timezone
          contentEncoding: int32
          default: 0
      description: Site configuration and metadata within an organization
    site_app:
      title: site_app
      required:
      - group
      - key
      - name
      type: object
      properties:
        group:
          minLength: 1
          type: string
          description: Application category group for the site app
        key:
          minLength: 1
          type: string
          description: Stable application key for the site app
        name:
          minLength: 1
          type: string
          description: Display name of the site app
      description: Application summary returned by the site applications endpoint
    site_apps_count_distinct:
      title: site_apps_count_distinct
      enum:
      - ap
      - app
      - category
      - device_mac
      - port_id
      - service
      - src_ip
      - ssid
      - wcid
      - wlan_id app
      type: string
      description: 'enum: `ap`, `app`, `category`, `device_mac`, `port_id`, `service`, `src_ip`, `ssid`, `wcid`, `wlan_id app`'
    site_assets_count_distinct:
      title: site_assets_count_distinct
      enum:
      - by
      - device_name
      - eddystone_uid_instance
      - eddystone_uid_namespace
      - eddystone_url
      - ibeacon_major
      - ibeacon_minor
      - ibeacon_uuid
      - mac
      - map_id
      - name
      type: string
      description: 'enum: `by`, `device_name`, `eddystone_uid_instance`, `eddystone_uid_namespace`, `eddystone_url`, `ibeacon_major`, `ibeacon_minor`, `ibeacon_uuid`, `mac`, `map_id`, `name`'
    site_auto_upgrade_version:
      title: site_auto_upgrade_version
      enum:
      - beta
      - custom
      - stable
      type: string
      description: 'desired version. enum: `beta`, `custom`, `stable`'
      examples:
      - beta
    site_client_events_count_distinct:
      title: site_client_events_count_distinct
      enum:
      - band
      - channel
      - proto
      - ssid
      - type
      - wlan_id
      type: string
      description: 'enum: `band`, `channel`, `proto`, `ssid`, `type`, `wlan_id`'
    site_client_sessions_count_distinct:
      title: site_client_sessions_count_distinct
      enum:
      - ap
      - client_family
      - client_manufacture
      - client_model
      - client_os
      - mac
      - ssid
      - wlan_id
      type: string
      description: 'enum: `ap`, `client_family`, `client_manufacture`, `client_model`, `client_os`, `mac`, `ssid`, `wlan_id`'
    site_clients_count_distinct:
      title: site_clients_count_distinct
      enum:
      - ap
      - device
      - hostname
      - ip
      - model
      - os
      - ssid
      - vlan
      type: string
      description: 'enum: `ap`, `device`, `hostname`, `ip`, `model`, `os`, `ssid`, `vlan`'
    site_device_events_count_distinct:
      title: site_device_events_count_distinct
      enum:
      - mac
      - model
      - type
      - type_code
      type: string
      description: 'enum: `mac`, `model`, `type`, `type_code`'
    site_device_last_config_count_distinct:
      title: site_device_last_config_count_distinct
      enum:
      - mac
      - name
      - site_id
      - version
      type: string
      description: 'enum: `mac`, `name`, `site_id`, `version`'
    site_devices_count_distinct:
      title: site_devices_count_distinct
      enum:
      - hostname
      - lldp_mgmt_addr
      - lldp_port_id
      - lldp_system_desc
      - lldp_system_name
      - map_id
      - model
      - mxedge_id
      - mxtunnel_status
      - version
      type: string
      description: 'enum: `hostname`, `lldp_mgmt_addr`, `lldp_port_id`, `lldp_system_desc`, `lldp_system_name`, `map_id`, `model`, `mxedge_id`, `mxtunnel_status`, `version`'
    site_discovered_switches_count_distinct:
      title: site_discovered_switches_count_distinct
      enum:
      - mgmt_addr
      - model
      - system_name
      - version
      type: string
      description: 'enum: `mgmt_addr`, `model`, `system_name`, `version`'
    site_engagement:
      title: site_engagement
      type: object
      properties:
        dwell_tag_names:
          allOf:
          - $ref: '#/components/schemas/site_engagement_dwell_tag_names2'
          - description: Display labels for dwell-time visit categories
        dwell_tags:
          allOf:
          - $ref: '#/components/schemas/site_engagement_dwell_tags2'
          - description: Visit duration ranges used to assign engagement categories
        hours:
          allOf:
          - $ref: '#/components/schemas/hours3'
          - description: Schedule during which engagement analytics rules apply
        max_dwell:
          maximum: 68400
          minimum: 1
          type: integer
          description: Maximum dwell time in seconds considered by engagement analytics
          contentEncoding: int32
          default: 43200
          examples:
          - 43200
        min_dwell:
          minimum: 0
          type: integer
          description: Minimum dwell time in seconds for engagement analytics
          contentEncoding: int32
      description: Engagement analytics dwell-time rules for classifying site visits. If hours is omitted, rules apply every day from 00:00 to 23:59. Multiple ranges for the same day are not supported.
    site_engagement_dwell_tag_names:
      title: site_engagement_dwell_tag_names
      type: object
      properties:
        bounce:
          type: string
          description: Display label for bounce visits
          default: Visitor
          examples:
          - Bounce
        engaged:
          type: string
          description: Display label for engaged visits
          default: Associates
          examples:
          - Engaged
        passerby:
          type: string
          description: Display label for passerby visits
          default: Passerby
          examples:
          - Passer By
        stationed:
          type: string
          description: Display label for stationed visits
          default: Assets
          examples:
          - Stationed
      description: Display labels for engagement dwell-time categories
    site_engagement_dwell_tags:
      title: site_engagement_dwell_tags
      type: object
      properties:
        bounce:
          type:
          - string
          - 'null'
          description: Visit duration range for bounce visits, in seconds
          default: 301-14400
        engaged:
          type:
          - string
          - 'null'
          description: Visit duration range for engaged visits, in seconds
          default: 14401-28800
        passerby:
          type:
          - string
          - 'null'
          description: Visit duration range for passerby visits, in seconds
          default: 1-300
        stationed:
          type:
          - string
          - 'null'
          description: Visit duration range for stationed visits, in seconds
          default: 28801-42000
      description: Visit duration ranges in seconds used to assign engagement tags
    site_guests_count_distinct:
      title: site_guests_count_distinct
      enum:
      - auth_method
      - company
      - ssid
      type: string
      description: 'enum: `auth_method`, `company`, `ssid`'
    site_iotendpoints_count_distinct:
      title: site_iotendpoints_count_distinct
      enum:
      - ap_mac
      - mac
      - site_id
      - type
      type: string
      description: 'enum: `ap_mac`, `mac`, `site_id`, `type`'
    site_mxedge_events_count_distinct:
      title: site_mxedge_events_count_distinct
      enum:
      - mxcluster_id
      - mxedge_id
      - package
      - type
      type: string
      description: 'enum: `mxcluster_id`, `mxedge_id`, `package`, `type`'
    site_mxtunnel:
      title: site_mxtunnel
      type: object
      properties:
        additional_mxtunnels:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/site_mxtunnel_additional_mxtunnel'
          description: Additional named Mist Tunnel definitions configured for the site
        ap_subnets:
          type: array
          items:
            type: string
          description: AP source subnets allowed to establish Mist Tunnels
        auto_preemption:
          allOf:
          - $ref: '#/components/schemas/auto_preemption1'
          - description: Preemption behavior for restoring preferred tunnel peers after failover
        clusters:
          type: array
          items:
            $ref: '#/components/schemas/site_mxtunnel_cluster'
          description: Tunnel peer clusters used by APs for this site Mist Tunnel
        created_time:
          type: number
          description: Timestamp when the site Mist Tunnel configuration was created
          readOnly: true
        enabled:
          type: boolean
          description: Whether site Mist Tunnel tunneling is enabled
        for_site:
          type: boolean
          description: Whether this Mist Tunnel configuration is scoped to a site
          readOnly: true
        hello_interval:
          maximum: 300
          minimum: 1
          type: integer
          description: In seconds, used as heartbeat to detect if a tunnel is alive. AP will try another peer after missing N hellos specified by hello_retries
          contentEncoding: int32
          default: 60
          examples:
          - 60
        hello_retries:
          maximum: 30
          minimum: 2
          type: integer
          description: Number of missed hello heartbeats before an AP tries another tunnel peer
          contentEncoding: int32
          default: 7
          examples:
          - 3
        hosts:
          type: array
          items:
            type: string
          description: Tunnel peer hostnames or IP addresses reachable from APs
        id:
          type: string
          description: Unique value identifying the site Mist Tunnel configuration
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        modified_time:
          type: number
          description: Timestamp when the site Mist Tunnel configuration was last modified
          readOnly: true
        mtu:
          maximum: 1500
          minimum: 0
          type: integer
          description: 0 to enable MTU, 552-1500 to start MTU with a lower MTU
          contentEncoding: int32
          default: 0
          examples:
          - 1100
        org_id:
          type: string
          description: Identifier of the org that owns the site Mist Tunnel configuration
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        protocol:
          allOf:
          - $ref: '#/components/schemas/mxtunnel_protocol2'
          - description: 'Encapsulation protocol used for the site Mist Tunnel. enum: `ip`, `udp`.'
        radsec:
          allOf:
          - $ref: '#/components/schemas/site_mxtunnel_radsec2'
          - description: TLS-secured RADIUS proxy settings for the site Mist Tunnel
        site_id:
          type: string
          description: Identifier of the site that owns this Mist Tunnel configuration
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        vlan_ids:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: List of VLAN IDs carried by this site Mist Tunnel
      description: Site Mist Tunnel configuration for tunneling AP user VLANs to Mist Edge tunnel peers
    site_mxtunnel_additional_mxtunnel:
      title: site_mxtunnel_additional_mxtunnel
      type: object
      properties:
        clusters:
          type: array
          items:
            $ref: '#/components/schemas/site_mxtunnel_cluster'
          description: Tunnel peer clusters used by APs for this additional Mist Tunnel
        hello_interval:
          maximum: 300
          minimum: 1
          type: integer
          description: In seconds, used as heartbeat to detect if a tunnel is alive. AP will try another peer after missing N hellos specified by hello_retries
          contentEncoding: int32
          default: 60
          examples:
          - 60
        hello_retries:
          maximum: 30
          minimum: 2
          type: integer
          description: Number of missed hello heartbeats before an AP tries another tunnel peer
          contentEncoding: int32
          default: 7
          examples:
          - 3
        protocol:
          allOf:
          - $ref: '#/components/schemas/site_mxtunnel_protocol2'
          - description: 'Encapsulation protocol used for this additional Mist Tunnel. enum: `ip`, `udp`.'
            examples:
            - udp
        vlan_ids:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: List of VLAN IDs carried by this additional Mist Tunnel
          examples:
          - - 300
            - 310
            - 320
      description: Additional named Mist Tunnel configuration for a site
    site_mxtunnel_cluster:
      title: site_mxtunnel_cluster
      type: object
      properties:
        name:
          type: string
          description: Peer cluster name used in the site Mist Tunnel configuration
          examples:
          - primary
        tunterm_hosts:
          type: array
          items:
            type: string
          description: Tunnel termination hostnames or IP addresses in this peer cluster
          examples:
          - - mxedge1
            - mxedge2.local
      description: Mist Tunnel peer cluster definition for a site
    site_mxtunnel_protocol:
      title: site_mxtunnel_protocol
      enum:
      - ip
      - udp
      type: string
      description: 'Encapsulation protocol used for this additional Mist Tunnel. enum: `ip`, `udp`'
      examples:
      - udp
    site_mxtunnel_radsec:
      title: site_mxtunnel_radsec
      type: object
      properties:
        acct_servers:
          type: array
          items:
            $ref: '#/components/schemas/radius_acct_server'
          description: RADIUS accounting servers used by the site Mist Tunnel RadSec proxy
        auth_servers:
          type: array
          items:
            $ref: '#/components/schemas/radius_auth_server'
          description: RADIUS authentication servers used by the site Mist Tunnel RadSec proxy
        enabled:
          type: boolean
          description: Whether RadSec proxying is enabled for this site Mist Tunnel
          default: false
        use_mxedge:
          type: boolean
          description: Whether RadSec proxying uses Mist Edge
      description: RadSec proxy settings for a site Mist Tunnel
    site_nac_client_events_count_distinct:
      title: site_nac_client_events_count_distinct
      enum:
      - ap
      - auth_type
      - dryrun_nacrule_id
      - mac
      - nacrule_id
      - nas_vendor
      - ssid
      - type
      - username
      - vlan
      type: string
      description: 'enum: `ap`, `auth_type`, `dryrun_nacrule_id`, `mac`, `nacrule_id`, `nas_vendor`, `ssid`, `type`, `username`, `vlan`'
    site_nac_clients_count_distinct:
      title: site_nac_clients_count_distinct
      enum:
      - ap
      - auth_type
      - device_mac
      - edr_managed
      - edr_provider
      - edr_status
      - family
      - hostname
      - idp_id
      - mfg
      - mdm_compliance
      - mdm_managed
      - mdm_provider
      - model
      - mxedge_id
      - nacrule_matched
      - nacrule_name
      - nacrule_id
      - nas_ip
      - nas_vendor
      - os
      - ssid
      - status
      - type
      - usermac_label
      - username
      - vlan
      type: string
      description: 'enum: `ap`, `auth_type`, `device_mac`, `edr_managed`, `edr_provider`, `edr_status`, `family`, `hostname`, `idp_id`, `mfg`, `mdm_compliance`, `mdm_managed`, `mdm_provider`, `model`, `mxedge_id`, `nacrule_matched`, `nacrule_name`, `nacrule_id`, `nas_ip`, `nas_vendor`, `os`, `ssid`, `status`, `type`, `usermac_label`, `username`, `vlan`'
    site_occupancy_analytics:
      title: site_occupancy_analytics
      type: object
      properties:
        assets_enabled:
          type: boolean
          description: Indicate whether named BLE assets should be included in the zone occupancy calculation
          default: false
        clients_enabled:
          type: boolean
          description: Indicate whether connected Wi-Fi clients should be included in the zone occupancy calculation
          default: true
        min_duration:
          type: integer
          description: Minimum dwell duration before a client or asset is counted in occupancy analytics
          contentEncoding: int32
          default: 3000
          examples:
          - 3000
        sdkclients_enabled:
          type: boolean
          description: Indicate whether SDK clients should be included in the zone occupancy calculation
          default: false
        unconnected_clients_enabled:
          type: boolean
          description: Indicate whether unconnected Wi-Fi clients should be included in the zone occupancy calculation
          default: false
      description: Analytics settings for site occupancy
    site_other_device_events_count_distinct:
      title: site_other_device_events_count_distinct
      enum:
      - mac
      - site_id
      - type
      - vendor
      type: string
      description: 'enum: `mac`, `site_id`, `type`, `vendor`'
    site_ports_count_distinct:
      title: site_ports_count_distinct
      enum:
      - full_duplex
      - mac
      - neighbor_mac
      - neighbor_port_desc
      - neighbor_system_name
      - poe_disabled
      - poe_mode
      - poe_on
      - port_id
      - port_mac
      - speed
      - up
      type: string
      description: 'enum: `full_duplex`, `mac`, `neighbor_mac`, `neighbor_port_desc`, `neighbor_system_name`, `poe_disabled`, `poe_mode`, `poe_on`, `port_id`, `port_mac`, `speed`, `up`'
    site_rogue:
      title: site_rogue
      type: object
      properties:
        allowed_vlan_ids:
          type: array
          items:
            maximum: 4096
            minimum: 0
            type: integer
            contentEncoding: int32
          description: VLAN IDs allowed by the rogue detection policy
        enabled:
          type: boolean
          description: Whether rogue detection is enabled
          default: false
        honeypot_enabled:
          type: boolean
          description: Whether honeypot detection is enabled
          default: false
        min_duration:
          maximum: 59
          type: integer
          description: Minimum duration for a bssid to be considered neighbor
          contentEncoding: int32
          default: 10
          examples:
          - 10
        min_rogue_duration:
          maximum: 59
          type: integer
          description: Minimum duration for a bssid to be considered rogue
          contentEncoding: int32
          default: 10
          examples:
          - 10
        min_rogue_rssi:
          minimum: -85
          type: integer
          description: Minimum RSSI for an AP to be considered rogue
          contentEncoding: int32
          default: -80
          examples:
          - -80
        min_rssi:
          minimum: -85
          type: integer
          description: Minimum RSSI for an AP to be considered neighbor (ignoring APs that’s far away)
          contentEncoding: int32
          default: -80
          examples:
          - -80
        whitelisted_bssids:
          type: array
          items:
            type: string
          description: BSSID values or wildcard patterns excluded from rogue detection
          examples:
          - - NeighborSSID
        whitelisted_ssids:
          type: array
          items:
            type: string
          description: SSID names excluded from rogue detection
          examples:
          - - cc:8e:6f:d4:bf:16
            - cc-8e-6f-d4-bf-16
            - cc-73-*
            - cc:82:*
      description: Rogue AP detection settings for a site
    site_rogue_events_count_distinct:
      title: site_rogue_events_count_distinct
      enum:
      - ap
      - bssid
      - ssid
      - type
      type: string
      description: 'enum: `ap`, `bssid`, `ssid`, `type`'
    site_service_events_count_distinct:
      title: site_service_events_count_distinct
      enum:
      - mac
      - model
      - policy
      - port_id
      - site_id
      - type
      - vpn_name
      - vpn_path
      type: string
      description: 'enum: `mac`, `model`, `policy`, `port_id`, `site_id`, `type`, `vpn_name`, `vpn_path`'
    site_setting:
      title: site_setting
      type: object
      properties:
        acl_policies:
          type: array
          items:
            $ref: '#/components/schemas/acl_policy'
          description: Access control policies configured for the site
        acl_tags:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/acl_tag'
          description: Access control tag definitions available to site policies
        additional_config_cmds:
          type: array
          items:
            type: string
          description: Additional CLI configuration commands applied through the site setting
        allow_mist:
          type: boolean
          description: whether to allow Mist to look at this org
          default: false
        analytic:
          allOf:
          - $ref: '#/components/schemas/site_setting_analytic2'
          - description: Advanced analytics configuration for the site
        ap_matching:
          allOf:
          - $ref: '#/components/schemas/site_setting_ap_matching2'
          - description: Rules that apply model-specific AP port configuration
        ap_port_config:
          allOf:
          - $ref: '#/components/schemas/site_setting_ap_port_config2'
          - description: Ethernet port configuration overrides for APs at the site
        ap_synthetic_test:
          allOf:
          - $ref: '#/components/schemas/site_setting_ap_synthetic_test2'
          - description: Synthetic test configuration for APs at the site
        ap_updown_threshold:
          maximum: 240
          minimum: 0
          type:
          - integer
          - 'null'
          description: Enable threshold-based device down delivery for AP devices only. When configured it takes effect for AP devices and `device_updown_threshold` is ignored.
          contentEncoding: int32
          default: 0
        auto_placement:
          allOf:
          - $ref: '#/components/schemas/site_setting_auto_placement2'
          - description: Automatic AP placement settings for the site
        auto_upgrade:
          allOf:
          - $ref: '#/components/schemas/site_setting_auto_upgrade2'
          - description: Automatic AP firmware upgrade settings for the site. Overrides org setting when provided.
        auto_upgrade_esl:
          allOf:
          - $ref: '#/components/schemas/site_setting_auto_upgrade_esl2'
          - description: Automatic ESL firmware upgrade settings for the site
        auto_upgrade_linecard:
          type: boolean
          description: Whether line cards are included in automatic switch upgrades
          default: true
        bgp_neighbor_updown_threshold:
          minimum: 0
          type:
          - integer
          - 'null'
          description: enable threshold-based bgp neighbor down delivery.
          contentEncoding: int32
        blacklist_url:
          type: string
          description: Read-only URL for the site blacklist file
          readOnly: true
          examples:
          - https://papi.s3.amazonaws.com/blacklist/xxx...
        ble_config:
          allOf:
          - $ref: '#/components/schemas/ble_config3'
          - description: Bluetooth Low Energy configuration applied to APs at the site
        config_auto_revert:
          type: boolean
          description: Whether to enable ap auto config revert
          default: false
        config_push_policy:
          allOf:
          - $ref: '#/components/schemas/site_setting_config_push_policy2'
          - description: Policy controlling how site configuration pushes are applied
        created_time:
          type: number
          description: Timestamp when the site settings were created
          readOnly: true
        critical_url_monitoring:
          allOf:
          - $ref: '#/components/schemas/site_setting_critical_url_monitoring2'
          - description: Monitoring configuration for critical URLs at the site
        device_updown_threshold:
          maximum: 240
          minimum: 0
          type:
          - integer
          - 'null'
          description: By default, device_updown_threshold, if set, will apply to all devices types if different values for specific device type is desired, use the following
          contentEncoding: int32
          default: 0
        dhcp_snooping:
          allOf:
          - $ref: '#/components/schemas/dhcp_snooping4'
          - description: Layer 2 DHCP snooping settings for the site
        disabled_system_defined_port_usages:
          type: array
          items:
            $ref: '#/components/schemas/system_defined_port_usages'
          description: System-defined switch port usages disabled for the site
        dns_servers:
          type: array
          items:
            type: string
          description: Name server addresses configured for the site
        dns_suffix:
          type: array
          items:
            type: string
          description: Search suffixes used for DNS lookups at the site
        enable_unii_4:
          type: boolean
          description: Whether UNII-4 channels are enabled for the site
          default: false
        engagement:
          allOf:
          - $ref: '#/components/schemas/site_engagement1'
          - description: Dwell-time analytics rules for the site
        evpn_options:
          allOf:
          - $ref: '#/components/schemas/evpn_options3'
          - description: Fabric EVPN options for the site
        extra_routes:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/extra_route'
          description: Additional IPv4 routes configured for the site
          examples:
          - 0.0.0.0/0:
              via: 192.168.1.10
        extra_routes6:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/extra_route6'
          description: Additional IPv6 routes configured for the site
          examples:
          - 2a02:1234:420a:10c9::/64:
              via: 2a02:1234:200a::100
        flags:
          type: object
          additionalProperties:
            type: string
          description: Feature flags enabled for the site
        for_site:
          type: boolean
          description: Whether this settings object is scoped to a site
          readOnly: true
        gateway:
          allOf:
          - $ref: '#/components/schemas/gateway_template1'
          - description: Template settings applied to site gateways
        gateway_additional_config_cmds:
          type: array
          items:
            type: string
          description: Additional CLI configuration commands applied to gateways at the site
        gateway_mgmt:
          allOf:
          - $ref: '#/components/schemas/gateway_mgmt3'
          - description: Management access settings for gateways at the site
        gateway_tunnel_updown_threshold:
          minimum: 0
          type:
          - integer
          - 'null'
          description: enable threshold-based gateway tunnel (secure edge tunnels) up-down delivery.
          contentEncoding: int32
        gateway_updown_threshold:
          maximum: 240
          minimum: 0
          type:
          - integer
          - 'null'
          description: Enable threshold-based device down delivery for Gateway devices only. When configured it takes effect for GW devices and `device_updown_threshold` is ignored.
          contentEncoding: int32
          default: 0
        id:
          type: string
          description: Unique value identifying the site settings object
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        iotproxy:
          allOf:
          - $ref: '#/components/schemas/iotproxy1'
          - description: Proxy settings for IoT traffic at the site
        juniper_srx:
          allOf:
          - $ref: '#/components/schemas/site_setting_juniper_srx2'
          - description: SRX integration settings for the site
        led:
          allOf:
          - $ref: '#/components/schemas/ap_led3'
          - description: AP LED behavior configured for the site
        marvis:
          allOf:
          - $ref: '#/components/schemas/marvis1'
          - description: AI assistant settings for Marvis at the site
        mist_nac:
          allOf:
          - $ref: '#/components/schemas/switch_mist_nac3'
          - description: Network access control settings for switches at the site
        modified_time:
          type: number
          description: Timestamp when the site settings were last modified
          readOnly: true
        mxedge:
          allOf:
          - $ref: '#/components/schemas/site_setting_mxedge2'
          - description: Site Mist Edge service settings
        mxedge_mgmt:
          allOf:
          - $ref: '#/components/schemas/mxedge_mgmt4'
          - description: Mist Edge management access settings for the site
        mxtunnel:
          allOf:
          - $ref: '#/components/schemas/site_mxtunnel1'
          - description: Site Mist Tunnel configuration
        networks:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_network'
          description: Switch network definitions configured for the site
        ntp_servers:
          type: array
          items:
            type: string
          description: Time synchronization server addresses configured for the site
        occupancy:
          allOf:
          - $ref: '#/components/schemas/site_occupancy_analytics'
          - description: Analytics settings for site occupancy
        org_id:
          type: string
          description: Identifier of the org that owns the site settings
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        ospf_areas:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ospf_area'
          description: Routing area settings for OSPF on site switches
        paloalto_networks:
          allOf:
          - $ref: '#/components/schemas/site_setting_paloalto_networks2'
          - description: Firewall integration settings for Palo Alto Networks at the site
        persist_config_on_device:
          type: boolean
          description: Whether to store the config on AP
          default: false
        port_mirroring:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_port_mirroring_property'
          description: Switch port mirroring settings for the site
        port_usages:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_port_usage'
          description: Switch port usage profiles available at the site
        proxy:
          allOf:
          - $ref: '#/components/schemas/proxy3'
          - description: Network proxy settings for devices at the site
        radio_config:
          allOf:
          - $ref: '#/components/schemas/ap_radio3'
          - description: AP radio configuration for the site
        radius_config:
          allOf:
          - $ref: '#/components/schemas/switch_radius_config4'
          - description: Switch RADIUS configuration for the site
        remote_syslog:
          allOf:
          - $ref: '#/components/schemas/remote_syslog4'
          - description: Syslog forwarding settings for devices at the site
        remove_existing_configs:
          type: boolean
          description: By default, only the configuration generated by Mist is cleaned up during the configuration process. If `true`, all the existing configuration will be removed.
          default: false
        report_gatt:
          type: boolean
          description: Whether AP should periodically connect to BLE devices and report GATT device info (device name, manufacturer name, serial number, battery %, temperature, humidity)
          default: false
        rogue:
          allOf:
          - $ref: '#/components/schemas/site_rogue1'
          - description: AP threat detection settings for the site
        routing_policies:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/sw_routing_policy'
          description: Switch routing policy definitions for the site
        rtsa:
          allOf:
          - $ref: '#/components/schemas/site_setting_rtsa2'
          - description: Managed mobility and asset tracking settings for the site
        simple_alert:
          allOf:
          - $ref: '#/components/schemas/simple_alert2'
          - description: Threshold alert settings for the site
        site_id:
          type: string
          description: Identifier of the site these settings apply to
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        skyatp:
          allOf:
          - $ref: '#/components/schemas/site_setting_skyatp2'
          - description: Threat intelligence settings from Sky ATP for the site
        sle_thresholds:
          allOf:
          - $ref: '#/components/schemas/sle_thresholds2'
          - description: Service level expectation threshold settings for the site
        snmp_config:
          allOf:
          - $ref: '#/components/schemas/snmp_config3'
          - description: Management polling settings for SNMP on site devices
        srx_app:
          allOf:
          - $ref: '#/components/schemas/site_setting_srx_app'
          - description: Juniper SRX application visibility settings for the site
        ssh_keys:
          type: array
          items:
            type: string
          description: Public SSH keys configured for the site
        ssr:
          allOf:
          - $ref: '#/components/schemas/setting_ssr2'
          - description: Session Smart Router settings for the site
        status_portal:
          allOf:
          - $ref: '#/components/schemas/site_setting_status_portal'
          - description: End-user status portal settings for the site
        switch:
          allOf:
          - $ref: '#/components/schemas/site_setting_switch2'
          - description: Site-level switch feature configuration
        switch_matching:
          allOf:
          - $ref: '#/components/schemas/switch_matching1'
          - description: Rules for matching switches to model-specific settings
        switch_mgmt:
          allOf:
          - $ref: '#/components/schemas/switch_mgmt4'
          - description: Management access settings for switches at the site
        switch_updown_threshold:
          maximum: 240
          minimum: 0
          type:
          - integer
          - 'null'
          description: Enable threshold-based device down delivery for Switch devices only. When configured it takes effect for SW devices and `device_updown_threshold` is ignored.
          contentEncoding: int32
          default: 0
        synthetic_test:
          allOf:
          - $ref: '#/components/schemas/synthetictest_config1'
          - description: Active monitoring test configuration for the site
        track_anonymous_devices:
          type: boolean
          description: Whether to track anonymous BLE assets (requires ‘track_asset’  enabled)
          default: false
        tunterm_monitoring:
          type: array
          items:
            $ref: '#/components/schemas/tunterm_monitoring_item'
          description: Tunnel termination monitoring settings for the Mist Edges assigned to the site
        tunterm_monitoring_disabled:
          type: boolean
          description: Whether tunnel termination monitoring is disabled for the site
          default: false
        tunterm_multicast_config:
          allOf:
          - $ref: '#/components/schemas/site_setting_tunterm_multicast_config2'
          - description: Multicast settings for tunnel termination at the site
        uplink_port_config:
          allOf:
          - $ref: '#/components/schemas/ap_uplink_port_config3'
          - description: AP uplink port configuration for the site
        uses_description_from_port_usage:
          type: boolean
          description: by default, we only honor description provided in port_config. This allows fallback to those defined in port_usages
          default: false
        uwb_config:
          allOf:
          - $ref: '#/components/schemas/ap_uwb_config3'
          - description: UWB RTLS (OMLOX asset visibility) settings for the site, only effective on AP models with a UWB radio and in countries where the UWB radio is permitted. Overridden by the device profile and device-level settings
        vars:
          type: object
          additionalProperties:
            type: string
          description: Template variables defined for the site
          examples:
          - RADIUS_IP1: 172.31.2.5
            RADIUS_SECRET: 11s64632d
        vars_annotations:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/vars_annotation'
          description: Metadata annotations for site template variables
          examples:
          - MXTUNNEL_GUEST:
              type: mxtunnel_id
            RADIUS_IP1:
              note: RADIUS server IP address for US East Campus
        vna:
          allOf:
          - $ref: '#/components/schemas/site_setting_vna2'
          - description: Virtual Network Assistant settings for the site
        vpn_path_updown_threshold:
          minimum: 0
          type:
          - integer
          - 'null'
          description: enable threshold-based vpn path down delivery.
          contentEncoding: int32
        vpn_peer_updown_threshold:
          minimum: 0
          type:
          - integer
          - 'null'
          description: enable threshold-based vpn peer down delivery.
          contentEncoding: int32
        vrf_config:
          allOf:
          - $ref: '#/components/schemas/vrf_config6'
          - description: Routing instance configuration for the site
        vrf_instances:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_vrf_instance'
          description: Switch VRF instances configured for the site
          examples:
          - guest:
              extra_routes:
                0.0.0.0/0:
                  via: 192.168.31.1
              networks:
              - guest
        vrrp_groups:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/vrrp_group'
          description: High-availability VRRP group settings for the site
        vs_instance:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/vs_instance_property'
          description: EX9200 virtual switch instance definitions for the site
        wan_vna:
          allOf:
          - $ref: '#/components/schemas/site_setting_wan_vna2'
          - description: Virtual Network Assistant settings for WAN experiences at the site
        watched_station_url:
          type: string
          description: Read-only URL for the watched station list file
          readOnly: true
          examples:
          - https://papi.s3.amazonaws.com/watched_station/xxx...
        whitelist_url:
          type: string
          description: Read-only URL for the site whitelist file
          readOnly: true
          examples:
          - https://papi.s3.amazonaws.com/whitelist/xxx...
        wids:
          allOf:
          - $ref: '#/components/schemas/site_wids2'
          - description: Wireless intrusion detection settings for the site
        wifi:
          allOf:
          - $ref: '#/components/schemas/site_wifi2'
          - description: Wireless LAN configuration settings for the site
        wired_vna:
          allOf:
          - $ref: '#/components/schemas/site_setting_wired_vna2'
          - description: Virtual Network Assistant settings for wired experiences at the site
        zone_occupancy_alert:
          allOf:
          - $ref: '#/components/schemas/site_zone_occupancy_alert2'
          - description: Occupancy alert settings for site zones
      description: Configuration settings applied at the site level
    site_setting_analytic:
      title: site_setting_analytic
      type: object
      properties:
        enabled:
          type: boolean
          description: Enable Advanced Analytic feature (using SUB-ANA license)
          default: false
      description: Advanced analytics feature settings for a site
    site_setting_ap_matching:
      title: site_setting_ap_matching
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether AP matching rules are enabled
        rules:
          type: array
          items:
            $ref: '#/components/schemas/site_setting_ap_matching_rule'
          description: Ordered AP matching rules for applying port configuration
      description: Rules for applying AP port configuration by AP model or name
    site_setting_ap_matching_rule:
      title: site_setting_ap_matching_rule
      type: object
      properties:
        match_model:
          type: string
          description: AP model matched by this rule
          examples:
          - AP12
        name:
          type: string
          description: Display name of the AP matching rule
          examples:
          - AP12
        port_config:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ap_port_config'
          description: Property key is the interface(s) (e.g. "eth1,eth2")
      description: AP matching rule for selecting APs and applying port configuration
    site_setting_ap_port_config:
      title: site_setting_ap_port_config
      type: object
      properties:
        model_specific:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ap_port_config'
          description: Property key is the AP model (e.g. "AP32")
      description: AP Ethernet port configuration overrides by model
    site_setting_ap_synthetic_test:
      title: site_setting_ap_synthetic_test
      type: object
      properties:
        additional_vlan_ids:
          anyOf:
          - type: string
          - type: array
            items:
              $ref: '#/components/schemas/vlan_id_with_variable'
          description: VLAN IDs included in addition to the default VLAN set for AP synthetic tests
      description: AP Synthetic Test configuration
    site_setting_auto_placement:
      title: site_setting_auto_placement
      type: object
      properties:
        orientation:
          type: integer
          description: AP orientation angle in degrees on the map
          contentEncoding: int32
          examples:
          - 45
        x:
          type: number
          description: Map x-coordinate determined by auto placement
          examples:
          - 30
        y:
          type: number
          description: Map y-coordinate determined by auto placement
          examples:
          - 60
      description: Automatically determined AP placement coordinates and orientation
    site_setting_auto_upgrade:
      title: site_setting_auto_upgrade
      type: object
      properties:
        custom_versions:
          type: object
          additionalProperties:
            type: string
          description: Per-AP-model firmware versions or channels used for auto-upgrade
          examples:
          - AP21: alpha
            AP41: 0.1.5135
            AP61: 0.1.7215
        day_of_week:
          allOf:
          - $ref: '#/components/schemas/day_of_week4'
          - description: 'Weekly AP auto-upgrade day for the maintenance window. enum: `any`, `fri`, `mon`, `sat`, `sun`, `thu`, `tue`, `wed`.'
        enabled:
          type: boolean
          description: Whether auto upgrade should happen (Note that Mist may auto-upgrade if the version is not supported)
          default: false
        time_of_day:
          type: string
          description: '`any` / HH:MM (24-hour format), upgrade will happen within up to 1-hour from this time'
          examples:
          - 12:00
        version:
          allOf:
          - $ref: '#/components/schemas/site_auto_upgrade_version2'
          - description: 'Firmware release channel or custom version used for AP auto-upgrade. enum: `beta`, `custom`, `stable`.'
            examples:
            - beta
      description: Automatic AP firmware upgrade policy
    site_setting_auto_upgrade_esl:
      title: site_setting_auto_upgrade_esl
      type: object
      properties:
        allow_downgrade:
          type: boolean
          description: If true, it will allow downgrade to a lower version
          default: false
        custom_versions:
          type: object
          additionalProperties:
            type: string
          description: Custom versions for different models. Property key is the model name (e.g. "AP41")
          examples:
          - AP41: 2.4.6
            AP61: 2.5.0
        day_of_week:
          allOf:
          - $ref: '#/components/schemas/day_of_week5'
          - description: 'Weekly ESL auto-upgrade day for the maintenance window. enum: `any`, `fri`, `mon`, `sat`, `sun`, `thu`, `tue`, `wed`.'
        enabled:
          type: boolean
          description: Whether auto upgrade should happen (Note that Mist may auto-upgrade if the version is not supported)
          default: false
        time_of_day:
          type: string
          description: '`any` / HH:MM (24-hour format), upgrade will happen within up to 1-hour from this time'
          examples:
          - 12:00
        version:
          type: string
          description: ESL firmware version used for auto-upgrade
          examples:
          - 2.5.0
      description: Automatic AP ESL firmware upgrade policy. When both firmware and ESL auto-upgrade are enabled, ESL upgrade will be done only after firmware upgrade
    site_setting_config_push_policy:
      title: site_setting_config_push_policy
      type: object
      properties:
        no_push:
          type: boolean
          description: Stop any new config from being pushed to the device
          default: false
        push_window:
          allOf:
          - $ref: '#/components/schemas/push_policy_push_window1'
          - description: Allowed time window during which configuration pushes may run
      description: Mist also uses some heuristic rules to prevent destructive configs from being pushed
    site_setting_critical_url_monitoring:
      title: site_setting_critical_url_monitoring
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether critical URL monitoring is enabled
          default: true
        monitors:
          type: array
          items:
            $ref: '#/components/schemas/site_setting_critical_url_monitoring_monitor'
          description: Critical URLs monitored for site health latency
      description: Critical URLs whose latency is measured and included in site health
    site_setting_critical_url_monitoring_monitor:
      title: site_setting_critical_url_monitoring_monitor
      type: object
      properties:
        url:
          type: string
          description: Monitored HTTP or HTTPS URL used for site health latency
          examples:
          - http://50.1.3.5:8080
        vlan_id:
          oneOf:
          - type: string
          - maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
          description: Source VLAN ID used to run the critical URL monitor
      description: Critical URL monitor definition for site health
    site_setting_derived:
      title: site_setting_derived
      type: object
      properties:
        acl_policies:
          type: array
          items:
            $ref: '#/components/schemas/acl_policy'
          description: Access control policies configured for the site
        acl_tags:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/acl_tag'
          description: Access control tag definitions available to site policies
        additional_config_cmds:
          type: array
          items:
            type: string
          description: Additional CLI configuration commands applied through the site setting
        allow_mist:
          type: boolean
          description: whether to allow Mist to look at this org
          default: false
        analytic:
          allOf:
          - $ref: '#/components/schemas/site_setting_analytic2'
          - description: Advanced analytics configuration for the site
        ap_matching:
          allOf:
          - $ref: '#/components/schemas/site_setting_ap_matching2'
          - description: Rules that apply model-specific AP port configuration
        ap_port_config:
          allOf:
          - $ref: '#/components/schemas/site_setting_ap_port_config2'
          - description: Ethernet port configuration overrides for APs at the site
        ap_synthetic_test:
          allOf:
          - $ref: '#/components/schemas/site_setting_ap_synthetic_test2'
          - description: Synthetic test configuration for APs at the site
        ap_updown_threshold:
          maximum: 240
          minimum: 0
          type:
          - integer
          - 'null'
          description: Enable threshold-based device down delivery for AP devices only. When configured it takes effect for AP devices and `device_updown_threshold` is ignored.
          contentEncoding: int32
          default: 0
        auto_placement:
          allOf:
          - $ref: '#/components/schemas/site_setting_auto_placement2'
          - description: Automatic AP placement settings for the site
        auto_upgrade:
          allOf:
          - $ref: '#/components/schemas/site_setting_auto_upgrade2'
          - description: Automatic AP firmware upgrade settings for the site. Overrides org setting when provided.
        auto_upgrade_esl:
          allOf:
          - $ref: '#/components/schemas/site_setting_auto_upgrade_esl2'
          - description: Automatic ESL firmware upgrade settings for the site
        auto_upgrade_linecard:
          type: boolean
          description: Whether line cards are included in automatic switch upgrades
          default: true
        bgp_neighbor_updown_threshold:
          minimum: 0
          type:
          - integer
          - 'null'
          description: enable threshold-based bgp neighbor down delivery.
          contentEncoding: int32
        blacklist_url:
          type: string
          description: Read-only URL for the site blacklist file
          readOnly: true
          examples:
          - https://papi.s3.amazonaws.com/blacklist/xxx...
        ble_config:
          allOf:
          - $ref: '#/components/schemas/ble_config3'
          - description: Bluetooth Low Energy configuration applied to APs at the site
        config_auto_revert:
          type: boolean
          description: Whether to enable ap auto config revert
          default: false
        config_push_policy:
          allOf:
          - $ref: '#/components/schemas/site_setting_config_push_policy2'
          - description: Policy controlling how site configuration pushes are applied
        created_time:
          type: number
          description: Timestamp when the site settings were created
          readOnly: true
        critical_url_monitoring:
          allOf:
          - $ref: '#/components/schemas/site_setting_critical_url_monitoring2'
          - description: Monitoring configuration for critical URLs at the site
        device_updown_threshold:
          maximum: 240
          minimum: 0
          type:
          - integer
          - 'null'
          description: By default, device_updown_threshold, if set, will apply to all devices types if different values for specific device type is desired, use the following
          contentEncoding: int32
          default: 0
        dhcp_snooping:
          allOf:
          - $ref: '#/components/schemas/dhcp_snooping4'
          - description: Layer 2 DHCP snooping settings for the site
        disabled_system_defined_port_usages:
          type: array
          items:
            $ref: '#/components/schemas/system_defined_port_usages'
          description: System-defined switch port usages disabled for the site
        dns_servers:
          type: array
          items:
            type: string
          description: Name server addresses configured for the site
        dns_suffix:
          type: array
          items:
            type: string
          description: Search suffixes used for DNS lookups at the site
        enable_unii_4:
          type: boolean
          description: Whether UNII-4 channels are enabled for the site
          default: false
        engagement:
          allOf:
          - $ref: '#/components/schemas/site_engagement1'
          - description: Dwell-time analytics rules for the site
        evpn_options:
          allOf:
          - $ref: '#/components/schemas/evpn_options3'
          - description: Fabric EVPN options for the site
        extra_routes:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/extra_route'
          description: Additional IPv4 routes configured for the site
          examples:
          - 0.0.0.0/0:
              via: 192.168.1.10
        extra_routes6:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/extra_route6'
          description: Additional IPv6 routes configured for the site
          examples:
          - 2a02:1234:420a:10c9::/64:
              via: 2a02:1234:200a::100
        flags:
          type: object
          additionalProperties:
            type: string
          description: Feature flags enabled for the site
        for_site:
          type: boolean
          description: Whether this settings object is scoped to a site
          readOnly: true
        gateway:
          allOf:
          - $ref: '#/components/schemas/gateway_template1'
          - description: Template settings applied to site gateways
        gateway_additional_config_cmds:
          type: array
          items:
            type: string
          description: Additional CLI configuration commands applied to gateways at the site
        gateway_mgmt:
          allOf:
          - $ref: '#/components/schemas/gateway_mgmt3'
          - description: Management access settings for gateways at the site
        gateway_tunnel_updown_threshold:
          minimum: 0
          type:
          - integer
          - 'null'
          description: enable threshold-based gateway tunnel (secure edge tunnels) up-down delivery.
          contentEncoding: int32
        gateway_updown_threshold:
          maximum: 240
          minimum: 0
          type:
          - integer
          - 'null'
          description: Enable threshold-based device down delivery for Gateway devices only. When configured it takes effect for GW devices and `device_updown_threshold` is ignored.
          contentEncoding: int32
          default: 0
        id:
          type: string
          description: Unique value identifying the site settings object
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        iotproxy:
          allOf:
          - $ref: '#/components/schemas/iotproxy1'
          - description: Proxy settings for IoT traffic at the site
        juniper_srx:
          allOf:
          - $ref: '#/components/schemas/site_setting_juniper_srx2'
          - description: SRX integration settings for the site
        led:
          allOf:
          - $ref: '#/components/schemas/ap_led3'
          - description: AP LED behavior configured for the site
        marvis:
          allOf:
          - $ref: '#/components/schemas/marvis1'
          - description: AI assistant settings for Marvis at the site
        mist_nac:
          allOf:
          - $ref: '#/components/schemas/switch_mist_nac3'
          - description: Network access control settings for switches at the site
        modified_time:
          type: number
          description: Timestamp when the site settings were last modified
          readOnly: true
        mxedge:
          allOf:
          - $ref: '#/components/schemas/site_setting_mxedge2'
          - description: Site Mist Edge service settings
        mxedge_mgmt:
          allOf:
          - $ref: '#/components/schemas/mxedge_mgmt4'
          - description: Mist Edge management access settings for the site
        mxtunnel:
          allOf:
          - $ref: '#/components/schemas/site_mxtunnel1'
          - description: Site Mist Tunnel configuration
        networks:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_network'
          description: Switch network definitions configured for the site
        ntp_servers:
          type: array
          items:
            type: string
          description: Time synchronization server addresses configured for the site
        occupancy:
          allOf:
          - $ref: '#/components/schemas/site_occupancy_analytics'
          - description: Analytics settings for site occupancy
        org_id:
          type: string
          description: Identifier of the org that owns the site settings
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        ospf_areas:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ospf_area'
          description: Routing area settings for OSPF on site switches
        paloalto_networks:
          allOf:
          - $ref: '#/components/schemas/site_setting_paloalto_networks2'
          - description: Firewall integration settings for Palo Alto Networks at the site
        persist_config_on_device:
          type: boolean
          description: Whether to store the config on AP
          default: false
        port_mirroring:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_port_mirroring_property'
          description: Switch port mirroring settings for the site
        port_usages:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_port_usage'
          description: Switch port usage profiles available at the site
        proxy:
          allOf:
          - $ref: '#/components/schemas/proxy3'
          - description: Network proxy settings for devices at the site
        radio_config:
          allOf:
          - $ref: '#/components/schemas/ap_radio3'
          - description: AP radio configuration for the site
        radius_config:
          allOf:
          - $ref: '#/components/schemas/switch_radius_config4'
          - description: Switch RADIUS configuration for the site
        remote_syslog:
          allOf:
          - $ref: '#/components/schemas/remote_syslog4'
          - description: Syslog forwarding settings for devices at the site
        remove_existing_configs:
          type: boolean
          description: By default, only the configuration generated by Mist is cleaned up during the configuration process. If `true`, all the existing configuration will be removed.
          default: false
        report_gatt:
          type: boolean
          description: Whether AP should periodically connect to BLE devices and report GATT device info (device name, manufacturer name, serial number, battery %, temperature, humidity)
          default: false
        rogue:
          allOf:
          - $ref: '#/components/schemas/site_rogue1'
          - description: AP threat detection settings for the site
        routing_policies:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/sw_routing_policy'
          description: Switch routing policy definitions for the site
        rtsa:
          allOf:
          - $ref: '#/components/schemas/site_setting_rtsa2'
          - description: Managed mobility and asset tracking settings for the site
        simple_alert:
          allOf:
          - $ref: '#/components/schemas/simple_alert2'
          - description: Threshold alert settings for the site
        site_id:
          type: string
          description: Identifier of the site these settings apply to
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        skyatp:
          allOf:
          - $ref: '#/components/schemas/site_setting_skyatp2'
          - description: Threat intelligence settings from Sky ATP for the site
        sle_thresholds:
          allOf:
          - $ref: '#/components/schemas/sle_thresholds2'
          - description: Service level expectation threshold settings for the site
        snmp_config:
          allOf:
          - $ref: '#/components/schemas/snmp_config3'
          - description: Management polling settings for SNMP on site devices
        srx_app:
          allOf:
          - $ref: '#/components/schemas/site_setting_srx_app'
          - description: Juniper SRX application visibility settings for the site
        ssh_keys:
          type: array
          items:
            type: string
          description: Public SSH keys configured for the site
        ssr:
          allOf:
          - $ref: '#/components/schemas/setting_ssr2'
          - description: Session Smart Router settings for the site
        status_portal:
          allOf:
          - $ref: '#/components/schemas/site_setting_status_portal'
          - description: End-user status portal settings for the site
        switch:
          allOf:
          - $ref: '#/components/schemas/site_setting_switch2'
          - description: Site-level switch feature configuration
        switch_matching:
          allOf:
          - $ref: '#/components/schemas/switch_matching1'
          - description: Rules for matching switches to model-specific settings
        switch_mgmt:
          allOf:
          - $ref: '#/components/schemas/switch_mgmt4'
          - description: Management access settings for switches at the site
        switch_updown_threshold:
          maximum: 240
          minimum: 0
          type:
          - integer
          - 'null'
          description: Enable threshold-based device down delivery for Switch devices only. When configured it takes effect for SW devices and `device_updown_threshold` is ignored.
          contentEncoding: int32
          default: 0
        synthetic_test:
          allOf:
          - $ref: '#/components/schemas/synthetictest_config1'
          - description: Active monitoring test configuration for the site
        track_anonymous_devices:
          type: boolean
          description: Whether to track anonymous BLE assets (requires ‘track_asset’  enabled)
          default: false
        tunterm_monitoring:
          type: array
          items:
            $ref: '#/components/schemas/tunterm_monitoring_item'
          description: Tunnel termination monitoring settings for the Mist Edges assigned to the site
        tunterm_monitoring_disabled:
          type: boolean
          description: Whether tunnel termination monitoring is disabled for the site
          default: false
        tunterm_multicast_config:
          allOf:
          - $ref: '#/components/schemas/site_setting_tunterm_multicast_config2'
          - description: Multicast settings for tunnel termination at the site
        uplink_port_config:
          allOf:
          - $ref: '#/components/schemas/ap_uplink_port_config3'
          - description: AP uplink port configuration for the site
        uses_description_from_port_usage:
          type: boolean
          description: by default, we only honor description provided in port_config. This allows fallback to those defined in port_usages
          default: false
        uwb_config:
          allOf:
          - $ref: '#/components/schemas/ap_uwb_config3'
          - description: UWB RTLS (OMLOX asset visibility) settings for the site, only effective on AP models with a UWB radio and in countries where the UWB radio is permitted. Overridden by the device profile and device-level settings
        vars:
          type: object
          additionalProperties:
            type: string
          description: Template variables defined for the site
          examples:
          - RADIUS_IP1: 172.31.2.5
            RADIUS_SECRET: 11s64632d
        vars_annotations:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/vars_annotation'
          description: Metadata annotations for site template variables
          examples:
          - MXTUNNEL_GUEST:
              type: mxtunnel_id
            RADIUS_IP1:
              note: RADIUS server IP address for US East Campus
        vna:
          allOf:
          - $ref: '#/components/schemas/site_setting_vna2'
          - description: Virtual Network Assistant settings for the site
        vpn_path_updown_threshold:
          minimum: 0
          type:
          - integer
          - 'null'
          description: enable threshold-based vpn path down delivery.
          contentEncoding: int32
        vpn_peer_updown_threshold:
          minimum: 0
          type:
          - integer
          - 'null'
          description: enable threshold-based vpn peer down delivery.
          contentEncoding: int32
        vrf_config:
          allOf:
          - $ref: '#/components/schemas/vrf_config6'
          - description: Routing instance configuration for the site
        vrf_instances:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_vrf_instance'
          description: Switch VRF instances configured for the site
          examples:
          - guest:
              extra_routes:
                0.0.0.0/0:
                  via: 192.168.31.1
              networks:
              - guest
        vrrp_groups:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/vrrp_group'
          description: High-availability VRRP group settings for the site
        vs_instance:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/vs_instance_property'
          description: EX9200 virtual switch instance definitions for the site
        wan_vna:
          allOf:
          - $ref: '#/components/schemas/site_setting_wan_vna2'
          - description: Virtual Network Assistant settings for WAN experiences at the site
        watched_station_url:
          type: string
          description: Read-only URL for the watched station list file
          readOnly: true
          examples:
          - https://papi.s3.amazonaws.com/watched_station/xxx...
        whitelist_url:
          type: string
          description: Read-only URL for the site whitelist file
          readOnly: true
          examples:
          - https://papi.s3.amazonaws.com/whitelist/xxx...
        wids:
          allOf:
          - $ref: '#/components/schemas/site_wids2'
          - description: Wireless intrusion detection settings for the site
        wifi:
          allOf:
          - $ref: '#/components/schemas/site_wifi2'
          - description: Wireless LAN configuration settings for the site
        wired_vna:
          allOf:
          - $ref: '#/components/schemas/site_setting_wired_vna2'
          - description: Virtual Network Assistant settings for wired experiences at the site
        zone_occupancy_alert:
          allOf:
          - $ref: '#/components/schemas/site_zone_occupancy_alert2'
          - description: Occupancy alert settings for site zones
        account_id:
          type: string
          description: Linked app account id
          readOnly: true
          examples:
          - iojzXIJWEuiD73ZvydOfg
        auto_probe_subnet:
          type: string
          description: For Prisma accounts only, tunnel auto probe subnet
          readOnly: true
          examples:
          - 11.0.0.0/8
        client_id:
          type: string
          description: Customer account Client ID
          readOnly: true
        cloud_name:
          type: string
          description: Name of the company whose account mist has subscribed to
          readOnly: true
          examples:
          - Tapi.sase.paloaltonetworks.com
        company:
          type: string
          description: Name of the company whose account mist has subscribed to
          readOnly: true
          examples:
          - Test Company1 Ltd
        enable_probe:
          type: boolean
          description: For Prisma accounts only, tunnel probe enable/disable
          readOnly: true
          examples:
          - false
        error:
          type: string
          description: This error is provided when the account fails to fetch token/data
          readOnly: true
          examples:
          - OAuth token refresh failed, please re-link your account
        errors:
          type: array
          items:
            type: string
          description: Problems reported during OAuth token refresh or account data sync
          readOnly: true
          examples:
          - - OAuth token refresh failed, please re-link your account
            - API daily rate limit reached for your account
        instance_url:
          type: string
          description: Customer account instance URL
          readOnly: true
        key_id:
          type: string
          description: For ZDX Account only, Customer account API key ID
          examples:
          - L72frZcK3JvrZc
        last_status:
          type: string
          description: Is the last data pull for account is successful or not
          readOnly: true
          examples:
          - failed
        last_sync:
          type: integer
          description: Last data pull timestamp, background jobs that pull account data
          contentEncoding: int64
          readOnly: true
          examples:
          - 1665465339000
        linked_by:
          type: string
          description: First name of the user who linked the account
          readOnly: true
          examples:
          - Testname1
        linked_timestamp:
          type: number
          description: Timestamp when this third-party account was linked
          readOnly: true
          examples:
          - 1665465339000
        max_daily_api_requests:
          type: integer
          description: Zoom daily api request quota, https://developers.zoom.us/docs/api/rest/rate-limits/
          contentEncoding: int32
          readOnly: true
          examples:
          - 5000
        name:
          type: string
          description: Display name of the linked third-party account or company
          readOnly: true
          examples:
          - Test Compay1 Ltd
        password:
          type: string
          description: Customer account password instance URL
          contentEncoding: password
          readOnly: true
        region:
          type: string
          description: For Prisma accounts only
          readOnly: true
          examples:
          - americas
        regions:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/account_oauth_info_account_region'
          description: Prisma Access regions with allocated bandwidth for this linked account
        service_account_name:
          type: string
          description: For Prisma accounts only
          readOnly: true
          examples:
          - Corp SA
        service_connections:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/account_oauth_info_account_service_connection'
          description: Prisma Access service connections configured for this linked account
        smartgroup_name:
          type: string
          description: Smart group membership for determining compliance status
          readOnly: true
          examples:
          - CompliantGroup1
        tsg_id:
          type: string
          description: For Prisma accounts only, Prisma Tenant Service Group id
          readOnly: true
          examples:
          - '189953456'
        username:
          type: string
          description: Login name configured for the linked third-party account
          readOnly: true
        webhook_auth_type:
          type: string
          description: For Crowdstrike, JAMF, SentinelOne and VMWare accounts only
          examples:
          - Basic
          - Bearer
        webhook_enabled:
          type: boolean
          description: For Crowdstrike, JAMF, SentinelOne and VMWare accounts only
        webhook_password:
          type: string
          description: For VMWare accounts only
          contentEncoding: password
          examples:
          - password_1234
        webhook_secret:
          type: string
          description: For Crowdstrike accounts only
          contentEncoding: password
          examples:
          - secret-value
        webhook_token:
          type: string
          description: For JAMF and SentinelOne accounts only
          examples:
          - token-value
        webhook_url:
          type: string
          description: For Crowdstrike, JAMF, SentinelOne and VMWare accounts only
          examples:
          - https://websync.nac-staging.mistsys.com/v1/S_org-8dcbe9005/ae9dee49-69e7-4710-a114-5b827a777738/crowdstrike/edr
          - https://websync.nac-staging.mistsys.com/v1/S_org-8dcbe9005/ae9dee49-69e7-4710-a114-5b827a777738/jamf/mdm
          - https://websync.nac-staging.mistsys.com/v1/S_org-8dcbe9005/00fd8b39-cf92-4b43-a2ff-a461b48e7059/sentinelone/edr
          - https://websync.nac-staging.mistsys.com/v1/S_41b2525af1d8dcbe9005/f43ea4c48f22/vmware/mdm
        webhook_username:
          type: string
          description: For VMWare accounts only
          examples:
          - username_1234
        zdx_org_id:
          type: string
          description: For ZDX Account only, ZDX organization id
          examples:
          - '123456'
      additionalProperties:
        allOf:
        - $ref: '#/components/schemas/account_oauth_info_account'
        - description: OAuth linked apps account info
      description: Site settings with derived OAuth account integration data
    system_defined_port_usages:
      title: system_defined_port_usages
      enum:
      - ap
      - iot
      - uplink
      type: string
      description: 'system-default port usages. enum: `ap`, `iot`, `uplink``'
    site_setting_juniper_srx:
      title: site_setting_juniper_srx
      type: object
      properties:
        auto_upgrade:
          allOf:
          - $ref: '#/components/schemas/juniper_srx_auto_upgrade2'
          - description: SRX auto-upgrade settings applied when SRX devices are onboarded
        gateways:
          type: array
          items:
            $ref: '#/components/schemas/site_setting_juniper_srx_gateway'
          description: SRX gateways integrated with this site
        send_mist_nac_user_info:
          type: boolean
          description: Whether Mist NAC user information is sent to Juniper SRX gateways
      description: Site-level Juniper SRX integration settings
    site_setting_juniper_srx_gateway:
      title: site_setting_juniper_srx_gateway
      type: object
      properties:
        api_key:
          type: string
          description: Authentication key used to access the Juniper SRX gateway API
          examples:
          - 5abf7c8a-1a1c-4398-ba2d-b0c297094d1a
        api_password:
          type: string
          description: Authentication password used to access the Juniper SRX gateway API
          examples:
          - abc@123
        api_url:
          type: string
          description: Base URL for the Juniper SRX gateway API
          examples:
          - https://23.43.12.78:8443
      description: Juniper SRX gateway API connection settings
    site_setting_mxedge:
      title: site_setting_mxedge
      type: object
      properties:
        mist_das:
          allOf:
          - $ref: '#/components/schemas/mxedge_das2'
          - description: DAS service settings for the site Mist Edge cluster
        mist_nac:
          allOf:
          - $ref: '#/components/schemas/mxcluster_nac2'
          - description: RADIUS settings for Mist NAC on the site Mist Edge cluster
        mist_nacedge:
          allOf:
          - $ref: '#/components/schemas/mist_nacedge1'
          - description: NAC Edge service settings for the site Mist Edge cluster
        radsec:
          allOf:
          - $ref: '#/components/schemas/mxcluster_radsec2'
          - description: TLS-secured RADIUS proxy settings for the site Mist Edge cluster
      description: Service settings for the site Mist Edge cluster
    site_setting_paloalto_network_gateway:
      title: site_setting_paloalto_network_gateway
      type: object
      properties:
        api_key:
          type: string
          description: Authentication key used to access the Palo Alto Networks gateway API
          examples:
          - 5abf7c8a-1a1c-4398-ba2d-b0c297094d1a
        api_url:
          type: string
          description: Base URL for the Palo Alto Networks gateway API
          examples:
          - https://23.43.12.78:8443
      description: Palo Alto Networks gateway API connection settings
    site_setting_paloalto_networks:
      title: site_setting_paloalto_networks
      type: object
      properties:
        gateways:
          type: array
          items:
            $ref: '#/components/schemas/site_setting_paloalto_network_gateway'
          description: Palo Alto Networks gateways integrated with this site
        send_mist_nac_user_info:
          type: boolean
          description: Whether Mist NAC user information is sent to Palo Alto Networks gateways
          default: false
      description: Palo Alto Networks integration settings for the site
    site_setting_rtsa:
      title: site_setting_rtsa
      type: object
      properties:
        app_waking:
          type: boolean
          description: Whether app wake-up support is enabled for managed mobility
          default: false
        disable_dead_reckoning:
          type: boolean
          description: Whether dead reckoning is disabled for managed mobility
        disable_pressure_sensor:
          type: boolean
          description: Whether pressure sensor use is disabled for managed mobility
          default: false
        enabled:
          type: boolean
          description: Whether managed mobility features are enabled
        track_asset:
          type: boolean
          description: Whether BLE asset tracking is enabled for managed mobility
          default: false
      description: Managed mobility and asset tracking settings
    site_setting_skyatp:
      title: site_setting_skyatp
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether Sky ATP is enabled for the site
        send_ip_mac_mapping:
          type: boolean
          description: Whether IP-to-MAC mappings are sent to Sky ATP
          default: false
      description: Sky ATP threat intelligence settings for the site
    site_setting_srx_app:
      title: site_setting_srx_app
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether Juniper SRX application visibility is enabled
          default: false
      description: Juniper SRX application visibility settings for the site
    site_setting_status_portal:
      title: site_setting_status_portal
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether the site status portal is enabled
          default: false
        hostnames:
          type: array
          items:
            type: string
          description: Portal hostnames served by the site status portal
      description: End-user status portal settings for the site
    site_setting_switch:
      title: site_setting_switch
      type: object
      properties:
        acl_policies:
          type: array
          items:
            $ref: '#/components/schemas/acl_policy'
          description: ACL policy defaults provided by this network template
        acl_tags:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/acl_tag'
          description: ACL tags available to access policies in this network template
        additional_config_cmds:
          type: array
          items:
            type: string
          description: Additional CLI configuration commands provided by this network template
        bgp_config:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_bgp_config'
          description: BGP routing defaults for this network template. Property key is the BGP session name
        created_time:
          type: number
          description: Timestamp when the network template was created
          readOnly: true
        dhcp_snooping:
          allOf:
          - $ref: '#/components/schemas/dhcp_snooping3'
          - description: DHCP snooping defaults provided by this network template
        dns_servers:
          type: array
          items:
            type: string
          description: DNS servers provided by this network template
        dns_suffix:
          type: array
          items:
            type: string
          description: DNS search suffixes provided by this network template
        extra_routes:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/extra_route'
          description: Additional IPv4 route defaults in this network template
          examples:
          - 0.0.0.0/0:
              via: 192.168.1.10
        extra_routes6:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/extra_route6'
          description: Additional IPv6 route defaults in this network template
          examples:
          - 2a02:1234:420a:10c9::/64:
              via: 2a02:1234:200a::100
        id:
          type: string
          description: Unique identifier of the network template
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        import_org_networks:
          type: array
          items:
            type: string
          description: Organization network names imported into this network template
        mist_nac:
          allOf:
          - $ref: '#/components/schemas/switch_mist_nac2'
          - description: Mist NAC defaults applied by this network template
        modified_time:
          type: number
          description: Timestamp when the network template was last modified
          readOnly: true
        multicast_config:
          allOf:
          - $ref: '#/components/schemas/switch_multicast_config1'
          - description: Multicast settings for networks in the master VRF (not assigned to any vrf_instances); PIM is automatically enabled when any master-VRF network has `multicast.enabled`==`true`
        name:
          type: string
          description: Display name of the network template
        networks:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_network'
          description: Layer 3 networks configured by this network template
        ntp_servers:
          type: array
          items:
            type: string
          description: NTP servers provided by this network template
        org_id:
          type: string
          description: Organization that owns this network template
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        ospf_areas:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ospf_area'
          description: OSPF area defaults provided by this network template
        port_mirroring:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_port_mirroring_property'
          description: Port mirroring defaults provided by this network template
        port_usages:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_port_usage'
          description: Reusable switch port usage profiles provided by this network template
        radius_config:
          allOf:
          - $ref: '#/components/schemas/switch_radius_config3'
          - description: RADIUS authentication and accounting defaults in this network template
        remote_syslog:
          allOf:
          - $ref: '#/components/schemas/remote_syslog2'
          - description: Remote syslog defaults provided by this network template
        remove_existing_configs:
          type: boolean
          description: By default, only the configuration generated by Mist is cleaned up during the configuration process. If `true`, all the existing configuration will be removed.
          default: false
        routing_policies:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/sw_routing_policy'
          description: Routing policy defaults applied by this network template
        snmp_config:
          allOf:
          - $ref: '#/components/schemas/snmp_config2'
          - description: SNMP defaults provided by this network template
        switch_matching:
          allOf:
          - $ref: '#/components/schemas/switch_matching3'
          - description: Matching rules that select switches for this network template
        switch_mgmt:
          allOf:
          - $ref: '#/components/schemas/switch_mgmt3'
          - description: Management-plane defaults provided by this network template
        vrf_config:
          allOf:
          - $ref: '#/components/schemas/vrf_config5'
          - description: VRF defaults applied by this network template
        vrf_instances:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_vrf_instance'
          description: VRF instances configured by this network template
          examples:
          - guest:
              extra_routes:
                0.0.0.0/0:
                  via: 192.168.31.1
              networks:
              - guest
        auto_upgrade:
          allOf:
          - $ref: '#/components/schemas/switch_auto_upgrade1'
          - description: Switch firmware auto-upgrade configuration
      description: Site switch settings combining a network template and auto-upgrade controls
    site_setting_tunterm_multicast_config:
      title: site_setting_tunterm_multicast_config
      type: object
      properties:
        mdns:
          allOf:
          - $ref: '#/components/schemas/site_setting_tunterm_multicast_config_mdns2'
          - description: Multicast DNS forwarding settings for tunneled VLANs
        multicast_all:
          type: boolean
          description: Whether all multicast traffic is forwarded through tunnel termination
          default: false
        ssdp:
          allOf:
          - $ref: '#/components/schemas/site_setting_tunterm_multicast_config_ssdp2'
          - description: Simple Service Discovery Protocol forwarding settings for tunneled VLANs
      description: Multicast forwarding settings for tunnel termination at the site
    site_setting_tunterm_multicast_config_mdns:
      title: site_setting_tunterm_multicast_config_mdns
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether mDNS multicast forwarding is enabled
          default: false
        vlan_ids:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: VLAN IDs where mDNS multicast forwarding is enabled
          examples:
          - - 2
            - 3
            - 5
      description: mDNS multicast forwarding settings for tunneled VLANs
    site_setting_tunterm_multicast_config_ssdp:
      title: site_setting_tunterm_multicast_config_ssdp
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether SSDP multicast forwarding is enabled
          default: false
        vlan_ids:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: VLAN IDs where SSDP multicast forwarding is enabled
          examples:
          - - 2
            - 3
            - 5
      description: SSDP multicast forwarding settings for tunneled VLANs
    site_setting_vna:
      title: site_setting_vna
      type: object
      properties:
        enabled:
          type: boolean
          description: Enable Virtual Network Assistant (using SUB-VNA license). This applied to AP / Switch / Gateway
          default: false
      description: Virtual Network Assistant settings for AP, switch, and gateway experiences at a site
    vrrp_group:
      title: vrrp_group
      type: object
      properties:
        auth_key:
          type: string
          description: If `auth_type`==`md5`, authentication key used by the VRRP group
          examples:
          - auth-key-1
        auth_password:
          type: string
          description: If `auth_type`==`simple`, password used by the VRRP group
          contentEncoding: password
        auth_type:
          allOf:
          - $ref: '#/components/schemas/vrrp_group_auth_type2'
          - description: 'Authentication method used by the VRRP group. enum: `md5`, `simple`.'
            examples:
            - md5
        networks:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/vrrp_group_network'
          description: VRRP network mappings and their virtual IP addresses
          examples:
          - data:
              ip: 10.182.96.1
            mgmt:
              ip: 10.182.104.1
            v10:
              ip: 10.182.104.129
            wap:
              ip: 10.182.102.1
      description: Junos VRRP group authentication and network settings
    site_setting_wan_vna:
      title: site_setting_wan_vna
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether WAN VNA is enabled for the site
          default: false
      description: WAN Virtual Network Assistant settings for the site
    site_setting_wired_vna:
      title: site_setting_wired_vna
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether Wired VNA is enabled for the site
          default: false
      description: Wired Virtual Network Assistant settings for the site
    site_sky_atp_events_count_distinct:
      title: site_sky_atp_events_count_distinct
      enum:
      - device_mac
      - mac
      - threat_level
      - type
      type: string
      description: 'enum: `device_mac`, `mac`, `threat_level`, `type`'
    site_sle_histogram_scope_parameters:
      title: site_sle_histogram_scope_parameters
      enum:
      - ap
      - client
      - gateway
      - site
      - switch
      type: string
      description: 'enum: `ap`, `client`, `gateway`, `site`, `switch`'
    site_sle_impact_summary_fields_parameter:
      title: site_sle_impact_summary_fields_parameter
      enum:
      - ap
      - band
      - chassis
      - client
      - device_os
      - device_type
      - gateway
      - gateway_zones
      - interface
      - mxedge
      - peer_path
      - server
      - switch
      - vlan
      - wlan
      type: string
      description: 'enum: `ap`, `band`, `chassis`, `client`, `device_os`, `device_type`, `gateway`, `gateway_zones`, `interface`, `mxedge`, `peer_path`, `server`, `switch`, `vlan`, `wlan`'
    site_sle_impact_summary_scope_parameters:
      title: site_sle_impact_summary_scope_parameters
      enum:
      - ap
      - client
      - gateway
      - site
      - switch
      type: string
      description: 'enum: `ap`, `client`, `gateway`, `site`, `switch`'
    site_sle_impacted_aps_scope_parameters:
      title: site_sle_impacted_aps_scope_parameters
      const: site
      type: string
      description: 'Scope parameter value for impacted AP SLE queries. enum: `site`'
    site_sle_impacted_chassis_scope_parameters:
      title: site_sle_impacted_chassis_scope_parameters
      enum:
      - gateway
      - site
      - switch
      type: string
      description: 'enum: `gateway`, `site`, `switch`'
    site_sle_impacted_clients_scope_parameters:
      title: site_sle_impacted_clients_scope_parameters
      enum:
      - gateway
      - site
      - switch
      type: string
      description: 'enum: `gateway`, `site`, `switch`'
    site_sle_impacted_gateways_scope_parameters:
      title: site_sle_impacted_gateways_scope_parameters
      const: site
      type: string
      description: 'Scope parameter value for impacted gateway SLE queries. enum: `site`'
    site_sle_impacted_interfaces_scope_parameters:
      title: site_sle_impacted_interfaces_scope_parameters
      enum:
      - gateway
      - site
      - switch
      type: string
      description: 'enum: `gateway`, `site`, `switch`'
    site_sle_impacted_switches_scope_parameters:
      title: site_sle_impacted_switches_scope_parameters
      const: site
      type: string
      description: 'Scope parameter value for impacted switch SLE queries. enum: `site`'
    site_sle_impacted_users_scope_parameter:
      title: site_sle_impacted_users_scope_parameter
      enum:
      - ap
      - site
      type: string
      description: 'Scope parameter value for impacted user SLE queries. enum: `ap`, `site`'
    site_sle_metric_classifiers_scope_parameters:
      title: site_sle_metric_classifiers_scope_parameters
      enum:
      - ap
      - client
      - gateway
      - site
      - switch
      type: string
      description: 'enum: `ap`, `client`, `gateway`, `site`, `switch`'
    site_sle_metric_summary_scope_parameters:
      title: site_sle_metric_summary_scope_parameters
      enum:
      - ap
      - client
      - gateway
      - site
      - switch
      type: string
      description: 'enum: `ap`, `client`, `gateway`, `site`, `switch`'
    site_sle_metrics:
      title: site_sle_metrics
      required:
      - enabled
      - supported
      type: object
      properties:
        enabled:
          uniqueItems: true
          type: array
          items:
            type: string
          description: SLE metric names enabled for the site
        supported:
          uniqueItems: true
          type: array
          items:
            type: string
          description: SLE metric names supported for the site
      description: SLE metrics available for a site
    site_sle_metrics_scope_parameters:
      title: site_sle_metrics_scope_parameters
      enum:
      - ap
      - client
      - gateway
      - site
      - switch
      type: string
      description: 'enum: `ap`, `client`, `gateway`, `site`, `switch`'
    site_sle_scope:
      title: site_sle_scope
      enum:
      - gateway
      - site
      - switch
      type: string
      description: 'enum: `gateway`, `site`, `switch`'
    site_sle_threshold_scope_parameter:
      title: site_sle_threshold_scope_parameter
      enum:
      - ap
      - client
      - gateway
      - site
      - switch
      type: string
      description: 'enum: `ap`, `client`, `gateway`, `site`, `switch`'
    site_system_events_count_distinct:
      title: site_system_events_count_distinct
      const: type
      type: string
      description: 'Distinct field used when counting site system events. enum: `type`'
    site_template:
      title: site_template
      type: object
      properties:
        auto_upgrade:
          allOf:
          - $ref: '#/components/schemas/site_template_auto_upgrade2'
          - description: Automatic upgrade settings applied by this site template
        name:
          type: string
          description: Display name of the site template
        vars:
          type: object
          additionalProperties:
            type: string
          description: Template variables available to WLAN configuration in this site template
          examples:
          - RADIUS_IP1: 172.31.2.5
            RADIUS_SECRET: 11s64632d
      description: Site template containing auto-upgrade settings and template variables
    site_template_auto_upgrade:
      title: site_template_auto_upgrade
      type: object
      properties:
        day_of_week:
          allOf:
          - $ref: '#/components/schemas/day_of_week6'
          - description: 'Day of week when the automatic upgrade window runs. enum: `any`, `fri`, `mon`, `sat`, `sun`, `thu`, `tue`, `wed`.'
        enabled:
          type: boolean
          description: Whether automatic upgrades are enabled for sites using this site template
        time_of_day:
          type: string
          description: Local time of day when the automatic upgrade window starts
        version:
          type: string
          description: Target firmware version installed during automatic upgrades
      description: Automatic upgrade settings applied by a site template
    site_wan_client_events_distinct:
      title: site_wan_client_events_distinct
      enum:
      - hostname
      - ip
      - mac
      - mfg
      - type
      type: string
      description: 'enum: `hostname`, `ip`, `mac`, `mfg`, `type`'
    site_wan_clients_count_distinct:
      title: site_wan_clients_count_distinct
      enum:
      - hostname
      - ip
      - mac
      - mfg
      type: string
      description: 'enum: `hostname`, `ip`, `mac`, `mfg`'
    site_wids:
      title: site_wids
      type: object
      properties:
        repeated_auth_failures:
          allOf:
          - $ref: '#/components/schemas/site_wids_repeated_auth_failures'
          - description: Detection settings for repeated authentication failures
      description: Wireless intrusion detection settings for a site
    site_wids_repeated_auth_failures:
      title: site_wids_repeated_auth_failures
      type: object
      properties:
        duration:
          type: integer
          description: Window where a trigger will be detected and action to be taken (in seconds)
          contentEncoding: int32
          examples:
          - 60
        threshold:
          type: integer
          description: Count of events to trigger
          contentEncoding: int32
      description: Detection settings for repeated authentication failures
    site_wifi:
      title: site_wifi
      type: object
      properties:
        cisco_enabled:
          type: boolean
          description: Whether Cisco compatibility features are enabled for site Wi-Fi
          default: true
        disable_11k:
          type: boolean
          description: Whether to disable 11k
          default: false
        disable_radios_when_power_constrained:
          type: boolean
          description: Whether AP radios are disabled when AP power is constrained
          default: false
        enable_arp_spoof_check:
          type: boolean
          description: When proxy_arp is enabled, check for arp spoofing.
          default: false
        enable_shared_radio_scanning:
          type: boolean
          description: Whether shared radio scanning is enabled for site Wi-Fi
          default: true
        enabled:
          type: boolean
          description: Enable Wi-Fi feature (using SUB-MAN license)
          default: true
        locate_connected:
          type: boolean
          description: Whether to locate connected clients
          default: true
        locate_unconnected:
          type: boolean
          description: Whether to locate unconnected clients
          default: false
        mesh_allow_dfs:
          type: boolean
          description: Whether to allow Mesh to use DFS channels. For DFS channels, Remote Mesh AP would have to do CAC when scanning for new Base AP, which is slow and will disrupt the connection. If roaming is desired, keep it disabled.
          default: false
        mesh_enable_crm:
          type: boolean
          description: Used to enable/disable CRM
          default: false
        mesh_enabled:
          type: boolean
          description: Whether to enable Mesh feature for the site
          default: false
        mesh_psk:
          type:
          - string
          - 'null'
          description: Optional passphrase of mesh networking, default is generated randomly
        mesh_ssid:
          type:
          - string
          - 'null'
          description: Optional ssid of mesh networking, default is based on site_id
        proxy_arp:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/site_wifi_proxy_arp2'
          - description: 'ARP proxy mode for site Wi-Fi. enum: `default`, `disabled`, `enabled`.'
      description: Wi-Fi configuration settings for a site
    site_wifi_proxy_arp:
      title: site_wifi_proxy_arp
      enum:
      - default
      - disabled
      - enabled
      type: string
      description: 'enum: `default`, `disabled`, `enabled`'
    site_wired_clients_count_distinct:
      title: site_wired_clients_count_distinct
      enum:
      - mac
      - port_id
      - vlan
      type: string
      description: 'enum: `mac`, `port_id`, `vlan`'
    site_zone_count_distinct:
      title: site_zone_count_distinct
      enum:
      - scope
      - scope_id
      - user
      - user_type
      type: string
      description: 'enum: `scope`, `scope_id`, `user`, `user_type`'
    site_zone_occupancy_alert:
      title: site_zone_occupancy_alert
      type: object
      properties:
        email_notifiers:
          type: array
          items:
            type: string
          description: Notification email recipients for zone occupancy alerts
          examples:
          - - foo@juniper.net
            - bar@juniper.net
        enabled:
          type: boolean
          description: Indicate whether zone occupancy alert is enabled for the site
          default: false
        threshold:
          maximum: 30
          minimum: 0
          type: integer
          description: Sending zone-occupancy-alert webhook message only if a zone stays non-compliant (i.e. actual occupancy > occupancy_limit) for a minimum duration specified in the threshold, in minutes
          contentEncoding: int32
          default: 5
          examples:
          - 5
      description: Zone occupancy alert settings for a site
    sitegroup:
      title: sitegroup
      required:
      - name
      type: object
      properties:
        created_time:
          type: number
          description: Timestamp when the site group was created
          readOnly: true
        id:
          type: string
          description: Unique value identifying the site group
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        modified_time:
          type: number
          description: Timestamp when the site group was last modified
          readOnly: true
        name:
          type: string
          description: Display name of the site group
        org_id:
          type: string
          description: Identifier of the org that owns the site group
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        site_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Site identifiers included in the site group
      description: Group of sites within an organization
    skyatp_list:
      title: skyatp_list
      type: object
      properties:
        domains:
          type: array
          items:
            $ref: '#/components/schemas/skyatp_list_domain'
          description: SecIntel domain entries in this Sky ATP list
        ip:
          type: array
          items:
            $ref: '#/components/schemas/skyatp_list_ip'
          description: SecIntel IP address entries in this Sky ATP list
      description: Sky ATP SecIntel allowlist or blocklist entries
    skyatp_list_domain:
      title: skyatp_list_domain
      required:
      - value
      type: object
      properties:
        comment:
          type: string
          description: Optional note describing the domain list entry
          examples:
          - restricted
        value:
          type: string
          description: Domain name included in the Sky ATP SecIntel list
          examples:
          - unsafe.com
      description: Domain entry in a Sky ATP SecIntel list
    skyatp_list_ip:
      title: skyatp_list_ip
      required:
      - value
      type: object
      properties:
        comment:
          type: string
          description: Optional note describing the IP address list entry
          examples:
          - nas
        value:
          type: string
          description: IP address included in the Sky ATP SecIntel list
          examples:
          - 10.1.3.5
      description: IP address entry in a Sky ATP SecIntel list
    sle_classifier:
      title: sle_classifier
      required:
      - impact
      - interval
      - name
      - x_label
      - y_label
      type: object
      properties:
        impact:
          allOf:
          - $ref: '#/components/schemas/sle_classifier_impact2'
          - description: Counts of affected APs and users for this classifier
        interval:
          type: number
          description: Sample interval in seconds for classifier time-series data
        name:
          minLength: 1
          type: string
          description: Classifier name for the SLE metric
        samples:
          allOf:
          - $ref: '#/components/schemas/sle_classifier_samples3'
          - description: Time-series sample arrays for the classifier
        x_label:
          minLength: 1
          type: string
          description: Label for the classifier sample x-axis
        y_label:
          minLength: 1
          type: string
          description: Label for the classifier sample y-axis
      description: Time-series classifier detail for an SLE metric
    sle_classifier_impact:
      title: sle_classifier_impact
      required:
      - num_aps
      - num_users
      - total_aps
      - total_users
      type: object
      properties:
        num_aps:
          type: number
          description: Number of APs affected by degraded SLE experience
        num_users:
          type: number
          description: Number of users affected by degraded SLE experience
        total_aps:
          type: number
          description: Total number of APs considered for the classifier
        total_users:
          type: number
          description: Total number of users considered for the classifier
      description: AP and user impact counts for an SLE classifier
    sle_classifier_samples:
      title: sle_classifier_samples
      required:
      - degraded
      - duration
      - total
      type: object
      properties:
        degraded:
          type: array
          items:
            $ref: '#/components/schemas/number_or_null'
          description: Per-interval degraded SLE values for the classifier
        duration:
          type: array
          items:
            type: number
          description: Per-interval observation durations for the classifier
        total:
          type: array
          items:
            $ref: '#/components/schemas/number_or_null'
          description: Per-interval total SLE values for the classifier
      description: Per-interval sample arrays for an SLE classifier
    sle_classifier_summary:
      title: sle_classifier_summary
      required:
      - classifier
      - end
      - failures
      - impact
      - metric
      - start
      type: object
      properties:
        classifier:
          allOf:
          - $ref: '#/components/schemas/sle_classifier1'
          - description: Requested SLE classifier detail for the metric
        end:
          type: number
          description: Last timestamp in the classifier summary window
        failures:
          type: array
          items:
            type: object
          description: Failure records included in the classifier summary
        impact:
          allOf:
          - $ref: '#/components/schemas/sle_classifier_summary_impact2'
          - description: AP and user impact counts for the classifier summary window
        metric:
          minLength: 1
          type: string
          description: SLE metric name summarized by this response
        start:
          type: number
          description: First timestamp in the classifier summary window
      description: Deprecated SLE classifier summary response
      deprecated: true
    sle_classifier_summary_impact:
      title: sle_classifier_summary_impact
      required:
      - num_aps
      - num_users
      - total_aps
      - total_users
      type: object
      properties:
        num_aps:
          type: number
          description: Number of APs affected by degraded SLE experience
        num_users:
          type: number
          description: Number of users affected by degraded SLE experience
        total_aps:
          type: number
          description: Total number of APs considered in the summary window
        total_users:
          type: number
          description: Total number of users considered in the summary window
      description: AP and user impact counts for a classifier summary window
    sle_classifier_summary_trend:
      title: sle_classifier_summary_trend
      required:
      - classifier
      - end
      - metric
      - start
      type: object
      properties:
        classifier:
          allOf:
          - $ref: '#/components/schemas/sle_trend_classifier2'
          - description: Requested SLE classifier trend detail for the metric
        end:
          type: number
          description: Last timestamp in the classifier trend window
        metric:
          minLength: 1
          type: string
          description: SLE metric name represented by the trend
        start:
          type: number
          description: First timestamp in the classifier trend window
      description: Time-series trend response for an SLE classifier
    sle_histogram:
      title: sle_histogram
      required:
      - data
      - end
      - metric
      - start
      - x_label
      - y_label
      type: object
      properties:
        data:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/sle_histogram_data_item'
          description: Histogram buckets for the SLE metric
        end:
          type: number
          description: Last timestamp in the histogram window
        metric:
          minLength: 1
          type: string
          description: SLE metric name represented by the histogram
        start:
          type: number
          description: First timestamp in the histogram window
        x_label:
          minLength: 1
          type: string
          description: Label for the histogram x-axis
        y_label:
          minLength: 1
          type: string
          description: Label for the histogram y-axis
      description: Histogram response for an SLE metric
    sle_histogram_data_item:
      title: sle_histogram_data_item
      required:
      - value
      type: object
      properties:
        range:
          type: array
          items:
            type:
            - number
            - 'null'
          description: Boundary values for this histogram bucket
        value:
          type: number
          description: Measured amount for this histogram bucket
      description: Single bucket in an SLE histogram
    sle_impact_summary:
      title: sle_impact_summary
      required:
      - ap
      - band
      - classifier
      - device_os
      - device_type
      - end
      - failure
      - metric
      - start
      - wlan
      type: object
      properties:
        ap:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/sle_impact_summary_ap_item'
          description: Impact rows grouped by AP
        band:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/sle_impact_summary_band_item'
          description: Impact rows grouped by radio band
        classifier:
          type: string
          description: Requested SLE classifier filter applied to the impact summary
        device_os:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/sle_impact_summary_device_os_item'
          description: Impact rows grouped by client device OS
        device_type:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/sle_impact_summary_device_type_item'
          description: Impact rows grouped by client device type
        end:
          type: number
          description: Last timestamp in the impact summary window
        failure:
          type: string
          description: Requested SLE failure filter applied to the impact summary
        metric:
          minLength: 1
          type: string
          description: SLE metric name summarized by this response
        start:
          type: number
          description: First timestamp in the impact summary window
        wlan:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/sle_impact_summary_wlan_item'
          description: Impact rows grouped by WLAN
      description: SLE impact summary grouped by client, device, AP, WLAN, and band dimensions
    sle_impact_summary_ap_item:
      title: sle_impact_summary_ap_item
      required:
      - ap_mac
      - degraded
      - duration
      - name
      - total
      type: object
      properties:
        ap_mac:
          minLength: 1
          type: string
          description: MAC address of the AP represented by this impact row
        degraded:
          type: number
          description: Portion of the SLE total that was degraded for this AP
        duration:
          type: number
          description: Observation time represented by this AP impact row
        name:
          minLength: 1
          type: string
          description: Display name for the AP impact row
        total:
          type: number
          description: Overall SLE total measured for this AP impact row
      description: SLE impact summary row for an AP
    sle_impact_summary_band_item:
      title: sle_impact_summary_band_item
      required:
      - band
      - degraded
      - duration
      - name
      - total
      type: object
      properties:
        band:
          minLength: 1
          type: string
          description: Radio band represented by this impact row
        degraded:
          type: number
          description: Portion of the SLE total that was degraded for this radio band
        duration:
          type: number
          description: Observation time represented by this radio-band impact row
        name:
          minLength: 1
          type: string
          description: Display name for the radio-band impact row
        total:
          type: number
          description: Overall SLE total measured for this radio-band impact row
      description: SLE impact summary row for a radio band
    sle_impact_summary_device_os_item:
      title: sle_impact_summary_device_os_item
      required:
      - degraded
      - device_os
      - duration
      - name
      - total
      type: object
      properties:
        degraded:
          type: number
          description: Portion of the SLE total that was degraded for this device OS
        device_os:
          type: string
          description: Client device OS represented by this impact row
        duration:
          type: number
          description: Observation time represented by this device-OS impact row
        name:
          minLength: 1
          type: string
          description: Display name for the device-OS impact row
        total:
          type: number
          description: Overall SLE total measured for this device-OS impact row
      description: SLE impact summary row for a client device OS
    sle_impact_summary_device_type_item:
      title: sle_impact_summary_device_type_item
      required:
      - degraded
      - device_type
      - duration
      - name
      - total
      type: object
      properties:
        degraded:
          type: number
          description: Portion of the SLE total that was degraded for this device type
        device_type:
          type: string
          description: Client device type represented by this impact row
        duration:
          type: number
          description: Observation time represented by this device-type impact row
        name:
          minLength: 1
          type: string
          description: Display name for the device-type impact row
        total:
          type: number
          description: Overall SLE total measured for this device-type impact row
      description: SLE impact summary row for a client device type
    sle_impact_summary_wlan_item:
      title: sle_impact_summary_wlan_item
      required:
      - degraded
      - duration
      - name
      - total
      - wlan_id
      type: object
      properties:
        degraded:
          type: number
          description: Portion of the SLE total that was degraded for this WLAN
        duration:
          type: number
          description: Observation time represented by this WLAN impact row
        name:
          minLength: 1
          type: string
          description: Display name for the WLAN impact row
        total:
          type: number
          description: Overall SLE total measured for this WLAN impact row
        wlan_id:
          minLength: 1
          type: string
          description: Identifier of the WLAN represented by this impact row
      description: SLE impact summary row for a WLAN
    sle_impacted_applications:
      title: sle_impacted_applications
      type: object
      properties:
        apps:
          type: array
          items:
            $ref: '#/components/schemas/sle_impacted_applications_app'
          description: Impacted application rows returned for the SLE query
        classifier:
          type: string
          description: Requested SLE classifier filter applied to the query
        end:
          type: integer
          description: Last timestamp in the impacted applications window
          contentEncoding: int32
        failure:
          type: string
          description: Requested SLE failure filter applied to the query
        limit:
          type: integer
          description: Maximum number of impacted application rows returned per page
          contentEncoding: int32
        metric:
          type: string
          description: SLE metric name used for the impacted applications query
        page:
          type: integer
          description: Current page number for impacted application results
          contentEncoding: int32
        start:
          type: integer
          description: First timestamp in the impacted applications window
          contentEncoding: int32
        total_count:
          type: integer
          description: Number of impacted application rows matching the query
          contentEncoding: int32
      description: Paginated list of applications impacted by an SLE metric
    sle_impacted_applications_app:
      title: sle_impacted_applications_app
      type: object
      properties:
        app:
          type: string
          description: Identifier of the application represented by this impacted row
        degraded:
          type: integer
          description: Portion of the SLE total that was degraded for this application
          contentEncoding: int32
        duration:
          type: integer
          description: Observation time represented by this application impact row
          contentEncoding: int32
        name:
          type: string
          description: Display name for the application impact row
        threshold:
          type: integer
          description: SLE threshold value used for this application
          contentEncoding: int32
        total:
          type: integer
          description: Overall SLE total measured for this application impact row
          contentEncoding: int32
      description: SLE impact row for an application
    sle_impacted_aps:
      title: sle_impacted_aps
      required:
      - aps
      - classifier
      - end
      - failure
      - limit
      - metric
      - page
      - start
      - total_count
      type: object
      properties:
        aps:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/sle_impacted_aps_ap'
          description: Impacted access point rows returned for the SLE query
        classifier:
          type: string
          description: Requested SLE classifier filter applied to the query
        end:
          type: number
          description: Last timestamp in the impacted APs window
        failure:
          type: string
          description: Requested SLE failure filter applied to the query
        limit:
          type: integer
          description: Maximum number of impacted AP rows returned per page
          contentEncoding: int32
        metric:
          minLength: 1
          type: string
          description: SLE metric name used for the impacted APs query
        page:
          type: number
          description: Current page number for impacted AP results
        start:
          type: number
          description: First timestamp in the impacted APs window
        total_count:
          type: number
          description: Number of impacted AP rows matching the query
      description: Paginated list of APs impacted by an SLE metric
    sle_impacted_aps_ap:
      title: sle_impacted_aps_ap
      required:
      - ap_mac
      - degraded
      - duration
      - name
      - total
      type: object
      properties:
        ap_mac:
          minLength: 1
          type: string
          description: MAC address of the AP represented by this impacted row
        degraded:
          type: number
          description: Portion of the SLE total that was degraded for this AP
        duration:
          type: number
          description: Observation time represented by this AP impact row
        name:
          minLength: 1
          type: string
          description: Display name for the AP impact row
        total:
          type: number
          description: Overall SLE total measured for this AP impact row
      description: SLE impact row for an AP
    sle_impacted_chassis:
      title: sle_impacted_chassis
      type: object
      properties:
        chassis:
          type: array
          items:
            $ref: '#/components/schemas/sle_impacted_chassis_chassis_item'
          description: Impacted chassis rows returned for the SLE query
        classifier:
          type: string
          description: Requested SLE classifier filter applied to the query
        end:
          type: integer
          description: Last timestamp in the impacted chassis window
          contentEncoding: int32
        failure:
          type: string
          description: Requested SLE failure filter applied to the query
        limit:
          type: integer
          description: Maximum number of impacted chassis rows returned per page
          contentEncoding: int32
        metric:
          type: string
          description: SLE metric name used for the impacted chassis query
        page:
          type: integer
          description: Current page number for impacted chassis results
          contentEncoding: int32
        start:
          type: integer
          description: First timestamp in the impacted chassis window
          contentEncoding: int32
        total_count:
          type: integer
          description: Number of impacted chassis rows matching the query
          contentEncoding: int32
      description: Paginated list of chassis impacted by an SLE metric
    sle_impacted_chassis_chassis_item:
      title: sle_impacted_chassis_chassis_item
      type: object
      properties:
        chassis:
          type: string
          description: Identifier of the chassis represented by this impacted row
        degraded:
          type: number
          description: Portion of the SLE total that was degraded for this chassis
        duration:
          type: number
          description: Observation time represented by this chassis impact row
        role:
          type: string
          description: Virtual Chassis role for the switch member
        switch_mac:
          type: string
          description: MAC address of the switch represented by this chassis row
        switch_name:
          type: string
          description: Display name of the switch represented by this chassis row
        total:
          type: number
          description: Overall SLE total measured for this chassis impact row
      description: SLE impact row for a chassis
    sle_impacted_client_gateway:
      title: sle_impacted_client_gateway
      type: object
      properties:
        chassis_mac:
          type: string
          description: MAC address of the chassis associated with this client gateway row
        gateway_mac:
          type: string
          description: MAC address of the gateway associated with this client row
        gateway_name:
          type: string
          description: Display name of the gateway associated with this client row
        interfaces:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Network interfaces associated with this client gateway row
      description: Gateway association for an impacted client
    sle_impacted_clients:
      title: sle_impacted_clients
      type: object
      properties:
        classifier:
          type: string
          description: Requested SLE classifier filter applied to the query
        clients:
          type: array
          items:
            $ref: '#/components/schemas/sle_impacted_clients_client'
          description: Impacted client rows returned for the SLE query
        end:
          type: integer
          description: Last timestamp in the impacted clients window
          contentEncoding: int32
        failure:
          type: string
          description: Requested SLE failure filter applied to the query
        limit:
          type: integer
          description: Maximum number of impacted client rows returned per page
          contentEncoding: int32
        metric:
          type: string
          description: SLE metric name used for the impacted clients query
        page:
          type: integer
          description: Current page number for impacted client results
          contentEncoding: int32
        start:
          type: integer
          description: First timestamp in the impacted clients window
          contentEncoding: int32
        total_count:
          type: integer
          description: Number of impacted client rows matching the query
          contentEncoding: int32
      description: Paginated list of clients impacted by an SLE metric
    sle_impacted_clients_client:
      title: sle_impacted_clients_client
      type: object
      properties:
        degraded:
          type: integer
          description: Portion of the SLE total that was degraded for this client
          contentEncoding: int32
        duration:
          type: integer
          description: Observation time represented by this client impact row
          contentEncoding: int32
        mac:
          type: string
          description: Client MAC address for the impacted client
        name:
          type: string
          description: Display name for the client impact row
        switches:
          type: array
          items:
            $ref: '#/components/schemas/sle_impacted_clients_client_switch'
          description: Switch rows associated with the impacted client
        total:
          type: integer
          description: Overall SLE total measured for this client impact row
          contentEncoding: int32
      description: SLE impact row for a client
    sle_impacted_clients_client_switch:
      title: sle_impacted_clients_client_switch
      type: object
      properties:
        interfaces:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Switch interfaces associated with this impacted client
        switch_mac:
          type: string
          description: MAC address of the switch associated with this impacted client
        switch_name:
          type: string
          description: Display name of the switch associated with this impacted client
      description: Switch association for an impacted client
    sle_impacted_gateways:
      title: sle_impacted_gateways
      type: object
      properties:
        classifier:
          type: string
          description: Requested SLE classifier filter applied to the query
        end:
          type: integer
          description: Last timestamp in the impacted gateways window
          contentEncoding: int32
        failure:
          type: string
          description: Requested SLE failure filter applied to the query
        gateways:
          type: array
          items:
            $ref: '#/components/schemas/sle_impacted_gateways_gateway'
          description: Impacted gateway rows returned for the SLE query
        limit:
          type: integer
          description: Maximum number of impacted gateway rows returned per page
          contentEncoding: int32
        metric:
          type: string
          description: SLE metric name used for the impacted gateways query
        page:
          type: integer
          description: Current page number for impacted gateway results
          contentEncoding: int32
        start:
          type: integer
          description: First timestamp in the impacted gateways window
          contentEncoding: int32
        total_count:
          type: integer
          description: Number of impacted gateway rows matching the query
          contentEncoding: int32
      description: Paginated list of gateways impacted by an SLE metric
    sle_impacted_gateways_gateway:
      title: sle_impacted_gateways_gateway
      type: object
      properties:
        degraded:
          type: number
          description: Portion of the SLE total that was degraded for this gateway
        duration:
          type: integer
          description: Observation time represented by this gateway impact row
          contentEncoding: int32
        gateway_mac:
          type: string
          description: MAC address of the gateway represented by this impacted row
        gateway_model:
          type: string
          description: Model of the gateway represented by this impacted row
        gateway_version:
          type: string
          description: Firmware version of the gateway represented by this impacted row
        name:
          type: string
          description: Display name for the gateway impact row
        total:
          type: integer
          description: Overall SLE total measured for this gateway impact row
          contentEncoding: int32
      description: SLE impact row for a gateway
    sle_impacted_interfaces:
      title: sle_impacted_interfaces
      type: object
      properties:
        classifier:
          type: string
          description: Requested SLE classifier filter applied to the query
        end:
          type: integer
          description: Last timestamp in the impacted interfaces window
          contentEncoding: int32
        failure:
          type: string
          description: Requested SLE failure filter applied to the query
        interfaces:
          type: array
          items:
            $ref: '#/components/schemas/sle_impacted_interfaces_interface'
          description: Impacted interface rows returned for the SLE query
        limit:
          type: integer
          description: Maximum number of impacted interface rows returned per page
          contentEncoding: int32
        metric:
          type: string
          description: SLE metric name used for the impacted interfaces query
        page:
          type: integer
          description: Current page number for impacted interface results
          contentEncoding: int32
        start:
          type: integer
          description: First timestamp in the impacted interfaces window
          contentEncoding: int32
        total_count:
          type: integer
          description: Number of impacted interface rows matching the query
          contentEncoding: int32
      description: Paginated list of interfaces impacted by an SLE metric
    sle_impacted_interfaces_interface:
      title: sle_impacted_interfaces_interface
      type: object
      properties:
        degraded:
          type: number
          description: Portion of the SLE total that was degraded for this interface
        duration:
          type: number
          description: Observation time represented by this interface impact row
        interface_name:
          type: string
          description: Name of the switch interface represented by this impacted row
        switch_mac:
          type: string
          description: MAC address of the switch associated with this interface
        switch_name:
          type: string
          description: Display name of the switch associated with this interface
        total:
          type: number
          description: Overall SLE total measured for this interface impact row
      description: SLE impact row for a switch interface
    sle_impacted_switches:
      title: sle_impacted_switches
      type: object
      properties:
        classifier:
          type: string
          description: Requested SLE classifier filter applied to the query
        end:
          type: integer
          description: Last timestamp in the impacted switches window
          contentEncoding: int32
        failure:
          type: string
          description: Requested SLE failure filter applied to the query
        limit:
          type: integer
          description: Maximum number of impacted switch rows returned per page
          contentEncoding: int32
        metric:
          type: string
          description: SLE metric name used for the impacted switches query
        page:
          type: integer
          description: Current page number for impacted switch results
          contentEncoding: int32
        start:
          type: integer
          description: First timestamp in the impacted switches window
          contentEncoding: int32
        switches:
          type: array
          items:
            $ref: '#/components/schemas/sle_impacted_switches_switch'
          description: Impacted switch rows returned for the SLE query
        total_count:
          type: integer
          description: Number of impacted switch rows matching the query
          contentEncoding: int32
      description: Paginated list of switches impacted by an SLE metric
    sle_impacted_switches_switch:
      title: sle_impacted_switches_switch
      type: object
      properties:
        degraded:
          type: number
          description: Portion of the SLE total that was degraded for this switch
        duration:
          type: number
          description: Observation time represented by this switch impact row
        interface:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Switch interfaces contributing to this impacted switch row
        name:
          type: string
          description: Display name for the switch impact row
        switch_mac:
          type: string
          description: MAC address of the switch represented by this impacted row
        switch_model:
          type: string
          description: Model of the switch represented by this impacted row
        switch_version:
          type: string
          description: Firmware version of the switch represented by this impacted row
        total:
          type: number
          description: Overall SLE total measured for this switch impact row
      description: SLE impact row for a switch
    sle_impacted_users:
      title: sle_impacted_users
      required:
      - classifier
      - end
      - failure
      - limit
      - metric
      - page
      - start
      - total_count
      type: object
      properties:
        classifier:
          type: string
          description: Requested SLE classifier filter applied to the query
        clients:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/sle_impacted_users_client'
          description: Impacted client rows returned for the SLE query
        end:
          type: number
          description: Last timestamp in the impacted users window
        failure:
          type: string
          description: Requested SLE failure filter applied to the query
        limit:
          type: integer
          description: Maximum number of impacted user rows returned per page
          contentEncoding: int32
        metric:
          minLength: 1
          type: string
          description: SLE metric name used for the impacted users query
        page:
          type: number
          description: Current page number for impacted user results
        start:
          type: number
          description: First timestamp in the impacted users window
        total_count:
          type: number
          description: Number of impacted user rows matching the query
        users:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/sle_impacted_users_user'
          description: Impacted user rows returned for the SLE query
      description: Paginated list of users impacted by an SLE metric
    sle_impacted_users_client:
      title: sle_impacted_users_client
      type: object
      properties:
        degraded:
          type: number
          description: Portion of the SLE total that was degraded for this client
        duration:
          type: number
          description: Observation time represented by this client impact row
        gateways:
          type: array
          items:
            $ref: '#/components/schemas/sle_impacted_client_gateway'
          description: Gateway rows associated with the impacted client
        mac:
          type: string
          description: Client MAC address for the impacted client
        name:
          type: string
          description: Display name for the client impact row
        src_ip:
          type: string
          description: Client source IP address for the impacted client
        total:
          type: number
          description: Overall SLE total measured for this client impact row
      description: SLE impact row for a client in an impacted users response
    sle_impacted_users_user:
      title: sle_impacted_users_user
      type: object
      properties:
        ap_mac:
          type: string
          description: MAC address of the AP associated with this impacted user
        ap_name:
          type: string
          description: Display name of the AP associated with this impacted user
        degraded:
          type: number
          description: Portion of the SLE total that was degraded for this user
        device_os:
          type: string
          description: Client device OS for this impacted user
        device_type:
          type: string
          description: Client device type for this impacted user
        duration:
          type: number
          description: Observation time represented by this user impact row
        mac:
          type: string
          description: Client MAC address for this impacted user
        name:
          type: string
          description: Display name for the user impact row
        ssid:
          type: string
          description: Wireless network SSID used by this impacted user
        total:
          type: number
          description: Overall SLE total measured for this user impact row
        wlan_id:
          type: string
          description: Identifier of the WLAN used by this impacted user
      description: SLE impact row for a user
    sle_summary:
      title: sle_summary
      required:
      - classifiers
      - end
      - events
      - impact
      - sle
      - start
      type: object
      properties:
        classifiers:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/sle_classifier'
          description: SLE classifier details included in the summary
        end:
          type: number
          description: Last timestamp in the SLE summary window
        events:
          type: array
          items:
            type: object
          description: Event records included in the SLE summary
        impact:
          allOf:
          - $ref: '#/components/schemas/sle_summary_impact2'
          - description: AP and user impact counts for the summary window
        sle:
          allOf:
          - $ref: '#/components/schemas/sle_summary_sle3'
          - description: Time-series SLE samples for the summary window
        start:
          type: number
          description: First timestamp in the SLE summary window
      description: Deprecated SLE summary response for a metric window
      deprecated: true
    sle_summary_impact:
      title: sle_summary_impact
      required:
      - num_aps
      - num_users
      - total_aps
      - total_users
      type: object
      properties:
        num_aps:
          type: number
          description: Number of APs affected by degraded SLE experience
        num_users:
          type: number
          description: Number of users affected by degraded SLE experience
        total_aps:
          type: number
          description: Total number of APs considered in the summary window
        total_users:
          type: number
          description: Total number of users considered in the summary window
      description: AP and user impact counts for an SLE summary window
    sle_summary_scope:
      title: sle_summary_scope
      enum:
      - ap
      - client
      - gateway
      - site
      - switch
      type: string
      description: 'enum: `ap`, `client`, `gateway`, `site`, `switch`'
    sle_summary_sle:
      title: sle_summary_sle
      required:
      - interval
      - name
      - samples
      - x_label
      - y_label
      type: object
      properties:
        interval:
          type: number
          description: Sample interval in seconds for SLE summary data
        name:
          minLength: 1
          type: string
          description: SLE metric name represented by the summary samples
        samples:
          allOf:
          - $ref: '#/components/schemas/sle_summary_sle_samples2'
          - description: Per-interval sample arrays for the SLE metric
        x_label:
          minLength: 1
          type: string
          description: Label for the SLE summary x-axis
        y_label:
          minLength: 1
          type: string
          description: Label for the SLE summary y-axis
      description: Time-series SLE metric samples for a summary response
    sle_summary_sle_samples:
      title: sle_summary_sle_samples
      required:
      - degraded
      - total
      - value
      type: object
      properties:
        degraded:
          type: array
          items:
            $ref: '#/components/schemas/number_or_null'
          description: Per-interval degraded SLE values for the summary
        total:
          type: array
          items:
            $ref: '#/components/schemas/number_or_null'
          description: Per-interval total SLE values for the summary
        value:
          type: array
          items:
            $ref: '#/components/schemas/number_or_null'
          description: Per-interval SLE score values for the summary
      description: Per-interval sample arrays for an SLE summary
    sle_summary_trend:
      title: sle_summary_trend
      required:
      - classifiers
      - end
      - sle
      - start
      type: object
      properties:
        classifiers:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/sle_trend_classifier'
          description: SLE classifier trend details included in the response
        end:
          type: number
          description: Last timestamp in the SLE summary trend window
        sle:
          allOf:
          - $ref: '#/components/schemas/sle_summary_sle2'
          - description: Time-series SLE samples for the trend window
        start:
          type: number
          description: First timestamp in the SLE summary trend window
      description: Time-series SLE summary trend response
    sle_trend_classifier:
      title: sle_trend_classifier
      required:
      - interval
      - name
      - x_label
      - y_label
      type: object
      properties:
        interval:
          type: number
          description: Sample interval in seconds for classifier trend data
        name:
          minLength: 1
          type: string
          description: Classifier name for the SLE metric trend
        samples:
          allOf:
          - $ref: '#/components/schemas/sle_classifier_samples2'
          - description: Time-series sample arrays for the classifier trend
        x_label:
          minLength: 1
          type: string
          description: Label for the classifier trend x-axis
        y_label:
          minLength: 1
          type: string
          description: Label for the classifier trend y-axis
      description: Time-series classifier trend detail for an SLE metric
    sle_threshold:
      title: sle_threshold
      type: object
      properties:
        default:
          type: number
          description: Built-in threshold value for this SLE metric
          readOnly: true
        direction:
          minLength: 1
          type: string
          description: Comparison direction used for SLE threshold evaluation
          readOnly: true
        maximum:
          type: number
          description: Highest allowed threshold value for this SLE metric
        metric:
          minLength: 1
          type: string
          description: SLE metric name associated with this threshold
          readOnly: true
        minimum:
          type: number
          description: Lowest allowed threshold value for this SLE metric
        threshold:
          minLength: 1
          type: string
          description: Configured threshold value for this SLE metric
          readOnly: true
        units:
          minLength: 1
          type: string
          description: Measurement units for this SLE threshold
          readOnly: true
      description: Threshold metadata and configured value for an SLE metric
    sle_thresholds:
      title: sle_thresholds
      type: object
      properties:
        capacity:
          maximum: 50
          minimum: 5
          type: integer
          description: Threshold percentage for capacity SLE scoring
          contentEncoding: int32
          default: 20
        coverage:
          maximum: -60
          minimum: -90
          type: integer
          description: RSSI threshold for coverage SLE scoring, in dBm
          contentEncoding: int32
          default: -72
        throughput:
          maximum: 100
          minimum: 1
          type: integer
          description: Minimum throughput threshold for SLE scoring, in Mbps
          contentEncoding: int32
          default: 10
        time-to-connect:
          maximum: 10
          minimum: 2
          type: integer
          description: Time to connect, in seconds
          contentEncoding: int32
          default: 4
      description: Site SLE threshold overrides for capacity, coverage, throughput, and time to connect
    snmp_config:
      title: snmp_config
      type: object
      properties:
        client_list:
          type: array
          items:
            $ref: '#/components/schemas/snmp_config_client_list'
          description: SNMP client allowlists that can be referenced by communities
        contact:
          type: string
          description: Administrative contact string advertised through SNMP
          examples:
          - cns@juniper.net
        description:
          type: string
          description: Device description string advertised through SNMP
          examples:
          - Juniper QFX Series Switch - 1K_5LA
        enabled:
          type: boolean
          description: Whether SNMP is enabled
          default: true
        engine_id:
          maxLength: 27
          type: string
          description: SNMP engine ID used for SNMPv3
        engine_id_type:
          allOf:
          - $ref: '#/components/schemas/snmp_config_engine_id_type2'
          - description: 'Method used to derive the SNMP engine ID. enum: `local`, `use_mac_address`.'
        location:
          type: string
          description: Physical location string advertised through SNMP
          examples:
          - Las Vegas, NV
        name:
          type: string
          description: System name advertised through SNMP
          examples:
          - TGH-1K-QFX10K
        network:
          type: string
          description: Management network used for SNMP traffic
          default: default
        trap_groups:
          type: array
          items:
            $ref: '#/components/schemas/snmp_config_trap_group'
          description: SNMP trap group definitions
        v2c_config:
          type: array
          items:
            $ref: '#/components/schemas/snmp_config_v2c_config'
          description: SNMPv2c community configuration entries for this SNMP profile
        v3_config:
          allOf:
          - $ref: '#/components/schemas/snmpv3_config2'
          - description: SNMPv3 user, VACM, notify, and target configuration
        views:
          type: array
          items:
            $ref: '#/components/schemas/snmp_config_view'
          description: SNMP MIB view definitions
      description: SNMP configuration for managed network devices
    snmp_config_client_list:
      title: snmp_config_client_list
      type: object
      properties:
        client_list_name:
          type: string
          description: Name of the SNMP client list
          examples:
          - clist-1
        clients:
          type: array
          items:
            type: string
          description: SNMP client IP addresses or CIDR ranges allowed by this list
      description: SNMP client allowlist definition
    snmp_config_engine_id_type:
      title: snmp_config_engine_id_type
      enum:
      - local
      - use_mac_address
      type: string
      description: 'Method used to derive the SNMP engine ID. enum: `local`, `use_mac_address`'
    snmp_config_trap_group:
      title: snmp_config_trap_group
      type: object
      properties:
        categories:
          type: array
          items:
            type: string
          description: Trap categories included in this SNMP trap group
        group_name:
          type: string
          description: Trap group name for this SNMP trap group
          examples:
          - profiler
        targets:
          type: array
          items:
            type: string
          description: Trap target addresses for this SNMP trap group
        version:
          allOf:
          - $ref: '#/components/schemas/snmp_config_trap_version2'
          - description: 'SNMP trap protocol version used by this group. enum: `all`, `v1`, `v2`.'
      description: SNMP trap group definition
    snmp_config_trap_version:
      title: snmp_config_trap_version
      enum:
      - all
      - v1
      - v2
      type: string
      description: 'enum: `all`, `v1`, `v2`'
    snmp_config_v2c_config:
      title: snmp_config_v2c_config
      type: object
      properties:
        authorization:
          type: string
          description: Access level for the SNMPv2c community
          examples:
          - read-only
        client_list_name:
          type: string
          description: SNMP client list name referenced by this community
          examples:
          - clist-1
        community_name:
          type: string
          description: SNMPv2c community string name
          examples:
          - abc123
        view:
          type: string
          description: SNMP view name that must be defined in the views list
          examples:
          - all
      description: SNMPv2c community configuration entry
    snmp_config_view:
      title: snmp_config_view
      type: object
      properties:
        include:
          type: boolean
          description: Whether the root OID is included in this SNMP view
        oid:
          type: string
          description: Root OID for this SNMP view
          examples:
          - 1.3.6.1
        view_name:
          type: string
          description: Name of the SNMP MIB view definition
          examples:
          - all
      description: SNMP MIB view definition
    snmp_usm:
      title: snmp_usm
      type: object
      properties:
        engine_type:
          allOf:
          - $ref: '#/components/schemas/snmp_usm_engine_type2'
          - description: 'SNMP engine type used for this USM configuration. enum: `local_engine`, `remote_engine`.'
        remote_engine_id:
          type: string
          description: Required only if `engine_type`==`remote_engine`
          examples:
          - 00:00:00:0b:00:00:70:10:6f:08:b6:3f
        users:
          type: array
          items:
            $ref: '#/components/schemas/snmp_usm_user'
          description: SNMPv3 USM users for this engine
      description: SNMPv3 User-based Security Model configuration
    snmp_usm_engine_type:
      title: snmp_usm_engine_type
      enum:
      - local_engine
      - remote_engine
      type: string
      description: 'SNMP engine type used for this USM configuration. enum: `local_engine`, `remote_engine`'
    snmp_usm_user:
      title: snmp_usm_user
      type: object
      properties:
        authentication_password:
          minLength: 7
          type: string
          description: Not required if `authentication_type`==`authentication-none`. Include alphabetic, numeric, and special characters, but it cannot include control characters.
        authentication_type:
          allOf:
          - $ref: '#/components/schemas/snmp_usm_user_authentication_type2'
          - description: 'Authentication protocol used by this SNMPv3 USM user. enum: `authentication-md5`, `authentication-none`, `authentication-sha`, `authentication-sha224`, `authentication-sha256`, `authentication-sha384`, `authentication-sha512`.'
        encryption_password:
          minLength: 8
          type: string
          description: Not required if `encryption_type`==`privacy-none`. Include alphabetic, numeric, and special characters, but it cannot include control characters
        encryption_type:
          allOf:
          - $ref: '#/components/schemas/snmp_usm_user_encryption_type2'
          - description: 'Privacy protocol used by this SNMPv3 USM user. enum: `privacy-3des`, `privacy-aes128`, `privacy-des`, `privacy-none`.'
        name:
          type: string
          description: Username for the SNMPv3 USM user
      description: SNMPv3 USM user definition
    snmp_usm_user_authentication_type:
      title: snmp_usm_user_authentication_type
      enum:
      - authentication-md5
      - authentication-none
      - authentication-sha
      - authentication-sha224
      - authentication-sha256
      - authentication-sha384
      - authentication-sha512
      type: string
      description: 'sha224, sha256, sha384, sha512 are supported in 21.1 and newer release. enum: `authentication-md5`, `authentication-none`, `authentication-sha`, `authentication-sha224`, `authentication-sha256`, `authentication-sha384`, `authentication-sha512`'
    snmp_usm_user_encryption_type:
      title: snmp_usm_user_encryption_type
      enum:
      - privacy-3des
      - privacy-aes128
      - privacy-des
      - privacy-none
      type: string
      description: 'enum: `privacy-3des`, `privacy-aes128`, `privacy-des`, `privacy-none`'
    snmp_vacm:
      title: snmp_vacm
      type: object
      properties:
        access:
          type: array
          items:
            $ref: '#/components/schemas/snmp_vacm_access_item'
          description: VACM access rules for SNMPv3
        security_to_group:
          allOf:
          - $ref: '#/components/schemas/snmp_vacm_security_to_group2'
          - description: VACM security-name to group mappings
      description: SNMPv3 View-based Access Control Model configuration
    snmp_vacm_access_item:
      title: snmp_vacm_access_item
      type: object
      properties:
        group_name:
          type: string
          description: SNMP VACM group name
        prefix_list:
          type: array
          items:
            $ref: '#/components/schemas/snmp_vacm_access_item_prefix_list_item'
          description: Context prefix rules for this VACM group
      description: VACM access rule for an SNMP group
    snmp_vacm_access_item_prefix_list_item:
      title: snmp_vacm_access_item_prefix_list_item
      type: object
      properties:
        context_prefix:
          type: string
          description: Context prefix for this VACM access rule. Required only if `type`==`context_prefix`
          examples:
          - iil
        notify_view:
          type: string
          description: Notify view name referenced by this VACM access rule
          examples:
          - all
        read_view:
          type: string
          description: Read view name referenced by this VACM access rule
          examples:
          - all
        security_level:
          allOf:
          - $ref: '#/components/schemas/snmp_vacm_access_item_prefix_list_item_level2'
          - description: 'Required security level for this VACM access rule. enum: `authentication`, `none`, `privacy`.'
        security_model:
          allOf:
          - $ref: '#/components/schemas/snmp_vacm_access_item_prefix_list_item_model2'
          - description: 'Required security model for this VACM access rule. enum: `any`, `usm`, `v1`, `v2c`.'
        type:
          allOf:
          - $ref: '#/components/schemas/snmp_vacm_access_item_type2'
          - description: 'VACM context matching type for this access rule. enum: `context_prefix`, `default_context_prefix`.'
        write_view:
          type: string
          description: Write view name referenced by this VACM access rule
          examples:
          - all
      description: Context prefix rule for a VACM access entry
    snmp_vacm_access_item_prefix_list_item_level:
      title: snmp_vacm_access_item_prefix_list_item_level
      enum:
      - authentication
      - none
      - privacy
      type: string
      description: 'enum: `authentication`, `none`, `privacy`'
    snmp_vacm_access_item_prefix_list_item_model:
      title: snmp_vacm_access_item_prefix_list_item_model
      enum:
      - any
      - usm
      - v1
      - v2c
      type: string
      description: 'enum: `any`, `usm`, `v1`, `v2c`'
    snmp_vacm_access_item_type:
      title: snmp_vacm_access_item_type
      enum:
      - context_prefix
      - default_context_prefix
      type: string
      description: 'VACM context matching type for this access rule. enum: `context_prefix`, `default_context_prefix`'
    snmp_vacm_security_model:
      title: snmp_vacm_security_model
      enum:
      - usm
      - v1
      - v2c
      type: string
      description: 'enum: `usm`, `v1`, `v2c`'
    snmp_vacm_security_to_group:
      title: snmp_vacm_security_to_group
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/snmp_vacm_security_to_group_content_item'
          description: VACM security-name to group mapping entries
        security_model:
          allOf:
          - $ref: '#/components/schemas/snmp_vacm_security_model2'
          - description: 'Required security model for these VACM group mappings. enum: `usm`, `v1`, `v2c`.'
      description: VACM security-name to group mapping configuration
    snmp_vacm_security_to_group_content_item:
      title: snmp_vacm_security_to_group_content_item
      type: object
      properties:
        group:
          type: string
          description: VACM group name referenced by this mapping
        security_name:
          type: string
          description: Name of the SNMP security principal mapped to a VACM group
      description: VACM security-name to group mapping entry
    snmpv3_config:
      title: snmpv3_config
      type: object
      properties:
        notify:
          type: array
          items:
            $ref: '#/components/schemas/snmpv3_config_notify_items'
          description: SNMPv3 notification definitions used for traps and informs
        notify_filter:
          type: array
          items:
            $ref: '#/components/schemas/snmpv3_config_notify_filter_item'
          description: SNMPv3 notification filter profiles
        target_address:
          type: array
          items:
            $ref: '#/components/schemas/snmpv3_config_target_address_item'
          description: SNMPv3 notification target addresses
        target_parameters:
          type: array
          items:
            $ref: '#/components/schemas/snmpv3_config_target_param'
          description: SNMPv3 target parameter profiles
        usm:
          type: array
          items:
            $ref: '#/components/schemas/snmp_usm'
          description: SNMPv3 USM engine configurations
        vacm:
          allOf:
          - $ref: '#/components/schemas/snmp_vacm2'
          - description: SNMPv3 VACM access control configuration
      description: SNMPv3 notification, target, USM, and VACM configuration
    snmpv3_config_notify_items:
      title: snmpv3_config_notify_items
      type: object
      properties:
        name:
          type: string
          description: Identifier for this SNMPv3 notification definition
        tag:
          type: string
          description: Notification tag used to select target addresses
        type:
          allOf:
          - $ref: '#/components/schemas/snmpv3_config_notify_type2'
          - description: Delivery mode for this SNMPv3 notification, such as trap or inform
      description: SNMPv3 notification definition for traps or informs
    snmpv3_config_notify_filter_item:
      title: snmpv3_config_notify_filter_item
      type: object
      properties:
        categories:
          type: array
          items:
            type: string
          description: CX only. List of SNMP trap group categories included in this filter profile. See https://www.juniper.net/documentation/software/topics/task/configuration/snmp-trap-groups-configuring-junos-nm.html for valid category names.
          examples:
          - - link
            - authentication
        contents:
          type: array
          items:
            $ref: '#/components/schemas/snmpv3_config_notify_filter_item_content'
          description: OID filter rules in this notification filter profile
        profile_name:
          type: string
          description: Notification filter profile name
      description: SNMPv3 notification filter profile
    snmpv3_config_notify_filter_item_content:
      title: snmpv3_config_notify_filter_item_content
      type: object
      properties:
        include:
          type: boolean
          description: Whether the matching OID subtree is included
        oid:
          type: string
          description: Matched OID subtree for this notification filter rule
          examples:
          - 1.3.6.1.4.1
      description: OID filter rule for an SNMPv3 notification profile
    snmpv3_config_notify_type:
      title: snmpv3_config_notify_type
      enum:
      - inform
      - trap
      type: string
      description: 'Delivery mode for this SNMPv3 notification, such as trap or inform. enum: `inform`, `trap`'
    snmpv3_config_target_address_item:
      title: snmpv3_config_target_address_item
      type: object
      properties:
        address:
          type: string
          description: IP address or hostname of the SNMP target
          examples:
          - 10.11.0.2
        address_mask:
          type: string
          description: Mask applied to the SNMP target address
          examples:
          - 255.255.255.0
        port:
          type:
          - string
          - 'null'
          description: UDP port used by the SNMP target
          default: '161'
        tag_list:
          type: string
          description: Set of notification tags for this target address; use spaces between multiple tags
        target_address_name:
          type: string
          description: Name of the SNMP target address entry
          examples:
          - target_address_name
        target_parameters:
          type: string
          description: Target parameter profile referenced by this target address
      description: SNMPv3 notification target address entry
    snmpv3_config_target_param:
      title: snmpv3_config_target_param
      type: object
      properties:
        message_processing_model:
          allOf:
          - $ref: '#/components/schemas/snmpv3_config_target_param_mess_process_model2'
          - description: 'SNMP message processing model used by this target parameter profile. enum: `v1`, `v2c`, `v3`.'
        name:
          type: string
          description: Target parameter profile name
        notify_filter:
          type: string
          description: Notification filter profile referenced by this target parameter profile
        security_level:
          allOf:
          - $ref: '#/components/schemas/snmpv3_config_target_param_security_level2'
          - description: 'Required security level for this target parameter profile. enum: `authentication`, `none`, `privacy`.'
        security_model:
          allOf:
          - $ref: '#/components/schemas/snmpv3_config_target_param_security_model2'
          - description: 'Required security model for this target parameter profile. enum: `usm`, `v1`, `v2c`.'
        security_name:
          type: string
          description: USM security name referenced by this target parameter profile
          examples:
          - m01620
      description: SNMPv3 target parameter profile
    snmpv3_config_target_param_mess_process_model:
      title: snmpv3_config_target_param_mess_process_model
      enum:
      - v1
      - v2c
      - v3
      type: string
      description: 'enum: `v1`, `v2c`, `v3`'
    snmpv3_config_target_param_security_level:
      title: snmpv3_config_target_param_security_level
      enum:
      - authentication
      - none
      - privacy
      type: string
      description: 'enum: `authentication`, `none`, `privacy`'
    snmpv3_config_target_param_security_model:
      title: snmpv3_config_target_param_security_model
      enum:
      - usm
      - v1
      - v2c
      type: string
      description: 'enum: `usm`, `v1`, `v2c`'
    spectrum_analysis:
      title: spectrum_analysis
      required:
      - band
      type: object
      properties:
        band:
          allOf:
          - $ref: '#/components/schemas/spectrum_analysis_band2'
          - description: 'Radio band to scan during spectrum analysis. enum: `24`, `5`, `6`.'
        channels:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: Optional list of channels to scan. If not specified, all supported channels will be scanned
          examples:
          - - 36
            - 40
            - 44
            - 48
        device_id:
          type: string
          description: Device ID of the AP that is performing spectrum analysis
          contentEncoding: uuid
        duration:
          maximum: 600
          minimum: 60
          type: integer
          description: Length of the spectrum analysis run, in seconds
          contentEncoding: int32
          default: 300
        format:
          allOf:
          - $ref: '#/components/schemas/spectrum_analysis_format2'
          - description: 'Output format for the spectrum analysis results. enum: `json`, `stream`.'
      description: Request parameters for starting AP spectrum analysis at a site
    spectrum_analysis_band:
      title: spectrum_analysis_band
      enum:
      - '24'
      - '5'
      - '6'
      type: string
      description: 'Band for spectrum analysis. enum: `24`, `5`, `6`'
    spectrum_analysis_format:
      title: spectrum_analysis_format
      enum:
      - json
      - stream
      type: string
      description: 'Format of the spectrum analysis data. enum: `json`, `stream`'
    ssl_proxy_ciphers_category:
      title: ssl_proxy_ciphers_category
      enum:
      - medium
      - strong
      - weak
      type: string
      description: 'enum: `medium`, `strong`, `weak`'
    sso:
      title: sso
      required:
      - name
      type: object
      properties:
        created_time:
          type: number
          description: Time when this SSO configuration was created, in epoch seconds
          readOnly: true
        custom_logout_url:
          type: string
          description: If `idp_type`==`saml`, a URL we will redirect the user after user logout from Mist (for some IdP which supports a custom logout URL that is different from SP-initiated SLO process)
        default_role:
          type: string
          description: If `idp_type`==`saml`, default role to assign if there’s no match. By default, an assertion is treated as invalid when there’s no role matched
        domain:
          type: string
          description: >-
            Random string generated during the SSO creation and used to generate the SAML URLs:
              * ACS URL = `/api/v1/saml/{domain}/login` (e.g. `https://api.mist.com/api/v1/saml/s4t5vwv8/login`)
              * Single Logout URL = `/api/v1/saml/{domain}/logout` (e.g. `https://api.mist.com/api/v1/saml/s4t5vwv8/logout`)
          readOnly: true
        group_filter:
          type: string
          description: Required if `ldap_type`==`custom`, LDAP filter that will identify the type of group
        id:
          type: string
          description: Unique identifier for this SSO configuration
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        idp_cert:
          type: string
          description: If `idp_type`==`saml`. IDP Cert (used to verify the signed response)
        idp_sign_algo:
          allOf:
          - $ref: '#/components/schemas/sso_idp_sign_algo2'
          - description: 'SAML assertion signing algorithm. Required if `idp_type`==`saml`. enum: `sha1`, `sha256`, `sha384`, `sha512`.'
        idp_sso_url:
          type: string
          description: Required if `idp_type`==`saml`, IDP Single-Sign-On URL
        idp_type:
          allOf:
          - $ref: '#/components/schemas/sso_idp_type2'
          - description: 'Identity provider type for this SSO configuration. enum: `ldap`, `mxedge_proxy`, `oauth`, `saml`, `openroaming`.'
        ignore_unmatched_roles:
          type: boolean
          description: If `idp_type`==`saml`, ignore any unmatched roles provided in assertion. By default, an assertion is treated as invalid for any unmatched role
        issuer:
          type: string
          description: If `idp_type`==`saml`. IDP issuer URL
        ldap_base_dn:
          type: string
          description: Required if `idp_type`==`ldap`, whole domain or a specific organization unit (container) in Search base to specify where users and groups are found in the LDAP tree
          examples:
          - DC=abc,DC=com
        ldap_bind_dn:
          type: string
          description: Required if `idp_type`==`ldap`, the account used to authenticate against the LDAP
          examples:
          - CN=nas,CN=users,DC=abc,DC=com
        ldap_bind_password:
          type: string
          description: Required if `idp_type`==`ldap`, the password used to authenticate against the LDAP
          examples:
          - secret
        ldap_cacerts:
          type: array
          items:
            type: string
          description: CA certificates used to validate LDAP or LDAPS server certificates. Required if `idp_type`==`ldap`
          examples:
          - - '-----BEGIN CERTIFICATE-----\nMIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE\n-----END CERTIFICATE-----'
            - '-----BEGIN CERTIFICATE-----\nBhMCRVMxFDASBgNVBAoMC1N0YXJ0Q29tIENBMSwwKgYDVn-----END CERTIFICATE-----'
        ldap_client_cert:
          type: string
          description: If `idp_type`==`ldap`, LDAPS Client certificate
          examples:
          - '-----BEGIN CERTIFICATE-----\nMIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE\n-----END CERTIFICATE-----'
        ldap_client_key:
          type: string
          description: If `idp_type`==`ldap`, Key for the `ldap_client_cert`
          examples:
          - '-----BEGIN PRI...'
        ldap_group_attr:
          type: string
          description: Group attribute used to resolve LDAP memberships. If `ldap_type`==`custom`
          default: memberOf
        ldap_group_dn:
          type: string
          description: Group search base used for custom LDAP group lookup. If `ldap_type`==`custom`
          default: base_dn
        ldap_resolve_groups:
          type: boolean
          description: If `idp_type`==`ldap`, whether to recursively resolve LDAP groups
          default: false
        ldap_server_hosts:
          type: array
          items:
            type: string
          description: Server hostnames or IP addresses for LDAP or LDAPS when `idp_type`==`ldap`
          examples:
          - - hostname
            - 63.1.3.5
        ldap_type:
          allOf:
          - $ref: '#/components/schemas/sso_ldap_type2'
          - description: 'Provider template for LDAP SSO when `idp_type`==`ldap`. enum: `azure`, `custom`, `google`, `okta`.'
        ldap_user_filter:
          type: string
          description: Required if `ldap_type`==`custom`, LDAP filter that will identify the type of user
          examples:
          - (mail=%s)
        member_filter:
          type: string
          description: Required if `ldap_type`==`custom`,LDAP filter that will identify the type of member
          examples:
          - (CN=%s)
        modified_time:
          type: number
          description: Time when this SSO configuration was last modified, in epoch seconds
          readOnly: true
        msp_id:
          type: string
          description: Owning MSP identifier for this SSO configuration, when MSP-scoped
          contentEncoding: uuid
          readOnly: true
          examples:
          - b9d42c2e-88ee-41f8-b798-f009ce7fe909
        mxedge_proxy:
          allOf:
          - $ref: '#/components/schemas/sso_mxedge_proxy2'
          - description: Mist Edge proxy settings used when `idp_type`==`mxedge_proxy`
        name:
          type: string
          description: Display name of the SSO configuration
        nameid_format:
          allOf:
          - $ref: '#/components/schemas/sso_nameid_format2'
          - description: 'SAML NameID format used when `idp_type`==`saml`. enum: `email`, `unspecified`.'
        oauth_cc_client_id:
          type: string
          description: Required if `idp_type`==`oauth`, Client Credentials
          examples:
          - e60da615-7def-4c5a-8196-43675f45e174
        oauth_cc_client_secret:
          type: string
          description: Required if `idp_type`==`oauth`, oauth_cc_client_secret is RSA private key, of the form "-----BEGIN RSA PRIVATE KEY--...."
          contentEncoding: password
          examples:
          - REDACTED_AZURE_AD_CLIENT_SECRET
        oauth_discovery_url:
          type: string
          description: OAuth discovery document URL used when `idp_type`==`oauth`
        oauth_ping_identity_region:
          allOf:
          - $ref: '#/components/schemas/oauth_ping_identity_region1'
          - description: 'Ping Identity region for OAuth SSO when `oauth_type`==`ping_identity`. enum: `asia`, `au`, `ca`, `eu`, `us`.'
        oauth_provider_domain:
          allOf:
          - $ref: '#/components/schemas/oauth_provider_domain1'
          - description: 'Provider domain for Okta OAuth SSO when `oauth_type`==`okta`. enum: `okta.com`, `oktapreview.com`, `okta-emea.com`, `okta-gov.com`, `okta.mil`, `mtls.okta.com`.'
            examples:
            - okta.com
        oauth_ropc_client_id:
          type: string
          description: If `idp_type`==`oauth`, ropc = Resource Owner Password Credentials
          examples:
          - 9ce04c97-b5b1-4ec8-af17-f5ed42d2daf7
        oauth_ropc_client_secret:
          type: string
          description: If `oauth_type`==`azure` or `oauth_type`==`azure-gov`. oauth_ropc_client_secret can be empty
          contentEncoding: password
          examples:
          - blM9R~6kWFMVFYl4TFZ3fi~8cMdyDONi6cj01dqI
        oauth_tenant_id:
          type: string
          description: Required if `idp_type`==`oauth`, oauth_tenant_id
          examples:
          - dev-88336535
        oauth_type:
          allOf:
          - $ref: '#/components/schemas/sso_oauth_type2'
          - description: 'Provider type for OAuth SSO when `idp_type`==`oauth`. enum: `azure`, `azure-gov`, `okta`, `ping_identity`.'
        openroaming_ssids:
          type: array
          items:
            type: string
          description: SSIDs that support OpenRoaming, used when `idp_type`==`openroaming`
          examples:
          - - ssid_name1
            - ssid_name2
        openroaming_wba_client_cert:
          type: string
          description: Optional WBA-issued client certificate for OpenRoaming. If not provided, the default WBA-issued certificate for Juniper will be used.
          contentEncoding: password
          examples:
          - '-----BEGIN CERTIFICATE-----\nMIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE\n-----END CERTIFICATE-----'
        openroaming_wba_client_key:
          type: string
          description: Optional WBA-issued client private key for OpenRoaming. If not provided, the default WBA-issued key for Juniper will be used.
          contentEncoding: password
          examples:
          - 'REDACTED_PRIVATE_KEY_EXAMPLE'
        org_id:
          type: string
          description: Owning organization identifier for this SSO configuration
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        role_attr_extraction:
          type: string
          description: If `idp_type`==`saml`, custom role attribute parsing scheme. Supported Role Parsing Schemes <table><tr><th>Name</th><th>Scheme</th></tr><tr><td>`cn`</td><td><ul><li>The expected role attribute format in SAML Assertion is "CN=cn,OU=ou1,OU=ou2,…"</li><li>CN (the key) is case-insensitive and exactly 1 CN is expected (or the entire entry will be ignored)</li></ul>E.g. if role attribute is "CN=cn,OU=ou1,OU=ou2" then parsed role value is "cn"</td></tr></table>
        role_attr_from:
          type: string
          description: If `idp_type`==`saml`, name of the attribute in SAML Assertion to extract role from
          default: Role
        scim_enabled:
          type: boolean
          description: If `idp_type`==`oauth`, indicates if SCIM provisioning is enabled for the OAuth IDP
          default: false
        scim_secret_token:
          type: string
          description: If `idp_type`==`oauth`, scim_secret_token (auto-generated when not provided by caller and `scim_enabled`==`true`, empty string when `scim_enabled`==`false`) is used as the Bearer token in the Authorization header of SCIM provisioning requests by the IDP
          contentEncoding: password
          examples:
          - FBitbKPE1aecSloPGBuqqPxDUrFeZyZk
        site_id:
          type: string
          description: Associated site identifier for this SSO configuration, when site-scoped
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
      description: Single sign-on identity provider configuration
    sso_delete_admins:
      title: sso_delete_admins
      required:
      - emails
      type: object
      properties:
        emails:
          type: array
          items:
            type: string
          description: List of admin email addresses to delete
      description: Request body listing SSO admin email addresses to delete
    sso_delete_admins_response:
      title: sso_delete_admins_response
      type: object
      properties:
        deleted:
          type: array
          items:
            type: string
          description: List of email addresses that were successfully deleted
        errors:
          type: array
          items:
            type: string
          description: List of error messages for emails that could not be deleted
      description: Result of deleting SSO admin accounts
    sso_idp_sign_algo:
      title: sso_idp_sign_algo
      enum:
      - sha1
      - sha256
      - sha384
      - sha512
      type: string
      description: 'Required if `idp_type`==`saml`, Signing algorithm for SAML Assertion. enum: `sha1`, `sha256`, `sha384`, `sha512`'
    sso_idp_type:
      title: sso_idp_type
      enum:
      - ldap
      - mxedge_proxy
      - oauth
      - saml
      - openroaming
      type: string
      description: >-
        SSO IDP Type:
          * For Admin SSO, enum: `saml`
          * For NAC SSO, enum: `ldap`, `mxedge_proxy`, `oauth`, `openroaming`
    sso_ldap_type:
      title: sso_ldap_type
      enum:
      - azure
      - custom
      - google
      - okta
      type: string
      description: 'if `idp_type`==`ldap`. enum: `azure`, `custom`, `google`, `okta`, `ping_identity`'
    sso_mxedge_proxy:
      title: sso_mxedge_proxy
      type: object
      properties:
        acct_servers:
          type: array
          items:
            $ref: '#/components/schemas/sso_mxedge_proxy_acct_server'
          description: RADIUS accounting servers used by the Mist Edge SSO proxy
        auth_servers:
          type: array
          items:
            $ref: '#/components/schemas/sso_mxedge_proxy_auth_server'
          description: RADIUS authentication servers used by the Mist Edge SSO proxy
        mxcluster_id:
          type: string
          description: Mist Edge cluster identifier that provides the SSO proxy
          contentEncoding: uuid
          examples:
          - 572586b7-f97b-a22b-526c-8b97a3f609c4
        operator_name:
          type: string
          description: Operator name as RADIUS attribute while proxying
        proxy_hosts:
          type: array
          items:
            type: string
          description: Public hostnames or IP addresses that clients use to reach the Mist Edge SSO proxy
          examples:
          - - mxedge1.corp.com
            - 63.1.3.5
        ssids:
          type: array
          items:
            type: string
          description: Eduroam SSIDs handled by the Mist Edge SSO proxy
          examples:
          - - eduroam_test, eduroam_main
      description: Mist Edge proxy settings for NAC SSO. If `idp_type`==`mxedge_proxy`, this requires `mist_nac` to be enabled on the mxcluster
    sso_mxedge_proxy_acct_server:
      title: sso_mxedge_proxy_acct_server
      type: object
      properties:
        host:
          type: string
          description: RADIUS accounting server hostname or IP address
          examples:
          - 1.2.3.4
        port:
          type: integer
          description: UDP port for RADIUS accounting requests
          contentEncoding: int32
          default: 1813
        secret:
          type: string
          description: Shared secret used with the RADIUS accounting server
          contentEncoding: password
          examples:
          - testing123
      description: RADIUS accounting server for the Mist Edge SSO proxy
    sso_mxedge_proxy_auth_server:
      title: sso_mxedge_proxy_auth_server
      type: object
      properties:
        host:
          type: string
          description: RADIUS authentication server hostname or IP address
          examples:
          - 1.2.3.4
        port:
          type: integer
          description: UDP port for RADIUS authentication requests
          contentEncoding: int32
          default: 1812
        require_message_authenticator:
          type: boolean
          description: Whether to require Message-Authenticator in requests
          default: false
        retry:
          type: integer
          description: Number of retry attempts for RADIUS authentication requests
          contentEncoding: int32
          default: 2
        secret:
          type: string
          description: Shared secret used with the RADIUS authentication server
          contentEncoding: password
          examples:
          - testing123
        timeout:
          type: integer
          description: Authentication request timeout, in seconds
          contentEncoding: int32
          default: 5
      description: RADIUS authentication server for the Mist Edge SSO proxy
    sso_nameid_format:
      title: sso_nameid_format
      enum:
      - email
      - unspecified
      type: string
      description: 'if `idp_type`==`saml`. enum: `email`, `unspecified`'
    sso_oauth_type:
      title: sso_oauth_type
      enum:
      - azure
      - azure-gov
      - okta
      - ping_identity
      type: string
      description: 'if `idp_type`==`oauth`. enum: `azure`, `azure-gov`, `okta`, `ping_identity`'
    sso_openroaming:
      title: sso_openroaming
      type: object
      properties:
        ssids:
          type: array
          items:
            type: string
          description: Network SSID names enabled for OpenRoaming SSO
          examples:
          - - ssid_name1
            - ssid_name2
        wba_cert:
          type: string
          description: Deprecated. Use `openroaming_wba_client_cert` instead.
          deprecated: true
      description: 'Deprecated. OpenRoaming configuration is now expressed as top-level fields on the SSO object: `openroaming_ssids`, `openroaming_wba_client_cert`, and `openroaming_wba_client_key`.'
      deprecated: true
    sso_role_msp:
      title: sso_role_msp
      required:
      - name
      - privileges
      type: object
      properties:
        created_time:
          type: number
          description: Time when this MSP SSO role was created, in epoch seconds
          readOnly: true
        for_site:
          type: boolean
          description: Whether this MSP SSO role is scoped for site-level access
          readOnly: true
        id:
          type: string
          description: Unique identifier for this MSP SSO role
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        modified_time:
          type: number
          description: Time when this MSP SSO role was last modified, in epoch seconds
          readOnly: true
        msp_id:
          type: string
          description: Owning MSP identifier for this SSO role
          contentEncoding: uuid
          readOnly: true
          examples:
          - b9d42c2e-88ee-41f8-b798-f009ce7fe909
        name:
          type: string
          description: Display name of the MSP SSO role
        org_id:
          type: string
          description: Organization identifier associated with this MSP SSO role, when applicable
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        privileges:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/privilege_msp'
          description: Access privileges granted by this MSP SSO role
      description: MSP SSO role definition
    sso_role_org:
      title: sso_role_org
      required:
      - name
      - privileges
      type: object
      properties:
        created_time:
          type: number
          description: Time when this organization SSO role was created, in epoch seconds
          readOnly: true
        for_site:
          type: boolean
          description: Whether this organization SSO role is scoped for site-level access
          readOnly: true
        id:
          type: string
          description: Unique identifier for this organization SSO role
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        modified_time:
          type: number
          description: Time when this organization SSO role was last modified, in epoch seconds
          readOnly: true
        msp_id:
          type: string
          description: Managing MSP identifier for this organization SSO role, when applicable
          contentEncoding: uuid
          readOnly: true
          examples:
          - b9d42c2e-88ee-41f8-b798-f009ce7fe909
        name:
          type: string
          description: Display name of the organization SSO role
        org_id:
          type: string
          description: Owning organization identifier for this SSO role
          contentEncoding: uuid
          examples:
          - 60f6bfdb-2f45-4022-8e2a-e00d977953fe
        privileges:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/privilege_org'
          description: Access privileges granted by this organization SSO role
      description: Organization SSO role definition
    ssr_proxy:
      title: ssr_proxy
      type: object
      properties:
        disabled:
          type: boolean
          description: Whether the SSR proxy configuration is disabled
          default: false
          examples:
          - true
        url:
          type: string
          description: Proxy URL that SSR devices use to reach Mist
          examples:
          - https://proxy.corp.com:8080/
      description: SSR proxy configuration to talk to Mist
    ssr_upgrade:
      title: ssr_upgrade
      required:
      - version
      type: object
      properties:
        channel:
          allOf:
          - $ref: '#/components/schemas/ssr_upgrade_channel1'
          - description: 'Firmware release channel to use for the SSR upgrade. enum: `alpha`, `beta`, `stable`.'
        force:
          type: boolean
          description: When true, forces the upgrade even when the requested version matches the currently running version; default is false
          default: false
        reboot_at:
          type: integer
          description: Reboot start time in epoch seconds, default is start_time, -1 disables reboot
          contentEncoding: int32
        start_time:
          type: integer
          description: 128T firmware download start time in epoch seconds, default is now, -1 disables download
          contentEncoding: int32
        version:
          minLength: 1
          type: string
          description: 128T firmware version to upgrade (e.g. 5.3.0-93)
      description: Request to upgrade a single SSR device
    ssr_upgrade_channel:
      title: ssr_upgrade_channel
      enum:
      - alpha
      - beta
      - stable
      type: string
      description: 'upgrade channel to follow. enum: `alpha`, `beta`, `stable`'
    ssr_upgrade_multi:
      title: ssr_upgrade_multi
      required:
      - device_ids
      type: object
      properties:
        channel:
          allOf:
          - $ref: '#/components/schemas/ssr_upgrade_channel1'
          - description: 'Firmware release channel to use for the SSR upgrade. enum: `alpha`, `beta`, `stable`.'
        device_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: List of 128T device IDs to upgrade; currently only one 128T device is allowed
        force:
          type: boolean
          description: When true, forces the upgrade even when the requested version matches the currently running version; default is false
          default: false
        reboot_at:
          type: integer
          description: Reboot start time in epoch seconds, default is start_time, -1 disables reboot
          contentEncoding: int32
        start_time:
          type: integer
          description: 128T firmware download start time in epoch seconds, default is now, -1 disables download
          contentEncoding: int32
        strategy:
          allOf:
          - $ref: '#/components/schemas/ssr_upgrade_strategy2'
          - description: 'Upgrade rollout strategy for the targeted SSR devices. enum: `big_bang`, `serial`.'
        version:
          minLength: 1
          type: string
          description: 128T firmware version to upgrade (e.g. 5.3.0-93)
      description: Request to upgrade multiple SSR devices
    ssr_upgrade_strategy:
      title: ssr_upgrade_strategy
      enum:
      - big_bang
      - serial
      type: string
      description: >-
        enum:
          * `big_bang`: upgrade all at once
          * `serial`: one at a time
    ssr_version:
      title: ssr_version
      required:
      - package
      - version
      type: object
      properties:
        default:
          type: boolean
          description: Whether this is the default SSR firmware version for its channel
          readOnly: true
        package:
          type: string
          description: Firmware package name for this SSR version
          readOnly: true
        tags:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Metadata labels associated with this SSR firmware version
        version:
          type: string
          description: Firmware version string available for SSR upgrades
          readOnly: true
      description: SSR firmware version available for upgrade
    ssr_version_channel:
      title: ssr_version_channel
      enum:
      - alpha
      - beta
      - stable
      type: string
      description: 'enum: `stable`, `beta`, `alpha`'
    stat_device_status_filter:
      title: stat_device_status_filter
      enum:
      - all
      - connected
      - disconnected
      type: string
      description: 'enum: `all`, `connected`, `disconnected`'
    stats_ap:
      title: stats_ap
      required:
      - type
      type: object
      properties:
        antenna_select:
          allOf:
          - $ref: '#/components/schemas/antenna_select2'
          - description: 'Selectable antenna mode reported for the AP. enum: ``, `external`, `internal`.'
            examples:
            - external
        auto_placement:
          allOf:
          - $ref: '#/components/schemas/stats_ap_auto_placement2'
          - description: Auto placement result and status for the AP
        auto_upgrade_stat:
          allOf:
          - $ref: '#/components/schemas/stats_ap_auto_upgrade4'
          - description: Automatic firmware upgrade status for the AP
        ble_stat:
          allOf:
          - $ref: '#/components/schemas/stats_ap_ble2'
          - description: BLE radio and beacon statistics reported by the AP
        cert_expiry:
          type:
          - number
          - 'null'
          description: Certificate expiry timestamp for the AP, in epoch seconds
          readOnly: true
          examples:
          - 1534534392
        config_reverted:
          type:
          - boolean
          - 'null'
          description: Whether the AP configuration was reverted by the device
          readOnly: true
        cpu_system:
          type:
          - integer
          - 'null'
          description: CPU system utilization reported by the AP
          contentEncoding: int64
          readOnly: true
        cpu_user:
          type:
          - integer
          - 'null'
          description: CPU user utilization reported by the AP
          contentEncoding: int32
          readOnly: true
        cpu_util:
          type:
          - integer
          - 'null'
          description: Total CPU utilization reported by the AP
          contentEncoding: int32
          readOnly: true
        created_time:
          type: number
          description: Time when the AP record was created, in epoch seconds
          readOnly: true
        deviceprofile_id:
          type:
          - string
          - 'null'
          description: Device profile identifier applied to the AP, when present
          contentEncoding: uuid
          readOnly: true
        env_stat:
          allOf:
          - $ref: '#/components/schemas/stats_ap_env_stat2'
          - description: Environmental sensor readings reported by the AP
        esl_stat:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/stats_ap_esl_stat2'
          - description: Electronic shelf label dongle status reported by the AP
          readOnly: true
        evpntopo_id:
          type:
          - string
          - 'null'
          description: EVPN topology identifier associated with the AP, when present
          contentEncoding: uuid
          readOnly: true
        expiring_certs:
          type: object
          additionalProperties:
            type: integer
            format: int32
          description: Certificates on the AP that are expiring within 30 days
        ext_ip:
          type:
          - string
          - 'null'
          description: Public IP address observed for the AP
          readOnly: true
          examples:
          - 73.92.124.103
        fwupdate:
          allOf:
          - $ref: '#/components/schemas/fwupdate_stat2'
          - description: Firmware update status for the AP
        gps_stat:
          allOf:
          - $ref: '#/components/schemas/stats_ap_gps_stat2'
          - description: GPS location data reported for the AP
        hw_rev:
          type:
          - string
          - 'null'
          description: Hardware revision reported by the AP
          readOnly: true
        id:
          type: string
          description: Unique identifier for the AP
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        inactive_wired_vlans:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: Wired VLAN identifiers currently inactive on the AP
        iot_stat:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/stats_ap_iot_stat_additional_properties'
          description: IoT input statistics reported by the AP
          examples:
          - DI2:
              value: 0
        ip:
          type:
          - string
          - 'null'
          description: Management IP address currently reported by the AP
          readOnly: true
          examples:
          - 10.2.9.159
        ip_config:
          allOf:
          - $ref: '#/components/schemas/ap_ip_config3'
          - description: IP configuration applied to the AP management interface
        ip_stat:
          allOf:
          - $ref: '#/components/schemas/ip_stat1'
          - description: Read-only IP addressing status reported by the AP
        l2tp_stat:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/stats_ap_l2tp_stat'
          description: L2TP tunnel status (key is the wxtunnel_id)
        last_seen:
          type:
          - number
          - 'null'
          description: Time when the AP was last seen by Mist, in epoch seconds
          readOnly: true
          examples:
          - 1470417522
        last_trouble:
          allOf:
          - $ref: '#/components/schemas/last_trouble1'
          - description: Most recent AP trouble indicator and timestamp
        led:
          allOf:
          - $ref: '#/components/schemas/ap_led4'
          - description: Light indicator state for the AP
        lldp_stat:
          allOf:
          - $ref: '#/components/schemas/stats_ap_lldp_stat2'
          - description: Primary LLDP neighbor and power negotiation details for the AP
        lldp_stats:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/stats_ap_lldp_stat'
          description: Per-port LLDP neighbor and power negotiation details for the AP
        locating:
          type:
          - boolean
          - 'null'
          description: Whether AP locating mode is currently active
          readOnly: true
          examples:
          - false
        locked:
          type:
          - boolean
          - 'null'
          description: Whether this AP is considered locked (placement / orientation has been vetted)
          readOnly: true
          examples:
          - true
        mac:
          type:
          - string
          - 'null'
          description: AP MAC address reported by Mist
          readOnly: true
          examples:
          - 5c5b35000010
        map_id:
          type:
          - string
          - 'null'
          description: Map identifier where the AP is placed, when available
          contentEncoding: uuid
          readOnly: true
          examples:
          - 63eda950-c6da-11e4-a628-60f81dd250cc
        mem_total_kb:
          type:
          - integer
          - 'null'
          description: Total memory available on the AP, in kilobytes
          contentEncoding: int64
          readOnly: true
        mem_used_kb:
          type:
          - integer
          - 'null'
          description: Memory currently used on the AP, in kilobytes
          contentEncoding: int64
          readOnly: true
        mesh_downlinks:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ap_stat_mesh_downlink'
          description: Property key is the mesh downlink id (e.g. `00000000-0000-0000-1000-5c5b35000010`)
        mesh_uplink:
          allOf:
          - $ref: '#/components/schemas/ap_stat_mesh_uplink1'
          - description: Mesh uplink status for the AP
        model:
          type:
          - string
          - 'null'
          description: AP model identifier reported by Mist
          readOnly: true
          examples:
          - AP200
        modified_time:
          type: number
          description: Time when the AP record was last modified, in epoch seconds
          readOnly: true
        mount:
          type:
          - string
          - 'null'
          description: Orientation configured for the AP mount
          readOnly: true
          examples:
          - faceup
        name:
          type:
          - string
          - 'null'
          description: Display name of the AP
          readOnly: true
          examples:
          - conference room
        notes:
          type:
          - string
          - 'null'
          description: Free-form notes configured on the AP record
          readOnly: true
        num_clients:
          type:
          - integer
          - 'null'
          description: How many wireless clients are currently connected
          contentEncoding: int32
          readOnly: true
        num_wlans:
          type: integer
          description: How many WLANs are applied to the device
          contentEncoding: int32
        org_id:
          type: string
          description: Organization identifier that owns the AP
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        port_stat:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/stats_ap_port_stat'
          description: Property key is the port name (e.g. `eth0`)
          readOnly: true
        power_budget:
          type:
          - integer
          - 'null'
          description: In mW, surplus if positive or deficit if negative
          contentEncoding: int32
          readOnly: true
          examples:
          - 1000
        power_constrained:
          type:
          - boolean
          - 'null'
          description: Whether the AP is operating with insufficient power
          readOnly: true
          examples:
          - false
        power_opmode:
          type:
          - string
          - 'null'
          description: Operating mode used while AP power is constrained
          readOnly: true
          examples:
          - '[20] 6GHz(2x2) 5GHz(4x4) 2.4GHz(2x2).'
        power_src:
          type:
          - string
          - 'null'
          description: DC Input / PoE 802.3at / PoE 802.3af / LLDP / ? (unknown)
          readOnly: true
          examples:
          - PoE 802.3af
        radio_config:
          allOf:
          - $ref: '#/components/schemas/stats_ap_radio_config2'
          - description: Radio configuration currently applied to the AP
        radio_stat:
          allOf:
          - $ref: '#/components/schemas/stats_ap_radio_stat2'
          - description: Radio statistics reported by AP bands
        rx_bps:
          type:
          - integer
          - 'null'
          description: Receive throughput for AP traffic, in bits per second
          contentEncoding: int64
          readOnly: true
          examples:
          - 60003
        rx_bytes:
          type:
          - integer
          - 'null'
          description: Total bytes received by the AP since connection
          contentEncoding: int64
          readOnly: true
          examples:
          - 8515104416
        rx_pkts:
          type:
          - integer
          - 'null'
          description: Total packets received by the AP since connection
          contentEncoding: int64
          readOnly: true
          examples:
          - 57770567
        serial:
          type:
          - string
          - 'null'
          description: Device serial number for the AP
          readOnly: true
          examples:
          - FXLH2015170017
        site_id:
          type: string
          description: Site identifier where the AP is assigned
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        status:
          type:
          - string
          - 'null'
          description: Connection status reported for the AP
          readOnly: true
        switch_redundancy:
          allOf:
          - $ref: '#/components/schemas/stats_ap_switch_redundancy2'
          - description: Switch redundancy status reported for the AP
        tx_bps:
          type:
          - integer
          - 'null'
          description: Transmit throughput for AP traffic, in bits per second
          contentEncoding: int64
          readOnly: true
          examples:
          - 634301
        tx_bytes:
          type:
          - integer
          - 'null'
          description: Total bytes transmitted by the AP since connection
          contentEncoding: int64
          readOnly: true
          examples:
          - 211217389682
        tx_pkts:
          type:
          - integer
          - 'null'
          description: Total packets transmitted by the AP since connection
          contentEncoding: int64
          readOnly: true
          examples:
          - 812204062
        type:
          const: ap
          type: string
          description: 'Device type for this statistics record. enum: `ap`.'
          readOnly: true
        uptime:
          type:
          - number
          - 'null'
          description: How long, in seconds, has the device been up (or rebooted)
          readOnly: true
          examples:
          - 13500
        usb_stat:
          allOf:
          - $ref: '#/components/schemas/stats_ap_usb_stat2'
          - description: USB peripheral status reported by the AP
        version:
          type:
          - string
          - 'null'
          description: Firmware version running on the AP
          readOnly: true
          examples:
          - 0.14.12345
        x:
          type:
          - number
          - 'null'
          description: Map X coordinate of the AP placement, in pixels
          readOnly: true
          examples:
          - 53.5
        y:
          type:
          - number
          - 'null'
          description: Map Y coordinate of the AP placement, in pixels
          readOnly: true
          examples:
          - 173.1
        zigbee_stat:
          allOf:
          - $ref: '#/components/schemas/stats_ap_zigbee_stat2'
          - description: ZigBee statistics reported by the AP, present only when ZigBee is enabled on the AP
      description: AP runtime statistics, placement data, and inventory metadata
    stats_ap_auto_placement:
      title: stats_ap_auto_placement
      type: object
      properties:
        info:
          allOf:
          - $ref: '#/components/schemas/stats_ap_auto_placement_info2'
          - description: Additional diagnostics for the AP auto placement result
        recommended_anchor:
          type: boolean
          description: Flag to represent if AP is recommended as an anchor by auto placement service
        status:
          type: string
          description: Current auto placement status for the AP
          examples:
          - localized
        status_detail:
          type: string
          description: Additional info about placement status
          examples:
          - localized
        x:
          type: number
          description: Auto-placed X coordinate, in pixels
          examples:
          - 53.5
        x_m:
          type: number
          description: Auto-placed X coordinate, in meters
          examples:
          - 5.35
        y:
          type: number
          description: Auto-placed Y coordinate, in pixels
          examples:
          - 173.1
        y_m:
          type: number
          description: Auto-placed Y coordinate, in meters
          examples:
          - 17.31
      description: Auto placement result and status for an AP
    stats_ap_auto_placement_info:
      title: stats_ap_auto_placement_info
      type: object
      properties:
        cluster_number:
          type: integer
          description: All APs sharing a given cluster number can be placed relative to each other
          contentEncoding: int32
          examples:
          - 0
        orientation_stats:
          type: integer
          description: The orientation of an AP
          contentEncoding: int32
          examples:
          - 0
        probability_surface:
          allOf:
          - $ref: '#/components/schemas/stats_ap_auto_placement_info_probability_surface2'
          - description: Uncertainty area for the AP auto placement result
      description: Additional diagnostics for AP auto placement
    stats_ap_auto_placement_info_probability_surface:
      title: stats_ap_auto_placement_info_probability_surface
      type: object
      properties:
        radius:
          type: number
          description: The RADIUS representing placement uncertainty, measured in pixels
          examples:
          - 2.1
        radius_m:
          type: number
          description: The RADIUS representing placement uncertainty, measured in meters
        x:
          type: number
          description: Potential placement center X coordinate, in pixels
          examples:
          - 17
      description: Circular uncertainty area for an AP auto placement result
    stats_ap_auto_upgrade:
      title: stats_ap_auto_upgrade
      type: object
      properties:
        lastcheck:
          type:
          - integer
          - 'null'
          description: Time when the AP last checked for auto-upgrade, in epoch seconds
          contentEncoding: int64
          readOnly: true
          examples:
          - 1720594762
      description: Auto-upgrade status for an AP
    stats_ap_ble:
      title: stats_ap_ble
      type: object
      properties:
        beacon_enabled:
          type:
          - boolean
          - 'null'
          description: Whether Mist BLE beacon transmission is enabled
          readOnly: true
        beacon_rate:
          type:
          - integer
          - 'null'
          description: Mist BLE beacon transmit rate, in beacons per second
          contentEncoding: int32
          readOnly: true
          examples:
          - 3
        eddystone_uid_enabled:
          type:
          - boolean
          - 'null'
          description: Whether Eddystone-UID beacon transmission is enabled
          readOnly: true
          examples:
          - false
        eddystone_uid_freq_msec:
          type:
          - integer
          - 'null'
          description: Interval for Eddystone-UID advertisements, in milliseconds
          contentEncoding: int32
          readOnly: true
          examples:
          - 2000
        eddystone_uid_instance:
          type:
          - string
          - 'null'
          description: Eddystone-UID instance value broadcast by the AP
          readOnly: true
          examples:
          - 5c5b35000001
        eddystone_uid_namespace:
          type:
          - string
          - 'null'
          description: Eddystone-UID namespace value broadcast by the AP
          readOnly: true
          examples:
          - 2818e3868dec25629ede
        eddystone_url_enabled:
          type:
          - boolean
          - 'null'
          description: Whether Eddystone-URL beacon transmission is enabled
          readOnly: true
          examples:
          - true
        eddystone_url_freq_msec:
          type:
          - integer
          - 'null'
          description: Interval for Eddystone-URL advertisements, in milliseconds
          contentEncoding: int32
          readOnly: true
          examples:
          - 100
        eddystone_url_url:
          type:
          - string
          - 'null'
          description: URL broadcast by the Eddystone-URL beacon
          readOnly: true
          examples:
          - https://www.abc.com
        ibeacon_enabled:
          type:
          - boolean
          - 'null'
          description: Whether iBeacon transmission is enabled
          readOnly: true
          examples:
          - true
        ibeacon_freq_msec:
          type:
          - integer
          - 'null'
          description: Interval for iBeacon advertisements, in milliseconds
          contentEncoding: int32
          readOnly: true
          examples:
          - 2000
        ibeacon_major:
          maximum: 65535
          minimum: 1
          type:
          - integer
          - 'null'
          description: Major value broadcast in iBeacon advertisements
          contentEncoding: int32
          examples:
          - 1234
        ibeacon_minor:
          maximum: 65535
          minimum: 1
          type:
          - integer
          - 'null'
          description: Minor value broadcast in iBeacon advertisements
          contentEncoding: int32
          examples:
          - 1234
        ibeacon_uuid:
          type:
          - string
          - 'null'
          description: UUID value broadcast in iBeacon advertisements
          contentEncoding: uuid
          examples:
          - f3f17139-704a-f03a-2786-0400279e37c3
        major:
          type:
          - integer
          - 'null'
          description: Reported iBeacon major value for BLE statistics
          contentEncoding: int32
          readOnly: true
          examples:
          - 12345
        minors:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: Reported iBeacon minor values for BLE statistics
        power:
          type:
          - integer
          - 'null'
          description: BLE transmit power setting reported by the AP
          contentEncoding: int32
          readOnly: true
          examples:
          - 10
        rx_bytes:
          type:
          - integer
          - 'null'
          description: BLE bytes received by the AP
          contentEncoding: int64
          readOnly: true
          examples:
          - 8515104416
        rx_pkts:
          type:
          - integer
          - 'null'
          description: BLE packets received by the AP
          contentEncoding: int64
          readOnly: true
          examples:
          - 57770567
        tx_bytes:
          type:
          - integer
          - 'null'
          description: BLE bytes transmitted by the AP
          contentEncoding: int64
          readOnly: true
          examples:
          - 211217389682
        tx_pkts:
          type:
          - integer
          - 'null'
          description: BLE packets transmitted by the AP
          contentEncoding: int64
          readOnly: true
          examples:
          - 812204062
        tx_resets:
          type:
          - integer
          - 'null'
          description: Resets due to tx hung
          contentEncoding: int32
          readOnly: true
          examples:
          - 0
        uuid:
          type:
          - string
          - 'null'
          description: Beacon UUID reported by BLE statistics
          contentEncoding: uuid
          readOnly: true
          examples:
          - ada72f8f-1643-e5c6-94db-f2a5636f1a64
      description: BLE beacon and traffic statistics reported by an AP
    stats_ap_env_stat:
      title: stats_ap_env_stat
      type: object
      properties:
        accel_x:
          type:
          - number
          - 'null'
          description: X-axis accelerometer reading reported by the AP
          readOnly: true
          examples:
          - 0
        accel_y:
          type:
          - number
          - 'null'
          description: Y-axis accelerometer reading reported by the AP
          readOnly: true
          examples:
          - 0.032
        accel_z:
          type:
          - number
          - 'null'
          description: Z-axis accelerometer reading reported by the AP
          readOnly: true
          examples:
          - -1.088
        ambient_temp:
          type:
          - integer
          - 'null'
          description: Temperature reading from the AP ambient sensor
          contentEncoding: int32
          readOnly: true
          examples:
          - 43
        attitude:
          type:
          - integer
          - 'null'
          description: Device attitude or orientation reading reported by the AP
          contentEncoding: int32
          readOnly: true
          examples:
          - 0
        cpu_temp:
          type:
          - integer
          - 'null'
          description: Temperature reading from the AP CPU sensor
          contentEncoding: int32
          readOnly: true
          examples:
          - 61
        humidity:
          type:
          - integer
          - 'null'
          description: Relative humidity sensor reading reported by the AP
          contentEncoding: int32
          readOnly: true
          examples:
          - 9
        magne_x:
          type:
          - number
          - 'null'
          description: X-axis magnetometer reading reported by the AP
          readOnly: true
          examples:
          - 0
        magne_y:
          type:
          - number
          - 'null'
          description: Y-axis magnetometer reading reported by the AP
          readOnly: true
          examples:
          - 0
        magne_z:
          type:
          - number
          - 'null'
          description: Z-axis magnetometer reading reported by the AP
          readOnly: true
          examples:
          - 0
        pressure:
          type:
          - number
          - 'null'
          description: Barometric pressure sensor reading reported by the AP
          readOnly: true
          examples:
          - 968
        vcore_voltage:
          type:
          - integer
          - 'null'
          description: Core voltage sensor reading reported by the AP
          contentEncoding: int32
          readOnly: true
          examples:
          - 0
      description: Device environment, including CPU temperature, Ambient temperature, Humidity, Attitude, Pressure, Accelerometers, Magnetometers and vCore Voltage
    stats_ap_esl_stat:
      title: stats_ap_esl_stat
      type: object
      properties:
        channel:
          type:
          - integer
          - 'null'
          description: Radio channel used by the ESL dongle
          contentEncoding: int32
          readOnly: true
        connected:
          type:
          - boolean
          - 'null'
          description: Whether the ESL dongle is connected
          readOnly: true
        ip:
          type:
          - string
          - 'null'
          description: Network IP address of Hanshow and SoluM dongles
          readOnly: true
          examples:
          - 172.16.2.249
        mac:
          type:
          - string
          - 'null'
          description: Dongle MAC address for Hanshow and SoluM dongles
          readOnly: true
          examples:
          - 98-6d-35-79-76-3b
        product_id:
          type:
          - string
          - 'null'
          description: Product ID of Hanshow and SoluM dongles
          readOnly: true
          examples:
          - A4A2
        type:
          type:
          - string
          - 'null'
          description: ESL dongle type reported by the AP
          readOnly: true
          examples:
          - imagotag
        up:
          type:
          - boolean
          - 'null'
          description: Whether the ESL dongle is operational
          readOnly: true
        vendor_id:
          type:
          - string
          - 'null'
          description: Vendor ID of Hanshow and SoluM dongles
          readOnly: true
          examples:
          - '0525'
      description: Electronic shelf label dongle status reported by an AP
    stats_ap_gps_stat:
      title: stats_ap_gps_stat
      type: object
      properties:
        accuracy:
          type: number
          description: The estimated accuracy or accuracy of the GPS coordinates, measured in meters.
          examples:
          - 12.5
        altitude:
          type: number
          description: The elevation of the AP above sea level, measured in meters.
          examples:
          - 99.939
        latitude:
          type: number
          description: The geographic latitude of the AP, measured in degrees.
          examples:
          - 37.29548
        longitude:
          type: number
          description: The geographic longitude of the AP, measured in degrees.
          examples:
          - -122.03304
        src:
          allOf:
          - $ref: '#/components/schemas/stats_ap_gps_stat_src2'
          - description: 'Source of the GPS location data. enum: `gps`, `other_ap`, `other_aps`.'
        timestamp:
          type: number
          description: Time when the GPS location data was observed, in epoch seconds
          readOnly: true
      description: GPS location data reported by an AP
    stats_ap_gps_stat_src:
      title: stats_ap_gps_stat_src
      enum:
      - gps
      - other_ap
      - other_aps
      type: string
      description: 'The origin of the GPS data. enum: `gps`: from this device GPS estimates, `other_aps` from neighboring devices GPS estimates. Note: API responses may return `other_aps` which should be treated as `other_ap`'
    stats_ap_iot_stat_additional_properties:
      title: stats_ap_iot_stat_additional_properties
      type: object
      properties:
        value:
          type:
          - integer
          - 'null'
          description: Reported value for this IoT input
          contentEncoding: int32
          readOnly: true
      description: IoT input statistic value
    stats_ap_l2tp_stat:
      title: stats_ap_l2tp_stat
      type: object
      properties:
        sessions:
          type: array
          items:
            $ref: '#/components/schemas/stats_ap_l2tp_stat_session'
          description: L2TP session entries for this tunnel
        state:
          allOf:
          - $ref: '#/components/schemas/l2tp_state2'
          - description: 'L2TP tunnel state reported by the AP. enum: `established`, `established_with_session`, `idle`, `wait-ctrl-conn`, `wait-ctrl-reply`.'
            examples:
            - established
        uptime:
          type:
          - integer
          - 'null'
          description: Tunnel uptime, in seconds
          contentEncoding: int32
          readOnly: true
          examples:
          - 135
        wxtunnel_id:
          type:
          - string
          - 'null'
          description: Identifier of the associated WxLAN tunnel
          contentEncoding: uuid
          readOnly: true
          examples:
          - 7dae216d-7c98-a51b-e068-dd7d477b7216
      description: L2TP tunnel status reported by an AP
    stats_ap_l2tp_stat_session:
      title: stats_ap_l2tp_stat_session
      type: object
      properties:
        local_sid:
          type:
          - integer
          - 'null'
          description: Local L2TP session identifier for this tunnel session
          contentEncoding: int32
          readOnly: true
          examples:
          - 31
        remote_id:
          type:
          - string
          - 'null'
          description: User-configured remote identifier for the WxLAN tunnel
          readOnly: true
          examples:
          - vpn1
        remote_sid:
          type:
          - integer
          - 'null'
          description: Remote L2TP session identifier for this tunnel session
          contentEncoding: int32
          readOnly: true
          examples:
          - 13
        state:
          allOf:
          - $ref: '#/components/schemas/l2tp_state1'
          - description: 'L2TP session state reported by the AP. enum: `established`, `established_with_session`, `idle`, `wait-ctrl-conn`, `wait-ctrl-reply`.'
            examples:
            - established
      description: L2TP tunnel session reported by an AP
    stats_ap_lldp_stat:
      title: stats_ap_lldp_stat
      type: object
      properties:
        chassis_id:
          type:
          - string
          - 'null'
          description: LLDP neighbor chassis identifier
          readOnly: true
        lldp_med_supported:
          type:
          - boolean
          - 'null'
          description: Whether it support LLDP-MED
          readOnly: true
        mgmt_addr:
          type:
          - string
          - 'null'
          description: Management IP address of the switch
          readOnly: true
        mgmt_addrs:
          type: array
          items:
            type: string
          description: Management IP addresses advertised by the LLDP neighbor
        port_desc:
          type:
          - string
          - 'null'
          description: Port description, e.g. “2/20”, “Port 2 on Switch0”
          readOnly: true
          examples:
          - 2/20
        port_id:
          type:
          - string
          - 'null'
          description: LLDP neighbor port identifier
          readOnly: true
          examples:
          - ge-0/0/4
        power_allocated:
          type:
          - number
          - 'null'
          description: In mW, power allocated by PSE
          readOnly: true
        power_avail:
          type: integer
          description: In mW, total Power Avail at AP from pwr source
          contentEncoding: int32
        power_budget:
          type: integer
          description: In mW, surplus if positive or deficit if negative
          contentEncoding: int32
        power_constrained:
          type: boolean
          description: Whether power is insufficient
        power_draw:
          type:
          - number
          - 'null'
          description: In mW, total power needed by PD
          readOnly: true
        power_needed:
          type: integer
          description: In mW, total Power needed incl Peripherals
          contentEncoding: int32
        power_opmode:
          type: string
          description: Power operating mode negotiated through LLDP
        power_request_count:
          type:
          - integer
          - 'null'
          description: Number of negotiations, if it keeps increasing, we don’ t have a stable power
          contentEncoding: int32
          readOnly: true
        power_requested:
          type:
          - number
          - 'null'
          description: In mW, power requested by PD
          readOnly: true
        power_src:
          type: string
          description: Primary AP power source reported through LLDP
        power_srcs:
          type: array
          items:
            type: string
          description: AP power sources reported through LLDP
        system_desc:
          type:
          - string
          - 'null'
          description: Description provided by switch
          readOnly: true
          examples:
          - 'uniper Networks, Inc. ex4300-48t internet router, kernel JUNOS 20.4R3-S7.2, Build date: 2023-04-21 19:47:18 UTC Copyright (c) 1996-2023 Juniper Networks, Inc.'
        system_name:
          type:
          - string
          - 'null'
          description: Name of the switch
          readOnly: true
          examples:
          - Core-AE23
      description: LLDP neighbor information and power negotiations. For backward compatibility, when multiple neighbors exist, only information from the first neighbor is displayed.
    stats_ap_port_stat:
      title: stats_ap_port_stat
      type: object
      properties:
        full_duplex:
          type:
          - boolean
          - 'null'
          description: Whether the AP Ethernet port is operating in full-duplex mode
          readOnly: true
          examples:
          - true
        rx_bytes:
          type:
          - integer
          - 'null'
          description: Bytes received on the AP Ethernet port
          contentEncoding: int64
          readOnly: true
          examples:
          - 8515104416
        rx_errors:
          type:
          - integer
          - 'null'
          description: Receive error count reported for the AP Ethernet port
          contentEncoding: int32
          readOnly: true
          examples:
          - 0
        rx_peak_bps:
          type:
          - integer
          - 'null'
          description: Peak receive throughput on the AP Ethernet port, in bits per second
          contentEncoding: int32
          readOnly: true
          examples:
          - 22185
        rx_pkts:
          type:
          - integer
          - 'null'
          description: Packets received on the AP Ethernet port
          contentEncoding: int64
          readOnly: true
          examples:
          - 57770567
        speed:
          type:
          - integer
          - 'null'
          description: Negotiated Ethernet link speed for the AP port, in Mbps
          contentEncoding: int32
          readOnly: true
          examples:
          - 1000
        tx_bytes:
          type:
          - integer
          - 'null'
          description: Bytes transmitted on the AP Ethernet port
          contentEncoding: int64
          readOnly: true
          examples:
          - 211217389682
        tx_peak_bps:
          type:
          - integer
          - 'null'
          description: Peak transmit throughput on the AP Ethernet port, in bits per second
          contentEncoding: int32
          readOnly: true
          examples:
          - 43922
        tx_pkts:
          type:
          - integer
          - 'null'
          description: Packets transmitted on the AP Ethernet port
          contentEncoding: int64
          readOnly: true
          examples:
          - 812204062
        up:
          type:
          - boolean
          - 'null'
          description: Whether the AP Ethernet port link is up
          readOnly: true
          examples:
          - true
      description: Ethernet port statistics reported by an AP
    stats_ap_radio_config:
      title: stats_ap_radio_config
      type: object
      properties:
        band_24:
          allOf:
          - $ref: '#/components/schemas/stats_ap_radio_config_band4'
          - description: 2.4 GHz radio configuration reported by the AP
        band_24_usage:
          type:
          - string
          - 'null'
          description: Current operating use for the 2.4 GHz radio
          readOnly: true
          examples:
          - '5'
        band_5:
          allOf:
          - $ref: '#/components/schemas/stats_ap_radio_config_band1'
          - description: 5 GHz radio configuration reported by the AP
        band_6:
          allOf:
          - $ref: '#/components/schemas/stats_ap_radio_config_band2'
          - description: 6 GHz radio configuration reported by the AP
        scanning_enabled:
          type: boolean
          description: Whether radio scanning is enabled on the AP
      description: Radio configuration reported by an AP
    stats_ap_radio_config_band:
      title: stats_ap_radio_config_band
      type: object
      properties:
        allow_rrm_disable:
          type:
          - boolean
          - 'null'
          description: Whether RRM disablement is allowed for this radio band
          readOnly: true
        bandwidth:
          type:
          - number
          - 'null'
          description: Channel bandwidth configured for this radio band
          readOnly: true
          examples:
          - 20
        channel:
          type: integer
          description: Operating channel configured for this radio band
          contentEncoding: int32
          examples:
          - 1
        disabled:
          type:
          - boolean
          - 'null'
          description: Whether this radio band is disabled
          readOnly: true
        dynamic_chaining_enabled:
          type:
          - boolean
          - 'null'
          description: Whether dynamic chaining is enabled for this radio band
          readOnly: true
          examples:
          - false
        power:
          type:
          - number
          - 'null'
          description: Transmit power configured for this radio band
          readOnly: true
          examples:
          - 10
        power_max:
          type:
          - number
          - 'null'
          description: Maximum transmit power allowed for this radio band
          readOnly: true
          examples:
          - 10
        power_min:
          type:
          - number
          - 'null'
          description: Minimum transmit power allowed for this radio band
          readOnly: true
          examples:
          - 10
        rx_chain:
          type:
          - integer
          - 'null'
          description: Number of receive chains enabled for this radio band
          contentEncoding: int32
          readOnly: true
          examples:
          - 4
        tx_chain:
          type:
          - integer
          - 'null'
          description: Number of transmit chains enabled for this radio band
          contentEncoding: int32
          readOnly: true
          examples:
          - 4
      description: Per-band radio configuration reported by an AP
    stats_ap_radio_stat:
      title: stats_ap_radio_stat
      type: object
      properties:
        band_24:
          allOf:
          - $ref: '#/components/schemas/ap_radio_stat1'
          - description: 2.4 GHz radio statistics reported by the AP
        band_5:
          allOf:
          - $ref: '#/components/schemas/ap_radio_stat2'
          - description: 5 GHz radio statistics reported by the AP
        band_6:
          allOf:
          - $ref: '#/components/schemas/ap_radio_stat3'
          - description: 6 GHz radio statistics reported by the AP
      description: Per-band radio statistics reported by an AP
    stats_ap_switch_redundancy:
      title: stats_ap_switch_redundancy
      type: object
      properties:
        num_redundant_aps:
          type:
          - integer
          - 'null'
          description: Number of redundant APs available for switch redundancy
          contentEncoding: int32
          readOnly: true
          examples:
          - 1
      description: Switch redundancy status reported by an AP
    stats_ap_usb_stat:
      title: stats_ap_usb_stat
      type: object
      properties:
        channel:
          type:
          - integer
          - 'null'
          description: Radio channel used by the USB peripheral
          contentEncoding: int32
          readOnly: true
          examples:
          - 3
        connected:
          type:
          - boolean
          - 'null'
          description: Whether the USB peripheral is connected
          readOnly: true
          examples:
          - true
        last_activity:
          type:
          - integer
          - 'null'
          description: Time of the last USB peripheral activity, in epoch seconds
          contentEncoding: int32
          readOnly: true
          examples:
          - 1586873254
        type:
          type:
          - string
          - 'null'
          description: USB peripheral type reported by the AP
          readOnly: true
          examples:
          - imagotag
        up:
          type:
          - boolean
          - 'null'
          description: Whether the USB peripheral is operational
          readOnly: true
          examples:
          - true
      description: USB peripheral status reported by an AP
    stats_ap_zigbee_stat:
      title: stats_ap_zigbee_stat
      type: object
      properties:
        iotproxy_status:
          type:
          - string
          - 'null'
          description: Connection status of the IoT proxy
          readOnly: true
          examples:
          - connected
        num_iotendpoints:
          type:
          - integer
          - 'null'
          description: Number of IoT endpoints connected through the AP
          contentEncoding: int32
          readOnly: true
          examples:
          - 3
      description: ZigBee statistics reported by an AP, present only when ZigBee is enabled on the AP
    stats_asset:
      title: stats_asset
      required:
      - mac
      type: object
      properties:
        _ttl:
          type: integer
          description: Time-to-live in seconds; how long this asset data is valid in cache
          contentEncoding: int32
        battery_percent:
          type: integer
          description: Estimated battery level (1–100%); currently supported for Aruba/HPE asset tags
          contentEncoding: int32
          examples:
          - 50
        battery_voltage:
          type: number
          description: Battery voltage, in mV
          examples:
          - 2970
        beam:
          type: integer
          description: BLE beam number where the asset was observed
          contentEncoding: int32
          examples:
          - 6
        by:
          type: string
          description: Observation source type for the asset statistic
          examples:
          - asset
        device_id:
          type: string
          description: Device ID of the loudest AP
          contentEncoding: uuid
          readOnly: true
          examples:
          - 00000000-0000-0000-1000-5c5b35000001
        device_name:
          type: string
          description: Display name of the loudest AP observing the asset
          examples:
          - a
        duration:
          type: integer
          description: Length of the current asset observation, in seconds
          contentEncoding: int32
          examples:
          - 120
        eddystone_uid_instance:
          type: string
          description: Eddystone-UID instance value advertised by the asset
          examples:
          - 5c5b35000001
        eddystone_uid_namespace:
          type: string
          description: Eddystone-UID namespace value advertised by the asset
          examples:
          - 2818e3868dec25629ede
        eddystone_url_url:
          type: string
          description: URL value advertised by the asset through Eddystone-URL
          examples:
          - https://www.abc.com
        ibeacon_major:
          maximum: 65535
          minimum: 1
          type:
          - integer
          - 'null'
          description: iBeacon major value advertised by the asset
          contentEncoding: int32
          examples:
          - 1234
        ibeacon_minor:
          maximum: 65535
          minimum: 1
          type:
          - integer
          - 'null'
          description: iBeacon minor value advertised by the asset
          contentEncoding: int32
          examples:
          - 1234
        ibeacon_uuid:
          type:
          - string
          - 'null'
          description: iBeacon UUID advertised by the asset
          contentEncoding: uuid
          examples:
          - f3f17139-704a-f03a-2786-0400279e37c3
        id:
          type: string
          description: Unique identifier for the asset statistic
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        last_seen:
          type:
          - number
          - 'null'
          description: Time when the BLE asset was last observed, in epoch seconds
          readOnly: true
          examples:
          - 1470417522
        mac:
          type: string
          description: Bluetooth MAC address for the asset
          examples:
          - 6fa474be7ae5
        manufacture:
          type: string
          description: Vendor name resolved from the BLE manufacturer company ID
        map_id:
          type: string
          description: Map where the device belongs to
          contentEncoding: uuid
          examples:
          - c45be59f-854d-4ef7-b782-dcd6309c84a9
        mfg_company_id:
          type: integer
          description: BLE manufacturer company ID from advertisement
          contentEncoding: int32
          examples:
          - 935
        mfg_data:
          type: string
          description: Manufacturer-specific data (hex encoded)
          examples:
          - 648520a1020000
        name:
          type: string
          description: Display label for the BLE asset
          examples:
          - 6fa474be7ae5
        rssi:
          type: integer
          description: Signal strength (RSSI) of the loudest AP in dBm
          contentEncoding: int32
          examples:
          - -60
        rssizones:
          type: array
          items:
            $ref: '#/components/schemas/asset_rssi_zone'
          description: RSSI zones currently containing this asset
        service_packets:
          maxItems: 10
          type: array
          items:
            $ref: '#/components/schemas/stats_asset_service_packet'
          description: Service data advertisements observed from this asset
        temperature:
          type: number
          description: Reported temperature value from the BLE asset
          examples:
          - 23
        x:
          type: number
          description: Map X coordinate of the asset location, in pixels
          examples:
          - 280.19918140310193
        y:
          type: number
          description: Map Y coordinate of the asset location, in pixels
          examples:
          - 420.2987721046529
        zones:
          type: array
          items:
            $ref: '#/components/schemas/asset_zone'
          description: Map zones currently containing this asset
      description: BLE asset location and advertisement statistics
    stats_asset_service_packet:
      title: stats_asset_service_packet
      type: object
      properties:
        data:
          type: string
          description: Service data payload (hex encoded)
          examples:
          - '640'
        last_rx_time:
          type: integer
          description: Unix timestamp when this service data was last received
          contentEncoding: int32
          examples:
          - 1645855923
        rx_cnt:
          type: integer
          description: Total number of times this service data was received
          contentEncoding: int32
          examples:
          - 213065
        uuid:
          type: string
          description: BLE service UUID advertised by the asset service packet
          examples:
          - 00003e10-0000-1000-8000-00805f9b34fb
      description: Service data advertisement from a BLE asset
    stats_beacon:
      title: stats_beacon
      required:
      - mac
      - map_id
      - name
      - power
      - type
      - x
      - y
      type: object
      properties:
        battery_voltage:
          type: number
          description: Battery voltage, in mV
        eddystone_instance:
          type: string
          description: Eddystone-UID instance value advertised by the beacon
        eddystone_namespace:
          type: string
          description: Eddystone-UID namespace value advertised by the beacon
        last_seen:
          type:
          - number
          - 'null'
          description: Time when the beacon was last observed, in epoch seconds
          readOnly: true
          examples:
          - 1470417522
        mac:
          type: string
          description: Beacon MAC address observed by Mist
        map_id:
          type: string
          description: Map identifier where the beacon is placed
          contentEncoding: uuid
        name:
          type: string
          description: Display name of the beacon
        power:
          type: integer
          description: Transmit power configured for the beacon
          contentEncoding: int32
        type:
          type: string
          description: Advertisement protocol type used by the beacon, such as iBeacon or Eddystone
        x:
          type: number
          description: Map X coordinate of the beacon placement, in pixels
        y:
          type: number
          description: Map Y coordinate of the beacon placement, in pixels
      description: BLE beacon runtime statistics and placement data
    stats_call:
      title: stats_call
      type: object
      properties:
        app:
          type: string
          description: Third-party collaboration application that reported the call statistics
        audio_quality:
          type: integer
          description: Quality score reported for the call audio stream
          contentEncoding: int32
        end_time:
          type: integer
          description: Time when the call ended, in epoch seconds
          contentEncoding: int32
        mac:
          type: string
          description: Client MAC address associated with the call statistics record
        meeting_id:
          type: string
          description: Collaboration meeting identifier reported for the call
        org_id:
          type: string
          description: Owning organization identifier for the call statistics record
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        rating:
          type: integer
          description: Overall call rating reported by the collaboration application, when available
          contentEncoding: int32
        screen_share_quality:
          type: integer
          description: Quality score reported for screen sharing during the call
          contentEncoding: int32
        site_id:
          type: string
          description: Associated site identifier for the call statistics record
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        start_time:
          type: integer
          description: Time when the call started, in epoch seconds
          contentEncoding: int32
        video_quality:
          type: integer
          description: Quality score reported for the call video stream
          contentEncoding: int32
      description: Statistics record for a detected collaboration call, such as Zoom or Teams
    stats_cluster_config:
      title: stats_cluster_config
      type: object
      properties:
        configuration:
          type: string
          description: Configured high-availability mode for the gateway cluster, such as active-active
        control_link_info:
          allOf:
          - $ref: '#/components/schemas/stats_cluster_config_control_link_info2'
          - description: Control link interface and operational state for the gateway cluster
        ethernet_connection:
          type: array
          items:
            $ref: '#/components/schemas/stats_cluster_config_ethernet_connection_item'
          description: Ethernet interface connection states used by the gateway cluster
        fabric_link_info:
          allOf:
          - $ref: '#/components/schemas/stats_cluster_config_fabric_link_info2'
          - description: Fabric link state and data-plane notification details for the gateway cluster
        last_status_change_reason:
          type: string
          description: Reason reported for the most recent gateway cluster status change
        operational:
          type: string
          description: Current operational high-availability mode of the gateway cluster
        primary_node_health:
          type: string
          description: Health state reported for the primary gateway cluster node
        redundancy_group_information:
          type: array
          items:
            $ref: '#/components/schemas/stats_cluster_config_redundancy_group_info_item'
          description: Redundancy group monitoring state reported by the gateway cluster
        secondary_node_health:
          type: string
          description: Health state reported for the secondary gateway cluster node
        status:
          type: string
          description: Overall health status reported for the gateway cluster
      description: High-availability cluster configuration and health reported by a gateway
    stats_cluster_config_control_link_info:
      title: stats_cluster_config_control_link_info
      type: object
      properties:
        name:
          type: string
          description: Control link interface name reported by the gateway cluster
        status:
          type: string
          description: Operational state reported for the control link
      description: Control link status details for a gateway cluster
    stats_cluster_config_ethernet_connection_item:
      title: stats_cluster_config_ethernet_connection_item
      type: object
      properties:
        name:
          type: string
          description: Ethernet interface name reported for cluster connectivity
        status:
          type: string
          description: Operational state reported for the Ethernet interface
      description: Ethernet interface connection state for a gateway cluster member
    stats_cluster_config_fabric_link_info:
      title: stats_cluster_config_fabric_link_info
      type: object
      properties:
        DataPlaneNotifiedStatus:
          type: string
          description: Fabric link data-plane notification status reported by the gateway
        Interface:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Fabric link interfaces reported for the gateway cluster
        InternalStatus:
          type: string
          description: Gateway-reported internal status for the fabric link
        State:
          type: string
          description: Administrative state of the fabric link
        Status:
          type: string
          description: Operational status of the fabric link
      description: Fabric link status details for a gateway cluster
    stats_cluster_config_redundancy_group_info_item:
      title: stats_cluster_config_redundancy_group_info_item
      type: object
      properties:
        Id:
          type: integer
          description: Redundancy group identifier reported by the gateway
          contentEncoding: int32
        MonitoringFailure:
          type: string
          description: Detected monitoring failure condition for the redundancy group
        Threshold:
          type: integer
          description: Configured monitoring threshold for the redundancy group
          contentEncoding: int32
      description: Redundancy group monitoring entry for a gateway cluster
    stats_device_other:
      title: stats_device_other
      type: object
      properties:
        cached_stats:
          type: boolean
          description: Whether the response was served from cached vendor statistics
        config_status:
          type: string
          description: Synchronization status of the other device configuration in Mist
          examples:
          - synced
        connected_devices:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/stats_device_other_connected_device'
          description: LLDP neighbor devices discovered from the other device
        interfaces:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/stats_device_other_interface'
          description: Network interface statistics reported for the other device
        last_config:
          type: integer
          description: Timestamp of the last configuration update reported for the other device, in epoch seconds
          contentEncoding: int32
          examples:
          - 1675392788
        last_seen:
          type:
          - number
          - 'null'
          description: Time when Mist last observed the other device, in epoch seconds
          readOnly: true
          examples:
          - 1470417522
        lldp_enabled:
          type: boolean
          description: Whether LLDP is enabled on the other device
        mac:
          type: string
          description: Other device MAC address reported in the statistics response
          examples:
          - 5c5b35000018
        status:
          type: string
          description: Connectivity status reported for the other device, such as online
          examples:
          - online
        uptime:
          type: integer
          description: Elapsed time since the other device last booted, in seconds
          contentEncoding: int32
          examples:
          - 20296
        vendor:
          type: string
          description: Device vendor name, such as Cradlepoint
          examples:
          - cradlepoint
        vendor_specific:
          allOf:
          - $ref: '#/components/schemas/stats_device_other_vendor_specific2'
          - description: Additional statistics returned by the device vendor
        version:
          type: string
          description: Vendor software version reported for the other device
          examples:
          - 7.22.70
      description: Statistics for a third-party or other device tracked by Mist
    stats_device_other_connected_device:
      title: stats_device_other_connected_device
      type: object
      properties:
        mac:
          type: string
          description: Connected device MAC address learned from LLDP
          examples:
          - 020001abcdef
        name:
          type: string
          description: LLDP system name reported for the connected device
          examples:
          - DNT-NTR-GWE
        port_id:
          type: string
          description: LLDP port identifier reported for the connected device
          examples:
          - ge-0/0/1
        type:
          type: string
          description: Detected Mist device type for the connected neighbor
          examples:
          - gateway
      description: LLDP neighbor device discovered from an other-device statistics record
    stats_device_other_interface:
      title: stats_device_other_interface
      type: object
      properties:
        bytes_in:
          type: integer
          description: Total bytes received on the interface
          contentEncoding: int64
          examples:
          - 5623096929
        bytes_out:
          type: integer
          description: Total bytes transmitted from the interface
          contentEncoding: int64
          examples:
          - 12372750366
        carrier:
          type: string
          description: Cellular carrier name reported for the interface, when applicable
          examples:
          - Orange
        imei:
          type: string
          description: Modem IMEI serving the interface, when applicable
          examples:
          - '866401234567893'
        imsi:
          type: string
          description: Subscriber IMSI associated with the interface, when applicable
          examples:
          - '2080101234567893'
        ip:
          type: string
          description: Interface IP address reported by the vendor
          examples:
          - 10.134.237.57
        link:
          type: boolean
          description: Whether the interface link is up
          examples:
          - true
        mode:
          type: string
          description: Interface role reported by the vendor, such as wan or lan
          examples:
          - wan
        mtu:
          type: integer
          description: Maximum transmission unit configured on the interface, in bytes
          contentEncoding: int32
          examples:
          - 1500
        rsrp:
          type: number
          description: Reference signal received power for a cellular interface, in dBm
          examples:
          - -108
        rsrq:
          type: number
          description: Reference signal received quality for a cellular interface, in dB
          examples:
          - -14
        rssi:
          type: integer
          description: Received signal strength indicator for a cellular interface, in dBm
          contentEncoding: int32
          examples:
          - -74
        service_mode:
          type: string
          description: Cellular service mode reported for the interface, such as 5G NSA
          examples:
          - 5G NSA
        sinr:
          type: number
          description: Signal-to-interference-plus-noise ratio for a cellular interface, in dB
          examples:
          - -1.2
        state:
          type: string
          description: Operational state reported for the interface
          examples:
          - READY
        type:
          type: string
          description: Interface type reported by the vendor, such as mdm or ethernet
          examples:
          - mdm
        uptime:
          type: integer
          description: Elapsed time since the interface last became active, in seconds
          contentEncoding: int32
          examples:
          - 2095779
      description: Network interface statistics for a third-party device tracked by Mist
    stats_device_other_vendor_specific:
      title: stats_device_other_vendor_specific
      type: object
      properties:
        interfaces:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/stats_device_other_vendor_specific_port'
          description: Cradlepoint interface statistics keyed by vendor interface identifier
          examples:
          - mdm-4d0e073b:
              bytes_in: 5623096929
              bytes_out: 12372750366
              carrier: Orange
              imei: '866401234567893'
              imsi: '2080101234567893'
              ip: 10.134.237.57
              link: true
              mode: wan
              rsrp: -108
              rsrq: -14
              rssi: -74
              service_mode: 5G NSA
              sinr: -1.2
              state: READY
              type: mdm
              uptime: 2095779
        target_version:
          type: string
          description: Cradlepoint software version targeted for the device
          examples:
          - 7.23.40
      description: When `vendor`==`cradlepoint`, contains Cradlepoint-specific statistics reported for the other device
    stats_device_other_vendor_specific_port:
      title: stats_device_other_vendor_specific_port
      type: object
      properties:
        bytes_in:
          type: integer
          description: Total bytes received on the Cradlepoint interface
          contentEncoding: int64
          examples:
          - 5623096929
        bytes_out:
          type: integer
          description: Total bytes transmitted from the Cradlepoint interface
          contentEncoding: int64
          examples:
          - 12372750366
        carrier:
          type: string
          description: Cellular carrier name reported for the Cradlepoint interface, when applicable
          examples:
          - Orange
        display_name:
          type: string
          description: Human-readable interface name reported by Cradlepoint
          examples:
          - mdm-4d0e073b
        imei:
          type: string
          description: Modem IMEI serving the Cradlepoint interface, when applicable
          examples:
          - '866401234567893'
        imsi:
          type: string
          description: Subscriber IMSI associated with the Cradlepoint interface, when applicable
          examples:
          - '2080101234567893'
        ip:
          type: string
          description: Cradlepoint interface IP address reported by the vendor
          examples:
          - 10.134.237.57
        link:
          type: boolean
          description: Whether the Cradlepoint interface link is up
          examples:
          - true
        mode:
          type: string
          description: Interface role reported by Cradlepoint, such as wan or lan
          examples:
          - wan
        mtu:
          type: integer
          description: Maximum transmission unit configured on the Cradlepoint interface, in bytes
          contentEncoding: int32
          examples:
          - 1500
        port_parent:
          type: string
          description: Parent Cradlepoint port or interface group for this interface
          examples:
          - mdm
        rsrp:
          type: number
          description: Reference signal received power for a Cradlepoint cellular interface, in dBm
          examples:
          - -108
        rsrq:
          type: number
          description: Reference signal received quality for a Cradlepoint cellular interface, in dB
          examples:
          - -14
        rssi:
          type: integer
          description: Received signal strength indicator for a Cradlepoint cellular interface, in dBm
          contentEncoding: int32
          examples:
          - -74
        service_mode:
          type: string
          description: Cellular service mode reported for the Cradlepoint interface, such as 5G NSA
          examples:
          - 5G NSA
        sinr:
          type: number
          description: Signal-to-interference-plus-noise ratio for a Cradlepoint cellular interface, in dB
          examples:
          - -1.2
        state:
          type: string
          description: Operational state reported for the Cradlepoint interface
          examples:
          - READY
        type:
          type: string
          description: Interface type reported by Cradlepoint, such as mdm or ethernet
          examples:
          - mdm
        uptime:
          type: integer
          description: Elapsed time since the Cradlepoint interface last became active, in seconds
          contentEncoding: int32
          examples:
          - 2095779
      description: Cradlepoint interface statistics for a device tracked by Mist
    stats_gateway:
      title: stats_gateway
      required:
      - mac
      - type
      type: object
      properties:
        ap_redundancy:
          allOf:
          - $ref: '#/components/schemas/ap_redundancy2'
          - description: AP redundancy statistics associated with the gateway
        arp_table_stats:
          allOf:
          - $ref: '#/components/schemas/arp_table_stats2'
          - description: ARP table utilization statistics for the gateway
        auto_upgrade_stat:
          allOf:
          - $ref: '#/components/schemas/stats_ap_auto_upgrade3'
          - description: Automatic firmware upgrade status for the gateway
        bgp_peers:
          type: array
          items:
            $ref: '#/components/schemas/bgp_peer'
          description: BGP peer statistics reported by the gateway
        cert_expiry:
          type: integer
          description: Time when the gateway certificate expires, in epoch seconds
          contentEncoding: int64
        cluster_config:
          allOf:
          - $ref: '#/components/schemas/stats_cluster_config1'
          - description: High-availability cluster configuration and health for the gateway
        cluster_stat:
          allOf:
          - $ref: '#/components/schemas/stats_gateway_cluster2'
          - description: High-availability cluster state summary for the gateway
        conductor_name:
          type: string
          description: SSR conductor name associated with the gateway, when applicable
          readOnly: true
        config_status:
          type: string
          description: Configuration synchronization status reported for the gateway
          readOnly: true
        config_timestamp:
          type: integer
          description: Time when the gateway configuration status was last updated, in epoch seconds
          contentEncoding: int32
        config_version:
          type: integer
          description: Currently applied configuration version for the gateway
          contentEncoding: int32
        cpu2_stat:
          allOf:
          - $ref: '#/components/schemas/cpu_stat3'
          - description: Processor utilization statistics for the secondary HA node
        cpu_stat:
          allOf:
          - $ref: '#/components/schemas/cpu_stat4'
          - description: Processor utilization statistics for the gateway or primary HA node
        created_time:
          type: number
          description: Time when the gateway record was created, in epoch seconds
          readOnly: true
        deviceprofile_id:
          type:
          - string
          - 'null'
          description: Applied device profile identifier for the gateway, when present
          contentEncoding: uuid
          readOnly: true
        deviceprofile_name:
          type: string
          description: Applied device profile name for the gateway
        dhcpd2_stat:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/dhcpd_stat_lan'
          description: Lease pool statistics from the secondary-node DHCP service
        dhcpd_stat:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/dhcpd_stat_lan'
          description: Lease pool statistics from the gateway DHCP service
        evpntopo_id:
          type:
          - string
          - 'null'
          description: Associated EVPN topology identifier for the gateway, when present
          contentEncoding: uuid
          readOnly: true
        ext_ip:
          type:
          - string
          - 'null'
          description: Public IP address observed for the gateway
          readOnly: true
          examples:
          - 66.129.234.224
        fwupdate:
          allOf:
          - $ref: '#/components/schemas/fwupdate_stat4'
          - description: Firmware update status for the gateway
        has_pcap:
          type:
          - boolean
          - 'null'
          description: Whether packet capture is available for the gateway
          readOnly: true
        hostname:
          type: string
          description: Device-reported hostname for the gateway
          examples:
          - sj1
        id:
          type: string
          description: Unique identifier of the gateway record
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        if2_stat:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/if_stat_property'
          description: Interface traffic statistics for the secondary HA node
        if_stat:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/if_stat_property'
          description: Interface traffic statistics for the gateway or primary HA node
        ip:
          type:
          - string
          - 'null'
          description: Management IP address reported for the gateway
          readOnly: true
          examples:
          - 10.2.11.137
        ip2_stat:
          allOf:
          - $ref: '#/components/schemas/ip_stat3'
          - description: Layer 3 address statistics for the secondary HA node
        ip_stat:
          allOf:
          - $ref: '#/components/schemas/ip_stat4'
          - description: Layer 3 address statistics for the gateway or primary HA node
        is_ha:
          type:
          - boolean
          - 'null'
          description: Whether the gateway is part of an HA cluster
          readOnly: true
        last_seen:
          type:
          - number
          - 'null'
          description: Time when Mist last observed the gateway, in epoch seconds
          readOnly: true
          examples:
          - 1470417522
        mac:
          type: string
          description: Gateway MAC address reported by Mist
          examples:
          - dc38e1dbf3cd
        mac_table_stats:
          allOf:
          - $ref: '#/components/schemas/stats_gateway_mac_table_stats2'
          - description: Layer 2 MAC table utilization statistics for the gateway
        map_id:
          type:
          - string
          - 'null'
          description: Placement map identifier associated with the gateway, when present
          contentEncoding: uuid
          readOnly: true
        memory2_stat:
          allOf:
          - $ref: '#/components/schemas/memory_stat3'
          - description: Secondary-node memory utilization statistics for the gateway
        memory_stat:
          allOf:
          - $ref: '#/components/schemas/memory_stat4'
          - description: Utilization statistics for gateway memory
        model:
          type: string
          description: Gateway model name reported by Mist
          examples:
          - SRX320
        modified_time:
          type: number
          description: Time when the gateway record was last modified, in epoch seconds
          readOnly: true
        module2_stat:
          maxItems: 1
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/stats_gateway_module_stat_item'
          description: Hardware module statistics for the secondary HA node
        module_stat:
          maxItems: 1
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/stats_gateway_module_stat_item'
          description: Hardware module statistics for the gateway or primary HA node
        name:
          type: string
          description: Device name if configured
          readOnly: true
          examples:
          - sj1
        node_name:
          type: string
          description: HA node name for the gateway, such as node0 or node1
          readOnly: true
          examples:
          - node0
        org_id:
          type: string
          description: Owning organization identifier for the gateway statistics record
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        ports:
          type: array
          items:
            $ref: '#/components/schemas/stats_gateway_port'
          description: Port statistics reported by the gateway
        route_summary_stats:
          allOf:
          - $ref: '#/components/schemas/route_summary_stats2'
          - description: Route table summary statistics for the gateway
        router_name:
          type: string
          description: Device name if configured
          readOnly: true
          examples:
          - sj1
        serial:
          type: string
          description: Gateway serial number reported by Mist
          readOnly: true
          examples:
          - TC3714190003
        service2_stat:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/service_stat_property'
          description: System service statistics for the secondary HA node
        service_stat:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/service_stat_property'
          description: System service statistics for the gateway or primary HA node
        service_status:
          allOf:
          - $ref: '#/components/schemas/stats_gateway_service_status2'
          - description: Security service status reported by the gateway
        site_id:
          type: string
          description: Associated site identifier for the gateway statistics record
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        spu2_stat:
          type: array
          items:
            $ref: '#/components/schemas/stats_gateway_spu_item'
          description: Secondary-node Services Processing Unit statistics for the gateway
        spu_stat:
          type: array
          items:
            $ref: '#/components/schemas/stats_gateway_spu_item'
          description: Services Processing Unit statistics for the gateway or primary HA node
        status:
          type: string
          description: Connection status reported for the gateway, such as connected
          readOnly: true
          examples:
          - connected
        tag_id:
          type: integer
          description: Numeric inventory tag identifier associated with the gateway
          contentEncoding: int32
        tag_uuid:
          type: string
          description: Inventory tag UUID associated with the gateway
          contentEncoding: uuid
        tunnels:
          type: array
          items:
            $ref: '#/components/schemas/stats_gateway_wan_tunnel'
          description: WAN tunnel statistics for the gateway
        type:
          const: gateway
          type: string
          description: Device type discriminator for gateway statistics
          readOnly: true
        uptime:
          type:
          - number
          - 'null'
          description: Elapsed time since the gateway last booted, in seconds
          readOnly: true
          examples:
          - 3671219
        version:
          type:
          - string
          - 'null'
          description: Software version running on the gateway
          readOnly: true
          examples:
          - 18.4R1.8
        vpn_peers:
          type: array
          items:
            $ref: '#/components/schemas/stats_gateway_vpn_peer'
          description: Remote VPN peer statistics for the gateway
      description: Gateway statistics reported by Mist for a site or organization stats response
    stats_gateway_cluster:
      title: stats_gateway_cluster
      type: object
      properties:
        state:
          type:
          - string
          - 'null'
          description: Current HA cluster state for the gateway
          readOnly: true
      description: High-availability cluster state reported by a gateway
    stats_gateway_mac_table_stats:
      title: stats_gateway_mac_table_stats
      type: object
      properties:
        mac_table_count:
          type: integer
          description: Number of MAC table entries currently learned by the gateway
          contentEncoding: int32
        max_mac_entries_supported:
          type: integer
          description: Maximum MAC table entries supported by the gateway
          contentEncoding: int32
      description: Gateway MAC table utilization counters
    stats_gateway_module_stat_item:
      title: stats_gateway_module_stat_item
      type: object
      properties:
        backup_version:
          type:
          - string
          - 'null'
          description: Backup software version stored on the gateway module
          readOnly: true
        bios_version:
          type:
          - string
          - 'null'
          description: BIOS firmware version reported for the gateway module
          readOnly: true
        boot_partition:
          type: string
          description: Active boot partition used by the gateway module
        cpld_version:
          type:
          - string
          - 'null'
          description: CPLD firmware version reported for the gateway module
          readOnly: true
        fans:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/module_stat_item_fans_items'
          description: Cooling fan status records for the gateway module
        fpga_version:
          type:
          - string
          - 'null'
          description: FPGA firmware version reported for the gateway module
          readOnly: true
        last_seen:
          type:
          - number
          - 'null'
          description: Time when Mist last observed this gateway module, in epoch seconds
          readOnly: true
          examples:
          - 1470417522
        locating:
          type: boolean
          description: Whether the gateway module locator indicator is active
        mac:
          type: string
          description: Gateway module MAC address reported by Mist
          examples:
          - fc3342123456
        memory_stat:
          allOf:
          - $ref: '#/components/schemas/memory_stat5'
          - description: Utilization statistics for gateway module memory
        model:
          type:
          - string
          - 'null'
          description: Gateway module model name reported by Mist
          readOnly: true
          examples:
          - EX4300-48P
        network_resources:
          type: array
          items:
            $ref: '#/components/schemas/module_stat_item_network_resource'
          description: Network resource utilization counters for the gateway module
        optics_cpld_version:
          type:
          - string
          - 'null'
          description: Optics CPLD firmware version reported for the gateway module
          readOnly: true
        pending_version:
          type:
          - string
          - 'null'
          description: Pending software version staged for the gateway module
          readOnly: true
        poe:
          allOf:
          - $ref: '#/components/schemas/module_stat_item_poe2'
          - description: Power over Ethernet telemetry for the gateway module
        poe_version:
          type:
          - string
          - 'null'
          description: PoE controller firmware version reported for the gateway module
          readOnly: true
        power_cpld_version:
          type:
          - string
          - 'null'
          description: Power CPLD firmware version reported for the gateway module
          readOnly: true
        psus:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/module_stat_item_psus_item'
          description: Power supply status records for the gateway module
        re_fpga_version:
          type:
          - string
          - 'null'
          description: Routing Engine FPGA firmware version reported for the gateway module
          readOnly: true
        recovery_version:
          type:
          - string
          - 'null'
          description: Recovery software version stored on the gateway module
          readOnly: true
        serial:
          type:
          - string
          - 'null'
          description: Gateway module serial number reported by Mist
          readOnly: true
          examples:
          - PX8716230021
        status:
          type:
          - string
          - 'null'
          description: Connection status reported for the gateway module
          readOnly: true
        temperatures:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/module_stat_item_temperatures_item'
          description: Temperature sensor readings for the gateway module
        tmc_fpga_version:
          type:
          - string
          - 'null'
          description: TMC FPGA firmware version reported for the gateway module
          readOnly: true
        uboot_version:
          type:
          - string
          - 'null'
          description: U-Boot firmware version reported for the gateway module
          readOnly: true
        uptime:
          type:
          - integer
          - 'null'
          description: Elapsed time since the gateway module last booted, in seconds
          contentEncoding: int32
          readOnly: true
        vc_links:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/module_stat_item_vc_links_item'
          description: Virtual chassis link records for the gateway module
        vc_mode:
          type:
          - string
          - 'null'
          description: Virtual chassis mode reported for the gateway module
          readOnly: true
        vc_role:
          type:
          - string
          - 'null'
          description: 'Virtual chassis role reported for the gateway module. enum: `master`, `backup`, `linecard`'
          readOnly: true
          examples:
          - master
        vc_state:
          type:
          - string
          - 'null'
          description: Virtual chassis state reported for the gateway module
          readOnly: true
        version:
          type:
          - string
          - 'null'
          description: Software version running on the gateway module
          readOnly: true
      description: Hardware module status and firmware inventory for a gateway
    stats_gateway_port:
      title: stats_gateway_port
      required:
      - neighbor_mac
      - port_id
      - port_mac
      type: object
      properties:
        active:
          type: boolean
          description: Indicates if interface is active/inactive
          readOnly: true
        auth_state:
          allOf:
          - $ref: '#/components/schemas/port_auth_state1'
          - description: 'Authentication state of the port. enum: ``, `authenticated`, `authenticating`, `held`, `init`.'
        disabled:
          type: boolean
          description: Indicates if interface is disabled
          readOnly: true
        for_site:
          type: boolean
          description: Whether the reporting device is scoped to a specific site
          readOnly: true
        full_duplex:
          type: boolean
          description: Indicates full or half duplex
          examples:
          - true
        jitter:
          type: number
          description: Last sampled jitter of the interface
          readOnly: true
        latency:
          type: number
          description: Last sampled latency of the interface
          readOnly: true
        loss:
          type: number
          description: Last sampled loss of the interface
          readOnly: true
        lte_iccid:
          type:
          - string
          - 'null'
          description: LTE ICCID value, Check for null/empty
        lte_imei:
          type:
          - string
          - 'null'
          description: LTE IMEI value, Check for null/empty
        lte_imsi:
          type:
          - string
          - 'null'
          description: LTE IMSI value, Check for null/empty
        mac_count:
          type: integer
          description: Number of MAC addresses in the forwarding table
          contentEncoding: int32
          readOnly: true
        mac_limit:
          minimum: 0
          type: integer
          description: Limit on number of dynamically learned macs
          contentEncoding: int32
          readOnly: true
        neighbor_mac:
          type: string
          description: chassis identifier of the chassis type listed
          readOnly: true
          examples:
          - 64d814353400
        neighbor_port_desc:
          type: string
          description: Description supplied by the system on the interface E.g. "GigabitEthernet2/0/39"
          readOnly: true
          examples:
          - GigabitEthernet1/0/21
        neighbor_system_name:
          type: string
          description: Name supplied by the system on the interface E.g. neighbor system name E.g. "Kumar-Acc-SW.mist.local"
          readOnly: true
          examples:
          - CORP-D-SW-2
        poe_disabled:
          type: boolean
          description: Is the POE configured not be disabled.
          readOnly: true
        poe_mode:
          allOf:
          - $ref: '#/components/schemas/stats_switch_port_poe_mode1'
          - description: 'PoE mode reported for the port. enum: `802.3af`, `802.3at`, `802.3bt`.'
        poe_on:
          type: boolean
          description: Is the device attached to POE
          readOnly: true
        port_id:
          type: string
          description: Identifier of the port reporting these statistics
          readOnly: true
          examples:
          - ge-0/0/0
        port_mac:
          type: string
          description: MAC address assigned to the interface
          readOnly: true
          examples:
          - 5c4527a96580
        port_usage:
          type: string
          description: Logical usage assigned to the port
          examples:
          - lan
        power_draw:
          type: number
          description: Amount of power being used by the interface at the time the command is executed. Unit in watts.
          readOnly: true
        rx_bcast_pkts:
          type: integer
          description: Number of broadcast packets received on the interface
          contentEncoding: int32
          readOnly: true
        rx_bps:
          type:
          - integer
          - 'null'
          description: Receive throughput of the port, in bits per second
          contentEncoding: int64
          readOnly: true
          examples:
          - 60003
        rx_bytes:
          type:
          - integer
          - 'null'
          description: Total bytes received on the port
          contentEncoding: int64
          readOnly: true
          examples:
          - 8515104416
        rx_errors:
          type: integer
          description: Number of receive errors observed on the interface
          contentEncoding: int32
          readOnly: true
        rx_mcast_pkts:
          type: integer
          description: Number of multicast packets received on the interface
          contentEncoding: int32
          readOnly: true
        rx_pkts:
          type:
          - integer
          - 'null'
          description: Total packets received on the port
          contentEncoding: int64
          readOnly: true
          examples:
          - 57770567
        speed:
          type: integer
          description: Current link speed of the port, in Mbps
          contentEncoding: int32
          readOnly: true
          examples:
          - 1000
        stp_role:
          allOf:
          - $ref: '#/components/schemas/port_stp_role1'
          - description: 'Current spanning tree role of the port. enum: ``, `alternate`, `backup`, `designated`, `disabled`, `root`, `root-prevented`.'
        stp_state:
          allOf:
          - $ref: '#/components/schemas/port_stp_state1'
          - description: 'Current spanning tree state of the port. enum: ``, `blocking`, `disabled`, `forwarding`, `learning`, `listening`.'
        tx_bcast_pkts:
          type: integer
          description: Number of broadcast packets transmitted on the interface
          contentEncoding: int32
          readOnly: true
        tx_bps:
          type:
          - integer
          - 'null'
          description: Transmit throughput of the port, in bits per second
          contentEncoding: int64
          readOnly: true
          examples:
          - 634301
        tx_bytes:
          type:
          - integer
          - 'null'
          description: Total bytes transmitted on the port
          contentEncoding: int64
          readOnly: true
          examples:
          - 211217389682
        tx_errors:
          type: integer
          description: Number of transmit errors observed on the interface
          contentEncoding: int32
          readOnly: true
        tx_mcast_pkts:
          type: integer
          description: Number of multicast packets transmitted on the interface
          contentEncoding: int32
          readOnly: true
        tx_pkts:
          type:
          - integer
          - 'null'
          description: Total packets transmitted on the port
          contentEncoding: int64
          readOnly: true
          examples:
          - 812204062
        type:
          allOf:
          - $ref: '#/components/schemas/stats_switch_port_type1'
          - description: 'Detected device category connected to the port, when available. enum: `ap`, `ble`, `gateway`, `mxedge`, `nac`, `switch`.'
            examples:
            - gateway
        unconfigured:
          type: boolean
          description: Indicates if interface is unconfigured
          readOnly: true
        up:
          type: boolean
          description: Indicates if interface is up
          readOnly: true
        xcvr_model:
          type: string
          description: Optic Slot ModelName, Check for null/empty
          readOnly: true
          examples:
          - SFP+-10G-SR
        xcvr_part_number:
          type: string
          description: Optic Slot Partnumber, Check for null/empty
          readOnly: true
          examples:
          - 740-021487
        xcvr_serial:
          type: string
          description: Optic Slot SerialNumber, Check for null/empty
          readOnly: true
          examples:
          - N6AA9HT
      description: Gateway port statistics record returned by stats APIs
    stats_gateway_service_status:
      title: stats_gateway_service_status
      type: object
      properties:
        appid_install_result:
          type: string
          description: Installation result reported for the AppID package
        appid_install_timestamp:
          type: string
          description: Installation time reported for the AppID package
        appid_status:
          type: string
          description: Operational status of the AppID service on the gateway
        appid_version:
          type: integer
          description: Installed AppID package version number
          contentEncoding: int32
        ewf_status:
          type: string
          description: Enhanced Web Filtering service status reported by the gateway
        idp_install_result:
          type: string
          description: Installation result reported for the intrusion detection and prevention package
        idp_install_timestamp:
          type: string
          description: Installation time reported for the intrusion detection and prevention package
        idp_policy:
          type: string
          description: Intrusion detection and prevention policy applied to the gateway
        idp_status:
          type: string
          description: Intrusion detection and prevention service status reported by the gateway
        idp_update_timestamp:
          type: string
          description: Last update time reported for the intrusion detection and prevention package
      description: Gateway security service installation and runtime status
    stats_gateway_spu_item:
      title: stats_gateway_spu_item
      type: object
      properties:
        spu_cpu:
          type: integer
          description: CPU utilization reported for the Services Processing Unit
          contentEncoding: int32
          examples:
          - 3670632
        spu_current_session:
          type: integer
          description: Current session count handled by the Services Processing Unit
          contentEncoding: int32
          examples:
          - 215
        spu_max_session:
          type: integer
          description: Maximum sessions supported by the Services Processing Unit
          contentEncoding: int32
          examples:
          - 131072
        spu_memory:
          type: integer
          description: Memory utilization reported for the Services Processing Unit
          contentEncoding: int32
          examples:
          - 46
        spu_pending_session:
          type: integer
          description: Pending session count on the Services Processing Unit
          contentEncoding: int32
          examples:
          - 0
        spu_uptime:
          type: integer
          description: Elapsed time since the Services Processing Unit started, in seconds
          contentEncoding: int32
          examples:
          - 0
        spu_valid_session:
          type: integer
          description: Valid session count currently tracked by the Services Processing Unit
          contentEncoding: int32
      description: Services Processing Unit resource and session counters
    stats_gateway_vpn_peer:
      title: stats_gateway_vpn_peer
      type: object
      properties:
        is_active:
          type: boolean
          description: Whether this VPN peer path is the active redundant path
        jitter:
          minimum: 0
          type: number
          description: Last sampled VPN peer jitter, in milliseconds
        last_seen:
          type:
          - number
          - 'null'
          description: Time when this VPN peer was last observed, in epoch seconds
          readOnly: true
          examples:
          - 1470417522
        latency:
          minimum: 0
          type: number
          description: Last sampled VPN peer latency, in milliseconds
        loss:
          maximum: 100
          minimum: 0
          type: number
          description: Packet loss observed for the VPN peer, as a percentage
        mos:
          maximum: 5
          minimum: 0
          type: number
          description: Mean Opinion Score for VPN link quality, from 0 to 5
        mtu:
          type: integer
          description: Maximum transmission unit for the VPN peer path, in bytes
          contentEncoding: int32
        peer_mac:
          minLength: 1
          type: string
          description: Peer router MAC address for the VPN link
        peer_port_id:
          minLength: 1
          type: string
          description: Peer router interface identifier for the VPN link
        peer_router_name:
          minLength: 1
          type: string
          description: Peer router name reported for the VPN link
        peer_site_id:
          type: string
          description: Site identifier for the peer side of the VPN link
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        port_id:
          minLength: 1
          type: string
          description: Local router interface identifier for the VPN link
        router_name:
          minLength: 1
          type: string
          description: Local router name reported for the VPN link
        type:
          minLength: 1
          type: string
          description: VPN implementation type for the peer, such as `ipsec` for SRX or `svr` for SSR
        up:
          type: boolean
          description: Whether the VPN peer is currently up
        uptime:
          type: integer
          description: Gateway-reported VPN peer uptime value, in seconds
          contentEncoding: int32
      description: VPN peer path statistics reported by a gateway
    stats_gateway_wan_tunnel:
      title: stats_gateway_wan_tunnel
      type: object
      properties:
        auth_algo:
          type: string
          description: Authentication algorithm negotiated for the tunnel
        encrypt_algo:
          type: string
          description: Encryption algorithm negotiated for the tunnel
        ike_version:
          type: string
          description: IKE version used to establish the tunnel
        ip:
          type: string
          description: Local IP address used by the tunnel
        last_event:
          type: string
          description: Most recent reason the tunnel went down
        last_flapped:
          type: number
          description: Indicates when the tunnel last flapped
        node:
          type: string
          description: HA node handling the tunnel, such as node0 or node1
        peer_host:
          type: string
          description: Hostname or configured peer host of the remote tunnel endpoint
        peer_ip:
          type: string
          description: IP address of the remote tunnel endpoint
        priority:
          allOf:
          - $ref: '#/components/schemas/tunnel_priority1'
          - description: 'Relative preference assigned to the tunnel. enum: `primary`, `secondary`.'
        protocol:
          allOf:
          - $ref: '#/components/schemas/wan_tunnel_protocol1'
          - description: 'Tunnel protocol used for the connection. enum: `gre`, `ipsec`.'
        rx_bytes:
          type:
          - integer
          - 'null'
          description: Total bytes received on the tunnel
          contentEncoding: int64
          readOnly: true
          examples:
          - 8515104416
        rx_pkts:
          type:
          - integer
          - 'null'
          description: Total packets received on the tunnel
          contentEncoding: int64
          readOnly: true
          examples:
          - 57770567
        tunnel_name:
          type: string
          description: Name of the Mist-managed WAN tunnel
        tx_bytes:
          type:
          - integer
          - 'null'
          description: Total bytes transmitted on the tunnel
          contentEncoding: int64
          readOnly: true
          examples:
          - 211217389682
        tx_pkts:
          type:
          - integer
          - 'null'
          description: Total packets transmitted on the tunnel
          contentEncoding: int64
          readOnly: true
          examples:
          - 812204062
        up:
          type: boolean
          description: Indicates whether the tunnel is currently up
        uptime:
          type: integer
          description: Duration since the tunnel security association was established
          contentEncoding: int32
        wan_name:
          type: string
          description: Name of the WAN interface carrying the tunnel
          examples:
          - wan
      description: WAN tunnel statistics reported by a gateway
    stats_marvis_client:
      title: stats_marvis_client
      type: object
      properties:
        battery_charging:
          type: boolean
          description: Whether the device battery is currently charging
        battery_level:
          type: integer
          description: Battery level percentage (0–100)
          contentEncoding: int32
        cpu_background:
          type: number
          description: Background CPU utilization (0–100)
        cpu_idle:
          type: number
          description: Idle CPU percentage (0–100)
        cpu_system:
          type: number
          description: System CPU utilization (0–100)
        cpu_user:
          type: number
          description: User-space CPU utilization (0–100)
        device_id:
          type: string
          description: UUID of the device the Marvis Client is installed on
          contentEncoding: uuid
        hostname:
          type: string
          description: Device hostname
        location:
          allOf:
          - $ref: '#/components/schemas/stats_marvis_client_location1'
          - description: Last known device location
        memory_total:
          type: integer
          description: Total device memory, in bytes
          contentEncoding: int32
        memory_usage:
          type: integer
          description: Memory in use, in bytes
          contentEncoding: int32
        mfg:
          type: string
          description: Device manufacturer
        model:
          type: string
          description: Device model name
        org_id:
          type: string
          description: Organization UUID
          contentEncoding: uuid
        os_type:
          type: string
          description: OS type or platform (e.g. Android, iOS)
        os_version:
          type: string
          description: OS version string
        serial:
          type: string
          description: Device serial number
        storage_total:
          type: integer
          description: Total device storage, in bytes
          contentEncoding: int32
        storage_usage:
          type: integer
          description: Storage in use, in bytes
          contentEncoding: int32
        timestamp:
          type: integer
          description: Timestamp of the stats record, in epoch seconds
          contentEncoding: int32
        wifi_band:
          type: string
          description: Wi-Fi band the device is connected on
        wifi_bssid:
          type: string
          description: BSSID the device is connected to
        wifi_channel:
          type: integer
          description: Wi-Fi channel the device is on
          contentEncoding: int32
        wifi_ip:
          type: string
          description: Device Wi-Fi IP address
        wifi_mac:
          type: string
          description: Device Wi-Fi MAC address
        wifi_rssi:
          type: integer
          description: Wi-Fi RSSI, in dBm
          contentEncoding: int32
        wifi_ssid:
          type: string
          description: SSID the device is connected to
      description: Marvis Client stats record returned by search
    stats_marvis_client_location:
      title: stats_marvis_client_location
      type: object
      properties:
        map_id:
          type: string
          description: UUID of the floor-plan map
          contentEncoding: uuid
        site_id:
          type: string
          description: UUID of the site the device was located in
          contentEncoding: uuid
        timestamp:
          type: integer
          description: Timestamp of the location fix, in epoch seconds
          contentEncoding: int32
        x:
          type: number
          description: X coordinate on the floor-plan map, in pixels
        y:
          type: number
          description: Y coordinate on the floor-plan map, in pixels
      description: Last known location fix for a Marvis Client device
    stats_marvis_clients_search:
      title: stats_marvis_clients_search
      type: object
      properties:
        limit:
          type: integer
          description: Maximum number of results requested
          contentEncoding: int32
        results:
          type: array
          items:
            $ref: '#/components/schemas/stats_marvis_client'
          description: List of Marvis Client stats records
        total:
          type: integer
          description: Total number of matching results
          contentEncoding: int32
      description: Paginated list of Marvis Client stats records
    stats_mxedge:
      title: stats_mxedge
      type: object
      properties:
        cpu_stat:
          allOf:
          - $ref: '#/components/schemas/stats_mxedge_cpu_stat2'
          - description: CPU utilization statistics reported by the Mist Edge
        created_time:
          type: number
          description: Time when the Mist Edge record was created, in epoch seconds
          readOnly: true
        fips_enabled:
          type: boolean
          description: Whether FIPS mode is enabled on the Mist Edge
        for_site:
          type: boolean
          description: Whether the Mist Edge is assigned directly to a site
          examples:
          - false
        fwupdate:
          allOf:
          - $ref: '#/components/schemas/fwupdate_stat5'
          - description: Firmware or package update status for the Mist Edge
        id:
          type: string
          description: Unique identifier of the Mist Edge
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        idrac_version:
          type: string
          description: IDRAC version of the mist edge device
          examples:
          - 7.00.00.00
        inactive_vlan_strs:
          allOf:
          - $ref: '#/components/schemas/stats_mxedge_inactive_vlan_strs2'
          - description: Inactive VLAN identifiers reported by the Mist Edge
        ip_stat:
          allOf:
          - $ref: '#/components/schemas/stats_mxedge_ip_stat2'
          - description: IP address statistics reported by the Mist Edge
        kernel_abi:
          type: string
          description: Kernel release version running on the Mist Edge
          examples:
          - 6.1.0-47
        kernel_version:
          type: string
          description: Kernel package version running on the Mist Edge
          examples:
          - 6.1.170-3
        lag_stat:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/stats_mxedge_lag_stat'
          description: Link aggregation statistics reported by the Mist Edge
          examples:
          - lacp0:
              active_ports:
              - port0
              - port1
        last_seen:
          type:
          - number
          - 'null'
          description: Time when Mist last observed the Mist Edge, in epoch seconds
          readOnly: true
          examples:
          - 1470417522
        mac:
          type: string
          description: Mist Edge MAC address reported by Mist
          examples:
          - 020000a80cb4
        magic:
          type: string
          description: Claim magic token associated with the Mist Edge
        memory_stat:
          allOf:
          - $ref: '#/components/schemas/stats_mxedge_memory_stat2'
          - description: Memory utilization statistics reported by the Mist Edge
        model:
          type: string
          description: Mist Edge hardware or VM model
          examples:
          - ME-VM
        modified_time:
          type: number
          description: Time when the Mist Edge record was last modified, in epoch seconds
          readOnly: true
        mxagent_registered:
          type: boolean
          description: Whether the Mist Edge management agent is registered with Mist
          examples:
          - true
        mxcluster_id:
          type: string
          description: Mist Edge cluster identifier associated with this Mist Edge
          contentEncoding: uuid
          examples:
          - 678bc339-7635-4556-bbc0-e77ad493ef8b
        name:
          type: string
          description: Display name of the Mist Edge
          examples:
          - me-vm-1
        num_tunnels:
          type: integer
          description: Number of tunnels currently terminated by the Mist Edge
          contentEncoding: int32
          examples:
          - 0
        oob_ip_config:
          allOf:
          - $ref: '#/components/schemas/mxedge_oob_ip_config2'
          - description: Configured out-of-band management IP settings for the Mist Edge
        oob_ip_stat:
          allOf:
          - $ref: '#/components/schemas/stats_mxedge_oob_ip_stat2'
          - description: Observed out-of-band management IP status for the Mist Edge
        org_id:
          type: string
          description: Organization identifier associated with the Mist Edge
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        port_stat:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/stats_mxedge_port_stat'
          description: Port statistics reported by the Mist Edge
          examples:
          - port0:
              full_duplex: true
              mac: 9e294e49091d
              rx_bytes: 646898375700
              rx_errors: 0
              rx_pkts: 8784449574
              speed: 10000
              state: forwarding
              tx_bytes: 647200748038
              tx_errors: 0
              tx_pkts: 8788647466
              up: true
            port1:
              full_duplex: true
              mac: a270fe53437e
              rx_bytes: 647200437652
              rx_errors: 0
              rx_pkts: 8788644886
              speed: 10000
              state: forwarding
              tx_bytes: 646898681650
              tx_errors: 0
              tx_pkts: 8784452092
              up: true
        serial:
          type:
          - string
          - 'null'
          description: Device serial number reported for the Mist Edge, when available
        service_stat:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/stats_mxedge_service_stat'
          description: Per-service runtime statistics reported by the Mist Edge
          examples:
          - mxagent:
              ext_ip: 99.0.86.164
              last_seen: 1633721215
              package_state: Installed
              package_version: 3.1.1037-1
              running_state: Running
              uptime: 21240
            tunterm:
              ext_ip: 99.0.86.164
              last_seen: 1633721203
              package_state: Installed
              package_version: 0.1.2449+deb10
              running_state: Running
              uptime: 76261
        services:
          type: array
          items:
            type: string
          description: Mist Edge services enabled or running on the device
          examples:
          - - tunterm
        site_id:
          type: string
          description: Site identifier associated with the Mist Edge, when assigned to a site
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        status:
          type: string
          description: Connection status reported for the Mist Edge, such as connected
          examples:
          - connected
        tunterm_ip_config:
          allOf:
          - $ref: '#/components/schemas/stats_mxedge_tunterm_ip_config2'
          - description: Configured tunnel termination IP settings for the Mist Edge
        tunterm_port_config:
          allOf:
          - $ref: '#/components/schemas/stats_mxedge_tunterm_port_config2'
          - description: Tunnel termination port configuration reported for the Mist Edge
        tunterm_registered:
          type: boolean
          description: Whether the tunnel termination service is registered with Mist
          examples:
          - true
        tunterm_stat:
          allOf:
          - $ref: '#/components/schemas/stats_mxedge_tunterm_stat2'
          - description: Tunnel termination monitoring status reported by the Mist Edge
        uptime:
          type: integer
          description: Number of seconds the Mist Edge has been running since last boot
          contentEncoding: int32
          examples:
          - 76281
        virtualization_type:
          type: string
          description: Virtualization platform or environment running the Mist Edge VM
          examples:
          - KVM
      description: Statistics for a Mist Edge appliance returned by stats endpoints
    stats_mxedge_cpu_stat:
      title: stats_mxedge_cpu_stat
      type: object
      properties:
        cpus:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/cpu_stat'
          description: Per-core CPU utilization statistics keyed by CPU name
          examples:
          - cpu0:
              idle: 89
              interrupt: 0
              system: 8
              usage: 10
              user: 1
            cpu1:
              idle: 81
              interrupt: 0
              system: 4
              usage: 18
              user: 13
            cpu2:
              idle: 81
              interrupt: 0
              system: 4
              usage: 18
              user: 13
            cpu3:
              idle: 2
              interrupt: 0
              system: 50
              usage: 97
              user: 46
        idle:
          type: integer
          description: Percentage of Idle, Idle/(Idle + Busy) since last sampling
          contentEncoding: int32
          examples:
          - 62
        interrupt:
          type: integer
          description: Percentage of Interrupt, (Irq + SoftIrq)/(Idle + Busy) since last sampling
          contentEncoding: int32
          examples:
          - 0
        system:
          type: integer
          description: Percentage of System, System/(Idle + Busy) since last sampling
          contentEncoding: int32
          examples:
          - 17
        usage:
          type: integer
          description: Percentage of load, Busy/(Idle + Busy) since last sampling
          contentEncoding: int32
          examples:
          - 37
        user:
          type: integer
          description: Percentage of User, User/(Idle + Busy) since last sampling
          contentEncoding: int32
          examples:
          - 19
      description: Aggregate and per-core CPU utilization statistics for a Mist Edge
    stats_mxedge_inactive_vlan_strs:
      title: stats_mxedge_inactive_vlan_strs
      type: object
      properties:
        l2tp:
          type: array
          items:
            type: string
          description: Inactive L2TP VLANs. Entries can be individual VLANs or ranges.
        wired:
          type: array
          items:
            type: string
          description: Inactive wired VLANs. Entries can be individual VLANs or ranges.
          examples:
          - - '100'
            - 102-106
      description: Inactive wired/L2TP VLANs. Entries can be individual VLANs or ranges.
    stats_mxedge_ip_stat:
      title: stats_mxedge_ip_stat
      type: object
      properties:
        ip:
          type: string
          description: Primary IPv4 address reported for the Mist Edge
          examples:
          - 192.168.1.244
        ip6:
          type: string
          description: Primary IPv6 address reported for the Mist Edge
          examples:
          - fd4e:c615:b27d:5555::45
        ips:
          type: object
          additionalProperties:
            type: string
          description: Interface IP addresses keyed by interface name
          examples:
          - ens18: 92.168.1.244/24,fd4e:c615:b27d:5555::45/128,fd4e:c615:b27d:5555:20c:29ff:fe44:af25/64,fe80::104c:ffff:fee0:caf8/64
        macs:
          type: object
          additionalProperties:
            type: string
          description: Interface MAC addresses keyed by interface name
          examples:
          - ens18: e4434b217044
        netmask:
          type: string
          description: IPv4 netmask reported for the primary Mist Edge address
          examples:
          - 255.255.255.0
        netmask6:
          type: string
          description: IPv6 prefix length reported for the primary Mist Edge address
          examples:
          - /128
      description: IP address statistics reported by a Mist Edge
    stats_mxedge_lag_stat:
      title: stats_mxedge_lag_stat
      type: object
      properties:
        active_ports:
          type: array
          items:
            type: string
          description: Ports currently active in the link aggregation group
      description: Link aggregation group status for a Mist Edge
    stats_mxedge_memory_stat:
      title: stats_mxedge_memory_stat
      type: object
      properties:
        active:
          type: integer
          description: The amount of memory, in kilobytes, that has been used more recently and is usually not reclaimed unless absolutely necessary.
          contentEncoding: int32
          examples:
          - 394936320
        available:
          type: integer
          description: An estimate of how much memory is available for starting new applications, without swapping.
          contentEncoding: int64
          examples:
          - 4699291648
        buffers:
          type: integer
          description: The amount, in kilobytes, of temporary storage for raw disk blocks.
          contentEncoding: int32
          examples:
          - 107646976
        cached:
          type: integer
          description: The amount of physical RAM, in kilobytes, used as cache memory.
          contentEncoding: int32
          examples:
          - 478060544
        free:
          type: integer
          description: The amount of physical RAM, in kilobytes, left unused by the system
          contentEncoding: int64
          examples:
          - 4330659840
        inactive:
          type: integer
          description: The amount of memory, in kilobytes, that has been used less recently and is more eligible to be reclaimed for other purposes.
          contentEncoding: int32
          examples:
          - 211980288
        swap_cached:
          type: integer
          description: The amount of memory, in kilobytes, that has once been moved into swap, then back into the main memory, but still also remains in the swapfile.
          contentEncoding: int32
          examples:
          - 0
        swap_free:
          type: integer
          description: The total amount of swap free, in kilobytes.
          contentEncoding: int32
          examples:
          - 1022357504
        swap_total:
          type: integer
          description: The total amount of swap available, in kilobytes.
          contentEncoding: int32
          examples:
          - 1022357504
        total:
          type: integer
          description: Usable RAM total, in kilobytes, which is physical RAM minus a number of reserved bits and the kernel binary code
          contentEncoding: int64
          examples:
          - 8365957120
        usage:
          type: integer
          description: Memory utilization percentage reported by the Mist Edge
          contentEncoding: int32
          examples:
          - 48
      description: Memory usage counters reported by a Mist Edge
    stats_mxedge_oob_ip_stat:
      title: stats_mxedge_oob_ip_stat
      type: object
      properties:
        dns:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Out-of-band management DNS servers
        gateway:
          type: string
          description: IPv4 default gateway for out-of-band management
        gateway6:
          type: string
          description: IPv6 default gateway for out-of-band management
        ip:
          type: string
          description: Out-of-band management IPv4 address
        ip6:
          type: string
          description: Out-of-band management IPv6 address
        netmask:
          type: string
          description: IPv4 netmask for the out-of-band management interface
        netmask6:
          type: string
          description: IPv6 prefix length for the out-of-band management interface
        type:
          allOf:
          - $ref: '#/components/schemas/mxedge_mgmt_oob_ip_type2'
          - description: 'IPv4 address assignment mode for out-of-band management. enum: `dhcp`, `disabled`, `static`.'
        type8:
          allOf:
          - $ref: '#/components/schemas/mxedge_mgmt_oob_ip_type62'
          - description: 'IPv6 address assignment mode for out-of-band management. enum: `autoconf`, `dhcp`, `disabled`, `static`.'
      description: Observed out-of-band management IP settings for a Mist Edge
    stats_mxedge_port_stat:
      title: stats_mxedge_port_stat
      type: object
      properties:
        full_duplex:
          type: boolean
          description: Whether the port is operating in full-duplex mode
        lacp:
          allOf:
          - $ref: '#/components/schemas/stats_mxedge_port_stat_lacp2'
          - description: Link aggregation control protocol state and packet counters for the port
        lldp_stats:
          allOf:
          - $ref: '#/components/schemas/stats_mxedge_port_stat_lldp_stats2'
          - description: LLDP neighbor information learned on the port
        mac:
          type: string
          description: Mist Edge port MAC address reported by Mist
        rx_bytes:
          type:
          - integer
          - 'null'
          description: Total bytes received on the port
          contentEncoding: int64
          readOnly: true
          examples:
          - 8515104416
        rx_errors:
          type: integer
          description: Number of receive errors observed on the port
          contentEncoding: int32
        rx_pkts:
          type:
          - integer
          - 'null'
          description: Total packets received on the port
          contentEncoding: int64
          readOnly: true
          examples:
          - 57770567
        sfp:
          allOf:
          - $ref: '#/components/schemas/stats_mxedge_port_stat_sfp2'
          - description: Transceiver details reported for the SFP module on the port
        speed:
          type: integer
          description: Current link speed of the port, in Mbps
          contentEncoding: int32
        state:
          type: string
          description: Forwarding or operational state reported for the port
        tx_bytes:
          type:
          - integer
          - 'null'
          description: Total bytes transmitted from the port
          contentEncoding: int64
          readOnly: true
          examples:
          - 211217389682
        tx_errors:
          type: integer
          description: Number of transmit errors observed on the port
          contentEncoding: int32
        tx_pkts:
          type:
          - integer
          - 'null'
          description: Total packets transmitted from the port
          contentEncoding: int64
          readOnly: true
          examples:
          - 812204062
        up:
          type: boolean
          description: Whether the Mist Edge port link is up
      description: Mist Edge port traffic and link status statistics
    stats_mxedge_port_stat_lacp:
      title: stats_mxedge_port_stat_lacp
      type: object
      properties:
        mux_state:
          type: string
          description: LACP multiplexer state reported for the port
        rx_lacpdu:
          type: integer
          description: Number of LACPDUs received on the port
          contentEncoding: int32
        rx_state:
          type: string
          description: LACP receive state reported for the port
        tx_lacpdu:
          type: integer
          description: Number of LACPDUs transmitted from the port
          contentEncoding: int32
      description: LACP state and counters for a Mist Edge port
    stats_mxedge_port_stat_lldp_stats:
      title: stats_mxedge_port_stat_lldp_stats
      type: object
      properties:
        chassis_id:
          type: string
          description: LLDP chassis identifier advertised by the neighbor
        mgmt_addr:
          type: string
          description: Management address advertised by the LLDP neighbor
        port_desc:
          type: string
          description: Port description advertised by the LLDP neighbor
        port_id:
          type: string
          description: Port identifier advertised by the LLDP neighbor
        system_desc:
          type: string
          description: System description advertised by the LLDP neighbor
        system_name:
          type: string
          description: System name advertised by the LLDP neighbor
      description: LLDP neighbor information reported for a Mist Edge port
    stats_mxedge_port_stat_sfp:
      title: stats_mxedge_port_stat_sfp
      type: object
      properties:
        codes:
          type: string
          description: Transceiver capability codes reported by the SFP module
        mbps:
          type: integer
          description: Nominal transceiver speed, in Mbps
          contentEncoding: int32
        part_no:
          type: string
          description: Manufacturer part number reported by the SFP module
        serial_no:
          type: string
          description: Manufacturer serial number reported by the SFP module
        type:
          type: integer
          description: Transceiver type code reported by the SFP module
          contentEncoding: int32
        vendor:
          type: string
          description: Manufacturer name reported by the SFP module
      description: SFP transceiver details reported for a Mist Edge port
    stats_mxedge_service_stat:
      title: stats_mxedge_service_stat
      type: object
      properties:
        ext_ip:
          type: string
          description: External IP from ep-terminator’s point of view. valid only for service having its own cloud connection
        last_seen:
          type: number
          description: Cloud Unix time, in seconds, when stats were last seen for this service, or the latest service last_seen time for whole-system records
        package_state:
          type: string
          description: Installation state of the Mist Edge service package
        package_version:
          type: string
          description: Installed version of the Mist Edge service package
        running_state:
          type: string
          description: Runtime state reported by the Mist Edge service
        uptime:
          type: integer
          description: Elapsed running time reported by the Mist Edge service, in seconds
          contentEncoding: int32
      description: Runtime and package state for one Mist Edge service
    stats_mxedge_tunterm_ip_config:
      title: stats_mxedge_tunterm_ip_config
      type: object
      properties:
        gateway:
          type: string
          description: IPv4 default gateway for tunnel termination traffic
          examples:
          - 192.168.11.1
        ip:
          type: string
          description: Tunnel termination IPv4 address used by the Mist Edge
          examples:
          - 192.168.11.91
        netmask:
          type: string
          description: IPv4 netmask for the tunnel termination address
          examples:
          - 255.255.255.0
      description: Tunnel termination IP configuration reported by a Mist Edge
    stats_mxedge_tunterm_port_config:
      title: stats_mxedge_tunterm_port_config
      type: object
      properties:
        downstream_ports:
          type: array
          items:
            type: string
          description: Ports configured for downstream tunnel termination traffic
          examples:
          - - '0'
            - '1'
        separate_upstream_downstream:
          type: boolean
          description: Whether separate port sets are used for upstream and downstream tunnel termination traffic
          examples:
          - false
        upstream_ports:
          type: array
          items:
            type: string
          description: Ports configured for upstream tunnel termination traffic
          examples:
          - - '0'
            - '1'
      description: Tunnel termination port role configuration reported by a Mist Edge
    stats_mxedge_tunterm_stat:
      title: stats_mxedge_tunterm_stat
      type: object
      properties:
        monitoring_failed:
          type: boolean
          description: Whether tunnel termination monitoring is currently failing
          examples:
          - false
      description: Tunnel termination monitoring status reported by a Mist Edge
    stats_mxtunnel:
      title: stats_mxtunnel
      required:
      - remote_ip
      type: object
      properties:
        ap:
          type: string
          description: MAC address of the AP associated with the tunnel statistics
          readOnly: true
        for_site:
          type: boolean
          description: Whether the tunnel statistics are scoped to a site
          readOnly: true
        fwupdate:
          allOf:
          - $ref: '#/components/schemas/fwupdate_stat1'
          - description: Firmware update status included with the tunnel statistics, when available
        last_seen:
          type:
          - number
          - 'null'
          description: Time when the tunnel statistics were last observed
          readOnly: true
          examples:
          - 1470417522
        mtu:
          type: integer
          description: Maximum transmission unit reported for the tunnel path
          contentEncoding: int32
          readOnly: true
        mxcluster_id:
          type: string
          description: Mist Edge cluster identifier associated with the tunnel statistics
          contentEncoding: uuid
          readOnly: true
        mxedge_id:
          type: string
          description: Mist Edge identifier for the tunnel endpoint
          contentEncoding: uuid
          readOnly: true
        mxtunnel_id:
          type: string
          description: Mist tunnel identifier associated with the tunnel statistics
          contentEncoding: uuid
          readOnly: true
        org_id:
          type: string
          description: Organization identifier associated with the tunnel statistics
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        peer_mxedge_id:
          type: string
          description: MxEdge ID of the peer(mist edge to mist edge tunnel)
          contentEncoding: uuid
          readOnly: true
        remote_ip:
          type: string
          description: Remote endpoint IP address for the tunnel
          readOnly: true
        remote_port:
          type: integer
          description: Remote endpoint port for the tunnel
          contentEncoding: int32
          readOnly: true
        sessions:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/stats_mxtunnel_session'
          description: WxLAN tunnel sessions reported for this tunnel
          readOnly: true
        site_id:
          type: string
          description: Site identifier associated with the tunnel statistics
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        start_time:
          type: integer
          description: Epoch timestamp when the tunnel was established
          contentEncoding: int32
          readOnly: true
        state:
          allOf:
          - $ref: '#/components/schemas/stats_mxtunnel_state2'
          - description: 'Current state of the WxLAN or Mist tunnel. enum: `established`, `established_with_sessions`, `idle`, `wait-ctrl-conn`, `wait-ctrl-reply`.'
          readOnly: true
      description: WxLAN or Mist tunnel statistics record
    stats_mxtunnel_session:
      title: stats_mxtunnel_session
      required:
      - local_sid
      - remote_id
      - remote_sid
      - state
      type: object
      properties:
        local_sid:
          type: integer
          description: Local session identifier for the tunnel session
          contentEncoding: int32
        remote_id:
          type: string
          description: Configured remote identifier for the tunnel session
        remote_sid:
          type: integer
          description: Peer session identifier for the tunnel session
          contentEncoding: int32
        state:
          type: string
          description: Current state of the tunnel session
      description: Session information for a WxLAN or Mist tunnel
    stats_mxtunnel_state:
      title: stats_mxtunnel_state
      enum:
      - established
      - established_with_sessions
      - idle
      - wait-ctrl-conn
      - wait-ctrl-reply
      type: string
      description: 'enum: `established`, `established_with_sessions`, `idle`, `wait-ctrl-conn`, `wait-ctrl-reply`'
    stats_org:
      title: stats_org
      required:
      - alarmtemplate_id
      - allow_mist
      - created_time
      - id
      - modified_time
      - msp_id
      - name
      - num_devices
      - num_devices_connected
      - num_devices_disconnected
      - num_inventory
      - num_sites
      - orggroup_ids
      - session_expiry
      - sle
      type: object
      properties:
        alarmtemplate_id:
          type: string
          description: Organization-level alarm template identifier used as the default for sites
          contentEncoding: uuid
        allow_mist:
          type: boolean
          description: Whether Mist support access is allowed for this organization
        created_time:
          type: number
          description: Time when the organization was created, in epoch seconds
          readOnly: true
        id:
          type: string
          description: Unique identifier of the organization
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        modified_time:
          type: number
          description: Time when the organization was last modified, in epoch seconds
          readOnly: true
        msp_id:
          type: string
          description: Managed service provider identifier associated with the organization
          contentEncoding: uuid
          readOnly: true
          examples:
          - b9d42c2e-88ee-41f8-b798-f009ce7fe909
        name:
          type: string
          description: Display name of the organization
        num_devices:
          type: integer
          description: Total number of devices in the organization
          contentEncoding: int32
        num_devices_connected:
          type: integer
          description: Number of organization devices currently connected to Mist
          contentEncoding: int32
        num_devices_disconnected:
          type: integer
          description: Number of organization devices currently disconnected from Mist
          contentEncoding: int32
        num_inventory:
          type: integer
          description: Number of devices in the organization's inventory
          contentEncoding: int32
        num_sites:
          type: integer
          description: Number of sites in the organization
          contentEncoding: int32
        orggroup_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Organization group identifiers that include this organization
        session_expiry:
          type: integer
          description: Admin session lifetime for the organization, in minutes
          contentEncoding: int64
        sle:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/stats_org_sle'
          description: Service level expectation summaries for the organization
      description: Organization statistics summary returned by the org stats endpoint
    stats_org_sle:
      title: stats_org_sle
      required:
      - path
      type: object
      properties:
        path:
          type: string
          description: SLE path represented by this organization summary
        user_minutes:
          allOf:
          - $ref: '#/components/schemas/stats_org_sle_user_minutes2'
          - description: User-minute totals for this SLE path
      description: Organization SLE summary for a service path
    stats_org_sle_user_minutes:
      title: stats_org_sle_user_minutes
      required:
      - ok
      - total
      type: object
      properties:
        ok:
          type: number
          description: User minutes that met the SLE target
        total:
          type: number
          description: Observed total user minutes for the SLE path
      description: User-minute totals for an organization SLE summary
    stats_rssi_zone:
      title: stats_rssi_zone
      required:
      - devices
      - id
      - name
      type: object
      properties:
        assets_wait:
          allOf:
          - $ref: '#/components/schemas/stats_zone_assets_waits3'
          - description: BLE asset wait-time summary for the RSSI zone
        clients_wait:
          allOf:
          - $ref: '#/components/schemas/stats_zone_clients_waits3'
          - description: Wi-Fi client wait-time summary for the RSSI zone
        created_time:
          type: number
          description: Time when the RSSI zone was created, in epoch seconds
          readOnly: true
        devices:
          type: array
          items:
            $ref: '#/components/schemas/stats_rssi_zones_device'
          description: AP devices and RSSI thresholds that define the RSSI zone
        discovered_assets_wait:
          allOf:
          - $ref: '#/components/schemas/stats_zone_discovered_assets_waits3'
          - description: Discovered BLE asset wait-time summary for the RSSI zone
        id:
          type: string
          description: Unique identifier of the RSSI zone
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        modified_time:
          type: number
          description: Time when the RSSI zone was last modified, in epoch seconds
          readOnly: true
        name:
          type: string
          description: Display name of the RSSI zone
          examples:
          - Zone A
        num_assets:
          type: integer
          description: Number of BLE assets currently counted in the RSSI zone
          contentEncoding: int32
          examples:
          - 0
        num_clients:
          type: integer
          description: Number of Wi-Fi clients (unconnected + connected)
          contentEncoding: int32
          examples:
          - 80
        num_discovered_assets:
          type: integer
          description: Number of discovered BLE assets currently counted in the RSSI zone
          contentEncoding: int32
          examples:
          - 0
        num_sdkclients:
          type: integer
          description: Number of SDK clients currently counted in the RSSI zone
          contentEncoding: int32
          examples:
          - 10
        num_unconnected_clients:
          type: integer
          description: Number of unconnected Wi-Fi clients
          contentEncoding: int32
          examples:
          - 80
        occupancy_limit:
          type: integer
          description: Configured occupancy limit for the RSSI zone
          contentEncoding: int32
          examples:
          - 4
        org_id:
          type: string
          description: Organization identifier associated with the RSSI zone
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        sdkclients_wait:
          allOf:
          - $ref: '#/components/schemas/stats_zone_sdkclients_waits3'
          - description: SDK client wait-time summary for the RSSI zone
        site_id:
          type: string
          description: Site identifier associated with the RSSI zone
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        unconnected_clients_wait:
          allOf:
          - $ref: '#/components/schemas/stats_zone_unconnected_clients_waits3'
          - description: Unconnected Wi-Fi client wait-time summary for the RSSI zone
      description: RSSI-based zone statistics for a site
    stats_rssi_zones_device:
      title: stats_rssi_zones_device
      type: object
      properties:
        device_id:
          type: string
          description: Identifier of the AP device used by this RSSI zone
          contentEncoding: uuid
        rssi:
          type: integer
          description: Minimum RSSI threshold for considering a device inside the zone
          contentEncoding: int32
      description: AP device and RSSI threshold used by an RSSI zone
    stats_sdkclient:
      title: stats_sdkclient
      required:
      - id
      - network_connection
      - uuid
      type: object
      properties:
        id:
          type: string
          description: Unique value identifying the SDK client
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        last_seen:
          type:
          - number
          - 'null'
          description: Time when the SDK client was last observed, in epoch seconds
          readOnly: true
          examples:
          - 1470417522
        map_id:
          type:
          - string
          - 'null'
          description: Map identifier for the SDK client's location, if known
          contentEncoding: uuid
          examples:
          - 845a23bf-bed9-e43c-4c86-6fa474be7ae5
        name:
          type: string
          description: Display name provided for the SDK client
          examples:
          - John's iPhone
        network_connection:
          allOf:
          - $ref: '#/components/schemas/stats_sdkclient_network_connection1'
          - description: Current network connection details for the SDK client
        uuid:
          type: string
          description: Application UUID for the SDK client
          contentEncoding: uuid
          examples:
          - ada72f8f-1643-e5c6-94db-f2a5636f1a64
        x:
          type: number
          description: Horizontal map coordinate of the SDK client location, in pixels, if known
          examples:
          - 60
        y:
          type: number
          description: Vertical map coordinate of the SDK client location, in pixels, if known
          examples:
          - 80
      description: Detailed statistics for an individual SDK client
    stats_sdkclient_network_connection:
      title: stats_sdkclient_network_connection
      required:
      - mac
      - rssi
      - signal_level
      - type
      type: object
      properties:
        mac:
          type: string
          description: Current network connection MAC address reported for the SDK client
        rssi:
          type: number
          description: Received signal strength indicator for the SDK client's current network connection, in dBm
        signal_level:
          type: number
          description: Numeric signal quality level reported with the SDK client's current network connection
        type:
          type: string
          description: Network connection type reported for the SDK client, such as WiFi
      description: Current network connection details reported for an SDK client
    stats_site:
      title: stats_site
      required:
      - country_code
      - created_time
      - id
      - latlng
      - modified_time
      - name
      - num_ap
      - num_ap_connected
      - num_clients
      - num_devices
      - num_devices_connected
      - num_gateway
      - num_gateway_connected
      - num_switch
      - num_switch_connected
      - org_id
      - timezone
      - tzoffset
      type: object
      properties:
        address:
          type: string
          description: Configured physical address for the site
        alarmtemplate_id:
          type:
          - string
          - 'null'
          description: Alarm template applied to the site, when one overrides the organization-level alarm template
          contentEncoding: uuid
        analyticEnabled:
          type: boolean
          description: Whether analytics features are enabled for the site
        aptemplate_id:
          type:
          - string
          - 'null'
          description: AP template applied to access points in the site, when configured
          contentEncoding: uuid
        country_code:
          type: string
          description: Two-letter country code used for site configuration generation
        created_time:
          type: number
          description: Time when the site was created, in epoch seconds
          readOnly: true
        engagementEnabled:
          type: boolean
          description: Whether engagement features are enabled for the site
        gatewaytemplate_id:
          type:
          - string
          - 'null'
          description: Gateway template applied to gateways in the site, when configured
          contentEncoding: uuid
        id:
          type: string
          description: Unique identifier for the site
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        lat:
          type: number
          description: Geographic latitude coordinate for the site location
        latlng:
          allOf:
          - $ref: '#/components/schemas/lat_lng2'
          - description: Latitude and longitude for the site location
        lng:
          type: number
          description: Longitude coordinate for the site location
        modified_time:
          type: number
          description: Time when the site was last modified, in epoch seconds
          readOnly: true
        msp_id:
          type: string
          description: Managing MSP identifier for the site, when applicable
          contentEncoding: uuid
          readOnly: true
          examples:
          - b9d42c2e-88ee-41f8-b798-f009ce7fe909
        name:
          type: string
          description: Display name of the site
        networktemplate_id:
          type:
          - string
          - 'null'
          description: Network template applied to the site, when configured
          contentEncoding: uuid
        notes:
          type: string
          description: Free-form notes configured for the site
        num_ap:
          type: integer
          description: Number of access points in the site
          contentEncoding: int32
        num_ap_connected:
          type: integer
          description: Number of access points currently connected in the site
          contentEncoding: int32
        num_clients:
          type: integer
          description: Number of clients currently counted in the site
          contentEncoding: int32
        num_devices:
          type: integer
          description: Number of managed devices in the site
          contentEncoding: int32
        num_devices_connected:
          type: integer
          description: Number of managed devices currently connected in the site
          contentEncoding: int32
        num_gateway:
          type: integer
          description: Number of gateways in the site
          contentEncoding: int32
        num_gateway_connected:
          type: integer
          description: Number of gateways currently connected in the site
          contentEncoding: int32
        num_switch:
          type: integer
          description: Number of switches in the site
          contentEncoding: int32
        num_switch_connected:
          type: integer
          description: Number of switches currently connected in the site
          contentEncoding: int32
        org_id:
          type: string
          description: Owning organization identifier for the site
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        rftemplate_id:
          type:
          - string
          - 'null'
          description: RF template applied to the site, when configured
          contentEncoding: uuid
        secpolicy_id:
          type:
          - string
          - 'null'
          description: Security policy applied to the site, when configured
          contentEncoding: uuid
        sitegroup_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Site group identifiers for groups that include this site
        sitetemplate_id:
          type:
          - string
          - 'null'
          description: Site template applied to the site, when configured
          contentEncoding: uuid
        timezone:
          type: string
          description: IANA time zone name for the site
        tzoffset:
          type: integer
          description: Time zone offset value derived from the site's timezone
          contentEncoding: int32
      description: Site metadata and aggregate device/client counts returned by organization site stats endpoints
    stats_switch:
      title: stats_switch
      required:
      - type
      type: object
      properties:
        ap_redundancy:
          allOf:
          - $ref: '#/components/schemas/stats_switch_ap_redundancy2'
          - description: AP redundancy statistics associated with the switch
        arp_table_stats:
          allOf:
          - $ref: '#/components/schemas/arp_table_stats1'
          - description: ARP table utilization statistics for the switch
        auto_upgrade_stat:
          allOf:
          - $ref: '#/components/schemas/stats_ap_auto_upgrade2'
          - description: Automatic firmware upgrade status for the switch
        cert_expiry:
          type: integer
          description: Time when the switch certificate expires, in epoch seconds
          contentEncoding: int64
        clients:
          type: array
          items:
            $ref: '#/components/schemas/stats_switch_client_item'
          description: Switch port clients currently observed by the switch
        clients_stats:
          allOf:
          - $ref: '#/components/schemas/stats_switch_clients_stats2'
          - description: Aggregate client counts reported for the switch
        config_status:
          type: string
          description: Configuration synchronization status reported for the switch
          readOnly: true
        config_timestamp:
          type: integer
          description: Time when the switch configuration status was last updated, in epoch seconds
          contentEncoding: int32
        config_version:
          type: integer
          description: Currently applied configuration version for the switch
          contentEncoding: int32
        cpu_stat:
          allOf:
          - $ref: '#/components/schemas/cpu_stat2'
          - description: Processor utilization statistics for the switch
        created_time:
          type: number
          description: Time when the switch record was created, in epoch seconds
          readOnly: true
        deviceprofile_id:
          type:
          - string
          - 'null'
          description: Applied device profile identifier for the switch, when present
          contentEncoding: uuid
          readOnly: true
        dhcpd_stat:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/dhcpd_stat_lan'
          description: Lease pool statistics from the switch DHCP service
        evpntopo_id:
          type:
          - string
          - 'null'
          description: Associated EVPN topology identifier for the switch, when present
          contentEncoding: uuid
          readOnly: true
        ext_ip:
          type: string
          description: Public IP address observed for the switch
        fw_versions_outofsync:
          type: boolean
          description: Whether firmware versions are out of sync across switch members
          readOnly: true
        fwupdate:
          allOf:
          - $ref: '#/components/schemas/fwupdate_stat3'
          - description: Firmware update status for the switch
        has_pcap:
          type: boolean
          description: Whether the switch supports packet capture
          readOnly: true
          examples:
          - false
        hostname:
          type: string
          description: Device-reported hostname for the switch
          readOnly: true
          examples:
          - sj-sw1
        hw_rev:
          type: string
          description: Device hardware revision number
        id:
          type: string
          description: Unique identifier of the switch record
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        if_stat:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/if_stat_property'
          description: Interface traffic statistics for the switch
        ip:
          type: string
          description: Management IP address reported for the switch
          readOnly: true
          examples:
          - 10.2.11.137
        ip_stat:
          allOf:
          - $ref: '#/components/schemas/ip_stat2'
          - description: Layer 3 address statistics for the switch
        last_seen:
          type:
          - number
          - 'null'
          description: Time when Mist last observed the switch, in epoch seconds
          readOnly: true
          examples:
          - 1470417522
        last_trouble:
          allOf:
          - $ref: '#/components/schemas/last_trouble2'
          - description: Most recent trouble-code summary reported for the switch
        mac:
          type: string
          description: Switch MAC address reported by Mist
          readOnly: true
        mac_table_stats:
          allOf:
          - $ref: '#/components/schemas/mac_table_stats1'
          - description: Layer 2 MAC table utilization statistics for the switch
        map_id:
          type:
          - string
          - 'null'
          description: Placement map identifier associated with the switch, when present
          contentEncoding: uuid
          readOnly: true
        memory_stat:
          allOf:
          - $ref: '#/components/schemas/memory_stat2'
          - description: Utilization statistics for switch memory
        model:
          type: string
          description: Switch model name reported by Mist
          readOnly: true
          examples:
          - EX4600
        modified_time:
          type: number
          description: Time when the switch record was last modified, in epoch seconds
          readOnly: true
        module_stat:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/stats_switch_module_stat_item'
          description: Hardware module statistics for the switch
        name:
          type: string
          description: Device name if configured
          readOnly: true
          examples:
          - sj-sw1
        org_id:
          type: string
          description: Owning organization identifier for the switch statistics record
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        ports:
          type: array
          items:
            $ref: '#/components/schemas/stats_switch_port'
          description: Port statistics reported by the switch
        route_summary_stats:
          allOf:
          - $ref: '#/components/schemas/route_summary_stats1'
          - description: Route table summary statistics for the switch
        serial:
          type: string
          description: Switch serial number reported by Mist
          readOnly: true
          examples:
          - TC3714190003
        service_stat:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/service_stat_property'
          description: System service statistics for the switch
        site_id:
          type: string
          description: Associated site identifier for the switch statistics record
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        status:
          type: string
          description: Connection status reported for the switch, such as connected
          readOnly: true
          examples:
          - connected
        tag_id:
          type: integer
          description: Numeric inventory tag identifier associated with the switch
          contentEncoding: int32
        tag_uuid:
          type: string
          description: Inventory tag UUID associated with the switch
          contentEncoding: uuid
        type:
          const: switch
          type: string
          description: Device type discriminator for switch statistics
        uptime:
          type:
          - number
          - 'null'
          description: Elapsed time since the switch last booted, in seconds
          readOnly: true
          examples:
          - 13501
        vc_mac:
          type:
          - string
          - 'null'
          description: Virtual Chassis MAC address reported for the switch, when present
          readOnly: true
        vc_setup_info:
          allOf:
          - $ref: '#/components/schemas/stats_switch_vc_setup_info2'
          - description: Virtual Chassis setup request and status details for the switch
        version:
          type:
          - string
          - 'null'
          description: Software version running on the switch
          readOnly: true
          examples:
          - 18.4R1.8
      description: Switch statistics reported by Mist for a site or organization stats response
    stats_switch_ap_redundancy:
      title: stats_switch_ap_redundancy
      type: object
      properties:
        modules:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/stats_switch_ap_redundancy_module'
          description: Per-module AP redundancy counts for VC or stacked switches
        num_aps:
          type: integer
          description: Total number of APs considered for switch redundancy
          contentEncoding: int32
          examples:
          - 15
        num_aps_with_switch_redundancy:
          type: integer
          description: Number of APs that have switch redundancy coverage
          contentEncoding: int32
          examples:
          - 8
      description: AP switch redundancy coverage summary for a switch
    stats_switch_ap_redundancy_module:
      title: stats_switch_ap_redundancy_module
      type: object
      properties:
        num_aps:
          type: integer
          description: Total number of APs connected through this switch member
          contentEncoding: int32
          examples:
          - 15
        num_aps_with_switch_redundancy:
          type: integer
          description: Number of APs on this switch member with switch redundancy coverage
          contentEncoding: int32
          examples:
          - 8
      description: AP switch redundancy counts for one VC or stack member
    stats_switch_client_item:
      title: stats_switch_client_item
      type: object
      properties:
        device_mac:
          type: string
          description: Switch MAC address for the device reporting this client entry
        hostname:
          type: string
          description: Reported client hostname, when known
        mac:
          type: string
          description: Client MAC address observed on the switch port
        port_id:
          type: string
          description: Switch port identifier where the client was observed
      description: Client observed on a switch port in switch statistics
    stats_switch_clients_stats:
      title: stats_switch_clients_stats
      type: object
      properties:
        total:
          allOf:
          - $ref: '#/components/schemas/stats_switch_clients_stats_total2'
          - description: Aggregate client counts across the switch
      description: Aggregate switch client counts
    stats_switch_clients_stats_total:
      title: stats_switch_clients_stats_total
      type: object
      properties:
        num_aps:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: AP counts included in the aggregate switch client statistics
        num_wired_clients:
          type: integer
          description: Number of wired clients included in the aggregate switch client statistics
          contentEncoding: int32
      description: Total AP and wired-client counts for switch client statistics
    stats_switch_module_stat_item:
      title: stats_switch_module_stat_item
      type: object
      properties:
        backup_version:
          type:
          - string
          - 'null'
          description: Backup software version stored on the switch module
          readOnly: true
        bios_version:
          type:
          - string
          - 'null'
          description: BIOS firmware version reported for the switch module
          readOnly: true
        boot_partition:
          type: string
          description: Active boot partition used by the switch module
        cpld_version:
          type:
          - string
          - 'null'
          description: CPLD firmware version reported for the switch module
          readOnly: true
        cpu_stat:
          allOf:
          - $ref: '#/components/schemas/cpu_stat1'
          - description: Processor utilization statistics for the switch module
        errors:
          type: array
          items:
            $ref: '#/components/schemas/module_stat_item_errors_items'
          description: Hardware error records reported for the switch module
        fans:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/module_stat_item_fans_items'
          description: Cooling fan status records for the switch module
        fpc_idx:
          type: integer
          description: FPC index identifying this switch module
          contentEncoding: int32
          readOnly: true
        fpga_version:
          type:
          - string
          - 'null'
          description: FPGA firmware version reported for the switch module
          readOnly: true
        last_seen:
          type:
          - number
          - 'null'
          description: Time when Mist last observed this switch module, in epoch seconds
          readOnly: true
          examples:
          - 1470417522
        locating:
          type: boolean
          description: Whether the switch module locator indicator is active
        mac:
          type: string
          description: Switch module MAC address reported by Mist
          examples:
          - fc3342123456
        memory_stat:
          allOf:
          - $ref: '#/components/schemas/memory_stat1'
          - description: Utilization statistics for switch module memory
        model:
          type:
          - string
          - 'null'
          description: Switch module model name reported by Mist
          readOnly: true
          examples:
          - EX4300-48P
        optics_cpld_version:
          type:
          - string
          - 'null'
          description: Optics CPLD firmware version reported for the switch module
          readOnly: true
        pending_version:
          type:
          - string
          - 'null'
          description: Pending software version staged for the switch module
          readOnly: true
        pics:
          type: array
          items:
            $ref: '#/components/schemas/module_stat_item_pics_item'
          description: Physical Interface Card status records for the switch module
        poe:
          allOf:
          - $ref: '#/components/schemas/module_stat_item_poe1'
          - description: Power over Ethernet telemetry for the switch module
        poe_version:
          type:
          - string
          - 'null'
          description: PoE controller firmware version reported for the switch module
          readOnly: true
        power_cpld_version:
          type:
          - string
          - 'null'
          description: Power CPLD firmware version reported for the switch module
          readOnly: true
        psus:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/module_stat_item_psus_item'
          description: Power supply status records for the switch module
        re_fpga_version:
          type:
          - string
          - 'null'
          description: Routing Engine FPGA firmware version reported for the switch module
          readOnly: true
        recovery_version:
          type:
          - string
          - 'null'
          description: Recovery software version stored on the switch module
          readOnly: true
        serial:
          type:
          - string
          - 'null'
          description: Switch module serial number reported by Mist
          readOnly: true
          examples:
          - PX8716230021
        status:
          type:
          - string
          - 'null'
          description: Connection status reported for the switch module
          readOnly: true
        temperatures:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/module_stat_item_temperatures_item'
          description: Temperature sensor readings for the switch module
        tmc_fpga_version:
          type:
          - string
          - 'null'
          description: TMC FPGA firmware version reported for the switch module
          readOnly: true
        type:
          type:
          - string
          - 'null'
          description: Module type reported for the switch module
          readOnly: true
        uboot_version:
          type:
          - string
          - 'null'
          description: U-Boot firmware version reported for the switch module
          readOnly: true
        uptime:
          type:
          - integer
          - 'null'
          description: Elapsed time since the switch module last booted, in seconds
          contentEncoding: int32
          readOnly: true
        vc_links:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/module_stat_item_vc_links_item'
          description: Virtual chassis link records for the switch module
        vc_mode:
          type:
          - string
          - 'null'
          description: Virtual chassis mode reported for the switch module
          readOnly: true
        vc_role:
          type:
          - string
          - 'null'
          description: 'enum: `master`, `backup`, `linecard`'
          readOnly: true
          examples:
          - master
        vc_state:
          type:
          - string
          - 'null'
          description: Virtual chassis state reported for the switch module
          readOnly: true
        version:
          type:
          - string
          - 'null'
          description: Software version running on the switch module
          readOnly: true
      description: Hardware module status and firmware inventory for a switch
    stats_switch_port_poe_mode:
      title: stats_switch_port_poe_mode
      enum:
      - 802.3af
      - 802.3at
      - 802.3bt
      type: string
      description: 'enum: `802.3af`, `802.3at`, `802.3bt`'
    stats_switch_port_type:
      title: stats_switch_port_type
      enum:
      - ap
      - ble
      - gateway
      - mxedge
      - nac
      - switch
      type: string
      description: 'device type. enum: `ap`, `ble`, `gateway`, `mxedge`, `nac`, `switch`'
      examples:
      - gateway
    stats_switch_vc_setup_info:
      title: stats_switch_vc_setup_info
      type: object
      properties:
        config_type:
          type: string
          description: Provisioning mode used for the Virtual Chassis setup
          readOnly: true
          examples:
          - nonprovisioned
        current_stats:
          type: string
          description: Status currently reported for the Virtual Chassis setup workflow
          readOnly: true
          examples:
          - VCSETUP_WAITING
        err_missing_dev_id_fpc:
          type: boolean
          description: Whether the Virtual Chassis setup is missing a device ID for an FPC member
          readOnly: true
        last_update:
          type: number
          description: Most recent update time for the Virtual Chassis setup status
          readOnly: true
        request_time:
          type: number
          description: Time when the Virtual Chassis setup request was submitted
          readOnly: true
        request_type:
          type: string
          description: Virtual Chassis setup request type
          readOnly: true
          examples:
          - vc_create
      description: Virtual Chassis setup request and status details reported by a switch
    stats_unconnected_client:
      title: stats_unconnected_client
      required:
      - ap_mac
      - mac
      - manufacture
      - rssi
      - y
      type: object
      properties:
        ap_mac:
          type: string
          description: MAC address of the AP that heard the client
        last_seen:
          type:
          - number
          - 'null'
          description: Time when Mist last observed the unconnected client, in epoch seconds
          readOnly: true
          examples:
          - 1470417522
        mac:
          type: string
          description: Unconnected client MAC address observed by an AP
        manufacture:
          type: string
          description: Device manufacture, through fingerprinting or OUI
        map_id:
          type:
          - string
          - 'null'
          description: Map identifier for the unconnected client's location, if known
          contentEncoding: uuid
        rssi:
          type: integer
          description: Client RSSI observed by the AP that heard the client (in dBm)
          contentEncoding: int32
        x:
          type: number
          description: Horizontal map coordinate of the unconnected client location, in pixels, if known
        y:
          type: number
          description: Vertical map coordinate of the unconnected client location, in pixels, if known
      description: Location statistics for an unconnected Wi-Fi client observed by an AP
    stats_wan_client:
      title: stats_wan_client
      type: object
      properties:
        dhcp_expire_time:
          type: number
          description: DHCP lease expiration time for the WAN client, in epoch seconds
        dhcp_start_time:
          type: number
          description: DHCP lease start time for the WAN client, in epoch seconds
        hostname:
          type: array
          items:
            type: string
          description: Observed hostnames for the WAN client during the search window
        ip:
          type: array
          items:
            type: string
          description: Observed IP addresses for the WAN client during the search window
        ip_src:
          type: string
          description: Source used to learn the WAN client IP address, such as dhcp
          examples:
          - dhcp
        last_hostname:
          type: string
          description: Most recent hostname observed for the WAN client
          examples:
          - sonoszp
        last_ip:
          type: string
          description: Most recent IP address observed for the WAN client
          examples:
          - 192.168.1.139
        mfg:
          type: string
          description: Manufacturer inferred for the WAN client
          examples:
          - Sonos
        network:
          type: string
          description: Mist network name associated with the WAN client
          examples:
          - lan
        org_id:
          type: string
          description: Owning organization identifier for the WAN client record
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        site_id:
          type: string
          description: Site identifier associated with the WAN client record
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        timestamp:
          type: number
          description: Time when the WAN client record was observed, in epoch seconds
          readOnly: true
        wcid:
          type: string
          description: WAN client identifier associated with the record
          examples:
          - 8bbe7389-212b-c65d-2208-00fab2017936
      description: WAN client record returned by WAN client search
    stats_wan_tunnel:
      title: stats_wan_tunnel
      required:
      - peer_ip
      type: object
      properties:
        auth_algo:
          type: string
          description: Authentication algorithm negotiated for the tunnel
        encrypt_algo:
          type: string
          description: Encryption algorithm negotiated for the tunnel
        ike_version:
          type: string
          description: IKE version used to establish the tunnel
        ip:
          type: string
          description: Local IP address used by the tunnel
        last_event:
          type: string
          description: Most recent reason the tunnel went down
        mac:
          type: string
          description: Router MAC address reporting the tunnel statistics
        node:
          type: string
          description: HA node handling the tunnel, such as node0 or node1
        org_id:
          type: string
          description: Organization identifier of the router reporting the tunnel statistics
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        peer_host:
          type: string
          description: Hostname or configured peer host of the remote tunnel endpoint
        peer_ip:
          type: string
          description: IP address of the remote tunnel endpoint
        priority:
          allOf:
          - $ref: '#/components/schemas/tunnel_priority1'
          - description: 'Relative preference assigned to the tunnel. enum: `primary`, `secondary`.'
        protocol:
          allOf:
          - $ref: '#/components/schemas/wan_tunnel_protocol1'
          - description: 'Tunnel protocol used for the connection. enum: `gre`, `ipsec`.'
        rx_bytes:
          type:
          - integer
          - 'null'
          description: Total bytes received on the tunnel
          contentEncoding: int64
          readOnly: true
          examples:
          - 8515104416
        rx_pkts:
          type:
          - integer
          - 'null'
          description: Total packets received on the tunnel
          contentEncoding: int64
          readOnly: true
          examples:
          - 57770567
        site_id:
          type: string
          description: Site identifier of the router reporting the tunnel statistics
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        tunnel_name:
          type: string
          description: Name of the Mist-managed WAN tunnel
        tx_bytes:
          type:
          - integer
          - 'null'
          description: Total bytes transmitted on the tunnel
          contentEncoding: int64
          readOnly: true
          examples:
          - 211217389682
        tx_pkts:
          type:
          - integer
          - 'null'
          description: Total packets transmitted on the tunnel
          contentEncoding: int64
          readOnly: true
          examples:
          - 812204062
        up:
          type: boolean
          description: Indicates whether the tunnel is currently up
        uptime:
          type: integer
          description: Duration since the tunnel security association was established
          contentEncoding: int32
        wan_name:
          type: string
          description: Name of the WAN interface carrying the tunnel
          examples:
          - wan
      description: WAN tunnel statistics record returned by tunnel search
    stats_wired_client:
      title: stats_wired_client
      required:
      - mac
      type: object
      properties:
        auth_state:
          minLength: 1
          type: string
          description: Authorization state reported for the wired client
        device_id:
          minLength: 1
          type: string
          description: Identifier of the AP the wired client is connected to
        eth_port:
          minLength: 1
          type: string
          description: AP Ethernet port where the wired client is connected
        last_seen:
          type: number
          description: Time when transmit or receive traffic was last observed for the wired client
        mac:
          minLength: 1
          type: string
          description: Wired client MAC address observed on the AP Ethernet port
        rx_bytes:
          type:
          - integer
          - 'null'
          description: Total bytes received by the wired client connection
          contentEncoding: int64
          readOnly: true
          examples:
          - 8515104416
        rx_pkts:
          type:
          - integer
          - 'null'
          description: Total packets received by the wired client connection
          contentEncoding: int64
          readOnly: true
          examples:
          - 57770567
        site_id:
          type: string
          description: Site identifier associated with the wired client statistics record
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        tx_bytes:
          type:
          - integer
          - 'null'
          description: Total bytes transmitted by the wired client connection
          contentEncoding: int64
          readOnly: true
          examples:
          - 211217389682
        tx_pkts:
          type:
          - integer
          - 'null'
          description: Total packets transmitted by the wired client connection
          contentEncoding: int64
          readOnly: true
          examples:
          - 812204062
        uptime:
          type: number
          description: Elapsed time since the wired client connected, in seconds
        vlan_id:
          type: number
          description: VLAN identifier used by the wired client, when present
      description: Wired client statistics for a client connected through an AP Ethernet port
    stats_wireless_client:
      title: stats_wireless_client
      required:
      - ap_id
      - ap_mac
      - band
      - channel
      - is_guest
      - key_mgmt
      - mac
      - proto
      - rssi
      - snr
      - ssid
      - wlan_id
      type: object
      properties:
        accuracy:
          type: integer
          description: Estimated client location accuracy, in meter
          contentEncoding: int32
        airespace_ifname:
          type: string
          description: RADIUS Airespace interface name reported for the wireless client, when available
        airwatch:
          allOf:
          - $ref: '#/components/schemas/stats_wireless_client_airwatch2'
          - description: Mobile device management authorization information from AirWatch for the wireless client
        annotation:
          type: string
          description: User-visible annotation label applied to the wireless client
        ap_id:
          type: string
          description: AP ID the client is connected to
          contentEncoding: uuid
        ap_mac:
          type: string
          description: AP the client is connected to
        assoc_time:
          type: integer
          description: Time when the wireless client associated to the AP, in epoch seconds
          contentEncoding: int32
        band:
          allOf:
          - $ref: '#/components/schemas/dot11_band3'
          - description: 'Wi-Fi radio band used by the wireless client connection. enum: `24`, `5`, `5-dedicated`, `5-selectable`, `6`, `6-dedicated`, `6-selectable`.'
        bssid:
          type: string
          description: AP radio BSSID serving the wireless client connection
        channel:
          type: integer
          description: Radio channel used by the wireless client connection
          contentEncoding: int32
        dual_band:
          type: boolean
          description: Whether the client is dual_band capable (determined by whether we’ve seen probe requests from both bands)
        family:
          type: string
          description: Device family, through fingerprinting. iPod / Nexus Galaxy / Windows Mobile or CE …
        group:
          type: string
          description: Client group label reported for the wireless client
        guest:
          allOf:
          - $ref: '#/components/schemas/guest1'
          - description: Portal guest details for the wireless client
        hostname:
          type: string
          description: DHCP hostname learned for the wireless client
        idle_time:
          type: number
          description: How long, in seconds, has the client been idle (since the last RX packet)
        ip:
          type: string
          description: Current IP address reported for the wireless client
        is_guest:
          type: boolean
          description: Whether this is a guest
        key_mgmt:
          type: string
          description: Security key-management and cipher suite used by the wireless client
        last_seen:
          type:
          - number
          - 'null'
          description: Time when Mist last observed the wireless client, in epoch seconds
          readOnly: true
          examples:
          - 1470417522
        mac:
          type: string
          description: Wireless client MAC address observed by Mist
        manufacture:
          type: string
          description: Device manufacture, through fingerprinting or OUI
        map_id:
          type: string
          description: Estimated client location - map_id
          contentEncoding: uuid
        model:
          type: string
          description: Device model, may be available if we can identify them
        mxedge_id:
          type: string
          description: Mist Edge the wireless client connection is tunneled through, when applicable
          contentEncoding: uuid
        num_locating_aps:
          type: integer
          description: Number of APs used to locate this client
          contentEncoding: int32
        os:
          type: string
          description: Device os, through fingerprinting
        power_saving:
          type: boolean
          description: If it’s currently in power-save mode
        proto:
          allOf:
          - $ref: '#/components/schemas/dot11_proto2'
          - description: '802.11 protocol amendment used by the wireless client. enum: `a`, `ac`, `ax`, `b`, `be`, `g`, `n`.'
        psk_id:
          type: string
          description: PSK id (if multi-psk is used)
          contentEncoding: uuid
        rssi:
          type: number
          description: Received signal strength indicator for the wireless client, in dBm
        rssizones:
          type: array
          items:
            $ref: '#/components/schemas/stats_wireless_client_rssi_zone'
          description: RSSI zone memberships for the wireless client
        rx_bps:
          type:
          - integer
          - 'null'
          description: Receive throughput for the wireless client, in bits per second
          contentEncoding: int64
          readOnly: true
          examples:
          - 60003
        rx_bytes:
          type:
          - integer
          - 'null'
          description: Total bytes received by the wireless client connection
          contentEncoding: int64
          readOnly: true
          examples:
          - 8515104416
        rx_pkts:
          type:
          - integer
          - 'null'
          description: Total packets received by the wireless client connection
          contentEncoding: int64
          readOnly: true
          examples:
          - 57770567
        rx_rate:
          type:
          - number
          - 'null'
          description: Receive PHY rate for the wireless client connection, in Mbps
          readOnly: true
        rx_retries:
          type:
          - integer
          - 'null'
          description: Receive retry count for the wireless client connection
          contentEncoding: int32
          readOnly: true
        site_id:
          type: string
          description: Site identifier associated with the wireless client statistics record
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        snr:
          type: number
          description: Signal-to-noise ratio for the wireless client connection
        ssid:
          type: string
          description: Wireless SSID used by the client connection
        tx_bps:
          type:
          - integer
          - 'null'
          description: Transmit throughput for the wireless client, in bits per second
          contentEncoding: int64
          readOnly: true
          examples:
          - 634301
        tx_bytes:
          type:
          - integer
          - 'null'
          description: Total bytes transmitted by the wireless client connection
          contentEncoding: int64
          readOnly: true
          examples:
          - 211217389682
        tx_pkts:
          type:
          - integer
          - 'null'
          description: Total packets transmitted by the wireless client connection
          contentEncoding: int64
          readOnly: true
          examples:
          - 812204062
        tx_rate:
          type:
          - number
          - 'null'
          description: Transmit PHY rate for the wireless client connection, in Mbps
          readOnly: true
        tx_retries:
          type:
          - integer
          - 'null'
          description: Transmit retry count for the wireless client connection
          contentEncoding: int32
          readOnly: true
        type:
          type: string
          description: Client’s type, regular / vip / resource / blocked (if client object is created)
        uptime:
          type: number
          description: How long, in seconds, has the client been connected
        username:
          type: string
          description: User identity learned from 802.1X, per-user PSK, or user portal authentication
        vbeacons:
          type: array
          items:
            $ref: '#/components/schemas/stats_wireless_client_vbeacon'
          description: Virtual beacon associations for the wireless client
        vlan_id:
          type: string
          description: VLAN ID, could be empty (from older AP)
        wlan_id:
          type: string
          description: WLAN ID the client is connected to
          contentEncoding: uuid
        wxrule_id:
          type: string
          description: Current WxlanRule using for a Client or an authorized Guest (portal user). null if default rule is matched.
          contentEncoding: uuid
        wxrule_usage:
          type: array
          items:
            $ref: '#/components/schemas/stats_wireless_client_wxrule_usage'
          description: WxLAN rule usage counters for the wireless client
        x:
          type: number
          description: Estimated client location in pixels
        x_m:
          type: number
          description: Estimated client location in meter
        y:
          type: number
          description: Estimated client location in pixels
        y_m:
          type: number
          description: Estimated client location in meter
        zones:
          type: array
          items:
            $ref: '#/components/schemas/stats_wireless_client_zone'
          description: Zone memberships for the wireless client
      description: Wireless client connection, traffic, and location statistics
    stats_wireless_client_airwatch:
      title: stats_wireless_client_airwatch
      required:
      - authorized
      type: object
      properties:
        authorized:
          type: boolean
          description: Whether the wireless client is authorized by AirWatch
      description: AirWatch authorization information reported for a wireless client
    stats_wireless_client_rssi_zone:
      title: stats_wireless_client_rssi_zone
      type: object
      properties:
        id:
          type: string
          description: RSSI zone identifier that currently contains the wireless client
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        since:
          type: number
          description: Time when the wireless client entered the RSSI zone, in epoch seconds
      description: RSSI zone currently containing a wireless client
    stats_wireless_client_vbeacon:
      title: stats_wireless_client_vbeacon
      type: object
      properties:
        id:
          type: string
          description: Virtual beacon identifier currently associated with the wireless client
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        since:
          type: number
          description: Time when the wireless client began matching the virtual beacon, in epoch seconds
      description: Virtual beacon currently associated with a wireless client
    stats_wireless_client_wxrule_usage:
      title: stats_wireless_client_wxrule_usage
      type: object
      properties:
        tag_id:
          type: string
          description: WxLAN tag identifier for this rule usage entry
          contentEncoding: uuid
        usage:
          type: integer
          description: Count recorded for this WxLAN rule usage entry
          contentEncoding: int32
      description: WxLAN rule usage counter for one wireless tag
    stats_wireless_client_zone:
      title: stats_wireless_client_zone
      type: object
      properties:
        id:
          type: string
          description: Zone identifier that currently contains the wireless client
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        since:
          type: number
          description: Time when the wireless client entered the zone, in epoch seconds
      description: Zone currently containing a wireless client
    stats_wxrule:
      title: stats_wxrule
      required:
      - action
      - client_mac
      - dst_allow_wxtags
      - dst_deny_wxtags
      - dst_wxtags
      - name
      - order
      - src_wxtags
      - usage
      type: object
      properties:
        action:
          allOf:
          - $ref: '#/components/schemas/stats_wxrule_action2'
          - description: Allow or block behavior enforced by this WxLAN rule
            examples:
            - allow
        client_mac:
          type: array
          items:
            type: string
          description: Wireless client MAC addresses matching this WxLAN rule
          examples:
          - - 3bbbf819bb6f
            - bd96cbc4910f
        dst_allow_wxtags:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Destination WxLAN tags explicitly allowed by this rule
          examples:
          - - fff34466-eec0-3756-6765-381c728a6037
            - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
        dst_deny_wxtags:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Destination WxLAN tags denied by this rule
          examples:
          - - aaa34466-eec0-3756-6765-381c728a6037
            - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
        dst_wxtags:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Destination WxLAN tags matched by this rule
          examples:
          - - d4134466-eec0-3756-6765-381c728a6037
            - 1a42c7b0-d1d0-5a30-f349-e35fa43dc3b3
        name:
          type: string
          description: Display name of the WxLAN rule
          examples:
          - Guest
        order:
          type: integer
          description: Rule evaluation order for WxLAN matching
          contentEncoding: int32
          examples:
          - 1
        src_wxtags:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Source WxLAN tags matched by this rule
          examples:
          - - 8bfc2490-d726-3587-038d-cb2e71bd2330
            - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
        usage:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/stats_wxrule_usage_properties'
          description: Flow counts keyed by destination WxLAN tag identifier
          examples:
          - 1a42c7b0-d1d0-5a30-f349-e35fa43dc3b3:
              num_flows: 60
            d4134466-eec0-3756-6765-381c728a6037:
              num_flows: 60
      description: WxLAN rule usage statistics for a site
    stats_wxrule_action:
      title: stats_wxrule_action
      enum:
      - allow
      - block
      type: string
      description: 'Allow or block behavior enforced by this WxLAN rule. enum: `allow`, `block`'
      examples:
      - allow
    stats_wxrule_usage_properties:
      title: stats_wxrule_usage_properties
      type: object
      properties:
        num_flows:
          type: integer
          description: Number of flows counted for this WxLAN rule and destination tag
          contentEncoding: int32
      description: Usage counters for one WxLAN rule destination tag
    stats_zone:
      title: stats_zone
      required:
      - id
      - map_id
      - name
      type: object
      properties:
        assets_wait:
          allOf:
          - $ref: '#/components/schemas/stats_zone_assets_waits1'
          - description: BLE asset wait-time summary for the zone
        clients_wait:
          allOf:
          - $ref: '#/components/schemas/stats_zone_clients_waits1'
          - description: Wi-Fi client wait-time summary for the zone
        created_time:
          type: number
          description: Time when the zone was created, in epoch seconds
          readOnly: true
        discovered_assets_wait:
          allOf:
          - $ref: '#/components/schemas/stats_zone_discovered_assets_waits1'
          - description: Discovered BLE asset wait-time summary for the zone
        id:
          type: string
          description: Unique identifier of the zone
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        map_id:
          type: string
          description: Map identifier for the zone
          contentEncoding: uuid
          examples:
          - 123449d4-d12f-4feb-b40f-5be0e2ae1234
        modified_time:
          type: number
          description: Time when the zone was last modified, in epoch seconds
          readOnly: true
        name:
          type: string
          description: Display name of the zone
          examples:
          - Zone A
        num_assets:
          type: integer
          description: Number of BLE assets currently counted in the zone
          contentEncoding: int32
          examples:
          - 0
        num_clients:
          type: integer
          description: Number of Wi-Fi clients currently counted in the zone, including connected and unconnected clients
          contentEncoding: int32
          examples:
          - 80
        num_discovered_assets:
          type: integer
          description: Number of discovered BLE assets currently counted in the zone
          contentEncoding: int32
          examples:
          - 0
        num_sdkclients:
          type: integer
          description: Number of SDK clients currently counted in the zone
          contentEncoding: int32
          examples:
          - 10
        num_unconnected_clients:
          type: integer
          description: Number of unconnected Wi-Fi clients currently counted in the zone
          contentEncoding: int32
          examples:
          - 80
        occupancy_limit:
          type: integer
          description: Configured occupancy limit for the zone
          contentEncoding: int32
          examples:
          - 4
        org_id:
          type: string
          description: Organization identifier associated with the zone
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        sdkclients_wait:
          allOf:
          - $ref: '#/components/schemas/stats_zone_sdkclients_waits1'
          - description: SDK client wait-time summary for the zone
        site_id:
          type: string
          description: Site identifier associated with the zone
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        unconnected_clients_wait:
          allOf:
          - $ref: '#/components/schemas/stats_zone_unconnected_clients_waits1'
          - description: Unconnected Wi-Fi client wait-time summary for the zone
        vertices:
          type: array
          items:
            $ref: '#/components/schemas/zone_vertex'
          description: Zone polygon vertices in map pixel coordinates
          examples:
          - - x: 732
              y: 1821
            - x: 732.5
              y: 1731
            - x: 837.5
              y: 1731.5
            - x: 839
              y: 1821
        vertices_m:
          type: array
          items:
            $ref: '#/components/schemas/zone_vertex_m'
          description: Zone polygon vertices in meters
          examples:
          - - x: 24.1983341951072
              y: 60.198314985369144
            - x: 24.21486311190714
              y: 57.22310996138056
            - x: 27.685935639893827
              y: 57.23963887818049
            - x: 27.73552239029364
              y: 60.198314985369144
      description: Zone statistics and occupancy counts for a site map zone
    stats_zone_assets_waits:
      title: stats_zone_assets_waits
      type: object
      properties:
        avg:
          type: number
          description: Average wait time in seconds
          examples:
          - 0
        max:
          type: number
          description: Longest wait time in seconds
          examples:
          - 0
        min:
          type: number
          description: Shortest wait time in seconds
          examples:
          - 0
        p95:
          type: number
          description: 95th percentile of all the wait time(s)
          examples:
          - 0
      description: BLE asset wait time right now
    stats_zone_clients_waits:
      title: stats_zone_clients_waits
      type: object
      properties:
        avg:
          type: number
          description: Average wait time in seconds
          examples:
          - 1200
        max:
          type: number
          description: Longest wait time in seconds
          examples:
          - 3610
        min:
          type: number
          description: Shortest wait time in seconds
          examples:
          - 600
        p95:
          type: number
          description: 95th percentile of all the wait time(s)
          examples:
          - 2800
      description: Client wait time right now
    stats_zone_details:
      title: stats_zone_details
      required:
      - client_waits
      - id
      - map_id
      - name
      - num_clients
      - num_sdkclients
      type: object
      properties:
        assets:
          type: array
          items:
            type: string
          description: BLE asset identifiers currently in the zone
        client_waits:
          allOf:
          - $ref: '#/components/schemas/stats_zone_details_client_waits2'
          - description: Wi-Fi client wait-time summary for the zone
        clients:
          type: array
          items:
            type: string
          description: Wi-Fi client MAC addresses currently in the zone
        id:
          type: string
          description: Unique identifier of the zone
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        map_id:
          type: string
          description: Map identifier for the zone
          contentEncoding: uuid
          examples:
          - 63eda950-c6da-11e4-a628-60f81dd250cc
        name:
          type: string
          description: Display name of the zone
          examples:
          - Board Room
        num_clients:
          type: integer
          description: Number of Wi-Fi clients currently counted in the zone
          contentEncoding: int32
          examples:
          - 80
        num_sdkclients:
          type: integer
          description: Number of SDK clients currently counted in the zone
          contentEncoding: int32
          examples:
          - 0
        sdkclients:
          type: array
          items:
            type: string
          description: SDK client identifiers currently in the zone
      description: Detailed zone statistics and occupants for a site map zone
    stats_zone_details_client_waits:
      title: stats_zone_details_client_waits
      required:
      - avg
      - max
      - min
      - p95
      type: object
      properties:
        avg:
          type: integer
          description: Average wait time in seconds
          contentEncoding: int32
          examples:
          - 1200
        max:
          type: integer
          description: Longest wait time in seconds
          contentEncoding: int32
          examples:
          - 3610
        min:
          type: integer
          description: Shortest wait time in seconds
          contentEncoding: int32
          examples:
          - 600
        p95:
          type: integer
          description: 95th percentile of all the wait time(s)
          contentEncoding: int32
          examples:
          - 2800
      description: Client wait time right now
    stats_zone_discovered_assets_waits:
      title: stats_zone_discovered_assets_waits
      type: object
      properties:
        avg:
          type: number
          description: Average wait time in seconds
          examples:
          - 0
        max:
          type: number
          description: Longest wait time in seconds
          examples:
          - 0
        min:
          type: number
          description: Shortest wait time in seconds
          examples:
          - 0
        p95:
          type: number
          description: 95th percentile of all the wait time(s)
          examples:
          - 0
      description: Discovered asset wait time right now
    stats_zone_sdkclients_waits:
      title: stats_zone_sdkclients_waits
      type: object
      properties:
        avg:
          type: number
          description: Average wait time in seconds
          examples:
          - 0
        max:
          type: number
          description: Longest wait time in seconds
          examples:
          - 0
        min:
          type: number
          description: Shortest wait time in seconds
          examples:
          - 0
        p95:
          type: number
          description: 95th percentile of all the wait time(s)
          examples:
          - 0
      description: SDK client wait time right now
    stats_zone_unconnected_clients_waits:
      title: stats_zone_unconnected_clients_waits
      type: object
      properties:
        avg:
          type: number
          description: Average wait time in seconds
          examples:
          - 0
        max:
          type: number
          description: Longest wait time in seconds
          examples:
          - 0
        min:
          type: number
          description: Shortest wait time in seconds
          examples:
          - 0
        p95:
          type: number
          description: 95th percentile of all the wait time(s)
          examples:
          - 0
      description: Unconnected Wi-Fi client wait time right now
    support_contract_status:
      title: support_contract_status
      enum:
      - Active
      - Declined
      - EOL
      - Service Available
      type: string
      description: 'Service contract status. enum: `Active`, `Declined`, `EOL`, `Service Available`'
    suppressed_alarm:
      title: suppressed_alarm
      type: object
      properties:
        applies:
          allOf:
          - $ref: '#/components/schemas/suppressed_alarm_applies2'
          - description: If `scope`==`site`. Site and site-group targets where alarms are suppressed
        duration:
          maximum: 15552000
          minimum: 0
          type: number
          description: Suppression length, in seconds. Maximum duration is 86400 * 180 (180 days). 0 is to un-suppress alarms
          default: 3600
        scheduled_time:
          type: integer
          description: Time when alarm suppression starts, in epoch seconds. Defaults to now; accepted range is from now to now + 7 days
          contentEncoding: int32
        scope:
          allOf:
          - $ref: '#/components/schemas/suppressed_alarm_scope1'
          - description: 'Alarm suppression target level. enum: `org`, `site`.'
      description: Request body for suppressing organization alarms
    suppressed_alarm_applies:
      title: suppressed_alarm_applies
      type: object
      properties:
        org_id:
          type: string
          description: UUID of the current org (if provided, the alarms will be suppressed at org level)
          contentEncoding: uuid
        site_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Site identifiers included in the suppression scope. If provided, alarms are suppressed for the listed sites.
        sitegroup_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Site group identifiers included in the suppression scope. If provided, alarms are suppressed for all sites in the listed site groups.
      description: If `scope`==`site`. Object defines the scope (within the org e.g. whole org, and/or some site_groups, and/or some sites) for which the alarm service has to be suppressed for some `duration`
    suppressed_alarm_scope:
      title: suppressed_alarm_scope
      enum:
      - org
      - site
      type: string
      description: 'level of scope. enum: `org`, `site`'
    sw_routing_policy:
      title: sw_routing_policy
      type: object
      properties:
        terms:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/sw_routing_policy_term'
          description: Ordered terms evaluated by this switch routing policy
      description: Switch routing policy made of ordered match-action terms
    sw_routing_policy_term:
      title: sw_routing_policy_term
      required:
      - name
      type: object
      properties:
        actions:
          allOf:
          - $ref: '#/components/schemas/sw_routing_policy_term_action2'
          - description: Policy actions applied when this routing policy term matches
        matching:
          allOf:
          - $ref: '#/components/schemas/sw_routing_policy_term_matching2'
          - description: Route match criteria that must be satisfied before actions are applied
        name:
          type: string
          description: Display name of the switch routing policy term
      description: Switch routing policy term with match criteria and actions
    sw_routing_policy_term_action:
      title: sw_routing_policy_term_action
      type: object
      properties:
        accept:
          type: boolean
          description: Whether to accept routes that match this term
        community:
          type: array
          items:
            type: string
          description: BGP communities to set when this term is used as an export policy
        local_preference:
          anyOf:
          - type: string
          - maximum: 4294967295
            minimum: 1
            type: integer
            contentEncoding: int32
          description: Preference value to set when this term is used as an import policy
        prepend_as_path:
          type: array
          items:
            type: string
          description: AS path values to prepend when this term is used as an export policy
      description: Actions applied to routes matched by a switch routing policy term
    sw_routing_policy_term_matching:
      title: sw_routing_policy_term_matching
      type: object
      properties:
        as_path:
          type: array
          items:
            $ref: '#/components/schemas/bgp_as'
          description: AS path values that routes must match
        community:
          type: array
          items:
            type: string
          description: BGP communities that routes must match
        prefix:
          type: array
          items:
            type: string
          description: Route prefixes that routes must match
        protocol:
          type: array
          items:
            $ref: '#/components/schemas/sw_routing_policy_term_matching_protocol_enum'
          description: Routing protocols that routes must match
      description: Route match criteria for a switch routing policy term; all specified criteria must match
    sw_routing_policy_term_matching_protocol_enum:
      title: sw_routing_policy_term_matching_protocol_enum
      enum:
      - bgp
      - direct
      - evpn
      - ospf
      - static
      type: string
      description: 'enum: `bgp`, `direct`, `evpn`, `ospf`, `static`'
    switch_auto_upgrade:
      title: switch_auto_upgrade
      type: object
      properties:
        custom_versions:
          type: object
          additionalProperties:
            type: string
          description: Per-model switch firmware versions to use for auto-upgrade
          examples:
          - QFX5120-32C: 23.4R2-S2.1
            QFX5130-32CD: 23.4R2-S2.3
        enabled:
          type: boolean
          description: Whether switch auto-upgrade is enabled
        snapshot:
          type: boolean
          description: Whether to create a recovery snapshot during the upgrade process
          default: false
      description: Switch firmware auto-upgrade settings
    switch_auto_upgrade_container:
      title: switch_auto_upgrade_container
      type: object
      properties:
        auto_upgrade:
          allOf:
          - $ref: '#/components/schemas/switch_auto_upgrade1'
          - description: Switch firmware auto-upgrade configuration
      description: Wrapper for switch firmware auto-upgrade settings
    switch_bgp_config:
      title: switch_bgp_config
      required:
      - local_as
      - type
      type: object
      properties:
        auth_key:
          type: string
          description: Authentication key used for BGP neighbor sessions, when configured
        bfd_minimum_interval:
          maximum: 255000
          minimum: 1
          type: integer
          description: Minimum interval in milliseconds for BFD hello packets. A neighbor is considered failed when the device stops receiving replies after the specified interval. Value must be between 1 and 255000.
          contentEncoding: int32
        export_policy:
          type: string
          description: Export policy must match one of the policy names defined in the `routing_policies` property.
        hold_time:
          oneOf:
          - $ref: '#/components/schemas/switch_bgp_config_hold_time_zero'
          - maximum: 65535
            minimum: 3
            type: integer
            contentEncoding: int32
          description: 'Default BGP hold time for switch BGP sessions. enum: `0`.'
        import_policy:
          type: string
          description: Import policy must match one of the policy names defined in the `routing_policies` property.
        local_as:
          anyOf:
          - type: string
          - maximum: 4294967294
            minimum: 1
            type: integer
            contentEncoding: int32
          description: Local BGP Autonomous System (AS) number for the switch
          examples:
          - '65000'
        neighbors:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_bgp_config_neighbor'
          description: BGP neighbor settings keyed by neighbor IP address
        networks:
          type: array
          items:
            type: string
          description: Network names used to add BGP groups to the corresponding VRFs
        type:
          allOf:
          - $ref: '#/components/schemas/switch_bgp_config_type2'
          - description: 'BGP session type for this switch BGP configuration. enum: `external`, `internal`.'
      description: Switch BGP configuration for a routing instance
    switch_bgp_config_hold_time_zero:
      title: switch_bgp_config_hold_time_zero
      const: 0
      type: integer
      description: BGP hold time value of 0
    switch_bgp_config_neighbor:
      title: switch_bgp_config_neighbor
      required:
      - neighbor_as
      type: object
      properties:
        export_policy:
          type: string
          description: Export policy must match one of the policy names defined in the `routing_policies` property.
        hold_time:
          oneOf:
          - $ref: '#/components/schemas/switch_bgp_config_hold_time_zero'
          - maximum: 65535
            minimum: 3
            type: integer
            contentEncoding: int32
          description: 'BGP hold time for this neighbor. enum: `0`.'
        import_policy:
          type: string
          description: Import policy must match one of the policy names defined in the `routing_policies` property.
        multihop_ttl:
          maximum: 255
          minimum: 1
          type: integer
          description: Time-to-live value for multihop BGP sessions to this neighbor
          contentEncoding: int32
        neighbor_as:
          anyOf:
          - type: string
          - maximum: 4294967294
            minimum: 1
            type: integer
            contentEncoding: int32
          description: Autonomous System (AS) number of the BGP neighbor. For internal BGP, this must match `local_as`. For external BGP, this must differ from `local_as`.
          examples:
          - '65000'
      description: Per-neighbor switch BGP session settings
    switch_bgp_config_type:
      title: switch_bgp_config_type
      enum:
      - external
      - internal
      type: string
      description: 'BGP session type for this switch BGP configuration. enum: `external`, `internal`'
    switch_dhcpd_config:
      title: switch_dhcpd_config
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether switch DHCP server or relay configuration is enabled
          default: false
      additionalProperties:
        allOf:
        - $ref: '#/components/schemas/switch_dhcpd_config_property'
        - description: DHCP server or relay configuration for one switch network. The property key is the network name. In case of DHCP relay, it's common for many networks to use the same dhcp relay, comma-separated network names can be used here (e.g. "net1,net2")
      description: Switch DHCP server or relay configuration keyed by network name
    switch_dhcpd_config_property:
      title: switch_dhcpd_config_property
      type: object
      properties:
        dns_servers:
          type: array
          items:
            type: string
          description: If `type`==`server` or `type6`==`server`, DNS servers advertised to DHCP clients
          examples:
          - - 8.8.8.8
            - 4.4.4.4
            - 2001:4860:4860::8888
        dns_suffix:
          type: array
          items:
            type: string
          description: If `type`==`server` or `type6`==`server`, DNS search suffixes advertised to DHCP clients
          examples:
          - - .mist.local
            - .mist.com
        fixed_bindings:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/dhcpd_config_fixed_binding'
          description: If `type`==`server` or `type6`==`server`, fixed client bindings for DHCP service
          examples:
          - 5684dae9ac8b:
              ip: 192.168.70.35
              name: John
        gateway:
          type: string
          description: If `type`==`server` - optional, `ip` will be used if not provided
          examples:
          - 192.168.70.1
        ip_end:
          type: string
          description: If `type`==`server`, ending IPv4 address for the DHCP lease pool
          examples:
          - 192.168.70.200
        ip_end6:
          type: string
          description: If `type6`==`server`, ending IPv6 address for the DHCP lease pool
          examples:
          - 2607:f8b0:4005:808::ff
        ip_start:
          type: string
          description: If `type`==`server`, starting IPv4 address for the DHCP lease pool
          examples:
          - 192.168.70.100
        ip_start6:
          type: string
          description: If `type6`==`server`, starting IPv6 address for the DHCP lease pool
          examples:
          - 2607:f8b0:4005:808::2
        lease_time:
          maximum: 604800
          minimum: 3600
          type: integer
          description: In seconds, lease time has to be between 3600 [1hr] - 604800 [1 week], default is 86400 [1 day]
          contentEncoding: int32
          default: 86400
        options:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/dhcpd_config_option'
          description: If `type`==`server` or `type6`==`server`, custom DHCP options advertised to clients
        server_id_override:
          type: boolean
          description: "`server_id_override`==`true` means the device, when acts as DHCP relay and forwards DHCP responses from DHCP server to clients, \nshould overwrite the Sever Identifier option (i.e. DHCP option 54) in DHCP responses with its own IP address."
          default: false
        servers:
          type: array
          items:
            type: string
          description: If `type`==`relay`, upstream IPv4 DHCP servers
          examples:
          - - 11.2.3.4
        servers6:
          type: array
          items:
            type: string
          description: If `type6`==`relay`, upstream IPv6 DHCP servers
          examples:
          - - 2607:f8b0:4005:808::64
        type:
          allOf:
          - $ref: '#/components/schemas/switch_dhcpd_config_type2'
          - description: 'IPv4 DHCP mode for this switch network. enum: `none`, `relay`, `server`.'
        type6:
          allOf:
          - $ref: '#/components/schemas/switch_dhcpd_config_type62'
          - description: 'IPv6 DHCP mode for this switch network. enum: `none`, `relay`, `server`.'
        vendor_encapsulated:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/dhcpd_config_vendor_option'
          description: If `type`==`server` or `type6`==`server`, vendor-encapsulated DHCP options advertised to clients
      description: DHCP server or relay configuration for one switch network. The property key is the network name. In case of DHCP relay, it's common for many networks to use the same dhcp relay, comma-separated network names can be used here (e.g. "net1,net2")
    switch_dhcpd_config_type:
      title: switch_dhcpd_config_type
      enum:
      - none
      - relay
      - server
      type: string
      description: 'enum: `none`, `relay` (DHCP Relay), `server` (DHCP Server)'
    switch_iot_port:
      title: switch_iot_port
      type: object
      properties:
        alarm_class:
          allOf:
          - $ref: '#/components/schemas/switch_iot_port_alarm_class2'
          - description: 'Alarm severity class raised for input-triggered switch IOT port events. enum: `minor`, `major`.'
        enabled:
          type: boolean
          description: Whether this switch IOT port is enabled
          default: false
        input_src:
          allOf:
          - $ref: '#/components/schemas/switch_iot_port_input_src2'
          - description: 'Only for `OUT` ports. Input port that triggers this output port. enum: `IN0`, `IN1`.'
        name:
          type: string
          description: Display name for the switch IOT port
      description: Switch IOT port configuration
    switch_iot_port_alarm_class:
      title: switch_iot_port_alarm_class
      enum:
      - minor
      - major
      type: string
      description: 'Alarm class for the switch iot port in. enum: `minor`, `major`'
    switch_iot_port_input_src:
      title: switch_iot_port_input_src
      enum:
      - IN0
      - IN1
      type: string
      description: 'Only for "OUT" ports, input source for the switch iot port out. enum: `IN0`, `IN1`'
    switch_matching:
      title: switch_matching
      type: object
      properties:
        enable:
          type: boolean
          description: Whether custom switch matching rules are enabled
        rules:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/switch_matching_rule'
          description: Switch matching rules evaluated to apply custom configuration
      description: Defines custom switch configuration based on different criteria
    switch_matching_rule:
      title: switch_matching_rule
      type: object
      properties:
        additional_config_cmds:
          type: array
          items:
            type: string
          description: Additional Junos CLI commands applied when this matching rule matches
        default_port_usage:
          type: string
          description: 'Port usage to assign to switch ports without any port usage assigned. Default: `default` to preserve default behavior'
          default: default
        ip_config:
          allOf:
          - $ref: '#/components/schemas/switch_matching_rule_ip_config2'
          - description: In-band management IP configuration applied when this matching rule matches
        name:
          maxLength: 32
          minLength: 1
          type: string
          description: 'Rule name. WARNING: the name `default` is reserved and can only be used for the last rule in the list'
        oob_ip_config:
          allOf:
          - $ref: '#/components/schemas/switch_matching_rule_oob_ip_config2'
          - description: Out-of-band management IP configuration applied when this matching rule matches
        port_config:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/junos_port_config'
          description: Per-port wired configuration applied when this matching rule matches
        port_mirroring:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_port_mirroring_property'
          description: Port mirroring configuration applied when this matching rule matches
        stp_config:
          allOf:
          - $ref: '#/components/schemas/switch_stp_config2'
          - description: Spanning Tree Protocol configuration applied when this matching rule matches
        switch_mgmt:
          allOf:
          - $ref: '#/components/schemas/switch_mgmt2'
          - description: Management-plane settings applied when this matching rule matches
      additionalProperties:
        type: string
      description: >-
        Property key defines the type of matching, value is the string to match. e.g:
          * `match_name[0:3]`: switch name must match the first 3 letters of the property value
          * `match_name[2:6]`: switch name must match the property value from the 2nd to the 6th letter
          * `match_model[0-8]`: switch model must match the first 8 letters of the property value
          * `match_role`: switch role must match the property value
      examples:
      - match_model: EX4300
        match_name[0:3]: abc
    switch_matching_rule_ip_config:
      title: switch_matching_rule_ip_config
      type: object
      properties:
        network:
          type: string
          description: VLAN Name for the management interface
        type:
          allOf:
          - $ref: '#/components/schemas/ip_type11'
          - description: 'IP assignment mode for in-band switch management. enum: `dhcp`, `static`.'
            examples:
            - static
      description: In-Band Management interface configuration
    switch_matching_rule_oob_ip_config:
      title: switch_matching_rule_oob_ip_config
      type: object
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/ip_type12'
          - description: 'IP assignment mode for out-of-band switch management. enum: `dhcp`, `static`.'
            examples:
            - static
        use_mgmt_vrf:
          type: boolean
          description: If supported on the platform. If enabled, DNS will be using this routing-instance, too
          default: false
        use_mgmt_vrf_for_host_out:
          type: boolean
          description: For host-out traffic (NTP/TACPLUS/RADIUS/SYSLOG/SNMP), if alternative source network/ip is desired
          default: false
      description: Out-of-Band Management interface configuration
    switch_metric_scope:
      title: switch_metric_scope
      enum:
      - site
      - switch
      type: string
      description: 'Scope level used when querying switch metrics. enum: `site`, `switch`'
    switch_metric_type:
      title: switch_metric_type
      const: active_ports_summary
      type: string
      description: 'Switch metric type requested for active port summaries. enum: `active_ports_summary`'
    switch_metrics_active_ports_summary_details:
      title: switch_metrics_active_ports_summary_details
      type: object
      properties:
        active_port_count:
          type: integer
          description: Number of active ports observed across evaluated switches
          contentEncoding: int32
        total_port_count:
          type: integer
          description: Total number of ports evaluated for the active-port metric
          contentEncoding: int32
      description: Port counts used by the active-port switch metric
    switch_metrics_compliance_major_version:
      title: switch_metrics_compliance_major_version
      type: object
      properties:
        major_count:
          type: integer
          description: Number of switches in this software version grouping
          contentEncoding: int32
        major_version:
          type: string
          description: Software version represented by this compliance grouping
        model:
          type: string
          description: Switch model represented by this compliance grouping
        system_names:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Switch system names included in this compliance grouping
      description: Version compliance grouping for one switch model
    switch_mgmt:
      title: switch_mgmt
      type: object
      properties:
        ap_affinity_threshold:
          type: integer
          description: AP affinity threshold for switch management. If set in both site settings and organization settings, the site setting value is used.
          contentEncoding: int32
          default: 10
        cli_banner:
          type: string
          description: Set Banners for switches. Allows markup formatting
          examples:
          - '\t\tWELCOME!'
        cli_idle_timeout:
          maximum: 60
          minimum: 1
          type: integer
          description: Sets timeout for switches
          contentEncoding: int32
        config_revert_timer:
          maximum: 30
          minimum: 1
          type: integer
          description: Rollback timer for commit confirmed
          contentEncoding: int32
          default: 10
        dhcp_option_fqdn:
          type: boolean
          description: Enable to provide the FQDN with DHCP option 81
          default: false
        disable_oob_down_alarm:
          type: boolean
          description: Whether to suppress alarms when the switch out-of-band management interface is down
        fips_enabled:
          type: boolean
          description: Whether FIPS mode is enabled on the switch
          default: false
        local_accounts:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/config_switch_local_accounts_user'
          description: Local switch user accounts keyed by username
        mxedge_proxy_host:
          type: string
          description: IP address or FQDN of the Mist Edge used to proxy the switch management traffic to the Mist Cloud
        mxedge_proxy_port:
          anyOf:
          - maximum: 65535
            minimum: 1
            type: integer
            contentEncoding: int32
            default: 2222
          - type: string
          description: Mist Edge proxy port used for switch management traffic
        protect_re:
          allOf:
          - $ref: '#/components/schemas/protect_re3'
          - description: Control-plane protection settings for the switch
        radius:
          allOf:
          - $ref: '#/components/schemas/switch_radius2'
          - description: Management authentication settings using RADIUS
        remove_existing_configs:
          type: boolean
          description: By default, only the configuration generated by Mist is cleaned up during the configuration process. If `true`, all the existing configuration will be removed.
          default: false
        root_password:
          type: string
          description: Root password for local switch access
          contentEncoding: password
        tacacs:
          allOf:
          - $ref: '#/components/schemas/tacacs2'
          - description: Management authentication settings using TACACS+
        use_mxedge_proxy:
          type: boolean
          description: Whether to use Mist Edge as a proxy for switch management traffic
      description: Switch management-plane access and proxy settings
    switch_mist_nac:
      title: switch_mist_nac
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether Mist NAC RadSec is enabled for the switch
        network:
          type: string
          description: Switch network used for Mist NAC RadSec connectivity
      description: Mist NAC RadSec settings for a switch
    switch_multicast_config:
      title: switch_multicast_config
      type: object
      properties:
        anycast_rp:
          type: boolean
          description: When `true`, auto-generates a shared RP on `is_l3_border` devices (ERB/IPClos topologies only)
          default: false
        rp_ip:
          type: string
          description: RP address used when `anycast_rp`==`false`. If the address matches a device SVI, it is configured as a local RP; otherwise a static RP is configured
          examples:
          - 10.2.1.10
        sbd_subnet:
          type: string
          description: SBD IRB subnet; Mist auto-assigns per-device IPs from this range (EVPN eOISM only)
          examples:
          - 10.99.0.0/24
        sbd_vlan_id:
          type: integer
          description: Supplemental Bridge Domain VLAN ID (EVPN topology / eOISM only)
          contentEncoding: int32
          examples:
          - 3900
      description: Multicast configuration for a VRF. When set at the network template level it applies to networks in the master VRF (not assigned to any vrf_instances). PIM is automatically enabled when any network in the VRF has `multicast.enabled`==`true`.
    switch_network:
      title: switch_network
      required:
      - vlan_id
      type: object
      properties:
        gateway:
          type: string
          description: Only required for EVPN-VXLAN networks, IPv4 Virtual Gateway
        gateway6:
          type: string
          description: Only required for EVPN-VXLAN networks, IPv6 Virtual Gateway
        isolation:
          type: boolean
          description: 'whether to stop clients to talk to each other, default is false (when enabled, a unique isolation_vlan_id is required). NOTE: this features requires uplink device to also a be Juniper device and `inter_switch_link` to be set. See also `inter_isolation_network_link` and `community_vlan_id` in port_usage'
          default: false
        isolation_vlan_id:
          type: string
          description: Required when `isolation`==`true`. Unique VLAN ID used for client isolation
          examples:
          - '3070'
        multicast:
          allOf:
          - $ref: '#/components/schemas/switch_network_multicast2'
          - description: Multicast (IGMP snooping) settings for this VLAN
        subnet:
          type: string
          description: Optional for pure switching, required when L3 / routing features are used
        subnet6:
          type: string
          description: Optional for pure switching, required when L3 / routing features are used
        vlan_id:
          oneOf:
          - type: string
          - maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
          description: VLAN identifier for this switch network
      description: A network represents a network segment. It can either represent a VLAN (then usually ties to a L3 subnet), optionally associate it with a subnet which can later be used to create addition routes. Used for ports doing `family ethernet-switching`. It can also be a pure L3-subnet that can then be used against a port that with `family inet`.
    switch_network_multicast:
      title: switch_network_multicast
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether to enable IGMP snooping on this VLAN
          default: false
        igmp_version:
          allOf:
          - $ref: '#/components/schemas/switch_network_multicast_igmp_version'
          - description: IGMP version. '2' (default, ASM/IGMPv2) / '3' (SSM/IGMPv3)
      description: Multicast settings for a switch network (VLAN)
    switch_network_multicast_igmp_version:
      title: switch_network_multicast_igmp_version
      enum:
      - '2'
      - '3'
      type: string
      description: IGMP version. '2' (default, ASM/IGMPv2) / '3' (SSM/IGMPv3)
    switch_oob_ip_config:
      title: switch_oob_ip_config
      type: object
      properties:
        gateway:
          type: string
          description: Default gateway for the out-of-band management interface when `type`==`static`
        ip:
          type: string
          description: Static IPv4 address for the out-of-band management interface when `type`==`static`
        netmask:
          type: string
          description: Used only if `subnet` is not specified in `networks`
        network:
          type: string
          description: Optional, the network to be used for mgmt
        type:
          allOf:
          - $ref: '#/components/schemas/ip_type2'
          - description: 'IP assignment mode for the out-of-band management interface. enum: `dhcp`, `static`.'
            examples:
            - static
        use_mgmt_vrf:
          type: boolean
          description: If supported on the platform. If enabled, DNS will be using this routing-instance, too
          default: false
        use_mgmt_vrf_for_host_out:
          type: boolean
          description: For host-out traffic (NTP/TACPLUS/RADIUS/SYSLOG/SNMP), if alternative source network/ip is desired
          default: false
      description: >-
        Switch OOB IP Config:
          - If HA configuration: key parameter will be nodeX (eg: node1)
          - If there are 2 routing engines, re1 mgmt IP has to be set separately (if desired): key parameter = `re1`
    switch_ospf_config:
      title: switch_ospf_config
      type: object
      properties:
        areas:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_ospf_config_area'
          description: OSPF areas configured on the switch
        enabled:
          type: boolean
          description: Enable OSPF on the switch
          default: false
        export_policy:
          type: string
          description: optional, for basic scenario, `import_policy` can be specified and can be applied to all networks in all areas if not explicitly specified
        import_policy:
          type: string
          description: optional, for basic scenario, `import_policy` can be specified and can be applied to all networks in all areas if not explicitly specified
        reference_bandwidth:
          anyOf:
          - type: integer
            contentEncoding: int32
          - type: string
          description: Reference bandwidth used for OSPF cost calculation
          examples:
          - '100000'
      description: OSPF routing configuration for a Junos switch
    switch_ospf_config_area:
      title: switch_ospf_config_area
      type: object
      properties:
        no_summary:
          type: boolean
          description: Disable OSPF summary routes for this area
          default: false
      description: Settings for a single OSPF area on a switch
    switch_port_config_overwrite:
      title: switch_port_config_overwrite
      type: object
      properties:
        description:
          type: string
          description: Administrative description applied to the switch port override
        disabled:
          type: boolean
          description: Whether the port is disabled
          default: false
        duplex:
          allOf:
          - $ref: '#/components/schemas/switch_port_usage_duplex_overwrite2'
          - description: 'Link duplex mode override for the switch port. enum: `auto`, `full`, `half`.'
        mac_limit:
          anyOf:
          - maximum: 16383
            minimum: 0
            type: integer
            contentEncoding: int32
            default: 0
          - type: string
          description: MAC address learning limit override for the switch port
        poe_disabled:
          type: boolean
          description: Whether PoE capabilities are disabled for a port
          default: false
        poe_keep_state_when_reboot:
          type: boolean
          description: Whether Perpetual PoE is enabled; keeps PoE state across reboots
          default: false
        port_network:
          type: string
          description: Native network/vlan for untagged traffic
        speed:
          allOf:
          - $ref: '#/components/schemas/switch_port_usage_speed_overwrite2'
          - description: 'Link speed override for the switch port. enum: `10m`, `100m`, `1g`, `2.5g`, `5g`, `10g`, `25g`, `40g`, `100g`, `auto`.'
      description: Switch port configuration overrides
    switch_port_local_usage_dot1x:
      title: switch_port_local_usage_dot1x
      const: dot1x
      type: string
      description: 'if dot1x is desired, set to dot1x. enum: `dot1x`'
    switch_port_local_usage_duplex:
      title: switch_port_local_usage_duplex
      enum:
      - auto
      - full
      - half
      type: string
      description: 'link connection mode. enum: `auto`, `full`, `half`'
    switch_port_local_usage_mac_auth_protocol:
      title: switch_port_local_usage_mac_auth_protocol
      enum:
      - eap-md5
      - eap-peap
      - pap
      type: string
      description: 'Only if `enable_mac_auth` ==`true`. This type is ignored if mist_nac is enabled. enum: `eap-md5`, `eap-peap`, `pap`'
    switch_port_local_usage_mode:
      title: switch_port_local_usage_mode
      enum:
      - access
      - inet
      - trunk
      type: string
      description: 'enum: `access`, `inet`, `trunk`'
    switch_port_local_usage_storm_control:
      title: switch_port_local_usage_storm_control
      type: object
      properties:
        disable_port:
          type: boolean
          description: Whether to disable the port when storm control is triggered
          default: false
        no_broadcast:
          type: boolean
          description: Whether to disable storm control on broadcast traffic
          default: false
        no_multicast:
          type: boolean
          description: Whether to disable storm control on multicast traffic
          default: false
        no_registered_multicast:
          type: boolean
          description: Whether to disable storm control on registered multicast traffic
          default: false
        no_unknown_unicast:
          type: boolean
          description: Whether to disable storm control on unknown unicast traffic
          default: false
        percentage:
          maximum: 100
          minimum: 0
          type: integer
          description: Bandwidth-percentage, configures the storm control level as a percentage of the available bandwidth
          contentEncoding: int32
          default: 80
      description: Storm-control settings for this local port configuration
    switch_port_mirroring_property:
      title: switch_port_mirroring_property
      type: object
      properties:
        input_networks_ingress:
          type: array
          items:
            type: string
          description: At least one mirror input source should be specified. Networks whose ingress traffic is mirrored
        input_port_ids_egress:
          type: array
          items:
            type: string
          description: At least one mirror input source should be specified. Switch ports whose egress traffic is mirrored
        input_port_ids_ingress:
          type: array
          items:
            type: string
          description: At least one mirror input source should be specified. Switch ports whose ingress traffic is mirrored
        output_ip_address:
          type: string
          description: Exactly one of the `output_ip_address`, `output_port_id` or `output_network` should be provided
          examples:
          - 1.2.3.4
        output_network:
          type: string
          description: Exactly one of the `output_ip_address`, `output_port_id` or `output_network` should be provided
          examples:
          - analyze
        output_port_id:
          type: string
          description: Exactly one of the `output_ip_address`, `output_port_id` or `output_network` should be provided
          examples:
          - ge-0/0/5
      description: Input and output settings for one switch port mirroring session
    switch_port_usage:
      title: switch_port_usage
      type: object
      properties:
        all_networks:
          type: boolean
          description: Only if `mode`==`trunk`. Whether to trunk all network/vlans
          default: false
        allow_dhcpd:
          type: boolean
          description: 'Only applies when `mode`!=`dynamic`. Controls whether DHCP server traffic is allowed on ports using this configuration if DHCP snooping is enabled. This is a tri-state setting; `true`: ports become trusted ports allowing DHCP server traffic, `false`: ports become untrusted blocking DHCP server traffic, undefined: use system defaults (access ports default to untrusted, trunk ports default to trusted).'
        allow_multiple_supplicants:
          type: boolean
          description: Only if `mode`!=`dynamic`
          default: false
        bypass_auth_when_server_down:
          type: boolean
          description: Only if `mode`!=`dynamic` and `port_auth`==`dot1x`. Bypass auth for known clients if set to true when RADIUS server is down
          default: false
        bypass_auth_when_server_down_for_unknown_client:
          type: boolean
          description: Only if `mode`!=`dynamic` and `port_auth`=`dot1x`. Bypass auth for all (including unknown clients) if set to true when RADIUS server is down
          default: false
        bypass_auth_when_server_down_for_voip:
          type: boolean
          description: Only if `mode`!=`dynamic` and `port_auth`==`dot1x`. Bypass auth for VOIP if set to true when RADIUS server is down
          default: false
        community_vlan_id:
          type: integer
          description: Only if `mode`!=`dynamic`. To be used together with `isolation` under networks. Signaling that this port connects to the networks isolated but wired clients belong to the same community can talk to each other
          contentEncoding: int32
        description:
          type: string
          description: Only if `mode`!=`dynamic`
        disable_autoneg:
          type: boolean
          description: Only if `mode`!=`dynamic`. If speed and duplex are specified, whether to disable autonegotiation
          default: false
        disabled:
          type: boolean
          description: Only if `mode`!=`dynamic`. Whether the port is disabled
          default: false
        duplex:
          allOf:
          - $ref: '#/components/schemas/switch_port_usage_duplex2'
          - description: 'Only if `mode`!=`dynamic`. Link duplex mode for this port usage. enum: `auto`, `full`, `half`.'
        dynamic_vlan_networks:
          type: array
          items:
            type: string
          description: Only if `mode`!=`dynamic` and `port_auth`==`dot1x`. Networks or VLANs that RADIUS can return for dynamic VLAN assignment
          examples:
          - - corp
            - user
        enable_mac_auth:
          type: boolean
          description: Only if `mode`!=`dynamic` and `port_auth`==`dot1x`. Whether to enable MAC Auth
          default: false
        enable_qos:
          type: boolean
          description: Only if `mode`!=`dynamic`
          default: false
        guest_network:
          type:
          - string
          - 'null'
          description: Only if `mode`!=`dynamic` and `port_auth`==`dot1x`. Which network to put the device into if the device cannot do dot1x. default is null (i.e. not allowed)
        inter_isolation_network_link:
          type: boolean
          description: Only if `mode`!=`dynamic`. `inter_isolation_network_link` is used together with `isolation` under networks, signaling that this port connects to isolated networks
          default: false
        inter_switch_link:
          type: boolean
          description: 'Only if `mode`!=`dynamic`. `inter_switch_link` is used together with `isolation` under networks. NOTE: `inter_switch_link` works only between Juniper devices. This has to be applied to both ports connected together'
          default: false
        mac_auth_only:
          type: boolean
          description: Only if `mode`!=`dynamic` and `enable_mac_auth`==`true`
        mac_auth_preferred:
          type: boolean
          description: Only if `mode`!=`dynamic` + `enable_mac_auth`==`true` + `mac_auth_only`==`false`, dot1x will be given priority then mac_auth. Enable this to prefer mac_auth over dot1x.
        mac_auth_protocol:
          allOf:
          - $ref: '#/components/schemas/switch_port_usage_mac_auth_protocol2'
          - description: 'Only if `mode`!=`dynamic` and `enable_mac_auth`==`true`. MAC authentication protocol to use; ignored if Mist NAC is enabled. enum: `eap-md5`, `eap-peap`, `pap`.'
        mac_limit:
          anyOf:
          - maximum: 16383
            minimum: 0
            type: integer
            contentEncoding: int32
            default: 0
          - type: string
          description: Only if `mode`!=`dynamic`. Maximum number of MAC addresses allowed on the port; 0 means unlimited
        mode:
          allOf:
          - $ref: '#/components/schemas/switch_port_usage_mode2'
          - description: 'Switching mode for this port usage. enum: `access`, `dynamic`, `inet`, `trunk`.'
        mtu:
          anyOf:
          - maximum: 9216
            minimum: 256
            type: integer
            contentEncoding: int32
          - type: string
          description: Only if `mode`!=`dynamic`. MTU for ports using this port usage
        networks:
          type: array
          items:
            type: string
          description: Only if `mode`==`trunk`. Network or VLAN names to trunk
        persist_mac:
          type: boolean
          description: Only if `mode`==`access` and `port_auth`!=`dot1x`. Whether the port should retain dynamically learned MAC addresses
          default: false
        poe_disabled:
          type: boolean
          description: Only if `mode`!=`dynamic`. Whether PoE capabilities are disabled for a port
          default: false
        poe_keep_state_when_reboot:
          type: boolean
          description: Only if `mode`!=`dynamic`. Whether Perpetual PoE is enabled; keeps PoE state across reboots
          default: false
        poe_priority:
          allOf:
          - $ref: '#/components/schemas/poe_priority3'
          - description: 'Only if `mode`!=`dynamic`. PoE priority for ports using this port usage. enum: `low`, `high`.'
        port_auth:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/switch_port_usage_dot1x2'
          - description: 'Only if `mode`!=`dynamic`. 802.1X authentication mode for this port usage. enum: `dot1x`.'
        port_network:
          type: string
          description: Only if `mode`!=`dynamic`. Native network/vlan for untagged traffic
        reauth_interval:
          anyOf:
          - maximum: 65535
            minimum: 10
            type: integer
            contentEncoding: int32
            default: 3600
          - type: string
          description: Only if `mode`!=`dynamic` and `port_auth`==`dot1x`. RADIUS reauthentication interval for clients on the port
        reset_default_when:
          allOf:
          - $ref: '#/components/schemas/switch_port_usage_dynamic_reset_default_when2'
          - description: 'Only if `mode`==`dynamic`. Condition that resets a dynamic port to the default port usage. enum: `link_down`, `none`.'
            examples:
            - link_down
        rules:
          type: array
          items:
            $ref: '#/components/schemas/switch_port_usage_dynamic_rule'
          description: Only if `mode`==`dynamic`. Dynamic matching rules that select the port usage to apply
        server_fail_network:
          type:
          - string
          - 'null'
          description: Only if `mode`!=`dynamic` and `port_auth`==`dot1x`. Sets server fail fallback vlan
        server_fail_retry_interval:
          maximum: 65535
          minimum: 120
          type: integer
          description: Only if `mode`!=`dynamic` and `port_auth`==`dot1x`. Interval, in seconds. Sets the wait time before retrying authentication after RADIUS failure to reduce client flapping. Range 120-65535
          contentEncoding: int32
          default: 120
        server_reject_network:
          type:
          - string
          - 'null'
          description: Only if `mode`!=`dynamic` and `port_auth`==`dot1x`. When RADIUS server reject / fails
        speed:
          allOf:
          - $ref: '#/components/schemas/switch_port_usage_speed2'
          - description: 'Only if `mode`!=`dynamic`. Link speed for this port usage. enum: `10m`, `100m`, `1g`, `2.5g`, `5g`, `10g`, `25g`, `40g`, `100g`, `auto`.'
        storm_control:
          allOf:
          - $ref: '#/components/schemas/switch_port_usage_storm_control2'
          - description: Only if `mode`!=`dynamic`. Storm-control settings for this port usage
        stp_disable:
          type: boolean
          description: Only if `mode`!=`dynamic` and `stp_required`==`false`. Drop bridge protocol data units (BPDUs ) that enter any interface or a specified interface
          default: false
        stp_edge:
          type: boolean
          description: Only if `mode`!=`dynamic`. When enabled, the port is not expected to receive BPDU frames
          default: false
        stp_no_root_port:
          type: boolean
          description: Only if `mode`!=`dynamic`
          default: false
        stp_p2p:
          type: boolean
          description: Only if `mode`!=`dynamic`
          default: false
        stp_required:
          type: boolean
          description: Only if `mode`!=`dynamic`. Whether to remain in block state if no BPDU is received
          default: false
        ui_evpntopo_id:
          type: string
          description: Optional for Campus Fabric Core-Distribution ESI-LAG profile. Helper used by the UI to select this port profile as the ESI-Lag between Distribution and Access switches
          contentEncoding: uuid
        use_vstp:
          type: boolean
          description: If this is connected to a vstp network
          default: false
        voip_network:
          type:
          - string
          - 'null'
          description: Only if `mode`!=`dynamic`. Network/vlan for voip traffic, must also set port_network. to authenticate device, set port_auth
      description: Junos switch port usage template and authentication settings
    switch_port_usage_dot1x:
      title: switch_port_usage_dot1x
      const: dot1x
      type: string
      description: 'Only if `mode`!=`dynamic`. If dot1x is desired, set to dot1x. enum: `dot1x`'
    switch_port_usage_duplex:
      title: switch_port_usage_duplex
      enum:
      - auto
      - full
      - half
      type: string
      description: 'Only if `mode`!=`dynamic`. Link connection mode. enum: `auto`, `full`, `half`'
    switch_port_usage_duplex_overwrite:
      title: switch_port_usage_duplex_overwrite
      enum:
      - auto
      - full
      - half
      type: string
      description: 'Link connection mode. enum: `auto`, `full`, `half`'
    switch_port_usage_dynamic_reset_default_when:
      title: switch_port_usage_dynamic_reset_default_when
      enum:
      - link_down
      - none
      type: string
      description: 'Only if `mode`==`dynamic` Control when the DPC port should be changed to the default port usage. enum: `link_down`, `none` (let the DPC port keep at the current port usage)'
      examples:
      - link_down
    switch_port_usage_dynamic_rule:
      title: switch_port_usage_dynamic_rule
      required:
      - src
      type: object
      properties:
        description:
          type: string
          description: Optional description of the rule
        equals:
          type: string
          description: Exact value that the selected source attribute must match
        equals_any:
          type: array
          items:
            type: string
          description: List of values where any match satisfies this dynamic rule
        expression:
          type: string
          description: >-
            "[0:3]":"abcdef" -> "abc"

            "split(.)[1]": "a.b.c" -> "b"

            "split(-)[1][0:3]: "a1234-b5678-c90" -> "b56"
        src:
          allOf:
          - $ref: '#/components/schemas/switch_port_usage_dynamic_rule_src2'
          - description: 'Source attribute evaluated by this dynamic rule. enum: `link_peermac`, `lldp_chassis_id`, `lldp_hardware_revision`, `lldp_manufacturer_name`, `lldp_oui`, `lldp_serial_number`, `lldp_system_description`, `lldp_system_name`, `radius_dynamicfilter`, `radius_usermac`, `radius_username`.'
        usage:
          type: string
          description: Port usage name to apply when this dynamic rule matches
      description: Dynamic port usage rule evaluated against LLDP, RADIUS, or peer MAC attributes
    switch_port_usage_dynamic_rule_src:
      title: switch_port_usage_dynamic_rule_src
      enum:
      - link_peermac
      - lldp_chassis_id
      - lldp_hardware_revision
      - lldp_manufacturer_name
      - lldp_oui
      - lldp_serial_number
      - lldp_system_description
      - lldp_system_name
      - radius_dynamicfilter
      - radius_usermac
      - radius_username
      type: string
      description: 'enum: `link_peermac`, `lldp_chassis_id`, `lldp_hardware_revision`, `lldp_manufacturer_name`, `lldp_oui`, `lldp_serial_number`, `lldp_system_description`, `lldp_system_name`, `radius_dynamicfilter`, `radius_usermac`, `radius_username`'
    switch_port_usage_mac_auth_protocol:
      title: switch_port_usage_mac_auth_protocol
      enum:
      - eap-md5
      - eap-peap
      - pap
      type: string
      description: 'Only if `mode`!=`dynamic` and `enable_mac_auth` ==`true`. This type is ignored if mist_nac is enabled. enum: `eap-md5`, `eap-peap`, `pap`'
    switch_port_usage_mode:
      title: switch_port_usage_mode
      enum:
      - access
      - dynamic
      - inet
      - trunk
      type: string
      description: '`mode`==`dynamic` must only be used if the port usage name is `dynamic`. enum: `access`, `dynamic`, `inet`, `trunk`'
    switch_port_usage_speed:
      title: switch_port_usage_speed
      enum:
      - 10m
      - 100m
      - 1g
      - 2.5g
      - 5g
      - 10g
      - 25g
      - 40g
      - 100g
      - auto
      type: string
      description: 'Only if `mode`!=`dynamic`, Port speed, default is auto to automatically negotiate speed enum: `100m`, `10m`, `1g`, `2.5g`, `5g`, `10g`, `25g`, `40g`, `100g`,`auto`'
    switch_port_usage_speed_overwrite:
      title: switch_port_usage_speed_overwrite
      enum:
      - 10m
      - 100m
      - 1g
      - 2.5g
      - 5g
      - 10g
      - 25g
      - 40g
      - 100g
      - auto
      type: string
      description: 'Port Speed, default is auto to automatically negotiate speed enum: `100m`, `10m`, `1g`, `2.5g`, `5g`, `10g`, `25g`, `40g`, `100g`,`auto`'
    switch_port_usage_storm_control:
      title: switch_port_usage_storm_control
      type: object
      properties:
        disable_port:
          type: boolean
          description: Whether to disable the port when storm control is triggered
          default: false
        no_broadcast:
          type: boolean
          description: Whether to disable storm control on broadcast traffic
          default: false
        no_multicast:
          type: boolean
          description: Whether to disable storm control on multicast traffic
          default: false
        no_registered_multicast:
          type: boolean
          description: Whether to disable storm control on registered multicast traffic
          default: false
        no_unknown_unicast:
          type: boolean
          description: Whether to disable storm control on unknown unicast traffic
          default: false
        percentage:
          maximum: 100
          minimum: 0
          type: integer
          description: Bandwidth-percentage, configures the storm control level as a percentage of the available bandwidth
          contentEncoding: int32
          default: 80
      description: Switch storm control. Only if `mode`!=`dynamic`
    switch_radius:
      title: switch_radius
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether RADIUS is enabled for switch management authentication
        radius_config:
          allOf:
          - $ref: '#/components/schemas/switch_radius_config1'
          - description: RADIUS configuration used when alternate RADIUS settings are required
        use_different_radius:
          type: string
          description: Selector for alternate RADIUS settings instead of the default switch `radius_config`
      description: Switch RADIUS override settings. By default, the switch `radius_config` is used; set `use_different_radius` to use alternate RADIUS settings.
    switch_radius_config:
      title: switch_radius_config
      type: object
      properties:
        acct_immediate_update:
          type: boolean
          description: Whether immediate RADIUS accounting updates are sent
        acct_interim_interval:
          maximum: 65535
          minimum: 0
          type: integer
          description: How frequently should interim accounting be reported, 60-65535. default is 0 (use one specified in Access-Accept request from RADIUS Server). Very frequent messages can affect the performance of the RADIUS server, 600 and up is recommended when enabled
          contentEncoding: int32
          default: 0
        acct_servers:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/radius_acct_server'
          description: RADIUS accounting servers used by this switch configuration
        auth_server_selection:
          allOf:
          - $ref: '#/components/schemas/switch_radius_config_auth_server_selection2'
          - description: 'Selection strategy for RADIUS authentication servers. enum: `ordered`, `unordered`.'
        auth_servers:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/radius_auth_server'
          description: RADIUS authentication servers used by this switch configuration
        auth_servers_retries:
          type: integer
          description: RADIUS auth session retries
          contentEncoding: int32
          default: 3
        auth_servers_timeout:
          type: integer
          description: RADIUS auth session timeout
          contentEncoding: int32
          default: 5
        coa_enabled:
          type: boolean
          description: Whether RADIUS Change of Authorization (CoA) is enabled
          default: false
        coa_port:
          anyOf:
          - maximum: 65545
            minimum: 1
            type: integer
            contentEncoding: int32
          - type: string
          description: UDP port used for RADIUS Change of Authorization (CoA)
        fast_dot1x_timers:
          type: boolean
          description: Whether fast 802.1X timers are enabled for RADIUS authentication
          default: false
        network:
          type: string
          description: Use `network`or `source_ip`. Which network the RADIUS server resides, if there's static IP for this network, we'd use it as source-ip
        source_ip:
          type: string
          description: Use `network` or `source_ip`. Explicit source IP address for RADIUS traffic
      description: Switch RADIUS authentication and accounting configuration
    switch_radius_config_auth_server_selection:
      title: switch_radius_config_auth_server_selection
      enum:
      - ordered
      - unordered
      type: string
      description: 'Selection strategy for RADIUS authentication servers. enum: `ordered`, `unordered`'
    switch_search:
      title: switch_search
      required:
      - type
      type: object
      properties:
        clustered:
          type: boolean
          description: Whether the switch is part of a virtual chassis or cluster
        evpn_missing_links:
          type: boolean
          description: Whether EVPN topology links are missing for this switch
        evpntopo_id:
          type: string
          description: EVPN topology ID associated with this switch
        ext_ip:
          type: string
          description: External IP address observed for switch management traffic
        hostname:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Observed hostnames detected for the switch in search results
        ip:
          type: string
          description: Management IP address currently reported for the switch
        last_config_status:
          type: string
          description: Most recent configuration status reported for the switch
        last_hostname:
          type: string
          description: Most recent hostname detected for the switch
        last_trouble_code:
          type: string
          description: Most recent trouble code reported for the switch
        last_trouble_timestamp:
          type: number
          description: Time when the most recent switch trouble code was reported
          readOnly: true
        mac:
          type: string
          description: Switch MAC address reported in search results
        managed:
          type: boolean
          description: Whether the switch is managed by Mist. Deprecated in favor of `mist_configured`
          deprecated: true
        mist_configured:
          type: boolean
          description: whether the device can be configured by Mist or not. This deprecates `managed` (for adopted device) and `disable_auto_config` for claimed device)
        model:
          type: string
          description: Switch model reported for this search result
        num_members:
          type: integer
          description: Number of members in the switch virtual chassis, when applicable
          contentEncoding: int32
        org_id:
          type: string
          description: Organization that owns this switch search result
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        radius_stats:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/device_search_radius_stat'
          description: RADIUS statistics for this switch keyed by server IP address
        role:
          type: string
          description: Switch role reported for this search result
        site_id:
          type: string
          description: Site that contains this switch search result
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        time_drifted:
          type: boolean
          description: Whether the switch clock has drifted from the expected time
        timestamp:
          type: number
          description: Time associated with this switch search result
          readOnly: true
        type:
          const: switch
          type: string
          description: Device type for this switch search result
        uptime:
          type: integer
          description: Device uptime for the switch, in seconds
          contentEncoding: int32
        version:
          type: string
          description: Software version currently running on the switch
      description: Switch record returned by device search endpoints
    switch_stp_config:
      title: switch_stp_config
      type: object
      properties:
        bridge_priority:
          type: string
          description: Switch STP priority. Range [0, 4k, 8k.. 60k] in steps of 4k. Bridge priority applies to both VSTP and RSTP.
          default: 32k
          examples:
          - 40k
      description: Switch spanning-tree protocol configuration
    switch_virtual_chassis:
      title: switch_virtual_chassis
      type: object
      properties:
        members:
          type: array
          items:
            $ref: '#/components/schemas/switch_virtual_chassis_member'
          description: Virtual Chassis members and their expected roles
        preprovisioned:
          type: boolean
          description: To configure whether the VC is preprovisioned or nonprovisioned
          default: false
      description: Required for preprovisioned Virtual Chassis
    switch_virtual_chassis_member:
      title: switch_virtual_chassis_member
      required:
      - mac
      - member_id
      - vc_role
      type: object
      properties:
        mac:
          type: string
          description: Virtual Chassis member MAC address; for FPC0 this matches the device ID MAC
          examples:
          - aff827549235
        member_id:
          type: integer
          description: Virtual Chassis member identifier
          contentEncoding: int32
        vc_role:
          allOf:
          - $ref: '#/components/schemas/switch_virtual_chassis_member_vc_role2'
          - description: 'Role of this member in the Virtual Chassis. enum: `backup`, `linecard`, `master`.'
      description: Virtual Chassis member identified by MAC address and role
    switch_virtual_chassis_member_vc_role:
      title: switch_virtual_chassis_member_vc_role
      enum:
      - backup
      - linecard
      - master
      type: string
      description: 'Both vc_role master and backup will be matched to routing-engine role in Junos preprovisioned VC config. enum: `backup`, `linecard`, `master`'
    switch_vrf_instance:
      title: switch_vrf_instance
      type: object
      properties:
        aggregate_routes:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/aggregate_route'
          description: IPv4 aggregate routes configured for this VRF instance
          examples:
          - 172.16.3.0/24:
              discard: false
              metric: null
              preference: 30
        aggregate_routes6:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/aggregate_route'
          description: IPv6 aggregate routes configured for this VRF instance
          examples:
          - 2a02:1234:420a:10c9::/64:
              discard: false
              metric: null
              preference: 30
        evpn_auto_loopback_subnet:
          type: string
          description: IPv4 subnet used for automatic EVPN loopback addresses in this VRF instance
          examples:
          - 100.101.0.0/24
        evpn_auto_loopback_subnet6:
          type: string
          description: IPv6 subnet used for automatic EVPN loopback addresses in this VRF instance
        extra_routes:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/vrf_extra_route'
          description: Additional IPv4 static routes configured for this VRF instance
          examples:
          - 0.0.0.0/0:
              via: 192.168.1.10
        extra_routes6:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/vrf_extra_route6'
          description: Additional IPv6 static routes configured for this VRF instance
          examples:
          - 2a02:1234:420a:10c9::/64:
              via: 2a02:1234:200a::100
        multicast_config:
          allOf:
          - $ref: '#/components/schemas/switch_multicast_config3'
          - description: Multicast configuration for this VRF instance. PIM is automatically enabled when any network in this VRF has `multicast.enabled`==`true`
        networks:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Names of switch networks included in this VRF instance
      description: Switch VRF instance routing and network membership settings
      examples:
      - extra_routes:
          0.0.0.0/0:
            via: 192.168.31.1
        networks:
        - guest
    synthetictest:
      title: synthetictest
      type: object
      properties:
        email:
          type: string
          description: Contact email address supplied when triggering the site synthetic test
          contentEncoding: email
          examples:
          - test@mist.com
      description: Request body for triggering a site synthetic test
    synthetictest_config:
      title: synthetictest_config
      type: object
      properties:
        aggressiveness:
          allOf:
          - $ref: '#/components/schemas/synthetictest_config_aggressiveness3'
          - description: 'Overall aggressiveness level for synthetic test probes. enum: `auto`, `high`, `med`, `low`.'
        custom_probes:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/synthetictest_config_custom_probe'
          description: Custom synthetic probe definitions keyed by probe name
        disabled:
          type: boolean
          description: Whether synthetic tests are disabled
          default: false
        lan_networks:
          type: array
          items:
            $ref: '#/components/schemas/synthetictest_config_lan_network'
          description: LAN network probe groups used by synthetic tests
        vlans:
          type: array
          items:
            $ref: '#/components/schemas/synthetictest_config_vlan'
          description: Deprecated VLAN-based synthetic test settings
          deprecated: true
        wan_speedtest:
          allOf:
          - $ref: '#/components/schemas/synthetictest_config_wan_speedtest2'
          - description: WAN speedtest settings for synthetic tests
      description: Synthetic test configuration for Marvis Minis
    synthetictest_config_aggressiveness:
      title: synthetictest_config_aggressiveness
      enum:
      - auto
      - high
      - med
      - low
      type: string
      description: 'Aggressiveness level for a synthetic test. enum: `auto`, `high`, `med`, `low`'
    synthetictest_config_custom_probe:
      title: synthetictest_config_custom_probe
      type: object
      properties:
        aggressiveness:
          allOf:
          - $ref: '#/components/schemas/synthetictest_config_aggressiveness1'
          - description: 'Probe aggressiveness level for this custom synthetic probe. enum: `auto`, `high`, `med`, `low`.'
        target:
          type: string
          description: Can be URL (e.g. http://x.com, https://x.com:8080/path/to/resource), IP address, or IP:port combination
          examples:
          - 10.3.5.3:8080
        threshold:
          type: integer
          description: Response-time threshold for this custom probe, in milliseconds
          contentEncoding: int32
          examples:
          - 100
        type:
          allOf:
          - $ref: '#/components/schemas/synthetictest_config_custom_probe_type3'
          - description: 'Probe type used by this custom synthetic probe. enum: `application`, `curl`, `icmp`, `reachability`, `tcp`.'
      description: Custom probe definition for synthetic tests
    synthetictest_config_custom_probe_type:
      title: synthetictest_config_custom_probe_type
      enum:
      - application
      - curl
      - icmp
      - reachability
      - tcp
      type: string
      description: 'enum: `application`, `curl`, `icmp`, `reachability`, `tcp`'
    synthetictest_config_lan_network:
      title: synthetictest_config_lan_network
      type: object
      properties:
        networks:
          type: array
          items:
            type: string
          description: LAN network names where synthetic probes are run
          examples:
          - - pos-stations
            - pos-machines
        probes:
          type: array
          items:
            type: string
          description: Synthetic probe names to run on the listed LAN networks
      description: configure minis probes to be tested on lan networks of gateways
    synthetictest_config_vlan:
      title: synthetictest_config_vlan
      type: object
      properties:
        custom_test_urls:
          type: array
          items:
            type: string
          description: Deprecated custom URLs tested by VLAN-based synthetic probes
          examples:
          - - https://www.abc.com/
            - https://10.3.5.1:8080/about
          deprecated: true
        disabled:
          type: boolean
          description: For some vlans where we don't want this to run
          default: false
        probes:
          type: array
          items:
            type: string
          description: Synthetic probe names to run for the listed VLANs
        vlan_ids:
          type: array
          items:
            $ref: '#/components/schemas/vlan_id_with_variable'
          description: VLAN identifiers where synthetic probes are run
          examples:
          - - 10
            - 20
            - '{{vlan}}'
      description: Deprecated VLAN-based synthetic test settings
    synthetictest_config_wan_speedtest:
      title: synthetictest_config_wan_speedtest
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether scheduled WAN speedtests are enabled
        time_of_day:
          type: string
          description: Scheduled time of day for WAN speedtests
          default: any
          examples:
          - 12:00
      description: WAN speedtest scheduling settings for synthetic tests
    synthetictest_device:
      title: synthetictest_device
      required:
      - type
      type: object
      properties:
        host:
          type: string
          description: If `type`==`lan_connectivity`. Hostname or IP address to probe for LAN connectivity testing
          examples:
          - www.example.com
        hostname:
          type: string
          description: If `type`==`dns`. Hostname to resolve during the DNS synthetic test
          examples:
          - google.com"
        ip:
          type: string
          description: If `type`==`arp`. IP address to resolve through ARP during the synthetic test
          examples:
          - 192.168.3.5
        password:
          type: string
          description: If `type`==`radius`. Password used for RADIUS authentication testing
          contentEncoding: password
          examples:
          - test123
        ping_count:
          maximum: 60
          minimum: 10
          type: integer
          description: If `type`==`lan_connectivity`. Number of ping probes to send during the LAN connectivity test
          contentEncoding: int32
          default: 10
        ping_details:
          type: boolean
          description: If `type`==`lan_connectivity`. Whether to include per-ping results in the LAN connectivity test output
          default: false
        ping_size:
          maximum: 65535
          minimum: 56
          type: integer
          description: If `type`==`lan_connectivity`. Payload size, in bytes, for each ping probe
          contentEncoding: int32
          default: 56
        port_id:
          type: string
          description: If `type`==`speedtest`, required for ssr
          examples:
          - wan0
        protocol:
          allOf:
          - $ref: '#/components/schemas/synthetictest_device_protocol2'
          - description: 'If `type`==`lan_connectivity`. Protocol or protocol combination used for the connectivity test. enum: `ping`, `ping+traceroute`, `traceroute`.'
        tenant:
          type: string
          description: If `type`==`curl` or `type`==`lan_connectivity`
          examples:
          - lan_network1
        timeout:
          maximum: 120
          minimum: 30
          type: integer
          description: If `type`==`curl`. Timeout, in seconds, for the HTTP request
          contentEncoding: int32
          default: 60
          examples:
          - 60
        traceroute_udp_port:
          maximum: 65535
          minimum: 0
          type: integer
          description: SRX only, traceroute udp port
          contentEncoding: int32
          default: 33434
        type:
          allOf:
          - $ref: '#/components/schemas/synthetictest_type1'
          - description: 'Synthetic test type to run against the target. enum: `arp`, `curl`, `dhcp`, `dhcp6`, `dns`, `lan_connectivity`, `radius`, `speedtest`.'
        url:
          type: string
          description: If `type`==`curl`. URL requested during the HTTP synthetic test
          examples:
          - https://www.example.com
        username:
          type: string
          description: If `type`==`radius`. Username used for RADIUS authentication testing
          examples:
          - user
        vlan_id:
          oneOf:
          - type: string
          - maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
          description: Required for AP. VLAN ID used by the synthetic test when the target device is an AP
      description: Request body for triggering a synthetic test on a device
    synthetictest_device_protocol:
      title: synthetictest_device_protocol
      enum:
      - ping
      - ping+traceroute
      - traceroute
      type: string
      description: 'If `type`==`lan_connectivity`. Protocol or protocol combination used by the LAN connectivity test. enum: `ping`, `traceroute`, `ping+traceroute`'
    synthetictest_protocol:
      title: synthetictest_protocol
      enum:
      - ping
      - traceroute
      type: string
      description: 'Protocol used by a synthetic test probe. enum: `ping`, `traceroute`'
    synthetictest_radius_server:
      title: synthetictest_radius_server
      required:
      - password
      - user
      type: object
      properties:
        password:
          type: string
          description: Specify the password associated with the username
          contentEncoding: password
        profile:
          type: string
          description: Specify the access profile associated with the subscriber
          default: dot1x
        user:
          type: string
          description: Specify the subscriber username to test
      description: Request body for testing RADIUS server availability from a switch
    synthetictest_type:
      title: synthetictest_type
      enum:
      - arp
      - curl
      - dhcp
      - dhcp6
      - dns
      - lan_connectivity
      - radius
      - speedtest
      type: string
      description: 'enum: `arp`, `curl`, `dhcp`, `dhcp6`, `dns`, `lan_connectivity`, `radius`, `speedtest`'
    tacacs:
      title: tacacs
      type: object
      properties:
        acct_servers:
          type: array
          items:
            $ref: '#/components/schemas/tacacs_acct_server'
          description: TACACS+ accounting servers used for switch management sessions
        default_role:
          allOf:
          - $ref: '#/components/schemas/tacacs_default_role2'
          - description: 'Default switch-management role to use for TACACS+ logins. enum: `admin`, `helpdesk`, `none`, `read`.'
        enabled:
          type: boolean
          description: Whether TACACS+ is enabled for switch management authentication
        network:
          type: string
          description: Source network used for connectivity to the TACACS+ servers
        tacplus_servers:
          type: array
          items:
            $ref: '#/components/schemas/tacacs_auth_server'
          description: TACACS+ authentication servers used for switch management logins
      description: TACACS+ settings for switch management authentication and accounting
    tacacs_acct_server:
      title: tacacs_acct_server
      type: object
      properties:
        host:
          type: string
          description: Address or hostname of the TACACS+ accounting server
        port:
          type: string
          description: TCP port used by the TACACS+ accounting server
        secret:
          type: string
          description: Shared secret used with this TACACS+ accounting server
          contentEncoding: password
        timeout:
          type: integer
          description: TACACS+ accounting server timeout, in seconds
          contentEncoding: int32
          default: 10
      description: TACACS+ accounting server settings
    tacacs_auth_server:
      title: tacacs_auth_server
      type: object
      properties:
        host:
          type: string
          description: Address or hostname of the TACACS+ authentication server
        port:
          type: string
          description: TCP port used by the TACACS+ authentication server
        secret:
          type: string
          description: Shared secret used with this TACACS+ authentication server
          contentEncoding: password
        timeout:
          type: integer
          description: TACACS+ authentication server timeout, in seconds
          contentEncoding: int32
          default: 10
      description: TACACS+ authentication server settings
    tacacs_default_role:
      title: tacacs_default_role
      enum:
      - admin
      - helpdesk
      - none
      - read
      type: string
      description: 'enum: `admin`, `helpdesk`, `none`, `read`'
    template:
      title: template
      required:
      - name
      type: object
      properties:
        applies:
          allOf:
          - $ref: '#/components/schemas/template_applies2'
          - description: Organizations, sites, or site groups targeted by this WLAN template
        created_time:
          type: number
          description: Timestamp when the WLAN template was created
          readOnly: true
        deviceprofile_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Device profile IDs that further limit where this WLAN template applies
        exceptions:
          allOf:
          - $ref: '#/components/schemas/template_exceptions2'
          - description: Sites or site groups excluded from this WLAN template even when included by the application scope
        filter_by_deviceprofile:
          type: boolean
          description: Whether to further filter by Device Profile
        id:
          type: string
          description: Unique identifier of the WLAN template
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        modified_time:
          type: number
          description: Timestamp when the WLAN template was last modified
          readOnly: true
        name:
          type: string
          description: Display name of the WLAN template
        org_id:
          type: string
          description: Organization that owns this WLAN template
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
      description: WLAN template configuration applied across sites or site groups
    template_applies:
      title: template_applies
      type: object
      properties:
        org_id:
          type: string
          description: Organization included in the WLAN template application scope
          contentEncoding: uuid
        site_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Sites included in the WLAN template application scope
        sitegroup_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Site groups included in the WLAN template application scope
      description: Where this template should be applied to, can be org_id, site_ids, sitegroup_ids
    template_exceptions:
      title: template_exceptions
      type: object
      properties:
        site_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Sites excluded from the WLAN template application scope
        sitegroup_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Site groups excluded from the WLAN template application scope
      description: Where this template should not be applied to (takes precedence)
    test_cradlepoint:
      title: test_cradlepoint
      type: object
      properties:
        alert_config_id:
          type: string
          description: Cradlepoint alert configuration ID created by the integration setup
          readOnly: true
          examples:
          - 8b7e06ac-0yu5-11f1-88h2-42628k552c3d
        cp_api_id:
          type: string
          description: Cradlepoint API ID stored for the integration (masked)
          readOnly: true
          examples:
          - '********'
        cp_api_key:
          type: string
          description: Cradlepoint API key stored for the integration (masked)
          contentEncoding: password
          readOnly: true
          examples:
          - '********'
        destination_config_id:
          type: string
          description: Cradlepoint destination configuration ID created by the integration setup
          readOnly: true
          examples:
          - 8ad364de-0yu5-13r1-9abc-263675be6074
        ecm_api_id:
          type: string
          description: Cradlepoint ECM API ID stored for the integration (masked)
          readOnly: true
          examples:
          - '********'
        ecm_api_key:
          type: string
          description: Cradlepoint ECM API key stored for the integration (masked)
          contentEncoding: password
          readOnly: true
          examples:
          - '********'
        enable_lldp:
          type: boolean
          description: Whether Mist uses Cradlepoint LLDP data to link routers to Mist sites and devices
          readOnly: true
        error:
          type: string
          description: if status is `inactive` this field returns the reason for it being inactive.
          readOnly: true
          examples:
          - Cradlepoint API keys are no longer valid, please verify and update the keys under organization settings.
        last_status:
          allOf:
          - $ref: '#/components/schemas/test_cradlepoint_last_status2'
          - description: 'Integration status detected during the most recent Cradlepoint sync. enum: `active`, `inactive`.'
            examples:
            - inactive
          readOnly: true
        shared_secret:
          type: string
          description: Shared secret generated by the integration setup (masked)
          contentEncoding: password
          readOnly: true
          examples:
          - '********'
      description: Cradlepoint integration connectivity test result
    test_cradlepoint_last_status:
      title: test_cradlepoint_last_status
      enum:
      - active
      - inactive
      type: string
      description: 'status of integration detected during last sync. enum: `active`, `inactive`'
      examples:
      - inactive
    test_sms_global:
      title: test_sms_global
      required:
      - smsglobal_api_key
      - smsglobal_api_secret
      - to
      type: object
      properties:
        smsglobal_api_key:
          type: string
          description: SMSGlobal API key used to send the test SMS
          examples:
          - '123456'
        smsglobal_api_secret:
          type: string
          description: SMSGlobal API secret used to send the test SMS
          contentEncoding: password
          examples:
          - abcdef
        smsglobal_sender:
          type: string
          description: Optional sender's number or sender ID. If not provided, uses the default number associated with the account
          examples:
          - '61400000002'
        to:
          type: string
          description: Phone number of the recipient of SMS with country code
          examples:
          - '+911122334455'
      description: Request body for validating SMSGlobal SMS gateway credentials
    test_telstra:
      title: test_telstra
      required:
      - telstra_client_id
      - telstra_client_secret
      - to
      type: object
      properties:
        telstra_client_id:
          type: string
          description: Telstra client identifier used to send the test SMS
          examples:
          - '123456'
        telstra_client_secret:
          type: string
          description: Telstra client secret used to send the test SMS
          contentEncoding: password
          examples:
          - abcdef
        to:
          type: string
          description: Phone number of the recipient of SMS with country code
          examples:
          - '+911122334455'
      description: Request body for validating Telstra SMS gateway credentials
    test_twilio:
      title: test_twilio
      required:
      - from
      - to
      - twilio_auth_token
      - twilio_sid
      type: object
      properties:
        from:
          type: string
          description: One of the numbers you have in your Twilio account
          examples:
          - '+185051234567'
        to:
          type: string
          description: Phone number of the recipient of SMS
          examples:
          - '+19999999999'
        twilio_auth_token:
          type: string
          description: Twilio Auth Token used to send the test SMS
          examples:
          - 2135be04736a1a0a314bce432d61721a
        twilio_sid:
          type: string
          description: Twilio account SID used to send the test SMS
          examples:
          - REDACTED_TWILIO_ACCOUNT_SID
      description: Request body for validating Twilio SMS gateway credentials
    ticket:
      title: ticket
      required:
      - subject
      - type
      type: object
      properties:
        case_number:
          type: string
          description: Support case number associated with this ticket
          readOnly: true
        comments:
          type: array
          items:
            $ref: '#/components/schemas/ticket_comment'
          description: Discussion comments recorded on this support ticket
        created_at:
          type: integer
          description: Time when this support ticket was created, in epoch seconds
          contentEncoding: int32
          readOnly: true
        id:
          type: string
          description: Unique identifier for this support ticket
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        requester:
          type: string
          description: User who opened or requested this support ticket
          readOnly: true
        requester_email:
          type: string
          description: Email of the requester
          contentEncoding: email
        status:
          allOf:
          - $ref: '#/components/schemas/ticket_status2'
          - description: 'Current lifecycle status of this support ticket. enum: `closed`, `open`, `pending`, `solved`.'
        subject:
          type: string
          description: Short summary of the support request
        type:
          type: string
          description: Question (default) / bug / critical
        updated_at:
          type: integer
          description: Time when this support ticket was last updated, in epoch seconds
          contentEncoding: int32
          readOnly: true
      description: Support ticket record with status, comments, and metadata
    ticket_attachment:
      title: ticket_attachment
      type: object
      properties:
        content_url:
          type: string
          description: Download URL for the support ticket attachment
          examples:
          - https://api.mist.com/api/v1/forward/download?jwt=...
      description: Download information for a support ticket attachment
    ticket_comment:
      title: ticket_comment
      required:
      - author
      - comment
      - created_at
      type: object
      properties:
        attachment_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Identifiers of attachments linked to this ticket comment
          readOnly: true
          examples:
          - - 00000000-0000-0000-0000-15231a659c78
        attachments:
          type: array
          items:
            $ref: '#/components/schemas/ticket_comments_attachment'
          description: Attachment metadata returned with this ticket comment
          readOnly: true
        author:
          type: string
          description: User who wrote this ticket comment
          readOnly: true
        comment:
          type: string
          description: Text body of this ticket comment
        created_at:
          type: integer
          description: Time when this ticket comment was created, in epoch seconds
          contentEncoding: int32
          readOnly: true
      description: Comment on a support ticket
    ticket_comment_import_file:
      title: ticket_comment_import_file
      type: object
      properties:
        comment:
          type: string
          description: Text body for the ticket comment submitted with the uploaded file
          examples:
          - this is urgent
        file:
          type: string
          description: Binary file payload to attach to the ticket comment
          contentEncoding: base64
      description: Multipart payload for adding a ticket comment with an attachment
    ticket_comments_attachment:
      title: ticket_comments_attachment
      type: object
      properties:
        content_type:
          type: string
          description: MIME type of the ticket comment attachment
          examples:
          - image/png
        content_url:
          type: string
          description: Download URL for the ticket comment attachment
          examples:
          - https://api.mist.com/api/v1/forward/download?jwt=...
        created_at:
          type: integer
          description: Time when this ticket comment attachment was created, in epoch seconds
          contentEncoding: int32
          examples:
          - 1453908369
        file_name:
          type: string
          description: Original file name of the ticket comment attachment
          examples:
          - crash.png
        id:
          type: string
          description: Unique identifier for this ticket comment attachment
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        size_in_bytes:
          type: integer
          description: Attachment file size, in bytes
          contentEncoding: int32
          examples:
          - 1943
      description: Metadata for an attachment on a ticket comment
    ticket_status:
      title: ticket_status
      enum:
      - closed
      - open
      - pending
      - solved
      type: string
      description: 'Ticket status. enum: `closed`, `open`, `pending`, `solved`. `open` means Mist is working on it, `pending` means requester attention is needed, `solved` means Mist considers it resolved but it can still be updated or rated, and `closed` means it is archived'
    ticket_upload_attachments_file:
      title: ticket_upload_attachments_file
      type: object
      properties:
        file:
          type: string
          description: Ekahau or ibwave file
          contentEncoding: base64
      description: Multipart upload payload containing a ticket attachment file
    troubleshoot_type:
      title: troubleshoot_type
      enum:
      - wan
      - wired
      - wireless
      type: string
      description: 'enum: `wan`, `wired`, `wireless`'
    tunnel_config:
      title: tunnel_config
      type: object
      properties:
        auto_provision:
          allOf:
          - $ref: '#/components/schemas/tunnel_config_auto_provision2'
          - description: Provider auto-provisioning settings for tunnel endpoints
        ike_lifetime:
          type: integer
          description: Only if `provider`==`custom-ipsec`. IKE lifetime configured for the custom IPsec tunnel
          contentEncoding: int32
        ike_mode:
          allOf:
          - $ref: '#/components/schemas/tunnel_config_ike_mode2'
          - description: 'Only if `provider`==`custom-ipsec`. IKE negotiation mode for the tunnel. enum: `aggressive`, `main`.'
        ike_proposals:
          type: array
          items:
            $ref: '#/components/schemas/tunnel_config_ike_proposal'
          description: If `provider`==`custom-ipsec`, IKE proposals used for custom IPsec negotiation
        ipsec_lifetime:
          type: integer
          description: If `provider`==`custom-ipsec`, IPsec lifetime configured for the custom tunnel
          contentEncoding: int32
        ipsec_proposals:
          type: array
          items:
            $ref: '#/components/schemas/tunnel_config_ipsec_proposal'
          description: Only if `provider`==`custom-ipsec`. IPsec proposals used for custom IPsec negotiation
        local_id:
          type: string
          description: Required if `provider`==`zscaler-ipsec`, `provider`==`jse-ipsec` or `provider`==`custom-ipsec`
        local_subnets:
          type: array
          items:
            type: string
          description: Local protected subnets advertised by this tunnel
        mode:
          allOf:
          - $ref: '#/components/schemas/tunnel_config_tunnel_mode2'
          - description: 'Tunnel failover mode used for primary and secondary endpoints. enum: `active-active`, `active-standby`.'
        networks:
          type: array
          items:
            type: string
          description: Destination networks reachable through this tunnel
        primary:
          allOf:
          - $ref: '#/components/schemas/tunnel_config_node3'
          - description: Main remote tunnel endpoint settings
        probe:
          allOf:
          - $ref: '#/components/schemas/tunnel_config_probe'
          - description: Tunnel health probe settings
        protocol:
          allOf:
          - $ref: '#/components/schemas/tunnel_config_protocol2'
          - description: 'Only if `provider`==`custom-ipsec`. Tunnel protocol for custom tunnel negotiation. enum: `gre`, `ipsec`.'
        provider:
          allOf:
          - $ref: '#/components/schemas/tunnel_config_provider2'
          - description: 'Tunnel provider used when auto provisioning is disabled. enum: `custom-ipsec`, `custom-gre`, `jse-ipsec`, `prisma-ipsec`, `zscaler-gre`, `zscaler-ipsec`.'
        psk:
          type: string
          description: Required if `provider`==`zscaler-ipsec`, `provider`==`jse-ipsec` or `provider`==`custom-ipsec`
        remote_subnets:
          type: array
          items:
            type: string
          description: Remote protected subnets reached through policy-based IPsec
        secondary:
          allOf:
          - $ref: '#/components/schemas/tunnel_config_node1'
          - description: Backup remote tunnel endpoint settings
        version:
          allOf:
          - $ref: '#/components/schemas/tunnel_config_version2'
          - description: 'Only if `provider`==`custom-gre` or `provider`==`custom-ipsec`. Tunnel version value for custom tunnel configuration. enum: `1`, `2`.'
      description: Gateway tunnel configuration for provider-managed or custom tunnels
    tunnel_config_auth_algo:
      title: tunnel_config_auth_algo
      enum:
      - md5
      - sha1
      - sha2
      type: string
      description: 'enum: `md5`, `sha1`, `sha2`'
    tunnel_config_auto_provision:
      title: tunnel_config_auto_provision
      required:
      - provider
      type: object
      properties:
        enabled:
          type: boolean
          description: Enable auto provisioning for the tunnel. If enabled, the `primary` and `secondary` nodes will be ignored.
        latlng:
          allOf:
          - $ref: '#/components/schemas/tunnel_config_auto_provision_lat_lng2'
          - description: Geographic coordinate override used for tunnel POP selection
        primary:
          allOf:
          - $ref: '#/components/schemas/tunnel_config_auto_provision_node3'
          - description: Main auto-provisioned tunnel endpoint settings
        provider:
          allOf:
          - $ref: '#/components/schemas/tunnel_config_auto_provision_provider2'
          - description: 'Tunnel provider used for automatic endpoint provisioning. enum: `jse-ipsec`, `zscaler-ipsec`.'
        region:
          type: string
          description: API override for POP selection in the case user wants to override the auto discovery of remote network location and force the tunnel to use the specified peer location.
        secondary:
          allOf:
          - $ref: '#/components/schemas/tunnel_config_auto_provision_node1'
          - description: Backup auto-provisioned tunnel endpoint settings
        service_connection:
          type: string
          description: if `provider`==`prisma-ipsec`. By default, we'll use the location of the site to determine the optimal Remote Network location, optionally, service_connection can be considered, then we'll also consider this along with the site location. Define service_connection if the traffic is to be routed to a specific service connection. This field takes a service connection name that is configured in the Prisma cloud, Prisma Access Setup -> Service Connections.
          examples:
          - Juniper-Lab-SC-1
      description: Auto-provisioning configuration for the tunnel. This takes precedence over the `primary` and `secondary` nodes.
    tunnel_config_auto_provision_lat_lng:
      title: tunnel_config_auto_provision_lat_lng
      required:
      - lat
      - lng
      type: object
      properties:
        lat:
          type: number
          description: Geographic latitude used for POP selection override
          examples:
          - 37.295833
        lng:
          type: number
          description: Geographic longitude used for POP selection override
          examples:
          - -122.032946
      description: Geographic coordinate override for tunnel POP selection
    tunnel_config_auto_provision_node:
      title: tunnel_config_auto_provision_node
      type: object
      properties:
        probe_ips:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Probe IP addresses used to monitor auto-provisioned tunnel reachability
        wan_names:
          type: array
          items:
            type: string
          description: WAN interface names used by the auto-provisioned tunnel endpoint
      description: Auto-provisioned tunnel endpoint settings
    tunnel_config_auto_provision_provider:
      title: tunnel_config_auto_provision_provider
      enum:
      - jse-ipsec
      - zscaler-ipsec
      type: string
      description: 'Tunnel provider used for automatic endpoint provisioning. enum: `jse-ipsec`, `zscaler-ipsec`'
    tunnel_config_dh_group:
      title: tunnel_config_dh_group
      enum:
      - '1'
      - '14'
      - '15'
      - '16'
      - '19'
      - '2'
      - '20'
      - '21'
      - '24'
      - '5'
      type: string
      description: 'Only if `provider`==`custom-ipsec`. Diffie-Hellman group for IPsec phase 2. enum: `1`, `14`, `15`, `16`, `19`, `2`, `20`, `21`, `24`, `5`. `14` is the default 2048-bit group; `19`, `20`, `21`, and `24` are ECP groups'
    tunnel_config_enc_algo:
      title: tunnel_config_enc_algo
      enum:
      - 3des
      - aes128
      - aes256
      - aes_gcm128
      - aes_gcm256
      type: string
      description: 'enum: `3des`, `aes128`, `aes256`, `aes_gcm128`, `aes_gcm256`'
    tunnel_config_ike_dh_group:
      title: tunnel_config_ike_dh_group
      enum:
      - '1'
      - '14'
      - '15'
      - '16'
      - '19'
      - '2'
      - '20'
      - '21'
      - '24'
      - '5'
      type: string
      description: 'Diffie-Hellman group for IKE phase 1. enum: `1`, `14`, `15`, `16`, `19`, `2`, `20`, `21`, `24`, `5`. `14` is the default 2048-bit group; `19`, `20`, `21`, and `24` are ECP groups'
    tunnel_config_ike_mode:
      title: tunnel_config_ike_mode
      enum:
      - aggressive
      - main
      type: string
      description: 'Only if `provider`==`custom-ipsec`. enum: `aggressive`, `main`'
    tunnel_config_ike_proposal:
      title: tunnel_config_ike_proposal
      type: object
      properties:
        auth_algo:
          allOf:
          - $ref: '#/components/schemas/tunnel_config_auth_algo3'
          - description: 'Integrity algorithm used by this IKE proposal. enum: `md5`, `sha1`, `sha2`.'
        dh_group:
          allOf:
          - $ref: '#/components/schemas/tunnel_config_ike_dh_group2'
          - description: 'Diffie-Hellman group used by this IKE proposal. enum: `1`, `14`, `15`, `16`, `19`, `2`, `20`, `21`, `24`, `5`.'
        enc_algo:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/tunnel_config_enc_algo3'
          - description: 'Cipher algorithm used by this IKE proposal. enum: `3des`, `aes128`, `aes256`, `aes_gcm128`, `aes_gcm256`.'
      description: IKE proposal settings for custom IPsec tunnels
    tunnel_config_ipsec_proposal:
      title: tunnel_config_ipsec_proposal
      type: object
      properties:
        auth_algo:
          allOf:
          - $ref: '#/components/schemas/tunnel_config_auth_algo1'
          - description: 'Integrity algorithm used by this IPsec proposal. enum: `md5`, `sha1`, `sha2`.'
        dh_group:
          allOf:
          - $ref: '#/components/schemas/tunnel_config_dh_group2'
          - description: 'Diffie-Hellman group used by this IPsec proposal. enum: `1`, `14`, `15`, `16`, `19`, `2`, `20`, `21`, `24`, `5`.'
        enc_algo:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/tunnel_config_enc_algo1'
          - description: 'Cipher algorithm used by this IPsec proposal. enum: `3des`, `aes128`, `aes256`, `aes_gcm128`, `aes_gcm256`.'
      description: IPsec proposal settings for custom IPsec tunnels
    tunnel_config_node:
      title: tunnel_config_node
      required:
      - hosts
      - wan_names
      type: object
      properties:
        hosts:
          type: array
          items:
            type: string
          description: Remote gateway host addresses for this tunnel node
        internal_ip6s:
          uniqueItems: true
          type: array
          items:
            type: string
          description: IPv6 addresses configured on this tunnel node
        internal_ips:
          type: array
          items:
            type: string
          description: Internal IP addresses configured on this tunnel node
        probe_hostnames:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Hostnames used as ICMP probe destinations for this tunnel node; applicable for both IPv4 and IPv6
        probe_http:
          allOf:
          - $ref: '#/components/schemas/tunnel_config_node_probe_http2'
          - description: HTTP probe settings for this tunnel node; success from any ICMP or HTTP probe indicates the tunnel is up
        probe_ip6s:
          uniqueItems: true
          type: array
          items:
            type: string
          description: IPv6 ICMP probe addresses used to monitor this tunnel node
        probe_ips:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Health-check IP addresses used to monitor this tunnel node
        remote_ids:
          type: array
          items:
            type: string
          description: IKE identities expected from this tunnel node
        wan_names:
          type: array
          items:
            type: string
          description: Interface names that source tunnel traffic for this node
      description: Only if `provider`==`zscaler-ipsec`, `provider`==`jse-ipsec` or `provider`==`custom-ipsec`
    tunnel_config_node_probe_http:
      title: tunnel_config_node_probe_http
      type: object
      properties:
        accepted_status_codes:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: HTTP response status codes that indicate a successful probe. Defaults to 200 if not specified.
          examples:
          - - 204
        urls:
          type: array
          items:
            type: string
          description: HTTP or HTTPS URLs to probe
          examples:
          - - http://www.google.com/generate_204
            - https://www.google.com/generate_204
      description: HTTP probe settings for a custom IPsec tunnel node
    tunnel_config_probe:
      title: tunnel_config_probe
      type: object
      properties:
        interval:
          type: integer
          description: How often to trigger the probe
          contentEncoding: int32
        threshold:
          type: integer
          description: Number of consecutive misses before declaring the tunnel down
          contentEncoding: int32
        timeout:
          type: integer
          description: Time within which to complete the connectivity check
          contentEncoding: int32
        type:
          allOf:
          - $ref: '#/components/schemas/tunnel_config_probe_type2'
          - description: 'Protocol used by the custom IPsec tunnel health probe. enum: `http`, `icmp`.'
      description: Tunnel health probe settings
    tunnel_config_probe_type:
      title: tunnel_config_probe_type
      enum:
      - http
      - icmp
      type: string
      description: 'Protocol used by the custom IPsec tunnel health probe. `http` is deprecated — use `probe_ips`/`probe_hostnames` for ICMP probes and `probe_http` for HTTP probes instead. enum: `http`, `icmp`'
    tunnel_config_protocol:
      title: tunnel_config_protocol
      enum:
      - gre
      - ipsec
      type: string
      description: 'Only if `provider`==`custom-ipsec`. enum: `gre`, `ipsec`'
    tunnel_config_provider:
      title: tunnel_config_provider
      enum:
      - custom-ipsec
      - custom-gre
      - jse-ipsec
      - prisma-ipsec
      - zscaler-gre
      - zscaler-ipsec
      type: string
      description: 'Only if `auto_provision.enabled`==`false`. enum: `custom-ipsec`, `custom-gre`, `jse-ipsec`, `prisma-ipsec`, `zscaler-gre`, `zscaler-ipsec`'
    tunnel_config_tunnel_mode:
      title: tunnel_config_tunnel_mode
      enum:
      - active-active
      - active-standby
      type: string
      description: 'Required if `provider`==`zscaler-gre`, `provider`==`jse-ipsec`. enum: `active-active`, `active-standby`'
    tunnel_config_version:
      title: tunnel_config_version
      enum:
      - '1'
      - '2'
      type: string
      description: 'Only if `provider`==`custom-gre` or `provider`==`custom-ipsec`. enum: `1`, `2`'
    tunnel_priority:
      title: tunnel_priority
      enum:
      - primary
      - secondary
      type: string
      description: 'Relative preference assigned to the tunnel. enum: `primary`, `secondary`'
    tunnel_provider_options:
      title: tunnel_provider_options
      type: object
      properties:
        jse:
          allOf:
          - $ref: '#/components/schemas/tunnel_provider_options_jse2'
          - description: Juniper Secure Edge provisioning options for tunnel endpoints
        prisma:
          allOf:
          - $ref: '#/components/schemas/tunnel_provider_options_prisma2'
          - description: Palo Alto Prisma Access provisioning options for tunnel endpoints
        zscaler:
          allOf:
          - $ref: '#/components/schemas/tunnel_provider_options_zscaler2'
          - description: Provider settings for Zscaler tunnel endpoints
      description: Provider-specific options for gateway tunnel auto provisioning
    tunnel_provider_options_jse:
      title: tunnel_provider_options_jse
      type: object
      properties:
        num_users:
          type: integer
          description: User capacity to provision on Juniper Secure Edge
          contentEncoding: int32
          examples:
          - 5
        org_name:
          type: string
          description: JSE Organization name. The list of available organizations can be retrieved with the [Get Org JSE Info]($e/Orgs%20Integration%20JSE/getOrgJseInfo) API Call
          examples:
          - JSE_ORG1
      description: For jse-ipsec, this allows provisioning of adequate resource on JSE. Make sure adequate licenses are added
    tunnel_provider_options_prisma:
      title: tunnel_provider_options_prisma
      type: object
      properties:
        service_account_name:
          type: string
          description: For prisma-ipsec, service account name to used for tunnel auto provisioning
          examples:
          - sa1@1823425211
      description: Prisma Access provider options for tunnel auto provisioning
    tunnel_provider_options_zscaler:
      title: tunnel_provider_options_zscaler
      type: object
      properties:
        aup_block_internet_until_accepted:
          type: boolean
          description: Whether Zscaler blocks internet access until the Acceptable Use Policy is accepted
          default: false
        aup_enabled:
          type: boolean
          description: Can only be `true` when `auth_required`==`false`, display Acceptable Use Policy (AUP)
          default: false
        aup_force_ssl_inspection:
          type: boolean
          description: Proxy HTTPs traffic, requiring Zscaler cert to be installed in browser
          default: false
        aup_timeout_in_days:
          maximum: 180
          minimum: 1
          type: integer
          description: Required if `aup_enabled`==`true`. Days before AUP is requested again
          contentEncoding: int32
        auth_required:
          type: boolean
          description: Enable this option to enforce user authentication
          default: false
        caution_enabled:
          type: boolean
          description: Can only be `true` when `auth_required`==`false`, display caution notification for non-authenticated users
          default: false
        dn_bandwidth:
          maximum: 99999
          minimum: 0.1
          type:
          - number
          - 'null'
          description: Download bandwidth cap of the link, in Mbps. Disabled if not set
          examples:
          - 200
        idle_time_in_minutes:
          maximum: 43200
          minimum: 0
          type: integer
          description: Required if `surrogate_IP`==`true`, idle Time to Disassociation
          contentEncoding: int32
        ofw_enabled:
          type: boolean
          description: If `true`, enable the firewall control option
          default: false
        sub_locations:
          type: array
          items:
            $ref: '#/components/schemas/tunnel_provider_options_zscaler_sub_location'
          description: Per-network Zscaler sub-location settings
        surrogate_IP:
          type: boolean
          description: Can only be `true` when `auth_required`==`true`. Map a user to a private IP address so it applies the user's policies, instead of the location's policies
          default: false
        surrogate_IP_enforced_for_known_browsers:
          type: boolean
          description: Can only be `true` when `surrogate_IP`==`true`, enforce surrogate IP for known browsers
        surrogate_refresh_time_in_minutes:
          maximum: 43200
          minimum: 1
          type: integer
          description: Required if `surrogate_IP_enforced_for_known_browsers`==`true`, must be lower or equal than `idle_time_in_minutes`, refresh Time for re-validation of Surrogacy
          contentEncoding: int32
        up_bandwidth:
          maximum: 99999
          minimum: 0.1
          type:
          - number
          - 'null'
          description: Download bandwidth cap of the link, in Mbps. Disabled if not set
          examples:
          - 200
        xff_forward_enabled:
          type: boolean
          description: Location uses proxy chaining to forward traffic
          default: false
      description: For zscaler-ipsec and zscaler-gre
    tunnel_provider_options_zscaler_sub_location:
      title: tunnel_provider_options_zscaler_sub_location
      type: object
      properties:
        aup_block_internet_until_accepted:
          type: boolean
          description: Whether this sub-location blocks internet access until the Acceptable Use Policy is accepted
          default: false
        aup_enabled:
          type: boolean
          description: Can only be `true` when `auth_required`==`false`, display Acceptable Use Policy (AUP)
          default: false
        aup_force_ssl_inspection:
          type: boolean
          description: Proxy HTTPs traffic, requiring Zscaler cert to be installed in browser
          default: false
        aup_timeout_in_days:
          maximum: 180
          minimum: 1
          type: integer
          description: Required if `aup_enabled`==`true`. Days before AUP is requested again
          contentEncoding: int32
        auth_required:
          type: boolean
          description: Enable this option to authenticate users
          default: false
        caution_enabled:
          type: boolean
          description: Can only be `true` when `auth_required`==`false`, display caution notification for non-authenticated users
          default: false
        dn_bandwidth:
          maximum: 99999
          minimum: 0.1
          type:
          - number
          - 'null'
          description: Download bandwidth cap of the link, in Mbps. Disabled if not set
          examples:
          - 200
        idle_time_in_minutes:
          maximum: 43200
          minimum: 0
          type: integer
          description: Required if `surrogate_IP`==`true`, idle Time to Disassociation
          contentEncoding: int32
        name:
          type: string
          description: '[network]($h/Orgs%20Networks/_overview) name'
        ofw_enabled:
          type: boolean
          description: If `true`, enable the firewall control option
          default: false
        surrogate_IP:
          type: boolean
          description: Can only be `true` when `auth_required`==`true`. Map a user to a private IP address so it applies the user's policies, instead of the location's policies
          default: false
        surrogate_IP_enforced_for_known_browsers:
          type: boolean
          description: Can only be `true` when `surrogate_IP`==`true`, enforce surrogate IP for known browsers
        surrogate_refresh_time_in_minutes:
          maximum: 43200
          minimum: 1
          type: integer
          description: Required if `surrogate_IP_enforced_for_known_browsers`==`true`, must be lower or equal than `idle_time_in_minutes`, refresh Time for re-validation of Surrogacy
          contentEncoding: int32
        up_bandwidth:
          maximum: 99999
          minimum: 0.1
          type:
          - number
          - 'null'
          description: Download bandwidth cap of the link, in Mbps. Disabled if not set
          examples:
          - 200
      description: Zscaler sub-location settings for a specific network
    tunnel_type:
      title: tunnel_type
      enum:
      - wan
      - wxtunnel
      type: string
      description: 'Tunnel category, either WAN tunnel or WxLAN tunnel. enum: `wan`, `wxtunnel`'
    tunnel_via:
      title: tunnel_via
      enum:
      - primary
      - secondary
      type: string
      description: 'If `via`==`tunnel`, specifies which tunnel (primary/secondary) this neighbor is associated with. enum: `primary`, `secondary`'
    tunterm_dhcpd_config:
      title: tunterm_dhcpd_config
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether DHCP relay is enabled for tunnel termination VLANs
          default: false
        servers:
          uniqueItems: true
          type: array
          items:
            type: string
          description: DHCP server IP addresses used as relay targets
        type:
          allOf:
          - $ref: '#/components/schemas/tunterm_dhcpd_type3'
          - description: 'DHCP forwarding mode for tunnel termination VLANs. enum: `relay`.'
      additionalProperties:
        allOf:
        - $ref: '#/components/schemas/tunterm_dhcpd_config_property'
        - description: Per-VLAN DHCP relay configuration for tunnel termination
      description: DHCP server/relay configuration of Mist Tunneled VLANs. Property key is the VLAN ID
    tunterm_dhcpd_config_property:
      title: tunterm_dhcpd_config_property
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether DHCP relay is enabled for this tunneled VLAN
          default: false
        servers:
          uniqueItems: true
          type: array
          items:
            type: string
          description: DHCP server IP addresses used as relay targets for this VLAN
        type:
          allOf:
          - $ref: '#/components/schemas/tunterm_dhcpd_type1'
          - description: 'DHCP forwarding mode for this tunneled VLAN. enum: `relay`.'
      description: Per-VLAN DHCP relay configuration for tunnel termination
    tunterm_dhcpd_type:
      title: tunterm_dhcpd_type
      const: relay
      type: string
      description: 'DHCP handling mode for tunnel termination. enum: `relay`'
    tunterm_monitoring_protocol:
      title: tunterm_monitoring_protocol
      enum:
      - arp
      - ping
      - tcp
      type: string
      description: 'enum: `arp`, `ping`, `tcp`'
      examples:
      - tcp
    tunterm_port_config:
      title: tunterm_port_config
      type: object
      properties:
        downstream_ports:
          type: array
          items:
            type: string
          description: Ports connected downstream toward APs for tunnel termination
          examples:
          - - '2'
            - '3'
        separate_upstream_downstream:
          type: boolean
          description: Whether to separate upstream / downstream ports. default is false where all ports will be used.
          default: false
        upstream_port_vlan_id:
          oneOf:
          - type: string
          - maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
          description: Native VLAN ID applied to upstream tunnel termination ports
        upstream_ports:
          type: array
          items:
            type: string
          description: Ports connected upstream toward the LAN for tunnel termination
          examples:
          - - '0'
            - '1'
      description: Ethernet port configuration for tunnel termination interfaces
    two_factor_code:
      title: two_factor_code
      required:
      - two_factor
      type: object
      properties:
        two_factor:
          type: string
          description: One-time password generated by the user's authenticator app
          examples:
          - '123456'
      description: Request body for verifying a 2FA one-time password
    two_factor_string:
      title: two_factor_string
      required:
      - two_factor
      type: object
      properties:
        two_factor:
          type: string
          description: One-time 2FA login code generated by the user's authenticator app
          examples:
          - '123456'
      description: Request body for submitting a 2FA login code
    ui_settings:
      title: ui_settings
      required:
      - description
      - purpose
      type: object
      properties:
        created_time:
          type: number
          description: Time when the databoard was created, in epoch seconds
          readOnly: true
        defaultScopeId:
          type: string
          description: Scope identifier used by default for this databoard
          examples:
          - 67970e46-4e12-11e6-9188-0242ad112847
        defaultScopeType:
          type: string
          description: Scope type used by default for this databoard
          examples:
          - site
        defaultTimeRange:
          allOf:
          - $ref: '#/components/schemas/ui_settings_default_time_range2'
          - description: Time range used by default for this databoard
        description:
          type: string
          description: Text describing the databoard
          examples:
          - Description of the databoard
        for_site:
          type: boolean
          description: Whether this databoard is scoped to a site
          readOnly: true
          examples:
          - true
        id:
          type: string
          description: Unique identifier for the databoard
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        isCustomDataboard:
          type: boolean
          description: Whether this databoard is custom-created
        isScopeLinked:
          type: boolean
          description: Whether tile scopes are linked to the databoard default scope
        isTimeRangeLinked:
          type: boolean
          description: Whether tile time ranges are linked to the databoard default time range
        modified_time:
          type: number
          description: Time when the databoard was last modified, in epoch seconds
          readOnly: true
        name:
          type: string
          description: Display name of the databoard
          examples:
          - New Databoard
        org_id:
          type: string
          description: Organization that owns the databoard
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        purpose:
          type: string
          description: UI surface or purpose for this databoard
          examples:
          - databoard
        site_id:
          type: string
          description: Site associated with this databoard
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        tiles:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/ui_settings_tile'
          description: Configured tiles for this databoard
      description: Site UI settings databoard
    ui_settings_default_time_range:
      title: ui_settings_default_time_range
      type: object
      properties:
        end:
          type: integer
          description: Upper bound of the default databoard time range, in epoch seconds
          contentEncoding: int32
          examples:
          - 1508828400
        endDate:
          type: string
          description: Display date for the end of the default databoard time range
          examples:
          - 10/23/2017
        interval:
          type: string
          description: Bucket interval used for the default databoard time range
          examples:
          - 1d
        name:
          type: string
          description: Display name for the default databoard time range
          examples:
          - This Week
        shortName:
          type: string
          description: Compact display label for the default databoard time range
          examples:
          - thisWeek
        start:
          type: integer
          description: Lower bound of the default databoard time range, in epoch seconds
          contentEncoding: int32
          examples:
          - 1508655600
        usePreset:
          type: boolean
          description: Whether the default databoard time range uses a named preset
          examples:
          - true
      description: Default time range applied to a site UI databoard
    ui_settings_tile:
      title: ui_settings_tile
      type: object
      properties:
        chartBand:
          type: string
          description: Band or category filter applied to the tile chart
          examples:
          - 2.4 ghz
        chartColor:
          type: string
          description: Hex color used to render the tile chart
          examples:
          - '#00B4AD'
        chartDirection:
          type: string
          description: Traffic direction displayed by the tile chart
          examples:
          - tx + rx
        chartRankBy:
          type: string
          description: Ranking field used by the tile chart
        chartType:
          type: string
          description: Visualization chart type for this tile
          examples:
          - timeSeries
        colspan:
          type: integer
          description: Number of grid columns spanned by this tile
          contentEncoding: int32
          examples:
          - 5
        column:
          type: integer
          description: Grid column where this tile starts
          contentEncoding: int32
          examples:
          - 1
        hideEmptyRows:
          type: boolean
          description: Whether empty rows are hidden in this tile
        id:
          type: string
          description: Unique identifier for this databoard tile
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        metric:
          allOf:
          - $ref: '#/components/schemas/ui_settings_tile_metric2'
          - description: Selected measurement configuration displayed by this tile
        name:
          type: string
          description: Display name of this databoard tile
          examples:
          - New Analysis
        row:
          type: integer
          description: Grid row where this tile starts
          contentEncoding: int32
          examples:
          - 1
        rowspan:
          type: integer
          description: Number of grid rows spanned by this tile
          contentEncoding: int32
          examples:
          - 2
        scopeId:
          type: string
          description: Identifier of the scope used by this tile
          examples:
          - e0c767834b4c
        scopeType:
          type: string
          description: Type of scope used by this tile
          examples:
          - client
        sortedColumnIds:
          type: array
          items:
            type: string
          description: Column identifiers that define the tile sort order
        timeRange:
          allOf:
          - $ref: '#/components/schemas/ui_settings_tile_time_range2'
          - description: Time range override for this tile
        trendType:
          type: string
          description: Rendering style for trend data in this tile
          examples:
          - line
        vizType:
          type: string
          description: Display visualization type used by this tile
          examples:
          - averageTimeSeriesChart
      description: Tile shown on a site UI databoard
    ui_settings_tile_metric:
      title: ui_settings_tile_metric
      type: object
      properties:
        apiName:
          type: string
          description: Metric API name requested by this tile
          examples:
          - client_dhcp_latency
      description: Metric selected for a site UI databoard tile
    ui_settings_tile_time_range:
      title: ui_settings_tile_time_range
      type: object
      properties:
        end:
          type: number
          description: Upper bound of the tile time range, in epoch seconds
          examples:
          - 1508823743
        endDate:
          type: string
          description: Display date for the end of the tile time range
          examples:
          - 10/23/2017
        interval:
          type: string
          description: Bucket interval used for the tile time range
          examples:
          - 1d
        name:
          type: string
          description: Display name for the tile time range
          examples:
          - Past 7 Days
        shortName:
          type: string
          description: Compact display label for the tile time range
          examples:
          - 7d
        start:
          type: integer
          description: Lower bound of the tile time range, in epoch seconds
          contentEncoding: int32
          examples:
          - 1508223600
        usePreset:
          type: boolean
          description: Whether the tile time range uses a named preset
          examples:
          - true
      description: Time range override for a site UI databoard tile
    upgrade_bios:
      title: upgrade_bios
      type: object
      properties:
        reboot:
          type: boolean
          description: Whether to restart the device immediately after the upgrade completes
          default: false
        version:
          type: string
          description: BIOS version to install on the device
          examples:
          - CDEN_P_EX1_00.20.01.00
      description: BIOS upgrade request for a single device
    upgrade_bios_multi:
      title: upgrade_bios_multi
      type: object
      properties:
        device_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Specific device IDs to include in the BIOS upgrade
        models:
          type: array
          items:
            type: string
          description: Device models to include in the BIOS upgrade
        reboot:
          type: boolean
          description: Whether to restart the selected devices immediately after the upgrade completes
          default: false
        version:
          type: string
          description: BIOS version to install on the selected devices
          examples:
          - CDEN_P_EX1_00.15.01.00
      description: BIOS upgrade request for multiple devices
    upgrade_device_rrm_mesh_upgrade:
      title: upgrade_device_rrm_mesh_upgrade
      enum:
      - parallel
      - sequential
      type: string
      description: 'For APs only and if `strategy`==`rrm`. Whether to upgrade mesh AP’s parallelly or sequentially at the end of the upgrade. enum: `parallel`, `sequential`'
    upgrade_device_rrm_node_order:
      title: upgrade_device_rrm_node_order
      enum:
      - center_to_fringe
      - fringe_to_center
      type: string
      description: 'For APs only and if `strategy`==`rrm`. Used in rrm to determine whether to start upgrade from fringe or center AP’s. enum: `center_to_fringe`, `fringe_to_center`'
    upgrade_device_status:
      title: upgrade_device_status
      enum:
      - cancelled
      - completed
      - created
      - downloaded
      - downloading
      - failed
      - queued
      - upgrading
      type: string
      description: 'status upgrade is in. enum: `cancelled`, `completed`, `created`, `downloaded`, `downloading`, `failed`, `upgrading`, `queued`'
    upgrade_device_strategy:
      title: upgrade_device_strategy
      enum:
      - big_bang
      - canary
      - rrm
      - serial
      type: string
      description: 'enum: `big_bang` (upgrade all at once), `canary`, `rrm` (APs only), `serial` (one at a time)'
    upgrade_device_strategy_deprecated:
      title: upgrade_device_strategy_deprecated
      enum:
      - big_bang
      - canary
      - rrm
      - serial
      type: string
      description: Deprecated; use `download_strategy` and `reboot_strategy` instead. `big_bang` (upgrade all at once, no orchestration), `serial` (one at a time), `canary`, or `rrm` (AP only); default is big_bang
      deprecated: true
    upgrade_devices_targets:
      title: upgrade_devices_targets
      type: object
      properties:
        download_requested:
          type: array
          items:
            type: string
          description: Device MAC addresses for devices requested to download firmware
        downloaded:
          type: array
          items:
            type: string
          description: Device MAC addresses for devices that have downloaded firmware
        downloading:
          type: array
          items:
            type: string
          description: Device MAC addresses for devices currently downloading firmware
        failed:
          type: array
          items:
            type: string
          description: Device MAC addresses for devices that failed to upgrade
        reboot_in_progress:
          type: array
          items:
            type: string
          description: Device MAC addresses for devices currently rebooting
        rebooted:
          type: array
          items:
            type: string
          description: Device MAC addresses for devices that rebooted successfully
        scheduled:
          type: array
          items:
            type: string
          description: Device MAC addresses for devices scheduled for upgrade by the cloud
        skipped:
          type: array
          items:
            type: string
          description: Device MAC addresses for devices skipped because the requested version matched the running version
        total:
          type: integer
          description: Count of devices part of this upgrade
          contentEncoding: int32
        upgraded:
          type: array
          items:
            type: string
          description: Device MAC addresses for devices that upgraded successfully
      description: Read-only device target lists grouped by upgrade status
    upgrade_fpga:
      title: upgrade_fpga
      type: object
      properties:
        reboot:
          type: boolean
          description: Whether to restart the device immediately after the upgrade completes
          default: false
        version:
          type: string
          description: FPGA version to install on the device
          examples:
          - REV37
      description: FPGA upgrade request for a single device
    upgrade_fpga_multi:
      title: upgrade_fpga_multi
      type: object
      properties:
        device_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Specific device IDs to include in the FPGA upgrade
        models:
          type: array
          items:
            type: string
          description: Device models to include in the FPGA upgrade
        reboot:
          type: boolean
          description: Whether to restart the selected devices immediately after the upgrade completes
          default: false
        version:
          type: string
          description: FPGA version to install on the selected devices
          examples:
          - REV37
      description: FPGA upgrade request for multiple devices
    upgrade_info_status:
      title: upgrade_info_status
      enum:
      - error
      - inprogress
      - scheduled
      - starting
      - success
      type: string
      description: 'enum: `error`, `inprogress`, `scheduled`, `starting`, `success`'
    upgrade_org_devices:
      title: upgrade_org_devices
      type: object
      properties:
        all_sites:
          type: boolean
          description: If `true`, will upgrade all sites in this org; overrides `site_ids`
          default: false
        canary_phases:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: Only if `strategy`==`canary`. Canary phase percentages for the organization upgrade
          default:
          - 1
          - 10
          - 50
          - 100
        device_type:
          allOf:
          - $ref: '#/components/schemas/device_type5'
          - description: 'Device family selected for the organization upgrade. enum: `ap`, `gateway`, `switch`.'
        download_strategy:
          allOf:
          - $ref: '#/components/schemas/upgrade_org_devices_download_strategy2'
          - description: 'Firmware download orchestration strategy for the organization upgrade. enum: `canary`, `big_bang`, `serial`.'
        enable_p2p:
          type: boolean
          description: For APs only. Whether to allow local AP-to-AP firmware upgrade
        max_failure_percentage:
          maximum: 100
          minimum: 0
          type: integer
          description: If `strategy`!=`big_bang`. Allowed failure percentage across the organization upgrade
          contentEncoding: int32
          default: 5
        max_failures:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: If `strategy`==`canary`. Per-phase failure limits for the organization upgrade
        models:
          type: array
          items:
            type: array
            items:
              type: string
          description: Device models selected for the organization upgrade
        p2p_cluster_size:
          minimum: 0
          type: integer
          description: For APs only. Size to split devices for peer-to-peer download batches; default 10
          contentEncoding: int32
          default: 10
          examples:
          - 10
        p2p_parallelism:
          type: integer
          description: For APs only. Number of parallel peer-to-peer download batches to create. If not set, automatically determined based on device count (<=50 uses 1, 51-100 uses 3, >100 uses 10)
          contentEncoding: int32
        reboot_at:
          type: integer
          description: Reboot start time in epoch seconds, default is `start_time`; deprecated, use `reboot_datetime` instead
          contentEncoding: int32
          examples:
          - 1624399840
          deprecated: true
        reboot_datetime:
          type: string
          description: Reboot start time in ISO 8601 format; default is `start_datetime`. Exclude timezone component to use site local timezone
          examples:
          - 2024-06-13 15:00:00-07:00
        reboot_strategy:
          allOf:
          - $ref: '#/components/schemas/upgrade_device_strategy4'
          - description: 'Device reboot orchestration strategy for selected devices. enum: `big_bang`, `canary`, `rrm`, `serial`.'
        rrm_first_batch_percentage:
          type: integer
          description: For APs only and if `strategy`==`rrm`. Percentage of APs that need to be present in the first RRM batch
          contentEncoding: int32
          examples:
          - 2
        rrm_max_batch_percentage:
          type: integer
          description: For APs only and if `strategy`==`rrm`. Max percentage of APs that need to be present in each RRM batch
          contentEncoding: int32
          examples:
          - 10
        rrm_mesh_upgrade:
          allOf:
          - $ref: '#/components/schemas/upgrade_device_rrm_mesh_upgrade1'
          - description: 'For APs only and if `strategy`==`rrm`. Mesh AP upgrade order for the organization upgrade. enum: `parallel`, `sequential`.'
        rrm_node_order:
          allOf:
          - $ref: '#/components/schemas/upgrade_device_rrm_node_order1'
          - description: 'For APs only and if `strategy`==`rrm`. AP ordering direction for RRM upgrade batches. enum: `center_to_fringe`, `fringe_to_center`.'
        rrm_slow_ramp:
          type: boolean
          description: For APs only and if `strategy`==`rrm`. True will make rrm batch sizes slowly ramp up
        rules:
          type: array
          items:
            type: object
            additionalProperties:
              type: string
            description: Selection rules used to choose devices for this organization upgrade
            examples:
            - - match_model: AP43
                match_name[2:8]: access
              - match_model: AP45
          description: Selection rules used to choose devices for this organization upgrade
          examples:
          - - match_model: AP43
              match_name[2:8]: access
            - match_model: AP45
        site_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Identifiers of sites used to limit the organization upgrade
        snapshot:
          type: boolean
          description: For Junos devices only. Perform recovery snapshot after device is rebooted
          default: false
        start_datetime:
          type: string
          description: Firmware download start time in ISO 8601 format; default is now. Exclude timezone component to use site local timezone
          examples:
          - 2024-06-13 15:00:00-07:00
        start_time:
          type: integer
          description: Firmware download start time in epoch seconds, default is now; deprecated, use `start_datetime` instead
          contentEncoding: int32
          examples:
          - 1624399840
          deprecated: true
        strategy:
          allOf:
          - $ref: '#/components/schemas/upgrade_device_strategy_deprecated'
          - description: Deprecated; use `download_strategy` and `reboot_strategy` instead. `big_bang` (upgrade all at once, no orchestration), `serial` (one at a time), `canary`, or `rrm` (AP only); default is big_bang
            deprecated: true
        version:
          type: string
          description: Deprecated; use `versions` instead. Specific firmware version, `suggested`, or `alpha`; default is latest
          deprecated: true
        versions:
          type: array
          items:
            $ref: '#/components/schemas/upgrade_org_devices_version'
          description: Target firmware versions for this organization upgrade
      description: Organization-wide device upgrade request
    upgrade_org_devices_download_strategy:
      title: upgrade_org_devices_download_strategy
      enum:
      - canary
      - big_bang
      - serial
      type: string
      description: >-
        enum:
          * `big_bang`: download all at once, no orchestration
          * `serial`: one at a time'
          * `canary`: upgrade in phases
    upgrade_org_devices_item:
      title: upgrade_org_devices_item
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the organization upgrade job
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        site_upgrades:
          type: array
          items:
            $ref: '#/components/schemas/upgrade_org_devices_item_site_upgrade'
          description: Per-site upgrade jobs created by this organization upgrade
      description: Organization device upgrade job returned by upgrade APIs
    upgrade_org_devices_item_site_upgrade:
      title: upgrade_org_devices_item_site_upgrade
      type: object
      properties:
        site_id:
          type: string
          description: Identifier of the site that received this upgrade job
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        upgrade_id:
          type: string
          description: Identifier of the site-level upgrade job
          contentEncoding: uuid
          examples:
          - ebbdbd0b-1bcf-4e55-8a6a-3416049a52b1
      description: Site upgrade mapping returned for an organization upgrade
    upgrade_org_devices_upgrade:
      title: upgrade_org_devices_upgrade
      type: object
      properties:
        site_id:
          type: string
          description: Identifier of the site for this upgrade entry
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        upgrade:
          allOf:
          - $ref: '#/components/schemas/upgrade_org_devices_upgrade_info2'
          - description: Site-level job details for this upgrade entry
      description: Upgrade entry for a single site within an organization upgrade job
    upgrade_org_devices_upgrade_info:
      title: upgrade_org_devices_upgrade_info
      type: object
      properties:
        id:
          type: string
          description: Unique value identifying the site-level upgrade job
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        start_time:
          type: integer
          description: Epoch timestamp, in seconds, when the site-level upgrade starts
          contentEncoding: int32
          examples:
          - 1717658765
        status:
          allOf:
          - $ref: '#/components/schemas/upgrade_device_status2'
          - description: 'Current status of the site-level upgrade job. enum: `cancelled`, `completed`, `created`, `downloaded`, `downloading`, `failed`, `queued`, `upgrading`.'
        targets:
          allOf:
          - $ref: '#/components/schemas/upgrade_devices_targets1'
          - description: Device targets grouped by upgrade state
          readOnly: true
      description: Site-level upgrade job details within an organization upgrade
    upgrade_org_devices_version:
      title: upgrade_org_devices_version
      type: object
      properties:
        firmware_type:
          allOf:
          - $ref: '#/components/schemas/upgrade_org_devices_version_firmware_type2'
          - description: 'Firmware family this version entry applies to. enum: `ap`, `junos`, `ssr`.'
        force:
          type: boolean
          description: Set to `true` to force upgrade. For `device_type`==`ap`, applies when target version <= running version. For `device_type`==`gateway` with `firmware_type`==`ssr`, applies only when target version == running version; default false
          default: false
        model_version:
          type: object
          additionalProperties:
            type: string
          description: Map of device model to firmware version; overrides `version` for the specified models
        version:
          type: string
          description: Firmware version to deploy for this entry
      description: Target firmware version entry for an organization upgrade request
    upgrade_org_devices_version_firmware_type:
      title: upgrade_org_devices_version_firmware_type
      enum:
      - ap
      - junos
      - ssr
      type: string
      description: 'Firmware family this version entry applies to. enum: `ap`, `junos`, `ssr`'
    upgrade_site_devices:
      title: upgrade_site_devices
      type: object
      properties:
        canary_phases:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: Only if `strategy`==`canary`. Canary phase percentages for the site upgrade
          default:
          - 1
          - 10
          - 50
          - 100
        device_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Specific device IDs selected for the site upgrade
        enable_p2p:
          type: boolean
          description: For APs only. Whether to allow local AP-to-AP FW upgrade
        force:
          type: boolean
          description: '`force`==`true` will force upgrade when requested version is same as running version'
          default: false
        max_failure_percentage:
          maximum: 100
          minimum: 0
          type: integer
          description: If `strategy`!=`big_bang`. Allowed failure percentage across the site upgrade
          contentEncoding: int32
          default: 5
        max_failures:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: If `strategy`==`canary`. Per-phase failure limits for the site upgrade
        models:
          type: array
          items:
            type: string
          description: Device models selected for the site upgrade
        p2p_cluster_size:
          minimum: 0
          type: integer
          description: For APs only and if `enable_p2p`==`true`. Size to split devices for peer-to-peer download batches; default 10
          contentEncoding: int32
          default: 10
          examples:
          - 10
        p2p_parallelism:
          type: integer
          description: For APs only and if `enable_p2p`==`true`. Number of parallel peer-to-peer download batches to create. If not set, automatically determined based on device count (<=50 uses 1, 51-100 uses 3, >100 uses 10)
          contentEncoding: int32
        reboot:
          type: boolean
          description: For Switches and Gateways only (APs are automatically rebooted). Reboot device immediately after upgrade is completed
          default: false
        reboot_at:
          type: integer
          description: For Switches and Gateways only and if `reboot`==`true`. Reboot start time in epoch seconds, default is `start_time`
          contentEncoding: int32
          examples:
          - 1624399840
        rrm_first_batch_percentage:
          type: integer
          description: For APs only and if `strategy`==`rrm`. Percentage of APs that need to be present in the first RRM batch
          contentEncoding: int32
          examples:
          - 2
        rrm_max_batch_percentage:
          type: integer
          description: For APs only and if `strategy`==`rrm`. Max percentage of APs that need to be present in each RRM batch
          contentEncoding: int32
          examples:
          - 10
        rrm_mesh_upgrade:
          allOf:
          - $ref: '#/components/schemas/upgrade_device_rrm_mesh_upgrade2'
          - description: 'For APs only and if `strategy`==`rrm`. Mesh AP upgrade order for the site upgrade. enum: `parallel`, `sequential`.'
        rrm_node_order:
          allOf:
          - $ref: '#/components/schemas/upgrade_device_rrm_node_order1'
          - description: 'For APs only and if `strategy`==`rrm`. AP ordering direction for RRM upgrade batches. enum: `center_to_fringe`, `fringe_to_center`.'
        rrm_slow_ramp:
          type: boolean
          description: For APs only and if `strategy`==`rrm`. True will make rrm batch sizes slowly ramp up
        rules:
          type: array
          items:
            type: object
            additionalProperties:
              type: string
            description: Selection rules used to choose devices for this site upgrade
            examples:
            - - match_model: AP43
                match_name[2:8]: access
              - match_model: AP45
          description: Selection rules used to choose devices for this site upgrade
          examples:
          - - match_model: AP43
              match_name[2:8]: access
            - match_model: AP45
        snapshot:
          type: boolean
          description: For Junos devices only. Perform recovery snapshot after device is rebooted
          default: false
        start_time:
          type: integer
          description: Upgrade start time in epoch seconds, default is now
          contentEncoding: int32
          examples:
          - 1624399840
        strategy:
          allOf:
          - $ref: '#/components/schemas/upgrade_device_strategy5'
          - description: 'Upgrade orchestration strategy for selected devices. enum: `big_bang`, `canary`, `rrm`, `serial`.'
        version:
          type: string
          description: Specific version / stable, default is to use the latest available version
          examples:
          - 3.1.5
      description: Site device upgrade request
    upgrade_site_devices_counts:
      title: upgrade_site_devices_counts
      type: object
      properties:
        download_requested:
          type: integer
          description: Count of devices which cloud has requested to download firmware
          contentEncoding: int32
        downloaded:
          type: integer
          description: Count of ap's which have the firmware downloaded
          contentEncoding: int32
        failed:
          type: integer
          description: Count of devices which have failed to upgrade
          contentEncoding: int32
        reboot_in_progress:
          type: integer
          description: Count of devices which are rebooting
          contentEncoding: int32
        rebooted:
          type: integer
          description: Count of devices which have rebooted successfully
          contentEncoding: int32
        scheduled:
          type: integer
          description: Count of devices which cloud has scheduled an upgrade for
          contentEncoding: int32
        skipped:
          type: integer
          description: Count of devices which skipped upgrade since requested version was same as running version. Use force to always upgrade
          contentEncoding: int32
        total:
          type: integer
          description: Count of devices part of this upgrade
          contentEncoding: int32
        upgraded:
          type: integer
          description: Count of devices which have upgraded successfully
          contentEncoding: int32
      description: Device counts grouped by status for a site upgrade job
    use_auto_ap_values:
      title: use_auto_ap_values
      type: object
      properties:
        accept:
          type: boolean
          description: Whether to accept cached values; false rejects them for the selected APs
          default: false
        for:
          allOf:
          - $ref: '#/components/schemas/use_auto_ap_values_for2'
          - description: 'Localization value type to accept or reject. enum: `orientation`, `placement`.'
        macs:
          type: array
          items:
            type: string
          description: AP MAC addresses whose cached values are accepted or rejected
      description: Request to accept or reject cached AP placement or orientation values on a map
    use_auto_ap_values_for:
      title: use_auto_ap_values_for
      enum:
      - orientation
      - placement
      type: string
      description: 'The selector to choose auto placement or auto orientation. enum: `orientation`, `placement`'
    user_apitoken:
      title: user_apitoken
      type: object
      properties:
        created_time:
          type: number
          description: Time when this user API token was created, in epoch seconds
          readOnly: true
        id:
          type: string
          description: Unique identifier for this user API token
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        key:
          type: string
          description: Secret API token value returned for this token
          readOnly: true
          examples:
          - 1qkb...QQCL
        last_used:
          type:
          - integer
          - 'null'
          description: Time when this user API token was last used, in epoch seconds; null if never used
          contentEncoding: int32
          readOnly: true
          examples:
          - 1690115110
        name:
          type: string
          description: Display label for this user API token
          examples:
          - org_token_xyz
      description: User API token metadata
    user_mac:
      title: user_mac
      required:
      - mac
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for this user MAC entry
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        labels:
          type: array
          items:
            type: string
          description: Applied labels for this user MAC entry
          examples:
          - - byod
            - flr1
        mac:
          type: string
          description: Client MAC address for this entry. Only non-local-admin MAC addresses are accepted
          examples:
          - 5684dae9ac8b
        name:
          type: string
          description: Display name for this user MAC entry
          examples:
          - Printer2
        notes:
          type: string
          description: Free-form notes about this user MAC entry
          examples:
          - MAC address refers to Canon printers
        radius_group:
          type: string
          description: RADIUS group associated with this user MAC entry
          examples:
          - VIP
        site_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Optional list of site IDs this user MAC entry is scoped to
        vlan:
          type: string
          description: Network VLAN value associated with this user MAC entry
          examples:
          - '30'
      description: Organization user MAC entry
    user_mac_import:
      title: user_mac_import
      type: object
      properties:
        added:
          type: array
          items:
            type: string
          description: MAC addresses added by the import
          examples:
          - - 921b638445cd
        detail:
          type: string
          description: Status message returned for asynchronous imports
        errors:
          type: array
          items:
            type: string
          description: Import error messages for user MAC entries
          examples:
          - - 921b638445ce - mac invalid
            - 921b638445cf - mac already provided
        updated:
          type: array
          items:
            type: string
          description: MAC addresses updated by the import
          examples:
          - - 721b638445ef
            - 721b638445ee
      description: Result of importing user MAC entries
    user_macs_count:
      title: user_macs_count
      type: object
      properties:
        end:
          type: integer
          description: Query end timestamp for user MAC counts
          contentEncoding: int32
        limit:
          type: integer
          description: Maximum number of distinct count results to return
          contentEncoding: int32
        results:
          type: array
          items:
            $ref: '#/components/schemas/user_mac'
          description: User MAC entries returned by the count query
        start:
          type: integer
          description: Query start timestamp for user MAC counts
          contentEncoding: int32
        total:
          type: integer
          description: Overall number of user MAC count results
          contentEncoding: int32
      description: User MACs count response
    user_macs_update:
      title: user_macs_update
      type: object
      properties:
        detail:
          type: string
          description: Status message returned for asynchronous batch updates
        errors:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Update errors reported for user MAC entries
        updated:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: User MAC entry IDs updated by the request
      description: Result of a bulk user MAC update
    usermacs_id:
      title: usermacs_id
      type: object
      properties:
        usermac_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: User MAC entry IDs to delete
      description: Request body for deleting multiple user MAC entries
    username_password:
      title: username_password
      type: object
      properties:
        password:
          type: string
          description: Credential password used for the validation attempt
          contentEncoding: password
        username:
          type: string
          description: Credential username used for the validation attempt
      description: Credential payload used to validate an identity provider login
    utils_bounce_port:
      title: utils_bounce_port
      type: object
      properties:
        ports:
          type: array
          items:
            type: string
          description: Device ports to bounce
      description: Request to bounce one or more device ports
    utils_cable_tests:
      title: utils_cable_tests
      required:
      - port
      type: object
      properties:
        port:
          type: string
          description: The port to run the cable test
      description: Request body for running a switch cable test on a port
    utils_clear_arp:
      title: utils_clear_arp
      type: object
      properties:
        ip:
          type: string
          description: The IP address for which to clear an ARP entry. port_id must be specified.
          examples:
          - 10.1.1.1
        node:
          allOf:
          - $ref: '#/components/schemas/ha_cluster_node_enum3'
          - description: 'HA cluster node on which to clear ARP entries. enum: `node0`, `node1`.'
        port_id:
          type: string
          description: The device interface on which to clear the ARP cache.
          examples:
          - wan
        vlan:
          type: integer
          description: The VLAN on which to clear the ARP cache. port_id must be specified.
          contentEncoding: int32
          examples:
          - 1000
        vrf:
          type: string
          description: The vrf for which to clear an ARP entry. applicable for switch.
          examples:
          - guest
      description: Request to clear ARP entries on a device
    utils_clear_bgp:
      title: utils_clear_bgp
      required:
      - neighbor
      - type
      type: object
      properties:
        neighbor:
          type: string
          description: can be ip, ipv6, all
        node:
          allOf:
          - $ref: '#/components/schemas/ha_cluster_node_enum4'
          - description: 'HA cluster node on which to clear BGP sessions. enum: `node0`, `node1`.'
        type:
          allOf:
          - $ref: '#/components/schemas/utils_clear_bgp_type2'
          - description: 'BGP clear operation type to run. enum: `hard`, `in`, `out`, `soft`.'
        vrf:
          type: string
          description: Routing instance or VRF containing the BGP session
      description: Request to clear BGP sessions on a device
    utils_clear_bgp_type:
      title: utils_clear_bgp_type
      enum:
      - hard
      - in
      - out
      - soft
      type: string
      description: 'enum: `hard`, `in`, `out`, `soft`'
    utils_clear_bpdu:
      title: utils_clear_bpdu
      type: object
      properties:
        ports:
          type: array
          items:
            type: string
          description: Switch ports on which to clear detected BPDU errors
      description: Request to clear detected BPDU errors on switch ports
    utils_clear_macs:
      title: utils_clear_macs
      type: object
      properties:
        ports:
          type: array
          items:
            type: string
          description: Switch ports on which to clear learned MAC addresses
      description: Request to clear learned MAC addresses from device ports
    utils_clear_session:
      title: utils_clear_session
      type: object
      properties:
        node:
          allOf:
          - $ref: '#/components/schemas/ha_cluster_node_enum5'
          - description: 'HA cluster node on which to clear sessions. enum: `node0`, `node1`.'
        service_name:
          type: string
          description: Service name, only supported in SSR
          examples:
          - internet-wan_and_lte
        session_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Session identifiers to clear
          examples:
          - - 88776655-0123-4567-890a-112233445566
      description: To use five tuples to lookup the session to be cleared, all must be provided
    utils_devices_restart:
      title: utils_devices_restart
      type: object
      properties:
        member:
          maximum: 9
          minimum: 0
          type: integer
          description: Virtual Chassis member number to restart
          contentEncoding: int32
        node:
          allOf:
          - $ref: '#/components/schemas/utils_devices_restart_node2'
          - description: 'SRX or SSR node to restart. enum: `node0`, `node1`.'
      description: Request to restart a device or device node
    utils_devices_restart_multi:
      title: utils_devices_restart_multi
      required:
      - device_ids
      type: object
      properties:
        device_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Identifiers of devices to restart
        node:
          type: string
          description: 'Only for SSR: if node is not present, both nodes are restarted. For other devices: node should not be present'
      description: Request to restart multiple devices
    utils_devices_restart_node:
      title: utils_devices_restart_node
      enum:
      - node0
      - node1
      type: string
      description: 'only for SRX/SSR: if node is not present, both nodes are restarted. For other devices: node should not be present. enum: `node0`, `node1`'
    utils_mac_table:
      title: utils_mac_table
      type: object
      properties:
        mac_address:
          type: string
          description: Client MAC address filter for the MAC table lookup
          examples:
          - f8c1165c6400
        port_id:
          type: string
          description: Interface identifier filter for the MAC table lookup
          examples:
          - ge-0/0/0.0
        vlan_id:
          type: string
          description: VLAN identifier filter for the MAC table lookup
          examples:
          - ge-0/0/0.0
      description: MAC table lookup filters
    utils_monitor_traffic:
      title: utils_monitor_traffic
      type: object
      properties:
        port:
          type: string
          description: Interface name to monitor; omit this field to monitor all ports
          examples:
          - ge-0/0/1
      description: Request body for monitoring traffic on one port or all ports
    utils_ping:
      title: utils_ping
      required:
      - host
      type: object
      properties:
        count:
          type: integer
          description: Number of echo requests to send
          contentEncoding: int32
          default: 10
        egress_interface:
          type: string
          description: Interface through which ping packets should egress
        host:
          type: string
          description: Destination IP address, IPv6 address, or hostname to ping
          examples:
          - 1.1.1.1
        node:
          allOf:
          - $ref: '#/components/schemas/ha_cluster_node_enum6'
          - description: 'HA cluster node from which to send ping packets. enum: `node0`, `node1`.'
        size:
          maximum: 65535
          minimum: 56
          type: integer
          description: ICMP payload size, in bytes
          contentEncoding: int32
          default: 56
        use_ipv6:
          type: boolean
          description: applicable when host is hostname
          default: false
        vrf:
          type: string
          description: Routing instance or VRF through which ping packets are sent
      description: Request body for running a ping utility command
    utils_release_dhcp:
      title: utils_release_dhcp
      required:
      - port_id
      type: object
      properties:
        node:
          allOf:
          - $ref: '#/components/schemas/ha_cluster_node_enum7'
          - description: 'HA cluster node on which to release the DHCP lease. enum: `node0`, `node1`.'
        port_id:
          minLength: 1
          type: string
          description: Network interface whose current DHCP lease should be released
          examples:
          - ge-0/0/1.10
      description: Request to release the DHCP lease on a device interface
    utils_release_dhcp_leases:
      title: utils_release_dhcp_leases
      required:
      - port_id
      type: object
      properties:
        macs:
          type: array
          items:
            type: string
          description: Client MAC addresses whose DHCP leases should be released
          examples:
          - - 90ec77aabbcc
            - 90ec77aabbdd
        network:
          type: string
          description: DHCP network containing the leases to release
          examples:
          - guest
        node:
          allOf:
          - $ref: '#/components/schemas/ha_cluster_node_enum8'
          - description: 'HA cluster node on which to release DHCP leases. enum: `node0`, `node1`.'
        port_id:
          minLength: 1
          type: string
          description: Network interface containing the DHCP leases to release
          examples:
          - ge-0/0/1.10
      description: "Note: \n  * valid combinations for Junos: \n    * `port_id` \n    * `macs` + `network`\n  * valid combinations for SSR: \n    * `port_id` \n    * `macs` + `network`\n    * `port_id` + `network`\n    * `network`\n  * if network or port_id is specified and macs is empty, it means all clients under network or port_id"
    utils_reset_radio_config:
      title: utils_reset_radio_config
      required:
      - bands
      type: object
      properties:
        bands:
          type: array
          items:
            type: string
          description: Radio bands to reset to RRM management
        force:
          type: boolean
          description: Whether to reset radios that are currently disabled; default `false` honors radios intentionally disabled by the user
          default: false
      description: Request to reset AP radio settings to RRM-managed values
    utils_rrm_optimize:
      title: utils_rrm_optimize
      required:
      - bands
      type: object
      properties:
        bands:
          type: array
          items:
            type: string
          description: Radio bands to include in the RRM optimization
        macs:
          type: array
          items:
            type: string
          description: AP MAC addresses to target for optimization; omitted or empty targets all APs
        txpower_only:
          type: boolean
          description: When true, adjust only transmit power so clients are not disconnected
          default: false
      description: Request to optimize RRM for selected AP radio bands
    utils_send_ble_beacon:
      title: utils_send_ble_beacon
      type: object
      properties:
        beacon_frame:
          type: string
          description: Raw BLE beacon frame payload to transmit
          examples:
          - 68b329da9893e34099c7d8ad5cb9c940
        beacon_freq:
          type: integer
          description: Transmission interval for the arbitrary BLE beacon frame
          contentEncoding: int32
          examples:
          - 100
        duration:
          maximum: 60
          minimum: 1
          type: integer
          description: Number of seconds to continue sending the BLE beacon frame
          contentEncoding: int32
          examples:
          - 10
        macs:
          type: array
          items:
            type: string
          description: AP MAC addresses of devices that should transmit the BLE beacon
          examples:
          - - 5c5b35584a6f
            - 5c5b350ea3b3
        map_ids:
          type: array
          items:
            type: string
          description: Identifiers of maps whose APs should transmit the BLE beacon
          examples:
          - - 845a23bf-bed9-e43c-4c86-6fa474be7ae5
      description: Request to transmit an arbitrary BLE beacon frame from selected APs
    utils_send_support_logs:
      title: utils_send_support_logs
      type: object
      properties:
        info:
          allOf:
          - $ref: '#/components/schemas/utils_send_support_logs_info2'
          - description: 'Support file bundle type to upload. enum: `code-dumps`, `full`, `messages`, `outbound-ssh`, `process`, `var-logs`.'
        node:
          type: string
          description: 'Optional for SSR: if node is not present, both nodes support files are uploaded'
        num_messages_files:
          maximum: 10
          minimum: 1
          type: integer
          description: Number of most recent messages files to upload when `info`==`messages`
          contentEncoding: int32
          default: 1
      description: Request to upload support files from a device
    utils_send_support_logs_info:
      title: utils_send_support_logs_info
      enum:
      - code-dumps
      - full
      - messages
      - outbound-ssh
      - process
      - var-logs
      type: string
      description: "Optional, enum: \n    * `code-dumps`: Upload all core dump files, if any found. Uploads for all members of VC on switches.\n    * `full`: Upload 1 file with output of `request support information`, 1 file that concatenates all `/var/log/outbound-ssh.log*` files, all core dump files, the 5 most recent `/var/log/messages*` files, and Mist agent logs\n    * `messages`: Upload 1 to 10 `/var/log/messages*` files\n    * `outbound-ssh`: Upload 1 file that concatenates all `/var/log/outbound-ssh.log*` files\n    * `process`: Upload 1 file with output of show `system processes extensive``\n    * `var-logs`: Upload all non-empty files in the `/var/log/` directory"
    utils_service_ping:
      title: utils_service_ping
      required:
      - host
      - service
      type: object
      properties:
        count:
          type: integer
          description: Number of ICMP echo requests to send for the service ping
          contentEncoding: int32
          default: 10
        host:
          type: string
          description: Destination IPv4 address for the service ping
          contentEncoding: ipv4
        node:
          allOf:
          - $ref: '#/components/schemas/ha_cluster_node_enum9'
          - description: 'HA cluster node from which to send the service ping. enum: `node0`, `node1`.'
        service:
          type: string
          description: Ping packet takes the same path as the service
        size:
          maximum: 65535
          minimum: 56
          type: integer
          description: ICMP payload size, in bytes
          contentEncoding: int32
          default: 56
        tenant:
          type: string
          description: Routing tenant context in which the packet is sent
      description: Service ping request for SSR devices
    utils_show_arp:
      title: utils_show_arp
      type: object
      properties:
        duration:
          maximum: 300
          minimum: 0
          type: integer
          description: Refresh duration in seconds; set only when `interval` is nonzero
          contentEncoding: int32
          default: 0
        interval:
          maximum: 10
          minimum: 0
          type: integer
          description: Refresh interval in seconds for repeated command output
          contentEncoding: int32
          default: 0
        ip:
          type: string
          description: Address filter for the ARP table lookup
          examples:
          - 192.168.30.7
        node:
          allOf:
          - $ref: '#/components/schemas/ha_cluster_node_enum10'
          - description: 'HA cluster node to run the command on, required for Gateways. enum: `node0`, `node1`.'
        port_id:
          type: string
          description: Device port identifier filter for the ARP table lookup
          examples:
          - ge-0/0/0.0
        vrf:
          type: string
          description: Routing instance or VRF filter for the ARP table lookup
          examples:
          - guest
      description: ARP table lookup request for device command output
    utils_show_bgp_summary:
      title: utils_show_bgp_summary
      type: object
      properties:
        node:
          allOf:
          - $ref: '#/components/schemas/ha_cluster_node_enum11'
          - description: 'HA cluster node on which to show the BGP summary. enum: `node0`, `node1`.'
      description: BGP summary command request
    utils_show_dhcp_leases:
      title: utils_show_dhcp_leases
      required:
      - network
      type: object
      properties:
        network:
          type: string
          description: DHCP network for the leases, returns full table if not specified
          examples:
          - guest
        node:
          allOf:
          - $ref: '#/components/schemas/ha_cluster_node_enum12'
          - description: 'HA cluster node on which to show DHCP leases. enum: `node0`, `node1`.'
      description: DHCP leases command request
    utils_show_dot1x:
      title: utils_show_dot1x
      type: object
      properties:
        duration:
          maximum: 300
          minimum: 0
          type: integer
          description: Refresh duration in seconds; set only when `interval` is nonzero
          contentEncoding: int32
          default: 0
        interval:
          maximum: 10
          minimum: 0
          type: integer
          description: Refresh interval in seconds for repeated command output
          contentEncoding: int32
          default: 0
        port_id:
          type: string
          description: Device port identifier filter for the 802.1X table lookup
          examples:
          - ge-0/0/0.0
      description: 802.1X table lookup request for device command output
    utils_show_evpn_database:
      title: utils_show_evpn_database
      type: object
      properties:
        duration:
          maximum: 300
          minimum: 0
          type: integer
          description: Refresh duration in seconds; set only when `interval` is nonzero
          contentEncoding: int32
          default: 0
        interval:
          maximum: 10
          minimum: 0
          type: integer
          description: Refresh interval in seconds for repeated command output
          contentEncoding: int32
          default: 0
        mac:
          type: string
          description: Client MAC address filter for the EVPN database lookup
          examples:
          - f8c1165c6400
        port_id:
          type: string
          description: Interface identifier filter for the EVPN database lookup
          examples:
          - ge-0/0/0.0
      description: EVPN database lookup request for device command output
    utils_show_forwarding_table:
      title: utils_show_forwarding_table
      type: object
      properties:
        node:
          allOf:
          - $ref: '#/components/schemas/ha_cluster_node_enum13'
          - description: 'HA cluster node on which to show the forwarding table. enum: `node0`, `node1`.'
        prefix:
          type: string
          description: IPv4 or IPv6 prefix filter for forwarding table entries
          examples:
          - 3.1.1.0/24
        service_ip:
          type: string
          description: Only supported with SSR
          examples:
          - 3.1.1.10
        service_name:
          type: string
          description: Only supported with SSR
          examples:
          - internet-wan_and_lte
        service_port:
          type: integer
          description: Only supported with SSR
          contentEncoding: int32
          examples:
          - 32768
        service_protocol:
          type: string
          description: Only supported with SSR
          examples:
          - udp
        service_tenant:
          type: string
          description: Only supported with SSR
          examples:
          - branch1-wifi-mgt
        vrf:
          type: string
          description: Routing instance or VRF filter for forwarding table entries
          examples:
          - guest
      description: Forwarding table lookup request for device command output
    utils_show_ospf_database:
      title: utils_show_ospf_database
      type: object
      properties:
        node:
          allOf:
          - $ref: '#/components/schemas/ha_cluster_node_enum14'
          - description: 'HA cluster node on which to show the OSPF database. enum: `node0`, `node1`.'
        self_originate:
          type: boolean
          description: Whether to show only self-originated OSPF database entries
          default: false
        vrf:
          type: string
          description: Routing instance or VRF filter for OSPF database output
          examples:
          - lan
      description: OSPF database command request for SSR and SRX devices
    utils_show_ospf_interfaces:
      title: utils_show_ospf_interfaces
      type: object
      properties:
        node:
          allOf:
          - $ref: '#/components/schemas/ha_cluster_node_enum15'
          - description: 'HA cluster node on which to show OSPF interfaces. enum: `node0`, `node1`.'
        port_id:
          type: string
          description: Network interface filter for OSPF interface output
          examples:
          - ge-0/0/3
        vrf:
          type: string
          description: Routing instance or VRF filter for OSPF interface output
          examples:
          - lan
      description: OSPF interfaces command request for SSR and SRX devices
    utils_show_ospf_neighbors:
      title: utils_show_ospf_neighbors
      type: object
      properties:
        neighbor:
          type: string
          description: OSPF neighbor IP address filter
          examples:
          - 10.1.1.1
        node:
          allOf:
          - $ref: '#/components/schemas/ha_cluster_node_enum16'
          - description: 'HA cluster node on which to show OSPF neighbors. enum: `node0`, `node1`.'
        port_id:
          type: string
          description: Network interface filter for OSPF neighbor output
          examples:
          - ge-0/0/3
        vrf:
          type: string
          description: Routing instance or VRF filter for OSPF neighbor output
          examples:
          - lan
      description: OSPF neighbors command request for SSR and SRX devices
    utils_show_ospf_summary:
      title: utils_show_ospf_summary
      type: object
      properties:
        node:
          allOf:
          - $ref: '#/components/schemas/ha_cluster_node_enum17'
          - description: 'HA cluster node on which to show the OSPF summary. enum: `node0`, `node1`.'
        vrf:
          type: string
          description: Routing instance or VRF filter for OSPF summary output
          examples:
          - lan
      description: OSPF summary command request for SSR and SRX devices
    utils_show_route:
      title: utils_show_route
      type: object
      properties:
        duration:
          maximum: 300
          minimum: 0
          type: integer
          description: Refresh duration in seconds; set only when `interval` is nonzero
          contentEncoding: int32
          default: 0
        interval:
          maximum: 10
          minimum: 0
          type: integer
          description: Refresh interval in seconds for repeated command output
          contentEncoding: int32
          default: 0
        neighbor:
          type: string
          description: BGP neighbor IP address filter for received or advertised routes
          examples:
          - 192.168.4.1
        node:
          allOf:
          - $ref: '#/components/schemas/ha_cluster_node1'
          - description: HA cluster node on which to show routes
        prefix:
          type: string
          description: IPv4 or IPv6 prefix filter for route entries
          examples:
          - 192.168.0.5/30
        protocol:
          allOf:
          - $ref: '#/components/schemas/utils_show_route_protocol2'
          - description: 'Routing protocol filter for route entries. enum: `any`, `bgp`, `direct`, `evpn`, `ospf`, `static`.'
        route:
          type: string
          description: >-
            if neighbor is specified, received / advertised; if not specified, both will be shown
              * for SSR, show bgp neighbors 10.250.18.202 received-routes/advertised-routes
              * for SRX and Switches, show route receive-protocol/advertise-protocol bgp 192.168.255.12
          examples:
          - advertised
        vrf:
          type: string
          description: Routing instance or VRF filter for route entries
          examples:
          - default
      description: Route table lookup request for device command output
    utils_show_route_protocol:
      title: utils_show_route_protocol
      enum:
      - any
      - bgp
      - direct
      - evpn
      - ospf
      - static
      type: string
      description: 'enum: `any`, `bgp`, `direct`, `evpn`, `ospf`, `static`'
    utils_show_service_path:
      title: utils_show_service_path
      type: object
      properties:
        node:
          allOf:
          - $ref: '#/components/schemas/ha_cluster_node_enum18'
          - description: 'HA cluster node on which to show the service path. enum: `node0`, `node1`.'
        service_name:
          type: string
          description: Exact service name for which to display the service path
          examples:
          - any
      description: Service path lookup request for SSR devices
    utils_show_session:
      title: utils_show_session
      type: object
      properties:
        node:
          allOf:
          - $ref: '#/components/schemas/ha_cluster_node_enum19'
          - description: 'HA cluster node on which to show active sessions. enum: `node0`, `node1`.'
        service_name:
          type: string
          description: The exact service name for which to display the active sessions
          examples:
          - any
        session_id:
          type: string
          description: Identifier of the session to show in detail
      description: Active session lookup request for device command output
    utils_traceroute:
      title: utils_traceroute
      type: object
      properties:
        host:
          type: string
          description: Destination IP address, IPv6 address, or hostname for traceroute
        network:
          type: string
          description: For SSR, source network from which to initiate traceroute
          default: internal
        node:
          allOf:
          - $ref: '#/components/schemas/ha_cluster_node_enum20'
          - description: 'HA cluster node from which to run traceroute. enum: `node0`, `node1`.'
        port:
          type: integer
          description: When `protocol`==`udp`, not supported in SSR. The udp port to use
          contentEncoding: int32
          default: 33434
        protocol:
          allOf:
          - $ref: '#/components/schemas/utils_traceroute_protocol2'
          - description: 'Transport protocol to use for traceroute. enum: `icmp`, `udp`.'
        timeout:
          type: integer
          description: Not supported in SSR. Maximum time in seconds to wait for the response
          contentEncoding: int32
          default: 60
        use_ipv6:
          type: boolean
          description: Whether to resolve hostname targets over IPv6
          default: false
        vrf:
          type: string
          description: For SRX, routing instance or VRF from which to initiate traceroute; master VRF/RI is used by default
      description: Request body for running a traceroute utility command
    utils_traceroute_protocol:
      title: utils_traceroute_protocol
      enum:
      - icmp
      - udp
      type: string
      description: 'enum: `icmp` (Only supported by AP/MxEdge), `udp`'
    utils_tunterm_bounce_port:
      title: utils_tunterm_bounce_port
      required:
      - ports
      type: object
      properties:
        hold_time:
          type: integer
          description: In milli seconds, hold time between multiple port bounces
          contentEncoding: int32
        ports:
          type: array
          items:
            type: string
          description: TunTerm data ports to bounce
      description: Request to bounce Mist Edge TunTerm data ports
    utils_zeroize_fips:
      title: utils_zeroize_fips
      required:
      - password
      type: object
      properties:
        password:
          type: string
          description: Confirmation password for the FIPS zeroize operation
          contentEncoding: password
      description: Request body for confirming FIPS AP zeroize operations
    utils_zigbee_join:
      title: utils_zigbee_join
      type: object
      properties:
        duration:
          maximum: 600
          minimum: 60
          type: integer
          description: Number of seconds to permit new Zigbee end-device joins; range is 60-600
          contentEncoding: int32
          default: 600
      description: Request body for temporarily allowing Zigbee end-device joins
    utils_zigbee_kick:
      title: utils_zigbee_kick
      required:
      - macs
      type: object
      properties:
        macs:
          minItems: 1
          type: array
          items:
            type: string
          description: One or more Zigbee EUI-64 (8-byte) MACs. Accepts colon-separated (`00:17:7a:01:06:0c:ae:9f`) or plain hex (`00177a01060cae9f`). Must be non-empty.
          examples:
          - - 00177a01060cae9f
            - 00177a01060caea1
      description: Request body for kicking one or more Zigbee clients from an AP
    var_source:
      title: var_source
      enum:
      - deviceprofile
      - site
      type: string
      description: 'Source level where a variable is defined. enum: `deviceprofile`, `site`'
    vars_annotation:
      title: vars_annotation
      type: object
      properties:
        note:
          type: string
          description: User-provided note to describe what this var was created for
        type:
          type: string
          description: >-
            Used to identify where to enumerate / auto-complete the field from. Default is `generic` (plain string, no special handling).


            enum: `generic`, `mxtunnel_id`
          default: generic
      description: Annotation for a single var, helping identify its purpose and enabling auto-complete/enumeration in UI
    vbeacon:
      title: vbeacon
      type: object
      properties:
        created_time:
          type: number
          description: Epoch timestamp when the virtual beacon was created
          readOnly: true
        for_site:
          type: boolean
          description: Whether this virtual beacon is defined at site scope
          readOnly: true
        id:
          type: string
          description: Unique identifier of the virtual beacon
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        major:
          type: integer
          description: Bluetooth beacon major value used for proximity matching
          contentEncoding: int32
          examples:
          - 1356
        map_id:
          type: string
          description: Floorplan map identifier containing the virtual beacon
          contentEncoding: uuid
          examples:
          - 63eda950-c6da-11e4-a628-60f81dd250cc
        message:
          type: string
          description: Notification message displayed by the SDK application when a client is near the virtual beacon
          examples:
          - Welcome to Mist
        minor:
          type: integer
          description: Bluetooth beacon minor value used for proximity matching
          contentEncoding: int32
          examples:
          - 21
        modified_time:
          type: number
          description: Epoch timestamp when the virtual beacon was last modified
          readOnly: true
        name:
          type: string
          description: Display name or label for the virtual beacon
          examples:
          - conference room
        org_id:
          type: string
          description: Organization identifier that owns the virtual beacon
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        power:
          maximum: 100
          minimum: -30
          type: integer
          description: Required if `power_mode`==`custom`, -30 - 100, in dBm. For default power_mode, power = 4 dBm.
          contentEncoding: int32
          default: 4
        power_mode:
          allOf:
          - $ref: '#/components/schemas/ble_config_power_mode2'
          - description: 'Transmit power mode for the virtual beacon. enum: `custom`, `default`.'
            examples:
            - custom
        site_id:
          type: string
          description: Site identifier that owns the virtual beacon
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        url:
          type: string
          description: Destination URL shown by the SDK application when a client is near the virtual beacon
          examples:
          - https://www.mist.com/any
        uuid:
          type: string
          description: Bluetooth beacon UUID used for proximity matching
          contentEncoding: uuid
          examples:
          - 31375aeb-b8d3-1ea6-83bf-a31eb04e1c38
        wayfinding_nodename:
          type: string
          description: Name to be used in wayfinding_path or wayfinding_grid blob
          examples:
          - node1
        x:
          type: number
          description: Horizontal pixel coordinate of the virtual beacon on the map
          examples:
          - 53.5
        y:
          type: number
          description: Vertical pixel coordinate of the virtual beacon on the map
          examples:
          - 173.1
      description: Virtual beacon configuration for SDK proximity notifications
    vc_port:
      title: vc_port
      type: object
      properties:
        mode:
          allOf:
          - $ref: '#/components/schemas/vc_port_mode2'
          - description: 'Virtual Chassis port mode to apply. enum: `network`, `vcp-higig`, `vcp-hgoe`.'
      description: Request to change the Virtual Chassis port mode on a switch
    vc_port_mode:
      title: vc_port_mode
      enum:
      - network
      - vcp-higig
      - vcp-hgoe
      type: string
      description: 'enum: `network`, `vcp-higig`, `vcp-hgoe`'
    version_string:
      title: version_string
      type: object
      properties:
        version:
          type: string
          description: Target software version for the JSI device upgrade
      description: JSI device upgrade target version request
    virtual_chassis_config:
      title: virtual_chassis_config
      type: object
      properties:
        locating:
          type: boolean
          description: Whether the Virtual Chassis is currently in locate mode
          readOnly: true
        members:
          type: array
          items:
            $ref: '#/components/schemas/virtual_chassis_config_member'
          description: Virtual Chassis members and their expected roles and VC ports
        preprovisioned:
          type: boolean
          description: Whether to create the Virtual Chassis in pre-provisioned mode
          default: false
      description: Virtual Chassis creation or configuration request
    virtual_chassis_config_member:
      title: virtual_chassis_config_member
      required:
      - mac
      - vc_role
      type: object
      properties:
        locating:
          type: boolean
          description: Whether this Virtual Chassis member is currently in locate mode
          readOnly: true
        mac:
          type: string
          description: Member MAC address; for FPC0 this matches the device MAC address
        member_id:
          type: integer
          description: Member ID used for a pre-provisioned Virtual Chassis
          contentEncoding: int32
        vc_ports:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Port names to use as Virtual Chassis ports on this member
        vc_role:
          allOf:
          - $ref: '#/components/schemas/virtual_chassis_config_member_vc_role2'
          - description: 'Role of this member in the Virtual Chassis. enum: `backup`, `linecard`, `master`.'
      description: Virtual Chassis member configuration
    virtual_chassis_config_member_vc_role:
      title: virtual_chassis_config_member_vc_role
      enum:
      - backup
      - linecard
      - master
      type: string
      description: 'enum: `backup`, `linecard`, `master`'
    virtual_chassis_member_update:
      title: virtual_chassis_member_update
      type: object
      properties:
        mac:
          type: string
          description: Required if `op`==`add` or `op`==`preprovision`; MAC address of the member to add or preprovision
        member:
          type: integer
          description: Required if `op`==`remove`; member ID to remove from the Virtual Chassis
          contentEncoding: int32
        member_id:
          type: integer
          description: Required if `op`==`preprovision`. Optional if `op`==`add`; target member ID for the Virtual Chassis member
          contentEncoding: int32
        vc_ports:
          type: array
          items:
            type: string
          description: Required if `op`==`add` or `op`==`preprovision`; port names to use as Virtual Chassis ports
        vc_role:
          allOf:
          - $ref: '#/components/schemas/virtual_chassis_member_update_vc_role2'
          - description: 'Required if `op`==`add` or `op`==`preprovision`; role of the member in the Virtual Chassis. enum: `backup`, `linecard`, `master`.'
      description: Member update for a Virtual Chassis add, remove, or preprovision operation
    virtual_chassis_member_update_vc_role:
      title: virtual_chassis_member_update_vc_role
      enum:
      - backup
      - linecard
      - master
      type: string
      description: 'Required if `op`==`add` or `op`==`preprovision`. enum: `backup`, `linecard`, `master`'
    virtual_chassis_port:
      title: virtual_chassis_port
      required:
      - members
      - op
      type: object
      properties:
        members:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/config_vc_port_member'
          description: Virtual Chassis members and ports affected by the operation
        op:
          allOf:
          - $ref: '#/components/schemas/virtual_chassis_port_operation2'
          - minLength: 1
            description: 'Action to perform on the specified Virtual Chassis ports. enum: `delete`, `set`.'
      description: Request to set or delete Virtual Chassis ports on members
    virtual_chassis_port_operation:
      title: virtual_chassis_port_operation
      enum:
      - delete
      - set
      type: string
      description: 'Action to perform on the specified Virtual Chassis ports. enum: `delete`, `set`'
    virtual_chassis_update:
      title: virtual_chassis_update
      type: object
      properties:
        member:
          type: integer
          description: Only if `op`==`renumber`; existing member ID to renumber
          contentEncoding: int32
        members:
          type: array
          items:
            $ref: '#/components/schemas/virtual_chassis_member_update'
          description: Member updates for add, remove, or preprovision operations
        new-member:
          type: integer
          description: Only if `op`==`renumber`; new member ID to assign
          contentEncoding: int32
        op:
          allOf:
          - $ref: '#/components/schemas/virtual_chassis_update_op2'
          - description: 'Action to perform on the Virtual Chassis. enum: `add`, `preprovision`, `remove`, `renumber`.'
        remove_inventory:
          type: boolean
          description: Only if `op`==`preprovision`. When removing members from a pre-provisioned VC, set to `true` to delete the inventory records for removed members (e.g. for RMA). Members being removed must be in "not-present" state.
          default: false
      description: Virtual Chassis member update request
    virtual_chassis_update_op:
      title: virtual_chassis_update_op
      enum:
      - add
      - preprovision
      - remove
      - renumber
      type: string
      description: 'enum: `add`, `preprovision`, `remove`, `renumber`'
    visits_scope:
      title: visits_scope
      enum:
      - map
      - rssizone
      - site
      - zone
      type: string
      description: 'enum: `map`, `rssizone`, `site`, `zone`'
    vpn:
      title: vpn
      required:
      - name
      - paths
      type: object
      properties:
        created_time:
          type: number
          description: Epoch timestamp when the VPN configuration was created
          readOnly: true
        id:
          type: string
          description: Unique identifier of the VPN configuration
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        modified_time:
          type: number
          description: Epoch timestamp when the VPN configuration was last modified
          readOnly: true
        name:
          minLength: 1
          type: string
          description: Display name of the VPN configuration
        org_id:
          type: string
          description: Organization that owns the VPN configuration
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        path_selection:
          allOf:
          - $ref: '#/components/schemas/vpn_path_selection2'
          - description: Path selection settings used when `type`==`hub_spoke`
        paths:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/vpn_path'
          description: VPN path definitions keyed by VPN name for `hub_spoke` mode or interface name for `mesh` mode
        type:
          allOf:
          - $ref: '#/components/schemas/vpn_mode2'
          - description: 'VPN topology mode for this configuration. enum: `hub_spoke`, `mesh`.'
      description: Organization VPN overlay configuration
    vpn_mode:
      title: vpn_mode
      enum:
      - hub_spoke
      - mesh
      type: string
      description: 'VPN topology mode for this configuration. enum: `hub_spoke`, `mesh`'
    vpn_path:
      title: vpn_path
      type: object
      properties:
        bfd_profile:
          allOf:
          - $ref: '#/components/schemas/vpn_path_bfd_profile2'
          - description: 'BFD profile used for this VPN path. enum: `broadband`, `lte`.'
        bfd_use_tunnel_mode:
          type: boolean
          description: If `type`==`mesh` and for SSR only, whether to use tunnel mode
          default: false
        ip:
          type: string
          description: Source IP address for this VPN path, if different from the WAN port IP
        peer_paths:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/vpn_path_peer_paths_peer'
          description: Peer path preferences used when `type`==`mesh`
        pod:
          maximum: 128
          minimum: 1
          type: integer
          description: Grouping index used to place this VPN path into a pod
          contentEncoding: int32
          default: 1
          examples:
          - 2
        traffic_shaping:
          allOf:
          - $ref: '#/components/schemas/vpn_path_traffic_shaping2'
          - description: Traffic shaping settings applied to this VPN path
      description: VPN path settings used by an organization VPN
    vpn_path_bfd_profile:
      title: vpn_path_bfd_profile
      enum:
      - broadband
      - lte
      type: string
      description: 'BFD profile used for this VPN path. enum: `broadband`, `lte`'
    vpn_path_peer_paths_peer:
      title: vpn_path_peer_paths_peer
      type: object
      properties:
        preference:
          type: integer
          description: Lower numeric value makes this outgoing WAN path more preferred
          contentEncoding: int32
      description: Peer path preference settings for mesh VPN routing
    vpn_path_selection:
      title: vpn_path_selection
      type: object
      properties:
        strategy:
          allOf:
          - $ref: '#/components/schemas/vpn_path_selection_strategy2'
          - description: 'Path selection strategy for a hub-and-spoke VPN. enum: `disabled`, `simple`, `manual`.'
      description: Only if `type`==`hub_spoke`; path selection behavior for VPN paths
    vpn_path_selection_strategy:
      title: vpn_path_selection_strategy
      enum:
      - disabled
      - simple
      - manual
      type: string
      description: 'enum: `disabled`, `simple`, `manual`'
    vpn_path_traffic_shaping:
      title: vpn_path_traffic_shaping
      type: object
      properties:
        class_percentage:
          maxItems: 4
          minItems: 4
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: Bandwidth percentages for high, medium, low, and best-effort traffic classes
          default:
          - 80
          - 10
          - 9
          - 1
        enabled:
          type: boolean
          description: Whether traffic shaping is enabled for this VPN path
        max_tx_kbps:
          type:
          - integer
          - 'null'
          description: Maximum transmit rate for this VPN path, in Kbps; `null` means no explicit limit
          contentEncoding: int32
      description: Traffic shaping settings for a VPN path
    vpn_peer_stat:
      title: vpn_peer_stat
      type: object
      properties:
        is_active:
          type: boolean
          description: Whether this VPN peer path is the active redundant path
        jitter:
          minimum: 0
          type: number
          description: Last sampled VPN peer jitter, in milliseconds
        last_seen:
          type:
          - number
          - 'null'
          description: Time when this VPN peer was last observed, in epoch seconds
          readOnly: true
          examples:
          - 1470417522
        latency:
          minimum: 0
          type: number
          description: Last sampled VPN peer latency, in milliseconds
        loss:
          maximum: 100
          minimum: 0
          type: number
          description: Packet loss in percentage
        mac:
          minLength: 1
          type: string
          description: Local router MAC address for the VPN link
        mos:
          maximum: 5
          minimum: 0
          type: number
          description: Mean Opinion Score, a measure of the quality of the VPN link
        mtu:
          type: integer
          description: Maximum transmission unit for the VPN peer path, in bytes
          contentEncoding: int32
        org_id:
          type: string
          description: Organization identifier for the VPN peer statistic
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        peer_mac:
          minLength: 1
          type: string
          description: Peer router MAC address for the VPN link
        peer_port_id:
          minLength: 1
          type: string
          description: Peer router interface identifier for the VPN link
        peer_router_name:
          minLength: 1
          type: string
          description: Peer router name reported for the VPN link
        peer_site_id:
          type: string
          description: Site identifier for the peer side of the VPN link
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        port_id:
          minLength: 1
          type: string
          description: Local router interface identifier for the VPN link
        router_name:
          minLength: 1
          type: string
          description: Local router name reported for the VPN link
        site_id:
          type: string
          description: Site identifier for the local side of the VPN link
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        type:
          minLength: 1
          type: string
          description: VPN implementation type for the peer, such as `ipsec` for SRX or `svr` for SSR
        up:
          type: boolean
          description: Whether the VPN peer is currently up
        uptime:
          type: integer
          description: Gateway-reported VPN peer uptime value, in seconds
          contentEncoding: int32
      description: VPN peer path statistics returned by organization VPN peer searches
    vpn_peer_stat_search:
      title: vpn_peer_stat_search
      required:
      - end
      - limit
      - results
      - start
      - total
      type: object
      properties:
        end:
          type: number
          description: Search window end timestamp, in epoch seconds
        limit:
          type: integer
          description: Maximum number of VPN peer statistics returned
          contentEncoding: int32
        next:
          type: string
          description: URL for the next page of VPN peer statistics, when more results are available
        results:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/vpn_peer_stat'
          description: VPN peer statistic rows returned by the search
        start:
          type: number
          description: Search window start timestamp, in epoch seconds
        total:
          type: integer
          description: Number of VPN peer statistics matching the search
          contentEncoding: int32
      description: Search response containing VPN peer path statistics
    vpn_type:
      title: vpn_type
      enum:
      - ipsec
      - svr
      type: string
      description: 'VPN type for tunnel or peer configuration. enum: `ipsec`, `svr`'
    vrf_config:
      title: vrf_config
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether to enable VRF (when supported on the device)
      description: VRF enablement settings applied when supported on the device
    vrf_extra_route:
      title: vrf_extra_route
      type: object
      properties:
        via:
          type: string
          description: IPv4 next-hop address for this VRF extra route
          contentEncoding: ipv4
      description: Additional IPv4 static route for a VRF instance
    vrf_extra_route6:
      title: vrf_extra_route6
      type: object
      properties:
        via:
          type: string
          description: IPv6 next-hop address for this VRF extra route
          contentEncoding: ipv6
      description: Additional IPv6 static route for a VRF instance
    vrrp_config:
      title: vrrp_config
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether VRRP configuration is enabled
        groups:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/vrrp_config_group'
          description: VRRP groups keyed by group name
      description: Junos VRRP configuration applied to a switch or switch profile
    vrrp_config_group:
      title: vrrp_config_group
      type: object
      properties:
        preempt:
          type: boolean
          description: If `true`, allow preemption (a backup router can preempt a primary router)
          default: false
        priority:
          type: integer
          description: VRRP priority for this router in the group
          contentEncoding: int32
      description: VRRP group behavior settings
    vrrp_group_auth_type:
      title: vrrp_group_auth_type
      enum:
      - md5
      - simple
      type: string
      description: 'Authentication method used by the VRRP group. enum: `md5`, `simple`'
      examples:
      - md5
    vrrp_group_network:
      title: vrrp_group_network
      type: object
      properties:
        ip:
          type: string
          description: Virtual IP address used by the VRRP group on this network
      description: Virtual IP assignment for a VRRP network
    vs_instance_property:
      title: vs_instance_property
      type: object
      properties:
        networks:
          type: array
          items:
            type: string
          description: List of network names included in this virtual-switch instance
      description: EX9200 virtual-switch instance settings
    wan_extra_routes:
      title: wan_extra_routes
      type: object
      properties:
        via:
          type: string
          description: IPv4 next-hop address for this WAN extra route
          contentEncoding: ipv4
      description: Additional IPv4 route for a WAN interface
    wan_extra_routes6:
      title: wan_extra_routes6
      type: object
      properties:
        via:
          type: string
          description: IPv6 next-hop address for this WAN extra route
          contentEncoding: ipv6
      description: Additional IPv6 route for a WAN interface
    wan_tunnel_protocol:
      title: wan_tunnel_protocol
      enum:
      - gre
      - ipsec
      type: string
      description: 'Tunnel protocol used for the connection. enum: `gre`, `ipsec`'
    wan_usages_count_distinct:
      title: wan_usages_count_distinct
      enum:
      - mac
      - path_type
      - peer_mac
      - peer_port_id
      - policy
      - port_id
      - tenant
      type: string
      description: 'enum: `mac`, `path_type`, `peer_mac`, `peer_port_id`, `policy`, `port_id`, `tenant`'
    webhook:
      title: webhook
      type: object
      properties:
        assetfilter_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Asset filter identifiers used to restrict `asset-raw-rssi` webhook events
        created_time:
          type: number
          description: Epoch timestamp when the webhook was created
          readOnly: true
        default_action:
          allOf:
          - $ref: '#/components/schemas/webhook_action3'
          - description: 'Default action applied when none of the `rules` match the incoming event. enum: `permit`, `block`.'
        enabled:
          type: boolean
          description: Whether webhook is enabled
          default: true
        for_site:
          type: boolean
          description: Whether this webhook is scoped to a site rather than the organization
          readOnly: true
        headers:
          type:
          - object
          - 'null'
          additionalProperties:
            type: string
          description: If `type`=`http-post`, additional custom HTTP headers to add. The headers name and value must be string, total bytes of headers name and value must be less than 1000
          examples:
          - x-custom-1: your_custom_header_value1
            x-custom-2: your_custom_header_value2
        id:
          type: string
          description: Unique identifier of the webhook
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        modified_time:
          type: number
          description: Epoch timestamp when the webhook was last modified
          readOnly: true
        name:
          type:
          - string
          - 'null'
          description: Display name of the webhook
        oauth2_client_id:
          type: string
          description: Required when `oauth2_grant_type`==`client_credentials`; OAuth2 client identifier used to request an access token
        oauth2_client_secret:
          type: string
          description: Required when `oauth2_grant_type`==`client_credentials`; OAuth2 client secret used to request an access token
          contentEncoding: password
        oauth2_grant_type:
          allOf:
          - $ref: '#/components/schemas/webhook_oauth2_grant_type2'
          - description: 'OAuth2 grant type used when `type`==`oauth2`. enum: `client_credentials`, `password`.'
        oauth2_password:
          type: string
          description: Required when `oauth2_grant_type`==`password`; password used for the OAuth2 token request
          contentEncoding: password
        oauth2_scopes:
          type: array
          items:
            type: string
          description: OAuth2 scopes included in the token request when `type`==`oauth2`
        oauth2_token_url:
          type: string
          description: Required when `type`==`oauth2`; token endpoint URL used to obtain the OAuth2 access token
        oauth2_username:
          type: string
          description: Required when `oauth2_grant_type`==`password`; username used for the OAuth2 token request
        org_id:
          type: string
          description: Organization that owns the webhook
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        rules:
          type: array
          items:
            $ref: '#/components/schemas/webhook_rule'
          description: Optional filtering rules to override `topics`. Each rule permits or blocks events for a topic, optionally based on event payload matching criteria
        secret:
          type:
          - string
          - 'null'
          description: "Only if `type`=`http-post` \n\nwhen `secret` is provided, two HTTP headers will be added: \n  * X-Mist-Signature-v2: HMAC_SHA256(secret, body)\n  * X-Mist-Signature: HMAC_SHA1(secret, body)"
        single_event_per_message:
          type: boolean
          description: Some solutions may not be able to parse multiple events from a single message (e.g. IBM Qradar, DSM). When set to `true`, only a single event will be sent per message. this feature is only available on certain topics (see [List Webhook Topics]($e/Constants%20Definitions/listWebhookTopics))
          default: false
        site_id:
          type: string
          description: Site associated with this webhook when it is site-scoped
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        splunk_token:
          type:
          - string
          - 'null'
          description: Required if `type`=`splunk`. If splunk_token is not defined for a type Splunk webhook, it will not send, regardless if the webhook receiver is configured to accept it.
        topics:
          type: array
          items:
            type: string
          description: Event topics delivered by this webhook
        type:
          allOf:
          - $ref: '#/components/schemas/webhook_type2'
          - description: 'Delivery mechanism used by this webhook. enum: `aws-sns`, `google-pubsub`, `http-post`, `oauth2`, `splunk`.'
        url:
          type: string
          description: Destination URL that receives webhook deliveries
        verify_cert:
          type: boolean
          description: When url uses HTTPS, whether to verify the certificate
          default: true
      description: Webhook configuration for delivering selected Mist events to an external destination
    webhook_action:
      title: webhook_action
      enum:
      - permit
      - block
      type: string
      description: 'Webhook filtering action. enum: `permit`, `block`'
    webhook_alarm_event:
      title: webhook_alarm_event
      required:
      - id
      - org_id
      - site_id
      - timestamp
      - type
      type: object
      properties:
        aps:
          type: array
          items:
            type: string
          description: Representative AP MAC addresses related to this alarm event
          readOnly: true
        bssids:
          type: array
          items:
            type: string
          description: Representative BSSIDs related to this alarm event
          readOnly: true
        count:
          type: integer
          description: If present, number of events of this type that occurred in the current interval; defaults to 1
          contentEncoding: int32
          readOnly: true
        event_id:
          type: string
          description: Unique identifier for this alarm webhook event
          contentEncoding: uuid
          readOnly: true
        for_site:
          type: boolean
          description: Whether this alarm event is scoped to a site rather than only to the organization
          readOnly: true
        id:
          type: string
          description: Unique identifier of the alarm associated with this event
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        last_seen:
          type:
          - number
          - 'null'
          description: Time when the most recent incident in the alarm window was seen, in epoch seconds
          readOnly: true
          examples:
          - 1470417522
        node:
          allOf:
          - $ref: '#/components/schemas/ha_cluster_node_enum21'
          - description: 'HA cluster node associated with this alarm event when applicable. enum: `node0`, `node1`.'
        org_id:
          type: string
          description: Organization associated with this alarm event
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        site_id:
          type: string
          description: Site associated with this alarm event
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        ssids:
          type: array
          items:
            type: string
          description: Representative wireless SSIDs related to this alarm event
          readOnly: true
        timestamp:
          type: number
          description: Time when this alarm event was raised, in epoch seconds
          readOnly: true
        type:
          type: string
          description: Alarm type key for this event
          readOnly: true
        update:
          type: boolean
          description: Whether this payload updates an alarm event that was sent earlier; defaults to false
          readOnly: true
      description: Alarm event delivered inside an `alarms` webhook payload
    webhook_alarms:
      title: webhook_alarms
      required:
      - events
      - topic
      type: object
      properties:
        events:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/webhook_alarm_event'
          description: Alarm events included in this webhook delivery
        topic:
          const: alarms
          type: string
          description: 'Webhook topic name for alarm event deliveries. enum: `alarms`.'
      description: >-
        Sample of the `alarms` webhook payload.


        **N.B.**: Fields like `aps`, `bssids`, `ssids` are event specific. They are relevant to this event type ( rogue-ap-detected). For a different event type, different fields may be sent. These don’t contain all affected entities and are representative samples of entities (capped at 10). For marvis action related events, we expose `details` to include more event specific details.


        Events specific fields for other alarm event type can be found with API [List Alarm Definitions#]($e/Constants%20Events/listAlarmDefinitions), under "fields" array of /alarm_defs response object.
    webhook_alarms_topic:
      title: webhook_alarms_topic
      const: alarms
      type: string
      description: 'Webhook topic name for alarm event deliveries. enum: `alarms`'
    webhook_asset_raw_rssi:
      title: webhook_asset_raw_rssi
      required:
      - events
      - topic
      type: object
      properties:
        events:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/webhook_asset_raw_rssi_event'
          description: Raw RSSI event records included in this webhook delivery
        topic:
          const: asset-raw-rssi
          type: string
          description: 'Webhook topic name for asset raw RSSI deliveries. enum: `asset-raw-rssi`.'
      description: "Sample of the `asset-raw-rssi` webhook payload.\n\n\nThis webhook topic provides raw data from packets emitted by named and filtered assets.\n\n\nRaw data webhooks are a special subset of webhooks that provide insight into raw data packets emitted by a client,\nidentified by their advertising MAC address (assets, discovered ble, connected wifi, unconnected wifi).  \nThe data that client raw data webhooks encompasses are reporting AP information, RSSI Data, and any special packets/telemetry\npackets that the client may emit.\n\nNote that client raw webhooks are the raw data coming from the client and do not contain the X,Y location data of the client.\nIn order to get the location data for a client please see our location webhooks. \nClients can be identified uniquely across these client raw data topics and location webhook topic using MAC address as the Unique identifier (client identifier)."
    webhook_asset_raw_rssi_event:
      title: webhook_asset_raw_rssi_event
      type: object
      properties:
        ap_loc:
          type: array
          items:
            type: number
          description: Location coordinates of the reporting AP when available, updated about once per minute per client
        beam:
          maximum: 9
          minimum: 1
          type: integer
          description: antenna index, clock-wise starting from the LED
          contentEncoding: int32
        device_id:
          type: string
          description: Identifier of the AP or device that reported the raw RSSI sample
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        ibeacon_major:
          maximum: 65535
          minimum: 1
          type:
          - integer
          - 'null'
          description: iBeacon major value decoded from the packet when present
          contentEncoding: int32
          examples:
          - 1234
        ibeacon_minor:
          maximum: 65535
          minimum: 1
          type:
          - integer
          - 'null'
          description: iBeacon minor value decoded from the packet when present
          contentEncoding: int32
          examples:
          - 1234
        ibeacon_uuid:
          type:
          - string
          - 'null'
          description: iBeacon UUID decoded from the packet when present
          contentEncoding: uuid
          examples:
          - f3f17139-704a-f03a-2786-0400279e37c3
        is_asset:
          type: boolean
          description: Whether the advertising MAC address is recognized as an asset
        mac:
          type: string
          description: Client MAC address for the asset or beacon that emitted the packet
        map_id:
          type: string
          description: Map associated with the reporting AP when location context is available
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        mfg_company_id:
          type:
          - integer
          - 'null'
          description: optional, BLE manufacturing company ID
          contentEncoding: int32
        mfg_data:
          type:
          - string
          - 'null'
          description: optional, BLE manufacturing data in hex byte-string format (ie “112233AABBCC”)
        org_id:
          type: string
          description: Organization associated with the raw RSSI sample
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        rssi:
          type: integer
          description: Received signal strength of the packet at the reporting AP, in dBm
          contentEncoding: int32
        service_packets:
          type: array
          items:
            $ref: '#/components/schemas/webhook_asset_raw_rssi_event_service_packet'
          description: BLE service data packets decoded from the advertised payload
        site_id:
          type: string
          description: Site associated with the raw RSSI sample
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        timestamp:
          type: number
          description: Time when the raw RSSI sample was observed, in epoch seconds
          readOnly: true
      description: Raw RSSI sample reported for an asset or beacon packet
    webhook_asset_raw_rssi_event_service_packet:
      title: webhook_asset_raw_rssi_event_service_packet
      type: object
      properties:
        service_data:
          type:
          - string
          - 'null'
          description: optional, data from service data
        service_uuid:
          type:
          - string
          - 'null'
          description: optional, UUID from service data
      description: BLE service data decoded from an asset raw RSSI packet
    webhook_asset_raw_rssi_topic:
      title: webhook_asset_raw_rssi_topic
      const: asset-raw-rssi
      type: string
      description: 'Webhook topic name for asset raw RSSI deliveries. enum: `asset-raw-rssi`'
    webhook_audits:
      title: webhook_audits
      required:
      - events
      - topic
      type: object
      properties:
        events:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/log_event'
          description: Audit log events included in this webhook delivery
        topic:
          const: audits
          type: string
          description: 'Webhook topic name for audit event deliveries. enum: `audits`.'
      description: Sample of the `audits` webhook payload.
    webhook_audits_topic:
      title: webhook_audits_topic
      const: audits
      type: string
      description: 'Webhook topic name for audit event deliveries. enum: `audits`'
    webhook_client_info:
      title: webhook_client_info
      type: object
      properties:
        events:
          type: array
          items:
            $ref: '#/components/schemas/webhook_client_info_event'
          description: Client information events included in this webhook delivery
        topic:
          allOf:
          - $ref: '#/components/schemas/webhook_client_info_topic2'
          - description: 'Webhook topic name for client information deliveries. enum: `client-info`.'
      description: Sample of the `client-info` webhook payload.
    webhook_client_info_event:
      title: webhook_client_info_event
      type: object
      properties:
        hostname:
          type: string
          description: Client hostname reported in the event
          examples:
          - service.company.net
        ip:
          type: string
          description: Client IP address reported in the event
        mac:
          type: string
          description: Client MAC address reported in the event
        org_id:
          type: string
          description: Organization associated with the client information event
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        site_id:
          type: string
          description: Site associated with the client information event
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        timestamp:
          type: number
          description: Time when the client information event was generated, in epoch seconds
          readOnly: true
      description: Client identity and addressing details delivered by a `client-info` webhook
    webhook_client_info_topic:
      title: webhook_client_info_topic
      const: client-info
      type: string
      description: 'Webhook topic name for client information deliveries. enum: `client-info`'
    webhook_client_join:
      title: webhook_client_join
      required:
      - events
      - topic
      type: object
      properties:
        events:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/webhook_client_join_event'
          description: Client join events included in this webhook delivery
        topic:
          const: client-join
          type: string
          description: 'Webhook topic name for client join deliveries. enum: `client-join`.'
      description: Sample of the `client-join` webhook payload.
    webhook_client_join_event:
      title: webhook_client_join_event
      required:
      - ap
      - ap_name
      - band
      - bssid
      - connect
      - connect_float
      - mac
      - org_id
      - rssi
      - site_id
      - site_name
      - ssid
      - timestamp
      - version
      - wlan_id
      type: object
      properties:
        ap:
          type: string
          description: MAC address of the AP the client connected to
        ap_name:
          type: string
          description: user-friendly name of the AP the client connected to.
        band:
          type: string
          description: 5GHz or 2.4GHz band
        bssid:
          type: string
          description: WLAN radio BSSID that the client associated with
        connect:
          type: integer
          description: Time when the client connected, in epoch seconds
          contentEncoding: int32
        connect_float:
          type: number
          description: Client connection timestamp with millisecond precision
        mac:
          type: string
          description: Client MAC address that joined the WLAN
        org_id:
          type: string
          description: Organization associated with the client join event
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        rssi:
          type: number
          description: Signal strength when the client associated, in dBm
        site_id:
          type: string
          description: Site associated with the client join event
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        site_name:
          type: string
          description: Site name associated with the client join event
        ssid:
          type: string
          description: WLAN SSID that the client joined
        timestamp:
          type: number
          description: Time when the client join event was generated, in epoch seconds
          readOnly: true
        version:
          type: number
          description: schema version of this message
        wlan_id:
          type: string
          description: Unique identifier of the WLAN the client joined
          contentEncoding: uuid
      description: Wireless client association event delivered when a client joins a WLAN
    webhook_client_join_topic:
      title: webhook_client_join_topic
      const: client-join
      type: string
      description: 'Webhook topic name for client join deliveries. enum: `client-join`'
    webhook_client_latency:
      title: webhook_client_latency
      type: object
      properties:
        events:
          type: array
          items:
            $ref: '#/components/schemas/webhook_client_latency_event'
          description: Client latency summary events included in this webhook delivery
        topic:
          allOf:
          - $ref: '#/components/schemas/webhook_client_latency_topic2'
          - description: 'Webhook topic name for client latency deliveries. enum: `client-latency`.'
      description: Sample of the `client-latency` webhook payload.
    webhook_client_latency_event:
      title: webhook_client_latency_event
      type: object
      properties:
        avg_auth:
          type: number
          description: Average authentication latency observed during the reporting interval
          examples:
          - 0.17170219
        avg_dhcp:
          type: number
          description: Average DHCP latency observed during the reporting interval
          examples:
          - 0.017828934
        avg_dns:
          type: number
          description: Average DNS latency observed during the reporting interval
          examples:
          - 0.024532124
        max_auth:
          type: number
          description: Maximum authentication latency observed during the reporting interval
          examples:
          - 0.18170219
        max_dhcp:
          type: number
          description: Maximum DHCP latency observed during the reporting interval
          examples:
          - 0.027828934
        max_dns:
          type: number
          description: Maximum DNS latency observed during the reporting interval
          examples:
          - 0.022532124
        min_auth:
          type: number
          description: Minimum authentication latency observed during the reporting interval
          examples:
          - 0.16050219
        min_dhcp:
          type: number
          description: Minimum DHCP latency observed during the reporting interval
          examples:
          - 0.015828934
        min_dns:
          type: number
          description: Minimum DNS latency observed during the reporting interval
          examples:
          - 0.029532124
        org_id:
          type: string
          description: Organization associated with the client latency metrics
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        site_id:
          type: string
          description: Site associated with the client latency metrics
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        timestamp:
          type: number
          description: Time when the client latency metrics were reported, in epoch seconds
          readOnly: true
      description: Site-level client latency metrics for authentication, DHCP, and DNS operations
    webhook_client_latency_topic:
      title: webhook_client_latency_topic
      const: client-latency
      type: string
      description: 'Webhook topic name for client latency deliveries. enum: `client-latency`'
    webhook_client_sessions:
      title: webhook_client_sessions
      required:
      - events
      - topic
      type: object
      properties:
        events:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/webhook_client_sessions_event'
          description: Client session events included in this webhook delivery
        topic:
          const: client-sessions
          type: string
          description: 'Webhook topic name for client session deliveries. enum: `client-sessions`.'
      description: Sample of the `client-sessions` webhook payload.
    webhook_client_sessions_event:
      title: webhook_client_sessions_event
      required:
      - ap
      - ap_name
      - band
      - bssid
      - client_family
      - client_manufacture
      - client_model
      - client_os
      - connect
      - connect_float
      - disconnect
      - disconnect_float
      - duration
      - mac
      - next_ap
      - org_id
      - rssi
      - site_id
      - site_name
      - ssid
      - termination_reason
      - timestamp
      - version
      - wlan_id
      type: object
      properties:
        ap:
          type: string
          description: MAC address of the AP the client roamed or disconnected from
        ap_name:
          type: string
          description: user-friendly name of the AP the client roamed or disconnected from.
        band:
          type: string
          description: 5GHz or 2.4GHz band
        bssid:
          type: string
          description: WLAN radio BSSID that the client was associated with
        client_family:
          type: string
          description: Device family E.g. "Mac", "iPhone", "Apple watch"
        client_manufacture:
          type: string
          description: Device manufacturer E.g. "Apple"
        client_model:
          type: string
          description: Device model E.g. "8+", "XS"
        client_os:
          type: string
          description: Device operating system E.g. "Mojave", "Windows 10", "Linux"
        connect:
          type: integer
          description: Time when the client connected, in epoch seconds
          contentEncoding: int32
        connect_float:
          type: number
          description: Client connection timestamp with millisecond precision
        disconnect:
          type: integer
          description: Time when the client disconnected, in epoch seconds
          contentEncoding: int32
        disconnect_float:
          type: number
          description: Client disconnect timestamp with millisecond precision
        duration:
          type: integer
          description: Length of the roamed or completed client session indicated by the `termination_reason` value
          contentEncoding: int32
        mac:
          type: string
          description: Client MAC address for the roaming or disconnected session
        next_ap:
          type: string
          description: the AP the client has roamed to.
        org_id:
          type: string
          description: Organization associated with the client session event
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        rssi:
          type: number
          description: Latest average RSSI before the user disconnects
        site_id:
          type: string
          description: Site associated with the client session event
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        site_name:
          type: string
          description: Site name associated with the client session event
        ssid:
          type: string
          description: WLAN SSID for the client session
        termination_reason:
          type: integer
          description: 1 disassociate - when the client disassociates. 2 inactive - when the client is timeout. 3 roamed - when the client is roamed between APs
          contentEncoding: int32
        timestamp:
          type: number
          description: Time when the client session event was generated, in epoch seconds
          readOnly: true
        version:
          type: number
          description: schema version of this message
        wlan_id:
          type: string
          description: Unique identifier of the WLAN for the client session
          contentEncoding: uuid
      description: Wireless client session event delivered when a client roams or disconnects
    webhook_client_sessions_topic:
      title: webhook_client_sessions_topic
      const: client-sessions
      type: string
      description: 'Webhook topic name for client session deliveries. enum: `client-sessions`'
    webhook_delivery_distinct:
      title: webhook_delivery_distinct
      enum:
      - status
      - status_code
      - topic
      - webhook_id
      type: string
      description: 'webhook topic. enum: `status`, `status_code`, `topic`, `webhook_id`'
      examples:
      - webhook_id
    webhook_delivery_status:
      title: webhook_delivery_status
      enum:
      - failure
      - success
      type: string
      description: 'webhook delivery status. enum: `failure`, `success`'
      examples:
      - failure
    webhook_delivery_topic:
      title: webhook_delivery_topic
      enum:
      - alarms
      - audits
      - device-updowns
      - occupancy-alerts
      - ping
      type: string
      description: 'webhook topic. enum: `alarms`, `audits`, `device-updowns`, `occupancy-alerts`, `ping`'
      examples:
      - audits
    webhook_device_events:
      title: webhook_device_events
      required:
      - events
      - topic
      type: object
      properties:
        events:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/device_event'
          description: Device events included in this webhook delivery
        topic:
          const: device-events
          type: string
          description: 'Webhook topic name for device event deliveries. enum: `device-events`.'
      description: Sample of the `device-events` webhook payload.
    webhook_device_events_event_ev_type:
      title: webhook_device_events_event_ev_type
      enum:
      - notice
      - warn
      type: string
      description: '(optional) event advisory. enum: `notice`, `warn`'
    webhook_device_events_topic:
      title: webhook_device_events_topic
      const: device-events
      type: string
      description: 'Webhook topic name for device event deliveries. enum: `device-events`'
    webhook_device_updowns:
      title: webhook_device_updowns
      required:
      - events
      - topic
      type: object
      properties:
        events:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/webhook_device_updowns_event'
          description: Device up/down events included in this webhook delivery
        topic:
          const: device-updowns
          type: string
          description: 'Webhook topic name for device up/down deliveries. enum: `device-updowns`.'
      description: Sample of the `device-updowns` webhook payload.
    webhook_device_updowns_event:
      title: webhook_device_updowns_event
      required:
      - ap
      - ap_name
      - org_id
      - site_id
      - site_name
      - timestamp
      - type
      type: object
      properties:
        ap:
          type: string
          description: MAC address for the AP whose availability changed
          readOnly: true
        ap_name:
          type: string
          description: AP name for the device whose availability changed
          readOnly: true
        for_site:
          type: boolean
          description: Whether this device up/down event is scoped to a site rather than only to the organization
          readOnly: true
        org_id:
          type: string
          description: Organization associated with the device up/down event
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        site_id:
          type: string
          description: Site associated with the device up/down event
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        site_name:
          type: string
          description: Site name associated with the device up/down event
          readOnly: true
        timestamp:
          type: number
          description: Time when the device availability event occurred, in epoch seconds
          readOnly: true
        type:
          type: string
          description: Reported up/down event type for the device
          readOnly: true
      description: Device availability event delivered when a monitored AP changes up/down state
    webhook_device_updowns_topic:
      title: webhook_device_updowns_topic
      const: device-updowns
      type: string
      description: 'Webhook topic name for device up/down deliveries. enum: `device-updowns`'
    webhook_discovered_raw_rssi:
      title: webhook_discovered_raw_rssi
      required:
      - topic
      type: object
      properties:
        events:
          type: array
          items:
            $ref: '#/components/schemas/webhook_discovered_raw_rssi_event'
          description: Discovered raw RSSI event records included in this webhook delivery
        topic:
          const: discovered-raw-rssi
          type: string
          description: 'Webhook topic name for discovered raw RSSI deliveries. enum: `discovered-raw-rssi`.'
      description: Sample of the `discovered-raw-rssi` webhook payload.
    webhook_discovered_raw_rssi_event:
      title: webhook_discovered_raw_rssi_event
      required:
      - beam
      - device_id
      - mac
      - map_id
      - org_id
      - rssi
      - site_id
      type: object
      properties:
        ap_loc:
          type: array
          items:
            type: number
          description: Location coordinates of the reporting AP when available, updated about once per minute per client
        beam:
          type: integer
          description: Antenna index, from 1-8, clock-wise starting from the LED
          contentEncoding: int32
        device_id:
          type: string
          description: Identifier of the AP that reported the raw RSSI sample
          contentEncoding: uuid
        ibeacon_major:
          maximum: 65535
          minimum: 1
          type:
          - integer
          - 'null'
          description: iBeacon major value decoded from the packet when present
          contentEncoding: int32
          examples:
          - 1234
        ibeacon_minor:
          maximum: 65535
          minimum: 1
          type:
          - integer
          - 'null'
          description: iBeacon minor value decoded from the packet when present
          contentEncoding: int32
          examples:
          - 1234
        ibeacon_uuid:
          type:
          - string
          - 'null'
          description: iBeacon UUID decoded from the packet when present
          contentEncoding: uuid
          examples:
          - f3f17139-704a-f03a-2786-0400279e37c3
        is_asset:
          type: boolean
          description: Whether the advertising MAC address is recognized as an asset
        mac:
          type: string
          description: Client MAC address for the passive BLE device or beacon that emitted the packet
        map_id:
          type: string
          description: Map associated with the reporting AP when location context is available
          contentEncoding: uuid
        mfg_company_id:
          type: string
          description: BLE manufacturing company ID
        mfg_data:
          type: string
          description: 'BLE manufacturing data in hex byte-string format (ie: "112233AABBCC")'
        org_id:
          type: string
          description: Organization associated with the raw RSSI sample
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        rssi:
          type: number
          description: Received signal strength of the packet at the reporting AP, in dBm
        service_packets:
          type: array
          items:
            $ref: '#/components/schemas/service_packet'
          description: BLE service data packets decoded from the advertised payload
        site_id:
          type: string
          description: Site associated with the raw RSSI sample
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        timestamp:
          type: number
          description: Time when the raw RSSI sample was observed, in epoch seconds
          readOnly: true
      description: Raw RSSI sample reported for a passive BLE device packet
    webhook_discovered_raw_rssi_topic:
      title: webhook_discovered_raw_rssi_topic
      const: discovered-raw-rssi
      type: string
      description: 'Webhook topic name for discovered raw RSSI deliveries. enum: `discovered-raw-rssi`'
    webhook_guest_authorizations:
      title: webhook_guest_authorizations
      type: object
      properties:
        events:
          type: array
          items:
            $ref: '#/components/schemas/webhook_guest_authorizations_event'
          description: Guest authorization events included in this webhook delivery
        topic:
          allOf:
          - $ref: '#/components/schemas/webhook_guest_authorizations_topic2'
          - description: 'Webhook topic name for guest authorization deliveries. enum: `guest-authorizations`.'
      description: Sample of the `guest-authorizations` webhook payload.
    webhook_guest_authorizations_event:
      title: webhook_guest_authorizations_event
      type: object
      properties:
        ap:
          type: string
          description: MAC address of the AP handling the guest authorization
          examples:
          - 5c5b350e55c8
        auth_method:
          type: string
          description: Guest portal authentication method used for this authorization event
          examples:
          - passphrase
        authorized_expiring_time:
          type: integer
          description: Unix timestamp when the guest authorization expires
          contentEncoding: int32
          examples:
          - 1677076639
        authorized_time:
          type: integer
          description: Unix timestamp when the guest authorization was granted
          contentEncoding: int32
          examples:
          - 1677076519
        carrier:
          type: string
          description: Mobile carrier used when authentication relies on a cellular provider
          examples:
          - docomo
        client:
          type: string
          description: MAC address of the guest client device
          examples:
          - ac2316eca70a
        company:
          type: string
          description: Guest company name provided during registration
          examples:
          - MIST
        email:
          type: string
          description: Guest email address provided during registration
          examples:
          - abcd@abcd.com
        field1:
          type: string
          description: Value submitted for custom guest field 1
          examples:
          - field1 value
        field2:
          type: string
          description: Value submitted for custom guest field 2
          examples:
          - field2 value
        field3:
          type: string
          description: Value submitted for custom guest field 3
          examples:
          - field3 value
        field4:
          type: string
          description: Value submitted for custom guest field 4
          examples:
          - field4 value
        mobile:
          type: string
          description: Guest mobile phone number provided during registration
          examples:
          - '+0123456789'
        name:
          type: string
          description: Full name provided by the guest during registration
          examples:
          - Dr Strange
        org_id:
          type: string
          description: Organization associated with the guest authorization event
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        site_id:
          type: string
          description: Site associated with the guest authorization event
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        sms_gateway:
          type: string
          description: SMS provider used for text-message authentication
          examples:
          - Telstra
        sponsor_email:
          type: string
          description: Sponsor email address associated with the guest authorization
          examples:
          - sponsor@gmail.com
        ssid:
          type: string
          description: WLAN SSID on which the guest was authorized
          examples:
          - Portal Auth
        wlan_id:
          type: string
          description: WLAN identifier on which the guest was authorized
          examples:
          - 7681be9a-044a-4622-90cf-3accde5ad853
      description: Guest portal authorization event with registration and WLAN context
    webhook_guest_authorizations_topic:
      title: webhook_guest_authorizations_topic
      const: guest-authorizations
      type: string
      description: 'Webhook topic name for guest authorization deliveries. enum: `guest-authorizations`'
    webhook_location:
      title: webhook_location
      required:
      - events
      - topic
      type: object
      properties:
        events:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/webhook_location_event'
          description: Location events included in this webhook delivery
        topic:
          const: location
          type: string
          description: Webhook topic name for generic location deliveries
      description: Sample of the `location` webhook payload.
    webhook_location_asset:
      title: webhook_location_asset
      required:
      - events
      - topic
      type: object
      properties:
        events:
          type: array
          items:
            $ref: '#/components/schemas/webhook_location_asset_event'
          description: Asset location events included in this webhook delivery
        topic:
          const: location-asset
          type: string
          description: 'Webhook topic name for asset location deliveries. enum: `location-asset`.'
      description: Sample of the `location_asset` webhook payload.
    webhook_location_asset_event:
      title: webhook_location_asset_event
      type: object
      properties:
        battery_voltage:
          type: integer
          description: Battery voltage value reported by the asset tag
          contentEncoding: int32
          examples:
          - 3370
        eddystone_uid_instance:
          type: string
          description: Eddystone UID instance value advertised by the asset tag
          examples:
          - 5c5b35000001
        eddystone_uid_namespace:
          type: string
          description: Eddystone UID namespace value advertised by the asset tag
          examples:
          - 2818e3868dec25629ede
        eddystone_url_url:
          type: string
          description: Eddystone URL advertised by the asset tag
          examples:
          - https://www.abc.com
        ibeacon_major:
          maximum: 65535
          minimum: 1
          type:
          - integer
          - 'null'
          description: iBeacon major value advertised by the asset tag when present
          contentEncoding: int32
          examples:
          - 1234
        ibeacon_minor:
          maximum: 65535
          minimum: 1
          type:
          - integer
          - 'null'
          description: iBeacon minor value advertised by the asset tag when present
          contentEncoding: int32
          examples:
          - 1234
        ibeacon_uuid:
          type:
          - string
          - 'null'
          description: iBeacon UUID advertised by the asset tag when present
          contentEncoding: uuid
          examples:
          - f3f17139-704a-f03a-2786-0400279e37c3
        mac:
          type: string
          description: Asset MAC address used as the location identifier
          examples:
          - 7fc2936fd243
        map_id:
          type: string
          description: Map where the asset location was calculated
          contentEncoding: uuid
          examples:
          - 845a23bf-bed9-e43c-4c86-6fa474be7ae5
        mfg_company_id:
          type: integer
          description: Optional, BLE manufacturing company ID
          contentEncoding: int32
          examples:
          - 935
        mfg_data:
          type: string
          description: 'Optional, BLE manufacturing data in hex byte-string format (ie: "112233AABBCC")'
          examples:
          - 648520a1020000
        site_id:
          type: string
          description: Site associated with the asset location event
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        timestamp:
          type: number
          description: Time when the asset location was calculated, in epoch seconds
          readOnly: true
        type:
          type: string
          description: Location object type for the asset event; defaults to `asset`
          default: asset
        x:
          type: number
          description: Horizontal map coordinate of the asset position, in meters
          examples:
          - 13.5
        y:
          type: number
          description: Vertical map coordinate of the asset position, in meters
          examples:
          - 3.2
      description: Asset location update with map coordinates and optional BLE beacon metadata
    webhook_location_asset_topic:
      title: webhook_location_asset_topic
      const: location-asset
      type: string
      description: 'Webhook topic name for asset location deliveries. enum: `location-asset`'
    webhook_location_centrak:
      title: webhook_location_centrak
      required:
      - events
      - topic
      type: object
      properties:
        events:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/webhook_location_centrak_event'
          description: CenTrak location events included in this webhook delivery
        topic:
          const: location-centrak
          type: string
          description: 'Webhook topic name for CenTrak location deliveries. enum: `location-centrak`.'
      description: Sample of the `location-centrak` webhook payload.
    webhook_location_centrak_event:
      title: webhook_location_centrak_event
      type: object
      properties:
        mac:
          type: string
          description: Device MAC address used as the CenTrak location identifier
        map_id:
          type: string
          description: Identifier of the map where the CenTrak location was calculated
        mfg_company_id:
          type: integer
          description: Optional, BLE manufacturing company ID
          contentEncoding: int32
        mfg_data:
          type: string
          description: Optional, BLE manufacturing data in hex byte-string format (i.e. "112233AABBCC")
        site_id:
          type: string
          description: Site associated with the CenTrak location event
          contentEncoding: uuid
        timestamp:
          type: number
          description: Time when the CenTrak location was calculated, in epoch seconds
          readOnly: true
        type:
          allOf:
          - $ref: '#/components/schemas/webhook_location_centrak_event_type2'
          - description: 'Location object type for the CenTrak event. enum: `wifi`.'
        wifi_beacon_extended_info:
          type: array
          items:
            $ref: '#/components/schemas/wifi_beacon_extended_info_items'
          description: Extended Wi-Fi beacon metadata included with this CenTrak location event
        x:
          type: number
          description: Horizontal map coordinate of the CenTrak device, in meters
        y:
          type: number
          description: Vertical map coordinate of the CenTrak device, in meters
      description: CenTrak location update with map coordinates and Wi-Fi beacon metadata
    webhook_location_centrak_event_type:
      title: webhook_location_centrak_event_type
      const: wifi
      type: string
      description: 'Location object type for CenTrak Wi-Fi beacon events. enum: `wifi`'
    webhook_location_centrak_topic:
      title: webhook_location_centrak_topic
      const: location-centrak
      type: string
      description: 'Webhook topic name for CenTrak location deliveries. enum: `location-centrak`'
    webhook_location_client:
      title: webhook_location_client
      required:
      - events
      - topic
      type: object
      properties:
        events:
          type: array
          items:
            $ref: '#/components/schemas/webhook_location_client_event'
          description: Connected client location events included in this webhook delivery
        topic:
          const: location-client
          type: string
          description: 'Webhook topic name for connected client location deliveries. enum: `location-client`.'
      description: Sample of the `location-client` webhook payload.
    webhook_location_client_event:
      title: webhook_location_client_event
      type: object
      properties:
        mac:
          type: string
          description: Connected client MAC address used as the location identifier
          examples:
          - 5684dae9ac8b
        map_id:
          type: string
          description: Map where the connected client location was calculated
          contentEncoding: uuid
          examples:
          - 845a23bf-bed9-e43c-4c86-6fa474be7ae5
        site_id:
          type: string
          description: Site associated with the connected client location event
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        timestamp:
          type: number
          description: Time when the connected client location was calculated, in epoch seconds
          readOnly: true
        type:
          type: string
          description: Location object type for the connected client event; defaults to `wifi`
          default: wifi
        wifi_beacon_extended_info:
          type: array
          items:
            $ref: '#/components/schemas/wifi_beacon_extended_info_items'
          description: Extended Wi-Fi beacon metadata included with this connected client location event
        x:
          type: number
          description: Horizontal map coordinate of the connected client, in meters
          examples:
          - 13.5
        y:
          type: number
          description: Vertical map coordinate of the connected client, in meters
          examples:
          - 3.2
      description: Connected Wi-Fi client location update with map coordinates
    webhook_location_client_topic:
      title: webhook_location_client_topic
      const: location-client
      type: string
      description: 'Webhook topic name for connected client location deliveries. enum: `location-client`'
    webhook_location_event:
      title: webhook_location_event
      required:
      - id
      - map_id
      - site_id
      - timestamp
      - type
      - x
      - y
      type: object
      properties:
        battery_voltage:
          type: integer
          description: Battery voltage value reported by the located entity
          contentEncoding: int32
        eddystone_uid_instance:
          type: string
          description: Eddystone UID instance value advertised by the located entity
        eddystone_uid_namespace:
          type: string
          description: Eddystone UID namespace value advertised by the located entity
        eddystone_url_url:
          type: string
          description: Eddystone URL advertised by the located entity
        ibeacon_major:
          maximum: 65535
          minimum: 1
          type:
          - integer
          - 'null'
          description: iBeacon major value advertised by the located entity when present
          contentEncoding: int32
          examples:
          - 1234
        ibeacon_minor:
          maximum: 65535
          minimum: 1
          type:
          - integer
          - 'null'
          description: iBeacon minor value advertised by the located entity when present
          contentEncoding: int32
          examples:
          - 1234
        ibeacon_uuid:
          type:
          - string
          - 'null'
          description: iBeacon UUID advertised by the located entity when present
          contentEncoding: uuid
          examples:
          - f3f17139-704a-f03a-2786-0400279e37c3
        id:
          type: string
          description: Unique identifier for the located entity in this event
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        mac:
          type: string
          description: Located entity MAC address for this location event
        map_id:
          type: string
          description: Identifier of the map where the location was calculated
          contentEncoding: uuid
        mfg_company_id:
          type: integer
          description: Optional, BLE manufacturing company ID
          contentEncoding: int32
        mfg_data:
          type: string
          description: Optional, BLE manufacturing data in hex byte-string format (ie "112233AABBCC")
        name:
          type: string
          description: Client or asset display name, when available
        site_id:
          type: string
          description: Site associated with the location event
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        timestamp:
          type: number
          description: Time when the location was calculated, in epoch seconds
          readOnly: true
        type:
          type: string
          description: Location object type for this event
        wifi_beacon_extended_info:
          type: array
          items:
            $ref: '#/components/schemas/wifi_beacon_extended_info_items'
          description: Extended Wi-Fi beacon metadata included with this location event
        x:
          type: number
          description: Horizontal map coordinate of the located entity, in meters
        y:
          type: number
          description: Vertical map coordinate of the located entity, in meters
      description: Generic location update with map coordinates and optional BLE or Wi-Fi metadata
    webhook_location_sdk:
      title: webhook_location_sdk
      required:
      - events
      - topic
      type: object
      properties:
        events:
          type: array
          items:
            $ref: '#/components/schemas/webhook_location_sdk_event'
          description: SDK client location events included in this webhook delivery
        topic:
          const: location-sdk
          type: string
          description: 'Webhook topic name for SDK client location deliveries. enum: `location-sdk`.'
      description: Sample of the `location-sdk` webhook payload.
    webhook_location_sdk_event:
      title: webhook_location_sdk_event
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the SDK client for this location event
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        map_id:
          type: string
          description: Map where the SDK client location was calculated
          contentEncoding: uuid
          examples:
          - 845a23bf-bed9-e43c-4c86-6fa474be7ae5
        name:
          type: string
          description: Display name of the SDK client when available
          examples:
          - optional
        site_id:
          type: string
          description: Site associated with the SDK client location event
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        timestamp:
          type: number
          description: Time when the SDK client location was calculated, in epoch seconds
          readOnly: true
        type:
          type: string
          description: Location object type for the SDK client event; defaults to `sdk`
          default: sdk
        x:
          type: number
          description: Horizontal map coordinate of the SDK client, in meters
          examples:
          - 13.5
        y:
          type: number
          description: Vertical map coordinate of the SDK client, in meters
          examples:
          - 3.2
      description: SDK client location update with map coordinates
    webhook_location_sdk_topic:
      title: webhook_location_sdk_topic
      const: location-sdk
      type: string
      description: 'Webhook topic name for SDK client location deliveries. enum: `location-sdk`'
    webhook_location_topic:
      title: webhook_location_topic
      const: location
      type: string
      description: 'Webhook topic name for generic location deliveries. enum: `location`'
    webhook_location_unclient:
      title: webhook_location_unclient
      required:
      - events
      - topic
      type: object
      properties:
        events:
          type: array
          items:
            $ref: '#/components/schemas/webhook_location_unclient_event'
          description: Unconnected client location events included in this webhook delivery
        topic:
          const: location-unclient
          type: string
          description: 'Webhook topic name for unconnected client location deliveries. enum: `location-unclient`.'
      description: Sample of the `location-unclient` webhook payload.
    webhook_location_unclient_event:
      title: webhook_location_unclient_event
      type: object
      properties:
        mac:
          type: string
          description: Unconnected client MAC address used as the location identifier
          examples:
          - 5684dae9ac8b
        map_id:
          type: string
          description: Map where the unconnected client location was calculated
          contentEncoding: uuid
          examples:
          - 845a23bf-bed9-e43c-4c86-6fa474be7ae5
        site_id:
          type: string
          description: Site associated with the unconnected client location event
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        timestamp:
          type: number
          description: Time when the unconnected client location was calculated, in epoch seconds
          readOnly: true
        type:
          type: string
          description: Location object type for the unconnected client event; defaults to `wifi`
          default: wifi
        wifi_beacon_extended_info:
          type: array
          items:
            $ref: '#/components/schemas/wifi_beacon_extended_info_items'
          description: Extended Wi-Fi beacon metadata included with this unconnected client location event
        x:
          type: number
          description: Horizontal map coordinate of the unconnected client, in meters
          examples:
          - 13.5
        y:
          type: number
          description: Vertical map coordinate of the unconnected client, in meters
          examples:
          - 3.2
      description: Unconnected Wi-Fi client location update with map coordinates
    webhook_location_unclient_topic:
      title: webhook_location_unclient_topic
      const: location-unclient
      type: string
      description: 'Webhook topic name for unconnected client location deliveries. enum: `location-unclient`'
    webhook_minis_application:
      title: webhook_minis_application
      required:
      - events
      - topic
      type: object
      properties:
        events:
          type: array
          items:
            $ref: '#/components/schemas/webhook_minis_application_event'
          description: Minis application test events included in this webhook delivery
        topic:
          const: minis-application
          type: string
          description: 'Webhook topic name for Minis application test deliveries. enum: `minis-application`.'
      description: Sample of the `minis-application` webhook payload.
    webhook_minis_application_event:
      title: webhook_minis_application_event
      type: object
      properties:
        device_mac:
          type: string
          description: MAC address of the device
        ip:
          type: string
          description: Destination IP address used for the application test
        latency:
          type: integer
          description: Application test latency measured in milliseconds
          contentEncoding: int32
        org_id:
          type: string
          description: Organization associated with the Minis application test result
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        probe_name:
          type: string
          description: Name of the probe
          examples:
          - connectivitycheck.gstatic.com
        probe_type:
          type: string
          description: Probe category used for the Minis application test
          examples:
          - application
        site_id:
          type: string
          description: Site associated with the Minis application test result
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        src_ip:
          type: string
          description: Source IP address of the test
        success:
          type: boolean
          description: Whether the test was successful
        test_type:
          allOf:
          - $ref: '#/components/schemas/synthetictest_config_custom_probe_type2'
          - description: 'Synthetic test type used for the Minis application result. enum: `application`, `curl`, `icmp`, `reachability`, `tcp`.'
        timestamp:
          type: number
          description: Time when the Minis application test result was reported, in epoch seconds
          readOnly: true
        vlan:
          type: integer
          description: Network VLAN ID used for the application test
          contentEncoding: int32
          examples:
          - 12
      description: Marvis Minis application synthetic test result
    webhook_minis_application_topic:
      title: webhook_minis_application_topic
      const: minis-application
      type: string
      description: 'Webhook topic name for Minis application test deliveries. enum: `minis-application`'
    webhook_minis_reachability:
      title: webhook_minis_reachability
      required:
      - events
      - topic
      type: object
      properties:
        events:
          type: array
          items:
            $ref: '#/components/schemas/webhook_minis_reachability_event'
          description: Minis reachability test events included in this webhook delivery
        topic:
          const: minis-reachability
          type: string
          description: 'Webhook topic name for Minis reachability test deliveries. enum: `minis-reachability`.'
      description: Sample of the `minis-reachability` webhook payload.
    webhook_minis_reachability_event:
      title: webhook_minis_reachability_event
      type: object
      properties:
        avg_latency:
          type: number
          description: Average latency in milliseconds
        device_mac:
          type: string
          description: MAC address of the device performing the test
          examples:
          - 7cb68d8f0440
        loss_percentage:
          type: number
          description: Percentage of packets lost during the reachability test
        max_latency:
          type: number
          description: Maximum latency in milliseconds
        min_latency:
          type: number
          description: Minimum latency in milliseconds
        org_id:
          type: string
          description: Organization associated with the Minis reachability test result
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        probe_name:
          type: string
          description: Name of the probe
          examples:
          - google ping
        probe_target:
          type: string
          description: Target host or IP for the probe
          examples:
          - google.com
        probe_type:
          type: string
          description: Probe category used for the Minis reachability test
          examples:
          - reachability
        protocol:
          type: string
          description: Network protocol used for the reachability test
          examples:
          - icmp
        site_id:
          type: string
          description: Site associated with the Minis reachability test result
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        test_type:
          type: string
          description: Type of test performed
          examples:
          - ping
        timestamp:
          type: number
          description: Time when the Minis reachability test result was reported, in epoch seconds
          readOnly: true
        vlan:
          type: integer
          description: Network VLAN ID used for the reachability test
          contentEncoding: int32
          examples:
          - 12
      description: Marvis Minis reachability synthetic test result
    webhook_minis_reachability_topic:
      title: webhook_minis_reachability_topic
      const: minis-reachability
      type: string
      description: 'Webhook topic name for Minis reachability test deliveries. enum: `minis-reachability`'
    webhook_mxedge_event_topic:
      title: webhook_mxedge_event_topic
      const: mxedge-events
      type: string
      description: 'Webhook topic name for Mist Edge event deliveries. enum: `mxedge-events`'
    webhook_mxedge_events:
      title: webhook_mxedge_events
      required:
      - events
      - topic
      type: object
      properties:
        events:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/mxedge_event'
          description: Mist Edge events included in this webhook delivery
        topic:
          const: mxedge-events
          type: string
          description: 'Webhook topic name for Mist Edge event deliveries. enum: `mxedge-events`.'
      description: Sample of the `mxedge-events` webhook payload.
    webhook_nac_accounting:
      title: webhook_nac_accounting
      type: object
      properties:
        events:
          type: array
          items:
            $ref: '#/components/schemas/webhook_nac_accounting_event'
          description: NAC accounting events included in this webhook delivery
        topic:
          allOf:
          - $ref: '#/components/schemas/webhook_nac_accounting_topic2'
          - description: 'Webhook topic name for NAC accounting deliveries. enum: `nac-accounting`.'
      description: Sample of the `nac-accounting` webhook payload.
    webhook_nac_accounting_event:
      title: webhook_nac_accounting_event
      type: object
      properties:
        ap:
          type: string
          description: MAC address of the AP the client roamed or disconnected from
          examples:
          - 5c5b355005be
        auth_type:
          allOf:
          - $ref: '#/components/schemas/nac_auth_type4'
          - description: 'Authentication method used for the NAC accounting session. enum: `cert`, `device-auth`, `eap-teap`, `eap-tls`, `eap-ttls`, `idp`, `mab`, `eap-peap`.'
            examples:
            - eap-tls
        bssid:
          type: string
          description: Wireless BSSID used for the NAC accounting session
          examples:
          - 5c5b35546bb4
        client_ip:
          type: string
          description: Client IP address observed for the NAC accounting session
          examples:
          - 172.16.87.4
        client_type:
          type: string
          description: Client type E.g. "wired", "wireless", "vty"
          examples:
          - wireless
        mac:
          type: string
          description: Client MAC address for the NAC accounting session
          examples:
          - 6e795836d5f9
        nas_vendor:
          type: string
          description: NAS Device vendor name E.g. "Juniper", "Cisco"
          examples:
          - juniper-mist
        org_id:
          type: string
          description: Organization associated with the NAC accounting event
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        rx_pkts:
          type:
          - integer
          - 'null'
          description: Number of packets received during the NAC accounting session
          contentEncoding: int64
          readOnly: true
          examples:
          - 57770567
        site_id:
          type: string
          description: Site associated with the NAC accounting event
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        ssid:
          type: string
          description: Wireless SSID used for the NAC accounting session
          examples:
          - Test-CMR SSID
        timestamp:
          type: number
          description: Time when the NAC accounting event was reported, in epoch seconds
          readOnly: true
        tx_pkts:
          type:
          - integer
          - 'null'
          description: Number of packets sent during the NAC accounting session
          contentEncoding: int64
          readOnly: true
          examples:
          - 812204062
        type:
          type: string
          description: NAC accounting event type, such as `ACCOUNTING_START`, `ACCOUNTING_UPDATE`, or `ACCOUNTING_STOP`
          examples:
          - NAC_ACCOUNTING_STOP
        username:
          type: string
          description: Client-presented username for NAC authentication
          examples:
          - hi
      description: NAC accounting event for a client session with traffic counters
    webhook_nac_accounting_topic:
      title: webhook_nac_accounting_topic
      const: nac-accounting
      type: string
      description: 'Webhook topic name for NAC accounting deliveries. enum: `nac-accounting`'
    webhook_nac_events:
      title: webhook_nac_events
      type: object
      properties:
        events:
          type: array
          items:
            $ref: '#/components/schemas/nac_client_event'
          description: NAC authentication events included in this webhook delivery
        topic:
          allOf:
          - $ref: '#/components/schemas/webhook_nac_events_topic2'
          - description: 'Webhook topic name for NAC event deliveries. enum: `nac-events`.'
      description: Sample of the `nac-events` webhook payload.
    webhook_nac_events_topic:
      title: webhook_nac_events_topic
      const: nac-events
      type: string
      description: 'Webhook topic name for NAC event deliveries. enum: `nac-events`'
    webhook_oauth2_grant_type:
      title: webhook_oauth2_grant_type
      enum:
      - client_credentials
      - password
      type: string
      description: 'required when `type`==`oauth2`. enum: `client_credentials`, `password`'
    webhook_occupancy_alert_type:
      title: webhook_occupancy_alert_type
      enum:
      - COMPLIANCE-OK
      - COMPLIANCE-VIOLATION
      type: string
      description: 'Occupancy compliance state reported for the zone. enum: `COMPLIANCE-OK`, `COMPLIANCE-VIOLATION`'
    webhook_occupancy_alerts:
      title: webhook_occupancy_alerts
      required:
      - events
      - topic
      type: object
      properties:
        events:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/webhook_occupancy_alerts_event'
          description: Occupancy alert batches included in this webhook delivery
        topic:
          const: occupancy-alerts
          type: string
          description: 'Webhook topic name for occupancy alert deliveries. enum: `occupancy-alerts`.'
      description: Sample of the `occupancy-alerts` webhook payload.
    webhook_occupancy_alerts_event:
      title: webhook_occupancy_alerts_event
      required:
      - site_id
      - site_name
      type: object
      properties:
        alert_events:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/webhook_occupancy_alerts_event_alert_events_items'
          description: Occupancy zone alerts detected for this site around the same time
          readOnly: true
        for_site:
          type: boolean
          description: Whether this occupancy alert batch is scoped to a site rather than only to the organization
          readOnly: true
        site_id:
          type: string
          description: Site associated with the occupancy alert batch
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        site_name:
          type: string
          description: Site name associated with the occupancy alert batch
          readOnly: true
      description: Site-level occupancy alert batch containing one or more zone alerts
    webhook_occupancy_alerts_event_alert_events_items:
      title: webhook_occupancy_alerts_event_alert_events_items
      required:
      - current_occupancy
      - map_id
      - occupancy_limit
      - org_id
      - timestamp
      - type
      - zone_id
      - zone_name
      type: object
      properties:
        current_occupancy:
          type: integer
          description: Current number of occupants detected in the zone
          contentEncoding: int32
        map_id:
          type: string
          description: Map associated with the occupancy zone
          contentEncoding: uuid
        occupancy_limit:
          type: integer
          description: Configured occupancy limit for the zone
          contentEncoding: int32
        org_id:
          type: string
          description: Organization associated with the occupancy alert
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        timestamp:
          type: number
          description: Time when the occupancy alert was generated, in epoch seconds
          readOnly: true
        type:
          allOf:
          - $ref: '#/components/schemas/webhook_occupancy_alert_type1'
          - description: 'Occupancy compliance state reported for the zone. enum: `COMPLIANCE-OK`, `COMPLIANCE-VIOLATION`.'
        zone_id:
          type: string
          description: Zone identifier associated with the occupancy alert
          contentEncoding: uuid
        zone_name:
          type: string
          description: Zone name associated with the occupancy alert
      description: Occupancy compliance alert for a single zone
    webhook_occupancy_alerts_topic:
      title: webhook_occupancy_alerts_topic
      const: occupancy-alerts
      type: string
      description: 'Webhook topic name for occupancy alert deliveries. enum: `occupancy-alerts`'
    webhook_ping:
      title: webhook_ping
      required:
      - events
      - topic
      type: object
      properties:
        events:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/webhook_ping_event'
          description: Ping events included in this webhook delivery
        topic:
          const: ping
          type: string
          description: Webhook topic name for ping deliveries
      description: Sample of the `ping` webhook payload.\n\nThe `ping` webhook can be manually sent with the following API calls:\n- for a Site level webhook with the [Ping Site Webhook]($e/Orgs%20Webhooks/pingOrgWebhook) endpoint\n- for an Org level webhook with the [Ping Org Webhook]($e/Orgs%20Webhooks/pingOrgWebhook) endpoint
    webhook_ping_event:
      title: webhook_ping_event
      required:
      - id
      - name
      - site_id
      - timestamp
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the webhook ping event
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        name:
          type: string
          description: Display name associated with the webhook ping event
        site_id:
          type: string
          description: Site associated with the webhook ping event
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        timestamp:
          type: number
          description: Time when the webhook ping event was generated, in epoch seconds
          readOnly: true
      description: Ping webhook event generated to verify webhook delivery
    webhook_ping_topic:
      title: webhook_ping_topic
      const: ping
      type: string
      description: 'Webhook topic name for ping deliveries. enum: `ping`'
    webhook_rssizone:
      title: webhook_rssizone
      required:
      - events
      - topic
      type: object
      properties:
        events:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/webhook_rssizone_event'
          description: RSSI zone events included in this webhook delivery
        topic:
          const: rssizone
          type: string
          description: 'Webhook topic name for RSSI zone event deliveries. enum: `rssizone`.'
      description: Sample of the `rssizone` webhook payload.
    webhook_rssizone_event:
      title: webhook_rssizone_event
      required:
      - mac
      - map_id
      - rssizone_id
      - site_id
      - timestamp
      - trigger
      - type
      type: object
      properties:
        mac:
          type: string
          description: Client MAC address associated with the RSSI zone event
        map_id:
          type: string
          description: Map associated with the RSSI zone event
          contentEncoding: uuid
        rssizone_id:
          type: string
          description: RSSI zone identifier associated with the event
          contentEncoding: uuid
        site_id:
          type: string
          description: Site associated with the RSSI zone event
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        timestamp:
          type: number
          description: Time when the RSSI zone transition was reported, in epoch seconds
          readOnly: true
        trigger:
          allOf:
          - $ref: '#/components/schemas/webhook_zone_event_trigger3'
          - description: 'Whether the client entered or exited the RSSI zone. enum: `enter`, `exit`.'
        type:
          allOf:
          - $ref: '#/components/schemas/webhook_zone_event_type3'
          - description: 'Client type reported for the RSSI zone event. enum: `asset`, `sdk`, `wifi`.'
      description: RSSI zone transition event for a Wi-Fi, SDK, or asset client
    webhook_rssizone_topic:
      title: webhook_rssizone_topic
      const: rssizone
      type: string
      description: 'Webhook topic name for RSSI zone event deliveries. enum: `rssizone`'
    webhook_rule:
      title: webhook_rule
      required:
      - topic
      type: object
      properties:
        action:
          allOf:
          - $ref: '#/components/schemas/webhook_action1'
          - description: 'Action applied when the rule matches the incoming event. enum: `permit`, `block`.'
        matching:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
            description: Optional event payload matching criteria. Property key is the event field name and the value is the list of accepted values
            example:
              type:
              - AP_DISCONNECTED
          description: Optional event payload matching criteria. Property key is the event field name and the value is the list of accepted values
          examples:
          - type:
            - AP_DISCONNECTED
        topic:
          type: string
          description: Webhook topic this rule applies to
      description: Filtering rule that permits or blocks webhook events for a topic
    webhook_sdkclient_scan_data:
      title: webhook_sdkclient_scan_data
      required:
      - events
      - topic
      type: object
      properties:
        events:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/webhook_sdkclient_scan_data_event'
          description: SDK client scan data events included in this webhook delivery
        topic:
          const: sdkclient-scan-data
          type: string
          description: 'Webhook topic name for SDK client scan data deliveries. enum: `sdkclient-scan-data`.'
      description: Sample of the `sdkclient-scan-data` webhook payload.
    webhook_sdkclient_scan_data_event:
      title: webhook_sdkclient_scan_data_event
      required:
      - connection_ap
      - connection_band
      - connection_bssid
      - connection_channel
      - connection_rssi
      - mac
      - site_id
      type: object
      properties:
        connection_ap:
          type: string
          description: MAC address of the AP the client is connected to
        connection_band:
          type: string
          description: 5GHz or 2.4GHz band, of the BSSID the client is connected to
        connection_bssid:
          type: string
          description: Connected AP BSSID for the SDK client
        connection_channel:
          type: integer
          description: Channel of the band the client is connected to
          contentEncoding: int32
        connection_rssi:
          type: number
          description: RSSI of the client’s connection to the AP/BSSID
        last_seen:
          type:
          - number
          - 'null'
          description: Time when the SDK client scan data was last observed, in epoch seconds
          readOnly: true
          examples:
          - 1470417522
        mac:
          type: string
          description: SDK client MAC address
        scan_data:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/webhook_sdkclient_scan_data_event_scan_data_item'
          description: Background Wi-Fi scan observations reported by the SDK client
        site_id:
          type: string
          description: Site associated with the SDK client scan data event
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
      description: SDK client connection state and background Wi-Fi scan observations
    webhook_sdkclient_scan_data_event_scan_data_item:
      title: webhook_sdkclient_scan_data_event_scan_data_item
      required:
      - ap
      - band
      - bssid
      - channel
      - rssi
      - ssid
      - timestamp
      type: object
      properties:
        ap:
          type: string
          description: MAC address of the AP associated with the BSSID scanned
        band:
          allOf:
          - $ref: '#/components/schemas/scan_data_item_band1'
          - minLength: 1
            description: 'Radio band on which the SDK client scanned the BSSID. enum: `2.4`, `5`.'
        bssid:
          type: string
          description: Scanned BSSID found during the SDK client's background Wi-Fi scan
        channel:
          type: integer
          description: Radio channel found in the SDK client's background scan
          contentEncoding: int32
        rssi:
          type: number
          description: Signal strength measured by the SDK client for the scanned BSSID
        ssid:
          type: string
          description: Network SSID containing the BSSID scanned by the SDK client
        timestamp:
          type: number
          description: Time when the SDK client scan observation was recorded, in epoch seconds
          readOnly: true
      description: Single BSSID observation from an SDK client's background Wi-Fi scan
    webhook_sdkclient_scan_data_topic:
      title: webhook_sdkclient_scan_data_topic
      const: sdkclient-scan-data
      type: string
      description: 'Webhook topic name for SDK client scan data deliveries. enum: `sdkclient-scan-data`'
    webhook_site_sle:
      title: webhook_site_sle
      required:
      - events
      - topic
      type: object
      properties:
        events:
          type: array
          items:
            $ref: '#/components/schemas/webhook_site_sle_event'
          description: Site SLE score events included in this webhook delivery
        topic:
          const: site-sle
          type: string
          description: 'Webhook topic name for site SLE score deliveries. enum: `site-sle`.'
      description: Sample of the `site-sle` webhook payload.
    webhook_site_sle_event:
      title: webhook_site_sle_event
      type: object
      properties:
        org_id:
          type: string
          description: Organization associated with the site SLE score event
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        site_id:
          type: string
          description: Site associated with the SLE score event
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        sle:
          allOf:
          - $ref: '#/components/schemas/webhook_site_sle_event_sle2'
          - description: Service-level experience scores reported for the site
        timestamp:
          type: number
          description: Time when the site SLE scores were reported, in epoch seconds
          readOnly: true
      description: Site-level Wi-Fi SLE score snapshot
    webhook_site_sle_event_sle:
      title: webhook_site_sle_event_sle
      type: object
      properties:
        ap-availability:
          type: number
          description: Wireless AP availability SLE score for the site
          examples:
          - 0.6
        successful-connect:
          type: number
          description: Connection success SLE score for the site
          examples:
          - 0.7
        time-to-connect:
          type: number
          description: Client connection-time SLE score for the site
          examples:
          - 0.9
      description: Wi-Fi SLE scores reported by a site SLE webhook event
    webhook_site_sle_topic:
      title: webhook_site_sle_topic
      const: site-sle
      type: string
      description: 'Webhook topic name for site SLE score deliveries. enum: `site-sle`'
    webhook_type:
      title: webhook_type
      enum:
      - aws-sns
      - google-pubsub
      - http-post
      - oauth2
      - splunk
      type: string
      description: 'enum: `aws-sns`, `google-pubsub`, `http-post`, `oauth2`, `splunk`'
    webhook_wifi_conn_raw:
      title: webhook_wifi_conn_raw
      required:
      - events
      - topic
      type: object
      properties:
        events:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/webhook_wifi_conn_raw_event'
          description: Connected Wi-Fi raw packet events included in this webhook delivery
        topic:
          const: wifi-conn-raw
          type: string
          description: 'Webhook topic name for connected Wi-Fi raw packet deliveries. enum: `wifi-conn-raw`.'
      description: "Sample of the `wifi-conn-raw` webhook payload.\n\n\nThis webhook topic provides raw data from packets emitted by connected devices.\n\n\nRaw data webhooks are a special subset of webhooks that provide insight into raw data packets emitted by a client,\nidentified by their advertising MAC address (assets, discovered ble, connected wifi, unconnected wifi).  \nThe data that client raw data webhooks encompasses are reporting AP information, RSSI Data, and any special packets/telemetry\npackets that the client may emit.\n\nNote that client raw webhooks are the raw data coming from the client and do not contain the X,Y location data of the client.\nIn order to get the location data for a client please see our location webhooks. \nClients can be identified uniquely across these client raw data topics and location webhook topic using MAC address as the Unique identifier (client identifier)."
    webhook_wifi_conn_raw_event:
      title: webhook_wifi_conn_raw_event
      type: object
      properties:
        ap_id:
          type: string
          description: AP MAC address that reported the connected client packet
        ap_loc:
          type: array
          items:
            type: number
          description: Location coordinates of the reporting AP when available, updated about once per minute per client
        client_id:
          type: string
          description: Client MAC address that emitted the connected Wi-Fi packet
        connected_site:
          type: boolean
          description: Whether the client is connected to the reporting site
        extended_info_list:
          type: array
          items:
            $ref: '#/components/schemas/webhook_wifi_conn_raw_event_extended_info'
          description: Extended telemetry packets decoded from the connected Wi-Fi client payload
        map_id:
          type: string
          description: Map associated with the reporting AP when location context is available
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        org_id:
          type: string
          description: Organization associated with the connected Wi-Fi raw event
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        packets:
          type: array
          items:
            $ref: '#/components/schemas/webhook_wifi_conn_raw_event_packet'
          description: RSSI packet observations reported for the connected Wi-Fi client
        site_id:
          type: string
          description: Site associated with the connected Wi-Fi raw event
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
      description: Raw packet observation for a connected Wi-Fi client
    webhook_wifi_conn_raw_event_extended_info:
      title: webhook_wifi_conn_raw_event_extended_info
      type: object
      properties:
        frame_ctrl:
          type: integer
          description: IEEE 802.11 frame control value from the telemetry packet
          contentEncoding: int32
        payload:
          type: string
          description: Raw telemetry payload carried by the connected Wi-Fi packet
        sequence_ctrl:
          type: integer
          description: IEEE 802.11 sequence control value from the telemetry packet
          contentEncoding: int32
      description: Extended telemetry details decoded from a connected Wi-Fi packet
    webhook_wifi_conn_raw_event_packet:
      title: webhook_wifi_conn_raw_event_packet
      type: object
      properties:
        band:
          type: string
          description: Radio band on which the connected Wi-Fi packet was observed
        rssi:
          type: integer
          description: Received signal strength of the connected Wi-Fi packet at the reporting AP, in dBm
          contentEncoding: int32
      description: RSSI observation for a connected Wi-Fi client packet
    webhook_wifi_conn_raw_topic:
      title: webhook_wifi_conn_raw_topic
      const: wifi-conn-raw
      type: string
      description: 'Webhook topic name for connected Wi-Fi raw packet deliveries. enum: `wifi-conn-raw`'
    webhook_wifi_unconn_raw:
      title: webhook_wifi_unconn_raw
      required:
      - events
      - topic
      type: object
      properties:
        events:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/webhook_wifi_unconn_raw_event'
          description: Unconnected Wi-Fi raw packet events included in this webhook delivery
        topic:
          const: wifi-unconn-raw
          type: string
          description: 'Webhook topic name for unconnected Wi-Fi raw packet deliveries. enum: `wifi-unconn-raw`.'
      description: "Sample of the `wifi-unconn-raw` webhook payload.\n\n\nThis webhook topic provides raw data from packets emitted by unconnected devices.\n\n\nRaw data webhooks are a special subset of webhooks that provide insight into raw data packets emitted by a client,\nidentified by their advertising MAC address (assets, discovered ble, connected wifi, unconnected wifi).  \nThe data that client raw data webhooks encompasses are reporting AP information, RSSI Data, and any special packets/telemetry\npackets that the client may emit.\n\nNote that client raw webhooks are the raw data coming from the client and do not contain the X,Y location data of the client.\nIn order to get the location data for a client please see our location webhooks. \nClients can be identified uniquely across these client raw data topics and location webhook topic using MAC address as the Unique identifier (client identifier)."
    webhook_wifi_unconn_raw_event:
      title: webhook_wifi_unconn_raw_event
      type: object
      properties:
        ap_id:
          type: string
          description: AP MAC address that reported the unconnected client packet
        ap_loc:
          type: array
          items:
            type: number
          description: Location coordinates of the reporting AP when available, updated about once per minute per client
        client_id:
          type: string
          description: Client MAC address that emitted the unconnected Wi-Fi packet
        connected_site:
          type: boolean
          description: Whether the observed client is connected to the reporting site
        map_id:
          type: string
          description: Map associated with the reporting AP when location context is available
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        org_id:
          type: string
          description: Organization associated with the unconnected Wi-Fi raw event
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        packets:
          type: array
          items:
            $ref: '#/components/schemas/webhook_wifi_unconn_raw_event_packet'
          description: RSSI packet observations reported for the unconnected Wi-Fi client
        site_id:
          type: string
          description: Site associated with the unconnected Wi-Fi raw event
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
      description: Raw packet observation for an unconnected Wi-Fi client
    webhook_wifi_unconn_raw_event_packet:
      title: webhook_wifi_unconn_raw_event_packet
      type: object
      properties:
        band:
          type: string
          description: Radio band on which the unconnected Wi-Fi packet was observed
        rssi:
          type: integer
          description: Received signal strength of the unconnected Wi-Fi packet at the reporting AP, in dBm
          contentEncoding: int32
      description: RSSI observation for an unconnected Wi-Fi client packet
    webhook_wifi_unconn_raw_topic:
      title: webhook_wifi_unconn_raw_topic
      const: wifi-unconn-raw
      type: string
      description: 'Webhook topic name for unconnected Wi-Fi raw packet deliveries. enum: `wifi-unconn-raw`'
    webhook_zone:
      title: webhook_zone
      required:
      - events
      - topic
      type: object
      properties:
        events:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/webhook_zone_event'
          description: Zone transition events included in this webhook delivery
        topic:
          const: zone
          type: string
          description: Webhook topic name for zone transition deliveries
      description: Sample of the `zone` webhook payload.
    webhook_zone_event:
      title: webhook_zone_event
      required:
      - map_id
      - site_id
      - timestamp
      - trigger
      - type
      - zone_id
      type: object
      properties:
        asset_id:
          type: string
          description: Only if `type`==`asset`. UUID of named asset
          contentEncoding: uuid
        id:
          type: string
          description: Only if `type`==`sdk`. UUID of the SDK Client
          contentEncoding: uuid
        mac:
          type: string
          description: Client or asset MAC address associated with the zone event
        map_id:
          type: string
          description: Map associated with the zone event
          contentEncoding: uuid
        name:
          type: string
          description: Display name of the client or asset, when available
        site_id:
          type: string
          description: Site associated with the zone event
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        timestamp:
          type: number
          description: Time when the zone transition was reported, in epoch seconds
          readOnly: true
        trigger:
          allOf:
          - $ref: '#/components/schemas/webhook_zone_event_trigger1'
          - description: 'Whether the client or asset entered or exited the zone. enum: `enter`, `exit`.'
        type:
          allOf:
          - $ref: '#/components/schemas/webhook_zone_event_type1'
          - description: 'Client or asset type reported for the zone event. enum: `asset`, `sdk`, `wifi`.'
        zone_id:
          type: string
          description: Zone identifier associated with the event
          contentEncoding: uuid
      description: Zone enter or exit event for a Wi-Fi client, SDK client, or asset
    webhook_zone_event_trigger:
      title: webhook_zone_event_trigger
      enum:
      - enter
      - exit
      type: string
      description: 'Zone transition direction, either enter or exit. enum: `enter`, `exit`'
    webhook_zone_event_type:
      title: webhook_zone_event_type
      enum:
      - asset
      - sdk
      - wifi
      type: string
      description: 'Type of client. enum: `asset` (BLE Tag), `sdk`, `wifi`'
    webhook_zone_topic:
      title: webhook_zone_topic
      const: zone
      type: string
      description: 'Webhook topic name for zone transition deliveries. enum: `zone`'
    websocket_session:
      title: websocket_session
      required:
      - session
      type: object
      properties:
        session:
          type: string
          description: Identifier used to correlate output on the WebSocket stream
          examples:
          - 19e73828-937f-05e6-f709-e29efdb0a82b
      description: Response containing the WebSocket session handle for asynchronous command output
    websocket_session_with_url:
      title: websocket_session_with_url
      required:
      - session
      - url
      type: object
      properties:
        session:
          type: string
          description: Identifier used to correlate output on the WebSocket stream
          examples:
          - 19e73828-937f-05e6-f709-e29efdb0a82b
        url:
          type: string
          description: WebSocket URL returned for connecting to this session
          examples:
          - wss://api-ws.mist.com/ssh?jwt=xxxx
      description: Response containing a WebSocket session handle and connection URL
    wifi_beacon_extended_info_items:
      title: wifi_beacon_extended_info_items
      type: object
      properties:
        frame_ctrl:
          type: integer
          description: Frame control field of 802.11 header
          contentEncoding: int32
        payload:
          type: string
          description: Extended Info Payload associated with frame
        seq_ctrl:
          type: integer
          description: Sequence control field of 802.11 header
          contentEncoding: int32
      description: Extended Wi-Fi beacon packet metadata with frame and sequence control fields
    wired_client_response_device_mac_port_item:
      title: wired_client_response_device_mac_port_item
      type: object
      properties:
        device_mac:
          minLength: 1
          type: string
          description: Switch or gateway MAC address for this wired client observation
        ip:
          type: string
          description: Client IP address observed for this port entry
          readOnly: true
        port_id:
          type: string
          description: Interface identifier where the wired client was observed
          readOnly: true
        port_parent:
          type: string
          description: Parent interface or port group associated with this port entry
        start:
          type: string
          description: Time when this wired client observation began
          readOnly: true
        vlan:
          type: integer
          description: Client VLAN identifier observed for this port entry
          contentEncoding: int32
          readOnly: true
        when:
          type: string
          description: Time when this wired client port entry was recorded
          readOnly: true
      description: Switch or gateway port observation for a wired client
    wlan_airwatch:
      title: wlan_airwatch
      type: object
      properties:
        api_key:
          type: string
          description: API key used to authenticate to the AirWatch service
          examples:
          - aHhlbGxvYXNkZmFzZGZhc2Rmc2RmCg=="
        console_url:
          type: string
          description: Base console URL of the AirWatch deployment
          examples:
          - https://hs1.airwatchportals.com
        enabled:
          type: boolean
          description: Whether AirWatch integration is enabled for the WLAN
          default: false
        password:
          type: string
          description: AirWatch integration account password for this WLAN
          contentEncoding: password
          examples:
          - user1
        username:
          type: string
          description: AirWatch integration account username for this WLAN
          examples:
          - test123
      description: AirWatch integration settings for the WLAN
    wlan_app_limit:
      title: wlan_app_limit
      type: object
      properties:
        apps:
          type: object
          additionalProperties:
            type: integer
            format: int32
          description: "Map from app key to bandwidth in kbps. \nProperty key is the app key, defined in Get Application List"
          default: {}
          examples:
          - dropbox: 300
            netflix: 60
        enabled:
          type: boolean
          description: Whether application bandwidth limits are enabled for this WLAN
          default: false
        wxtag_ids:
          type: object
          additionalProperties:
            type: integer
            format: int32
          description: Map from wxtag_id of Hostname Wxlan Tags to bandwidth in kbps. Property key is the `wxtag_id`
          default: {}
          examples:
          - f99862d9-2726-931f-7559-3dfdf5d070d3: 30
      description: Bandwidth limiting for apps (applies to up/down)
    wlan_app_qos:
      title: wlan_app_qos
      type: object
      properties:
        apps:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/wlan_app_qos_apps_properties'
          description: Map of application keys to QoS rewrite settings
          examples:
          - skype-business-video:
              dscp: 32
              dst_subnet: 10.2.0.0/16
              src_subnet: 10.2.0.0/16
        enabled:
          type: boolean
          description: Whether application QoS rewrite rules are enabled for this WLAN
          default: false
        others:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/wlan_app_qos_others_item'
          description: Custom traffic QoS rules that are not tied to named applications
      description: APP qos wlan settings
    wlan_app_qos_apps_properties:
      title: wlan_app_qos_apps_properties
      type: object
      properties:
        dscp:
          anyOf:
          - type: string
          - maximum: 63
            minimum: 0
            type: integer
            contentEncoding: int32
          description: Differentiated Services Code Point value applied to matching application traffic
        dst_subnet:
          type: string
          description: Subnet filter is not required but helps AP to only inspect certain traffic (thus reducing AP load)
        src_subnet:
          type: string
          description: Subnet filter is not required but helps AP to only inspect certain traffic (thus reducing AP load)
      description: QoS rewrite settings for traffic matching a named application
    wlan_app_qos_others_item:
      title: wlan_app_qos_others_item
      type: object
      properties:
        dscp:
          anyOf:
          - type: string
          - maximum: 63
            minimum: 0
            type: integer
            contentEncoding: int32
          description: Differentiated Services Code Point value applied to matching traffic
        dst_subnet:
          type: string
          description: Destination subnet filter for this custom QoS rule
          examples:
          - 10.2.0.0/16
        port_ranges:
          type: string
          description: TCP or UDP port ranges matched by this custom QoS rule
          examples:
          - 80,1024-6553
        protocol:
          type: string
          description: IP protocol matched by this custom QoS rule
          examples:
          - udp
        src_subnet:
          type: string
          description: Source subnet filter for this custom QoS rule
          examples:
          - 10.2.0.0/16
      description: Custom QoS rewrite rule for traffic not matched by a named application
    wlan_apply_to:
      title: wlan_apply_to
      enum:
      - aps
      - site
      - wxtags
      type: string
      description: 'enum: `aps`, `site`, `wxtags`'
    wlan_auth:
      title: wlan_auth
      required:
      - type
      type: object
      properties:
        anticlog_threshold:
          maximum: 32
          minimum: 16
          type: integer
          description: SAE anti-clogging token threshold
          contentEncoding: int32
          default: 16
          examples:
          - 16
        eap_reauth:
          type: boolean
          description: Whether to trigger EAP reauth when the session ends
          default: false
        enable_beacon_protection:
          type: boolean
          description: Enable Beacon Protection; default is false for better compatibility
          default: false
        enable_gcmp256:
          type: boolean
          description: Enable GCMP-256 encryption suite; default is false for better compatibility
          default: false
        enable_mac_auth:
          type: boolean
          description: Whether to enable MAC Auth, uses the same auth_servers
          default: false
        key_idx:
          maximum: 4
          minimum: 1
          type: integer
          description: When `type`==`wep`, index of the WEP key used as the default transmit key
          contentEncoding: int32
          default: 1
        keys:
          type: array
          items:
            type:
            - string
            - 'null'
          description: When `type`==`wep`, WEP keys configured for this WLAN
          default: []
        multi_psk_only:
          type: boolean
          description: When `type`==`psk`, whether to only use multi_psk
          default: false
        owe:
          allOf:
          - $ref: '#/components/schemas/wlan_auth_owe2'
          - description: 'When `type`==`open`, Opportunistic Wireless Encryption mode for this WLAN. enum: `disabled`, `enabled`, `required`.'
        pairwise:
          type: array
          items:
            oneOf:
            - {}
            - $ref: '#/components/schemas/wlan_auth_pairwise_item'
          description: When `type`==`psk` or `type`==`eap`, pairwise cipher suites allowed for this WLAN
        private_wlan:
          type: boolean
          description: When `multi_psk_only`==`true`, whether private wlan is enabled
          default: false
        psk:
          maxLength: 64
          minLength: 8
          type:
          - string
          - 'null'
          description: When `type`==`psk`, 8-64 characters, or 64 hex characters
          examples:
          - foryoureyesonly
        type:
          allOf:
          - $ref: '#/components/schemas/wlan_auth_type2'
          - description: 'Authentication mode used by this WLAN. enum: `eap`, `eap192`, `open`, `psk`, `psk-tkip`, `psk-wpa2-tkip`, `wep`.'
            examples:
            - psk
        wep_as_secondary_auth:
          type: boolean
          description: Enable WEP as secondary auth
          default: false
      description: WLAN client authentication settings
    wlan_auth_owe:
      title: wlan_auth_owe
      enum:
      - disabled
      - enabled
      - required
      type: string
      description: 'if `type`==`open`. enum: `disabled`, `enabled` (means transition mode), `required`'
    wlan_auth_pairwise_item:
      title: wlan_auth_pairwise_item
      enum:
      - wpa1-ccmp
      - wpa1-tkip
      - wpa2-ccmp
      - wpa2-tkip
      - wpa3
      type: string
      description: 'enum: `wpa1-ccmp`, `wpa1-tkip`, `wpa2-ccmp`, `wpa2-tkip`, `wpa3`'
      examples:
      - wpa3
    wlan_auth_server_selection:
      title: wlan_auth_server_selection
      enum:
      - ordered
      - unordered
      type: string
      description: 'When ordered, AP will prefer and go back to the first server if possible. enum: `ordered`, `unordered`'
      examples:
      - ordered
    wlan_auth_type:
      title: wlan_auth_type
      enum:
      - eap
      - eap192
      - open
      - psk
      - psk-tkip
      - psk-wpa2-tkip
      - wep
      type: string
      description: 'enum: `eap`, `eap192`, `open`, `psk`, `psk-tkip`, `psk-wpa2-tkip`, `wep`'
      examples:
      - psk
    wlan_bonjour:
      title: wlan_bonjour
      type: object
      properties:
        additional_vlan_ids:
          anyOf:
          - type: string
          - type: array
            items:
              $ref: '#/components/schemas/vlan_id_with_variable'
          description: VLAN IDs, beyond the client VLAN, where Bonjour queries and responses are forwarded
        enabled:
          type: boolean
          description: Whether to enable bonjour for this WLAN. Once enabled, limit_bcast is assumed true, allow_mdns is assumed false
          default: false
        services:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/wlan_bonjour_service_properties'
          description: "What services are allowed. \nProperty key is the service name"
          examples:
          - airplay:
              radius_groups:
              - teachers
              scope: same_ap
      description: Bonjour gateway wlan settings
    wlan_bonjour_service_properties:
      title: wlan_bonjour_service_properties
      type: object
      properties:
        disable_local:
          type: boolean
          description: Whether to prevent wireless clients to discover bonjour devices on the same WLAN
          default: false
        radius_groups:
          type: array
          items:
            type: string
          description: RADIUS groups allowed to discover this Bonjour service, when restricted
        scope:
          allOf:
          - $ref: '#/components/schemas/wlan_bonjour_service_properties_scope2'
          - description: 'Discovery scope for this Bonjour service on the WLAN. enum: `same_ap`, `same_map`, `same_site`.'
      description: Bonjour service discovery settings for one advertised service
    wlan_bonjour_service_properties_scope:
      title: wlan_bonjour_service_properties_scope
      enum:
      - same_ap
      - same_map
      - same_site
      type: string
      description: 'how bonjour services should be discovered for the same WLAN. enum: `same_ap`, `same_map`, `same_site`'
    wlan_cisco_cwa:
      title: wlan_cisco_cwa
      type: object
      properties:
        allowed_hostnames:
          type: array
          items:
            type: string
          description: Hostnames allowed for Cisco CWA client access before authorization
        allowed_subnets:
          type: array
          items:
            type: string
          description: CIDR subnets allowed for Cisco CWA client access before authorization
        blocked_subnets:
          type: array
          items:
            type: string
          description: CIDR subnets blocked for Cisco CWA client access
        enabled:
          type: boolean
          description: Whether Cisco CWA is enabled for this WLAN
          default: false
      description: 'Cisco CWA (central web authentication) required RADIUS with COA in order to work. See CWA: https://www.cisco.com/c/en/us/support/docs/security/identity-services-engine/115732-central-web-auth-00.html'
    wlan_datarates:
      title: wlan_datarates
      type: object
      properties:
        eht:
          type:
          - string
          - 'null'
          description: If `template`==`custom`. EHT MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit)
          examples:
          - 3fff0fff0fff03ff
        he:
          type:
          - string
          - 'null'
          description: If `template`==`custom`. HE MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit
          examples:
          - 0fff0fff0fff0fff
        ht:
          type:
          - string
          - 'null'
          description: If `template`==`custom`. MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit), e.g. 00ff 00f0 001f limits HT rates to MCS 0-7 for 1 stream, MCS 4-7 for 2 stream (i.e. MCS 12-15), MCS 1-5 for 3 stream (i.e. MCS 16-20)
          examples:
          - 00ff00ff00ff
        legacy:
          type: array
          items:
            $ref: '#/components/schemas/wlan_datarates_legacy_item'
          description: If `template`==`custom`, legacy 802.11 data rates allowed on this WLAN
          examples:
          - - '6'
            - '9'
            - '12'
            - '18'
            - 24b
            - '36'
            - '48'
            - '54'
        min_rssi:
          type: integer
          description: Minimum RSSI for client to connect, 0 means not enforcing
          contentEncoding: int32
          default: 0
          examples:
          - -70
        template:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/wlan_datarates_template2'
          - description: 'Data rate template used to derive WLAN rate settings. enum: `compatible`, `legacy-only`, `custom`, `no-legacy`, `high-density`.'
        vht:
          type:
          - string
          - 'null'
          description: If `template`==`custom`. MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit), e.g. 03ff 01ff 00ff limits VHT rates to MCS 0-9 for 1 stream, MCS 0-8 for 2 streams, and MCS 0-7 for 3 streams.
          examples:
          - 03ff03ff03ff01ff
      description: Data rates wlan settings
    wlan_datarates_legacy_item:
      title: wlan_datarates_legacy_item
      enum:
      - '1'
      - '11'
      - 11b
      - '12'
      - 12b
      - '18'
      - 18b
      - 1b
      - '2'
      - '24'
      - 24b
      - 2b
      - '36'
      - 36b
      - '48'
      - 48b
      - '5.5'
      - 5.5b
      - '54'
      - 54b
      - '6'
      - 6b
      - '9'
      - 9b
      type: string
      description: 'enum: `1`, `11`, `11b`, `12`, `12b`, `18`, `18b`, `1b`, `2`, `24`, `24b`, `2b`, `36`, `36b`, `48`, `48b`, `5.5`, `5.5b`, `54`, `54b`, `6`, `6b`, `9`, `9b`'
    wlan_datarates_template:
      title: wlan_datarates_template
      enum:
      - compatible
      - legacy-only
      - custom
      - no-legacy
      - high-density
      type: string
      description: "Data Rates template to apply. enum: \n  * `no-legacy`: no 11b\n  * `compatible`: all, like before, default setting that Broadcom/Atheros used\n  * `legacy-only`: disable 802.11n and 802.11ac\n  * `high-density`: no 11b, no low rates\n  * `custom`: user defined"
    wlan_dns_server_rewrite:
      title: wlan_dns_server_rewrite
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether DNS server rewrite by RADIUS group is enabled for this WLAN
          default: false
        radius_groups:
          type: object
          additionalProperties:
            type: string
          description: Map between radius_group and the desired DNS server (IPv4 only). Property key is the RADIUS group, property value is the desired DNS Server
          examples:
          - contractor: 172.1.1.1
            guest: 8.8.8.8
      description: For radius_group-based DNS server (rewrite DNS request depending on the Group RADIUS server returns)
    wlan_dynamic_psk:
      title: wlan_dynamic_psk
      type: object
      properties:
        default_psk:
          maxLength: 63
          minLength: 8
          type: string
          description: Default PSK to use if cloud WLC is not available, 8-63 characters
          examples:
          - foryoureyesonly
        default_vlan_id:
          oneOf:
          - type: string
          - maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
          description: Default VLAN ID used when dynamic PSK lookup does not return a VLAN
        enabled:
          type: boolean
          description: Whether dynamic PSK is enabled for this WLAN
          default: false
        force_lookup:
          type: boolean
          description: When 11r is enabled, we'll try to use the cached PMK, this can be disabled. `false` means auto
          default: false
        local_vlan_ids:
          type: array
          items:
            $ref: '#/components/schemas/vlan_id_with_variable'
          description: VLANs to be bridged locally when forwarding to mxtunnel or site mxedge
        source:
          allOf:
          - $ref: '#/components/schemas/dynamic_psk_source1'
          - description: 'Origin used to retrieve per-user PSKs. enum: `cloud_psks`, `radius`.'
            examples:
            - cloud_psks
      description: >-
        For dynamic PSK where we get per_user PSK from RADIUS. dynamic_psk allows PSK to be selected at runtime depending on context (wlan/site/user/...) thus following configurations are assumed (currently)
          * PSK will come from RADIUS server
          * AP sends client MAC as username and password (i.e. `enable_mac_auth` is assumed)
          * AP sends BSSID:SSID as Caller-Station-ID
          * `auth_servers` is required
          * PSK will come from cloud WLC if source is cloud_psks
          * default_psk will be used if cloud WLC is not available
          * `multi_psk_only` and `psk` is ignored
          * `pairwise` can only be wpa2-ccmp (for now, wpa3 support on the roadmap)
    wlan_dynamic_vlan:
      title: wlan_dynamic_vlan
      type: object
      properties:
        default_vlan_id:
          oneOf:
          - type: string
          - maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
            default: 999
          description: Deprecated default VLAN ID used when no RADIUS VLAN match is returned. Please use `default_vlan_ids` instead, which can support VLAN pools.
          deprecated: true
        default_vlan_ids:
          type: array
          items:
            $ref: '#/components/schemas/wlan_dynamic_vlan_default_vlan_id'
          description: Fallback VLAN IDs, ranges, or variables used when no RADIUS VLAN match is returned
        enabled:
          type: boolean
          description: Requires `vlan_enabled`==`true` to be set to `true`. Whether to enable dynamic vlan
          default: false
        local_vlan_ids:
          type: array
          items:
            $ref: '#/components/schemas/vlan_id_with_variable'
          description: VLAN IDs that should be locally bridged for dynamic VLAN assignment
        type:
          allOf:
          - $ref: '#/components/schemas/wlan_dynamic_vlan_type2'
          - description: 'Dynamic VLAN mapping method used for RADIUS-provided VLAN attributes. enum: `airespace-interface-name`, `standard`.'
            examples:
            - airespace-interface-name
        vlans:
          type: object
          additionalProperties:
            type: string
          description: >-
            Map between vlan_id (as string) to airespace interface names (comma-separated) or null for standard mapping
              * if `dynamic_vlan.type`==`standard`, property key is the VLAN ID and property value is \"\"
              * if `dynamic_vlan.type`==`airespace-interface-name`, property key is the VLAN ID and property value is the Airespace Interface Name
          examples:
          - '131': default
            '322': fast,video
      description: Dynamic VLAN assignment settings for 802.1X WLAN authentication
    wlan_dynamic_vlan_type:
      title: wlan_dynamic_vlan_type
      enum:
      - airespace-interface-name
      - standard
      type: string
      description: 'standard (using Tunnel-Private-Group-ID, widely supported), airespace-interface-name (Airespace/Cisco). enum: `airespace-interface-name`, `standard`'
      examples:
      - airespace-interface-name
    wlan_hotspot20_operators_item:
      title: wlan_hotspot20_operators_item
      enum:
      - ameriband
      - att
      - boingo
      - charter
      - eduroam
      - global_reach
      - google
      - hughes_systique
      - openroaming_legacy
      - openroaming_settled
      - openroaming_settlement_free
      - single_digits
      - tmobile
      - verizon
      type: string
      description: 'enum: `ameriband`, `att`, `boingo`, `charter`, `eduroam`, `global_reach`, `google`, `hughes_systique`, `openroaming_legacy`, `openroaming_settled`, `openroaming_settlement_free`, `single_digits`, `tmobile`, `verizon`'
    wlan_hotspot_20:
      title: wlan_hotspot_20
      type: object
      properties:
        domain_name:
          type: array
          items:
            type: string
          description: Advertised domain names for Hotspot 2.0 clients
          examples:
          - - mist.com
        enabled:
          type: boolean
          description: Whether to enable hotspot 2.0 config
        nai_realms:
          uniqueItems: true
          type: array
          items:
            type: string
          description: NAI realms advertised for Hotspot 2.0 authentication
        operators:
          type: array
          items:
            $ref: '#/components/schemas/wlan_hotspot20_operators_item'
          description: Operator profiles supported by this Hotspot 2.0 configuration
          examples:
          - - google
            - att
        rcoi:
          type: array
          items:
            type: string
          description: Roaming Consortium Organization Identifiers advertised for Hotspot 2.0
          examples:
          - - 5A03BA0000
        venue_name:
          type: string
          description: Venue name, default is site name
          examples:
          - some_name
      description: Hotspot 2.0 WLAN settings
    wlan_inject_dhcp_option_82:
      title: wlan_inject_dhcp_option_82
      type: object
      properties:
        circuit_id:
          type: string
          description: >-
            Information to set in the `circuit_id` field of the DHCP Option 82. It is possible to use static string or the following variables (e.g. `{{SSID}}:{{AP_MAC}}`):
              * {{AP_MAC}}
              * {{AP_MAC_DASHED}}
              * {{AP_MODEL}}
              * {{AP_NAME}}
              * {{SITE_NAME}}
              * {{SSID}}
          examples:
          - '{{SSID}}:{{AP_MAC}}'
        enabled:
          type: boolean
          description: Whether to inject option 82 when forwarding DHCP packets
          default: false
      description: DHCP Option 82 injection settings for a WLAN
    wlan_interface:
      title: wlan_interface
      enum:
      - all
      - eth0
      - eth1
      - eth2
      - eth3
      - mxtunnel
      - site_mxedge
      - wxtunnel
      type: string
      description: 'where this WLAN will be connected to. enum: `all`, `eth0`, `eth1`, `eth2`, `eth3`, `mxtunnel`, `site_mxedge`, `wxtunnel`'
      examples:
      - all
    wlan_mist_nac:
      title: wlan_mist_nac
      type: object
      properties:
        acct_interim_interval:
          maximum: 65535
          minimum: 0
          type: integer
          description: How frequently should interim accounting be reported, 60-65535. default is 0 (use one specified in Access-Accept request from Server). Very frequent messages can affect the performance of the RADIUS server, 600 and up is recommended when enabled.
          contentEncoding: int32
          default: 0
          examples:
          - 60
        auth_servers_retries:
          maximum: 10
          minimum: 1
          type: integer
          description: RADIUS auth session retries. Following fast timers are set if `fast_dot1x_timers` knob is enabled. "retries" are set to value of `auth_servers_timeout`. "max-requests" is also set when setting `auth_servers_retries` is set to default value to 3.
          contentEncoding: int32
          default: 2
          examples:
          - 3
        auth_servers_timeout:
          maximum: 30
          minimum: 1
          type: integer
          description: RADIUS auth session timeout. Following fast timers are set if `fast_dot1x_timers` knob is enabled. "quite-period" and "transmit-period" are set to half the value of `auth_servers_timeout`. "supplicant-timeout" is also set when setting `auth_servers_timeout` is set to default value of 10.
          contentEncoding: int32
          default: 5
          examples:
          - 5
        coa_enabled:
          type: boolean
          description: Allows a RADIUS server to dynamically modify the authorization status of a user session.
          default: false
        coa_port:
          maximum: 65535
          minimum: 1
          type: integer
          description: the communication port used for “Change of Authorization” (CoA) messages
          contentEncoding: int32
          examples:
          - 3799
        enabled:
          type: boolean
          description: >-
            When enabled:
              * `auth_servers` is ignored
              * `acct_servers` is ignored
              * `auth_servers_*` are ignored
              * `coa_servers` is ignored
              * `radsec` is ignored
              * `coa_enabled` is assumed
          default: false
        fast_dot1x_timers:
          type: boolean
          description: If set to true, sets default fast-timers with values calculated from `auth_servers_timeout` and `auth_server_retries`.
          default: false
        network:
          type:
          - string
          - 'null'
          description: Which network the mist nac server resides in
          examples:
          - default
        source_ip:
          type:
          - string
          - 'null'
          description: In case there is a static IP for this network, we can specify it using source ip
          examples:
          - 1.2.3.4
      description: Mist NAC RADIUS settings for a WLAN
    wlan_portal:
      title: wlan_portal
      type: object
      properties:
        allow_wlan_id_roam:
          type: boolean
          description: Optional if `amazon_enabled`==`true`. Whether to allow guest to connect to other Guest WLANs (with different `WLAN.ssid`) of same org without reauthentication (disable random_mac for seamless roaming)
          default: false
        amazon_client_id:
          type:
          - string
          - 'null'
          description: Optional if `amazon_enabled`==`true`. Amazon OAuth2 client id. This is optional. If not provided, it will use a default one.
        amazon_client_secret:
          type:
          - string
          - 'null'
          description: Optional if `amazon_enabled`==`true`. Amazon OAuth2 client secret. If amazon_client_id was provided, provide a corresponding value. Else leave blank.
          contentEncoding: password
        amazon_email_domains:
          type: array
          items:
            type: string
          description: Optional if `amazon_enabled`==`true`. Email domains allowed for Amazon-authenticated guest users. If null or empty, any authenticated Amazon email domain is allowed.
          default: []
        amazon_enabled:
          type: boolean
          description: Whether amazon is enabled as a login method
          default: false
        amazon_expire:
          type:
          - integer
          - 'null'
          description: Optional if `amazon_enabled`==`true`. Interval for which guest remains authorized using amazon auth (in minutes), if not provided, uses expire`
          contentEncoding: int32
        auth:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_auth2'
          - description: 'Guest portal login scheme used by the WLAN. enum: `amazon`, `azure`, `email`, `external`, `facebook`, `google`, `microsoft`, `multi`, `none`, `password`, `sms`, `sponsor`, `sso`.'
            examples:
            - none
        azure_client_id:
          type:
          - string
          - 'null'
          description: Required if `azure_enabled`==`true`. Azure active directory app client id
        azure_client_secret:
          type:
          - string
          - 'null'
          description: Required if `azure_enabled`==`true`. Azure active directory app client secret
          contentEncoding: password
        azure_enabled:
          type: boolean
          description: Whether Azure Active Directory is enabled as a login method
          default: false
        azure_expire:
          type:
          - integer
          - 'null'
          description: Interval for which guest remains authorized using azure auth (in minutes), if not provided, uses expire`
          contentEncoding: int32
        azure_tenant_id:
          type:
          - string
          - 'null'
          description: Required if `azure_enabled`==`true`. Azure active directory tenant id.
        broadnet_password:
          type: string
          description: Required if `sms_provider`==`broadnet`. Password for the Broadnet SMS provider account
          contentEncoding: password
          examples:
          - password
        broadnet_sid:
          type: string
          description: Required if `sms_provider`==`broadnet`. SID for the Broadnet SMS provider account
          examples:
          - MIST
        broadnet_user_id:
          type: string
          description: Required if `sms_provider`==`broadnet`. User ID for the Broadnet SMS provider account
          examples:
          - juniper
        bypass_when_cloud_down:
          type: boolean
          description: Whether to bypass the guest portal when cloud not reachable (and apply the default policies)
          default: false
        clickatell_api_key:
          type: string
          description: Required if `sms_provider`==`clickatell`. API key for the Clickatell SMS provider account
        cross_site:
          type: boolean
          description: Whether to allow guest to roam between WLANs (with same `WLAN.ssid`, regardless of variables) of different sites of same org without reauthentication (disable random_mac for seamless roaming)
          default: false
        email_enabled:
          type: boolean
          description: Whether email (access code verification) is enabled as a login method
          default: false
        enabled:
          type: boolean
          description: Whether guest portal is enabled
          default: false
        expire:
          type: integer
          description: How long to remain authorized, in minutes
          contentEncoding: int32
          default: 1440
          examples:
          - 1440
        external_portal_url:
          type: string
          description: Required if `wlan_portal_auth`==`external`. External portal URL (e.g. https://host/url) where we can append our query parameters to
        facebook_client_id:
          type:
          - string
          - 'null'
          description: Required if `facebook_enabled`==`true`. Facebook OAuth2 app id. This is optional. If not provided, it will use a default one.
        facebook_client_secret:
          type:
          - string
          - 'null'
          description: Required if `facebook_enabled`==`true`. Facebook OAuth2 app secret. If facebook_client_id was provided, provide a corresponding value. Else leave blank.
          contentEncoding: password
        facebook_email_domains:
          type: array
          items:
            type: string
          description: Optional if `facebook_enabled`==`true`. Email domains allowed for Facebook-authenticated guest users. If null or empty, any authenticated Facebook email domain is allowed.
          default: []
        facebook_enabled:
          type: boolean
          description: Whether facebook is enabled as a login method
          default: false
        facebook_expire:
          type:
          - integer
          - 'null'
          description: Optional if `facebook_enabled`==`true`. Interval for which guest remains authorized using facebook auth (in minutes), if not provided, uses expire`
          contentEncoding: int32
        forward:
          type: boolean
          description: Whether to forward the user to another URL after authorized
          default: false
        forward_url:
          type:
          - string
          - 'null'
          description: URL to forward the user to
          examples:
          - https://abc.com/promotions
        google_client_id:
          type:
          - string
          - 'null'
          description: Google OAuth2 app id. This is optional. If not provided, it will use a default one.
        google_client_secret:
          type:
          - string
          - 'null'
          description: Optional if `google_enabled`==`true`. Google OAuth2 app secret. If google_client_id was provided, provide a corresponding value. Else leave blank.
          contentEncoding: password
        google_email_domains:
          type: array
          items:
            type: string
          description: Optional if `google_enabled`==`true`. Email domains allowed for Google-authenticated guest users. If null or empty, any authenticated Google email domain is allowed.
          default: []
          examples:
          - - mydomain.edu
            - mydomain.org
        google_enabled:
          type: boolean
          description: Whether Google is enabled as login method
          default: false
        google_expire:
          type:
          - integer
          - 'null'
          description: Optional if `google_enabled`==`true`. Interval for which guest remains authorized using Google Auth (in minutes), if not provided, uses expire`
          contentEncoding: int32
        gupshup_password:
          type: string
          description: Required if `sms_provider`==`gupshup`. Password for the Gupshup SMS provider account
          contentEncoding: password
        gupshup_userid:
          type: string
          description: Required if `sms_provider`==`gupshup`. User ID for the Gupshup SMS provider account
        microsoft_client_id:
          type:
          - string
          - 'null'
          description: Optional if `microsoft_enabled`==`true`. Microsoft 365 OAuth2 client id. This is optional. If not provided, it will use a default one.
        microsoft_client_secret:
          type:
          - string
          - 'null'
          description: Optional if `microsoft_enabled`==`true`. Microsoft 365 OAuth2 client secret. If microsoft_client_id was provided, provide a corresponding value. Else leave blank.
          contentEncoding: password
        microsoft_email_domains:
          type: array
          items:
            type: string
          description: Optional if `microsoft_enabled`==`true`. Email domains allowed for Microsoft 365-authenticated guest users. If null or empty, any authenticated Microsoft 365 email domain is allowed.
          default: []
        microsoft_enabled:
          type: boolean
          description: Whether microsoft 365 is enabled as a login method
          default: false
        microsoft_expire:
          type:
          - integer
          - 'null'
          description: Optional if `microsoft_enabled`==`true`. Interval for which guest remains authorized using microsoft auth (in minutes), if not provided, uses expire`
          contentEncoding: int32
        passphrase_enabled:
          type: boolean
          description: Whether password is enabled
          default: false
        passphrase_expire:
          type:
          - integer
          - 'null'
          description: Optional if `passphrase_enabled`==`true`. Interval for which guest remains authorized using passphrase auth (in minutes), if not provided, uses `expire`
          contentEncoding: int32
        password:
          type:
          - string
          - 'null'
          description: Required if `passphrase_enabled`==`true`. Passphrase guests must enter when passphrase authentication is enabled
          examples:
          - let me in
        predefined_sponsors_enabled:
          type: boolean
          description: Whether to show list of sponsor emails mentioned in `sponsors` object as a dropdown. If both `sponsor_notify_all` and `predefined_sponsors_enabled` are false, behavior is acc to `sponsor_email_domains`
          default: true
        predefined_sponsors_hide_email:
          type: boolean
          description: Whether to hide sponsor’s email from list of sponsors
          default: false
        privacy:
          type: boolean
          description: Whether to show the privacy policy in the WLAN guest portal
          default: false
        puzzel_password:
          type: string
          description: Required if `sms_provider`==`puzzel`. Password for the Puzzel SMS provider account
          contentEncoding: password
        puzzel_service_id:
          type: string
          description: Required if `sms_provider`==`puzzel`. Service ID for the Puzzel SMS provider account
        puzzel_username:
          type: string
          description: Required if `sms_provider`==`puzzel`. Username for the Puzzel SMS provider account
        smsMessageFormat:
          type: string
          description: Optional if `sms_enabled`==`true`. SMS Message format
          default: Code {{code}} expires in {{duration}} minutes.
        sms_enabled:
          type: boolean
          description: Whether sms is enabled as a login method
          default: false
        sms_expire:
          type:
          - integer
          - 'null'
          description: Optional if `sms_enabled`==`true`. Interval for which guest remains authorized using sms auth (in minutes), if not provided, uses expire`
          contentEncoding: int32
        sms_provider:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_sms_provider2'
          - description: 'Optional if `sms_enabled`==`true`. SMS provider used to deliver guest portal access codes. enum: `broadnet`, `clickatell`, `gupshup`, `manual`, `puzzel`, `telstra`, `twilio`, `smsglobal`.'
            examples:
            - twilio
        smsglobal_api_key:
          type: string
          description: Required if `sms_provider`==`smsglobal`, Client API Key
        smsglobal_api_secret:
          type: string
          description: Required if `sms_provider`==`smsglobal`, Client secret
          contentEncoding: password
        smsglobal_sender:
          type: string
          description: Optional sender's number or sender ID for SMSGlobal. If not provided, uses the default number associated with the account
        sponsor_auto_approve:
          type: boolean
          description: Optional if `sponsor_enabled`==`true`. Whether to automatically approve guest and allow sponsor to revoke guest access, needs predefined_sponsors_enabled enabled and sponsor_notify_all disabled
          default: false
        sponsor_email_domains:
          type: array
          items:
            type: string
          description: Email domains allowed for sponsor email addresses. Required if `sponsor_enabled` is `true` and `sponsors` is empty.
          examples:
          - - reserved.net
            - reserved.org
        sponsor_enabled:
          type: boolean
          description: Whether sponsor is enabled
          default: false
        sponsor_expire:
          type:
          - integer
          - 'null'
          description: Optional if `sponsor_enabled`==`true`. Interval for which guest remains authorized using sponsor auth (in minutes), if not provided, uses expire`
          contentEncoding: int32
        sponsor_link_validity_duration:
          anyOf:
          - maximum: 60
            minimum: 5
            type: integer
            contentEncoding: int32
            default: 60
          - type: string
          description: Optional if `sponsor_enabled`==`true`. Validity duration, in minutes, for approve or deny links in sponsor emails. Valid values are 5 to 60.
        sponsor_notify_all:
          type: boolean
          description: Optional if `sponsor_enabled`==`true`. whether to notify all sponsors that are mentioned in `sponsors` object. Both `sponsor_notify_all` and `predefined_sponsors_enabled` should be true in order to notify sponsors. If true, email sent to 10 sponsors in no particular order.
          default: false
        sponsor_status_notify:
          type: boolean
          description: Optional if `sponsor_enabled`==`true`. If enabled, guest will get email about sponsor's action (approve/deny)
          default: false
        sponsors:
          oneOf:
          - type: array
            items:
              type: string
          - type: object
            additionalProperties:
              type: string
            examples:
            - sponsor1@company.com: FirstName1 LastName1
              sponsor2@company.com: FirstName2 LastName2
          description: Allowed sponsor email addresses and display names. Required if `sponsor_enabled` is `true` and `sponsor_email_domains` is empty.
        sso_default_role:
          type: string
          description: Optional if `wlan_portal_auth`==`sso`, default role to assign if there’s no match. By default, an assertion is treated as invalid when there’s no role matched
        sso_forced_role:
          type: string
          description: Optional if `wlan_portal_auth`==`sso`. Role assigned to authenticated users when guest SSO is used
        sso_idp_cert:
          type: string
          description: Required if `wlan_portal_auth`==`sso`. IDP Cert (used to verify the signed response)
        sso_idp_sign_algo:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_idp_sign_algo2'
          - description: 'Optional if `wlan_portal_auth`==`sso`. Signing algorithm used for SAML assertions from the identity provider. enum: `sha1`, `sha256`, `sha384`, `sha512`.'
        sso_idp_sso_url:
          type: string
          description: Required if `wlan_portal_auth`==`sso`, IDP Single-Sign-On URL
        sso_issuer:
          type: string
          description: Required if `wlan_portal_auth`==`sso`, IDP issuer URL
        sso_nameid_format:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_sso_nameid_format2'
          - description: 'Optional if `wlan_portal_auth`==`sso`. SAML NameID format expected from the identity provider. enum: `email`, `unspecified`.'
        telstra_client_id:
          type: string
          description: Required if `sms_provider`==`telstra`, Client ID provided by Telstra
        telstra_client_secret:
          type: string
          description: Required if `sms_provider`==`telstra`, Client secret provided by Telstra
          contentEncoding: password
        twilio_auth_token:
          type:
          - string
          - 'null'
          description: Required if `sms_provider`==`twilio`, Auth token account with twilio account
          contentEncoding: password
          examples:
          - af9dac44c344a875ab5d31cb7abcdefg
        twilio_phone_number:
          type:
          - string
          - 'null'
          description: Required if `sms_provider`==`twilio`, Twilio phone number associated with the account. See example for accepted format.
          examples:
          - '+18548888888'
        twilio_sid:
          type:
          - string
          - 'null'
          description: Required if `sms_provider`==`twilio`, Account SID provided by Twilio
          examples:
          - af9dac44c344a875ab5d31cb7abcdefg
      description: Guest portal settings for the WLAN
    wlan_portal_auth:
      title: wlan_portal_auth
      enum:
      - amazon
      - azure
      - email
      - external
      - facebook
      - google
      - microsoft
      - multi
      - none
      - password
      - sms
      - sponsor
      - sso
      type: string
      description: 'authentication scheme. enum: `amazon`, `azure`, `email`, `external`, `facebook`, `google`, `microsoft`, `multi`, `none`, `password`, `sms`, `sponsor`, `sso`'
      examples:
      - none
    wlan_portal_idp_sign_algo:
      title: wlan_portal_idp_sign_algo
      enum:
      - sha1
      - sha256
      - sha384
      - sha512
      type: string
      description: 'Optional if `wlan_portal_auth`==`sso`, Signing algorithm for SAML Assertion. enum: `sha1`, `sha256`, `sha384`, `sha512`'
    wlan_portal_sms_provider:
      title: wlan_portal_sms_provider
      enum:
      - broadnet
      - clickatell
      - gupshup
      - manual
      - puzzel
      - telstra
      - twilio
      - smsglobal
      type: string
      description: 'Optional if `sms_enabled`==`true`. enum: `broadnet`, `clickatell`, `gupshup`, `manual`, `puzzel`, `smsglobal`, `telstra`, `twilio`'
      examples:
      - twilio
    wlan_portal_sso_nameid_format:
      title: wlan_portal_sso_nameid_format
      enum:
      - email
      - unspecified
      type: string
      description: 'Optional if `wlan_portal_auth`==`sso`. enum: `email`, `unspecified`'
    wlan_portal_template:
      title: wlan_portal_template
      type: object
      properties:
        portal_template:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting2'
          - description: Template settings that define guest portal text, layout, and localization
      description: Guest portal template payload for a WLAN
    wlan_portal_template_setting:
      title: wlan_portal_template_setting
      required:
      - pageTitle
      type: object
      properties:
        accessCodeAlternateEmail:
          type: string
          description: Link text for using an alternate email address during access-code login
          default: Use alternate email address
        alignment:
          allOf:
          - $ref: '#/components/schemas/portal_template_alignment3'
          - description: 'Text and content alignment used by the guest portal template. enum: `center`, `left`, `right`.'
        ar:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale36'
          - description: Localized portal template strings for Arabic
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
          default: Sign in with Amazon
        authButtonAzure:
          type: string
          description: Label for Azure auth button
          default: Sign in with Azure
        authButtonEmail:
          type: string
          description: Label for Email auth button
          default: Sign in with Email
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
          default: Sign in with Facebook
        authButtonGoogle:
          type: string
          description: Label for Google auth button
          default: Sign in with Google
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
          default: Sign in with Microsoft
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
          default: Sign in with Passphrase
        authButtonSms:
          type: string
          description: Label for SMS auth button
          default: Sign in with Text Message
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
          default: Sign in as Guest
        authLabel:
          type: string
          description: Heading text displayed above portal authentication options
          default: Connect to Wi-Fi with
        backLink:
          type: string
          description: Label of the link to go back to /logon
        ca-ES:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale1'
          - description: Localized portal template strings for Catalan in Spain
        color:
          type: string
          description: Primary color used by the portal template
          default: '#1074bc'
        colorDark:
          type: string
          description: Darker accent color used by the portal template
          default: '#0b5183'
        colorLight:
          type: string
          description: Lighter accent color used by the portal template
          default: '#3589c6'
        company:
          type: boolean
          description: Whether company field is required
          default: false
        companyError:
          type: string
          description: Error message when company not provided
          default: Please provide your company name
        companyLabel:
          type: string
          description: Label displayed for the company input field
          default: Company
        cs-CZ:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale2'
          - description: Localized portal template strings for Czech in Czechia
        da-DK:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale3'
          - description: Localized portal template strings for Danish in Denmark
        de-DE:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale4'
          - description: Localized portal template strings for German in Germany
        el-GR:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale5'
          - description: Localized portal template strings for Greek in Greece
        email:
          type: boolean
          description: Whether email field is required
          default: false
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
          default: Email Access Domain Error
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
          default: Cancel
        emailCodeCancel:
          type: string
          description: Link text for requesting help when the email access code was not received
          default: I did not receive the code
        emailCodeError:
          type: string
          description: Error message shown when the alternate email address for access-code delivery is invalid
          default: Please provide valid alternate email
        emailCodeFieldLabel:
          type: string
          description: Label for the email access-code input field
          default: Access Code
        emailCodeMessage:
          type: string
          description: Instructional text shown before entering the email access code
          default: Enter the access number that was sent to your email address.
        emailCodeSubmit:
          type: string
          description: Button label for submitting the email access code
          default: Sign In
        emailCodeTitle:
          type: string
          description: Title shown on the email access-code entry page
          default: Access Code
        emailError:
          type: string
          description: Error message when email not provided
          default: Please provide valid email
        emailFieldLabel:
          type: string
          description: Label for the email address input field
          default: Enter your email address
        emailLabel:
          type: string
          description: Label displayed for the email input field
          default: Email
        emailMessage:
          type: string
          description: Instructional text explaining email access-code delivery
          default: We will email you an authentication code which you can use to connect to the Wi-Fi network.
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
          default: Send Access Code
        emailTitle:
          type: string
          description: Title for the Email registration
          default: Sign in with Email
        en-GB:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale6'
          - description: Localized portal template strings for English in the United Kingdom
        en-US:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale7'
          - description: Localized portal template strings for English in the United States
        es-ES:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale8'
          - description: Localized portal template strings for Spanish in Spain
        fi-FI:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale9'
          - description: Localized portal template strings for Finnish in Finland
        field1:
          type: boolean
          description: Whether to ask field1
          default: false
        field1Error:
          type: string
          description: Error message when field1 not provided
          default: Please provide Custom Field 1
        field1Label:
          type: string
          description: Label for custom field 1 input
          default: Custom Field 1
        field1Required:
          type: boolean
          description: Whether custom field 1 must be provided when the field is shown
        field2:
          type: boolean
          description: Whether to ask field2
          default: false
        field2Error:
          type: string
          description: Error message when field2 not provided
          default: Please provide Custom Field 2
        field2Label:
          type: string
          description: Label for custom field 2 input
          default: Custom Field 2
        field2Required:
          type: boolean
          description: Whether custom field 2 must be provided when the field is shown
        field3:
          type: boolean
          description: Whether to ask field3
          default: false
        field3Error:
          type: string
          description: Error message when field3 not provided
          default: Please provide Custom Field 3
        field3Label:
          type: string
          description: Label for custom field 3 input
          default: Custom Field 3
        field3Required:
          type: boolean
          description: Whether custom field 3 must be provided when the field is shown
        field4:
          type: boolean
          description: Whether to ask field4
          default: false
        field4Error:
          type: string
          description: Error message when field4 not provided
          default: Please provide Custom Field 4
        field4Label:
          type: string
          description: Label for custom field 4 input
          default: Custom Field 4
        field4Required:
          type: boolean
          description: Whether custom field 4 must be provided when the field is shown
        fr-FR:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale10'
          - description: Localized portal template strings for French in France
        he-IL:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale11'
          - description: Localized portal template strings for Hebrew in Israel
        hi-IN:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale12'
          - description: Localized portal template strings for Hindi in India
        hr-HR:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale13'
          - description: Localized portal template strings for Croatian in Croatia
        hu-HU:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale14'
          - description: Localized portal template strings for Hungarian in Hungary
        id-ID:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale15'
          - description: Localized portal template strings for Indonesian in Indonesia
        it-IT:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale16'
          - description: Localized portal template strings for Italian in Italy
        ja-JP:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale17'
          - description: Localized portal template strings for Japanese in Japan
        ko-KR:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale18'
          - description: Localized portal template strings for Korean in Korea
        logo:
          type:
          - string
          - 'null'
          description: Custom logo with `data:image/png;base64,` format, default null, uses Juniper Mist Logo. File size must be less than 100kB and image dimensions must be less than 500px x 200px (width x height).
          examples:
          - data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAZg…
        logoHeight:
          maximum: 200
          minimum: 0
          type: integer
          description: Height of the logo, in px
          contentEncoding: int32
          examples:
          - 123
        logoWidth:
          maximum: 500
          minimum: 0
          type: integer
          description: Width of the logo, in px
          contentEncoding: int32
          examples:
          - 408
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
          default: Marketing Policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
          default: false
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
          default: I wish to receive Marketing notifications
        marketingPolicyOptInText:
          type: string
          description: Text of the marketing policy opt-in content
          default: Marketing policy content
        message:
          type: string
          description: Main message displayed on the guest portal sign-in page
          default: Sign in to get online
        ms-MY:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale19'
          - description: Localized portal template strings for Malay in Malaysia
        multiAuth:
          type: boolean
          description: Whether the portal presents multiple authentication methods
          default: false
        name:
          type: boolean
          description: Whether name field is required
          default: false
        nameError:
          type: string
          description: Error message when name not provided
          default: Please provide your name
        nameLabel:
          type: string
          description: Label displayed for the name input field
          default: Name
        nb-NO:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale20'
          - description: Localized portal template strings for Norwegian Bokmal in Norway
        nl-NL:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale21'
          - description: Localized portal template strings for Dutch in the Netherlands
        optOutDefault:
          type: boolean
          description: Default value for the `Do not store` checkbox
          default: true
        optout:
          type: boolean
          description: Whether to display Do Not Store My Personal Information
          default: false
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
          default: Do not store
        pageTitle:
          type: string
          description: Browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
          default: Cancel
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
          default: Invalid Passphrase
        passphraseLabel:
          type: string
          description: Label for the passphrase input field
          default: Passphrase
        passphraseMessage:
          type: string
          description: Instructional text shown on the passphrase sign-in page
          default: Enter the secret passphrase to access the Wi-Fi network.
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
          default: Sign in
        passphraseTitle:
          type: string
          description: Title for passphrase details page
          default: Sign in with Passphrase
        pl-PL:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale22'
          - description: Localized portal template strings for Polish in Poland
        poweredBy:
          type: boolean
          description: Whether to show \"Powered by Mist\"
          default: true
        privacy:
          type: boolean
          description: Whether to require the Privacy Term acceptance
          default: false
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
          default: I accept the Privacy Terms
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
          default: Please review and accept the Privacy Terms
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
          default: Privacy Terms
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
          default: << provide your Privacy Terms here >>
        pt-BR:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale23'
          - description: Localized portal template strings for Portuguese in Brazil
        pt-PT:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale24'
          - description: Localized portal template strings for Portuguese in Portugal
        requiredFieldLabel:
          type: string
          description: Text used to mark a form field as required
          default: required
        responsiveLayout:
          type: boolean
          description: Whether the portal template uses a responsive layout
          default: true
        ro-RO:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale25'
          - description: Localized portal template strings for Romanian in Romania
        ru-RU:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale26'
          - description: Localized portal template strings for Russian in Russia
        signInLabel:
          type: string
          description: Label of the button to signin
          default: Sign In
        sk-SK:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale27'
          - description: Localized portal template strings for Slovak in Slovakia
        smsCarrierDefault:
          type: string
          description: Default option text shown in the SMS carrier selector
          default: Please Select
        smsCarrierError:
          type: string
          description: Error message shown when no mobile carrier is selected
          default: Please select a mobile carrier
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
          default: Mobile Carrier
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
          default: I did not receive the code
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
          default: Invalid Access Code
        smsCodeFieldLabel:
          type: string
          description: Label for the SMS confirmation-code input field
          default: Confirmation Code
        smsCodeMessage:
          type: string
          description: Instructional text shown before entering the SMS access code
          default: Enter the access number that was sent to your mobile number.
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
          default: Sign In
        smsCodeTitle:
          type: string
          description: Title shown on the SMS access-code entry page
          default: Access Code
        smsCountryFieldLabel:
          type: string
          description: Label for the SMS country-code input field
          default: Country Code
        smsCountryFormat:
          type: string
          description: Example country code format shown for SMS authentication
          default: '+1'
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
          default: I have an access code
        smsIsTwilio:
          type: boolean
          description: Whether the SMS portal flow uses Twilio-specific behavior
          default: false
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
          default: Cancel
        smsNumberError:
          type: string
          description: Error message shown when the mobile number is invalid
          default: Invalid Mobile Number
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
          default: Mobile Number
        smsNumberFormat:
          type: string
          description: Example mobile number format shown for SMS authentication
          default: 2125551212 (digits only)
        smsNumberMessage:
          type: string
          description: Instructional text explaining SMS access-code delivery
          default: We will send an access code to your mobile number which you can use to connect to the Wi-Fi network. Message and data rates may apply.
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
          default: Send Access Code
        smsNumberTitle:
          type: string
          description: Title for phone number details
          default: Sign in with Text Message
        smsUsernameFormat:
          type: string
          description: Example username format shown for SMS authentication
          default: username
        smsValidityDuration:
          maximum: 30
          minimum: 1
          type: integer
          description: How long confirmation code should be considered valid (in minutes)
          contentEncoding: int32
        sponsorBackLink:
          type: string
          description: Link text for returning to edit the sponsor request form
          default: Go back and edit request form
        sponsorCancel:
          type: string
          description: Button label for canceling sponsor authentication
          default: Cancel
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
          default: Sponsor Email
        sponsorEmailError:
          type: string
          description: Error message shown when the sponsor email address is invalid
          default: Please provide valid sponsor email
        sponsorEmailTemplate:
          type: string
          description: "HTML template to replace/override default sponsor email template \nSponsor Email Template supports following template variables:\n  * `approve_url`: Renders URL to approve the request; optionally &minutes=N query param can be appended to change the Authorization period of the guest, where N is a valid integer denoting number of minutes a guest remains authorized\n  * `deny_url`: Renders URL to reject the request\n  * `guest_email`: Renders Email ID of the guest\n  * `guest_name`: Renders Name of the guest\n  * `field1`: Renders value of the Custom Field 1\n  * `field2`: Renders value of the Custom Field 2\n  * `sponsor_link_validity_duration`: Renders validity time of the request (i.e. Approve/Deny URL)\n  * `auth_expire_minutes`: Renders Wlan-level configured Guest Authorization Expiration time period (in minutes), If not configured then default (1 day in minutes)"
        sponsorInfoApproved:
          type: string
          description: Status message prefix shown when a sponsor approves the request
          default: Your request was approved by
        sponsorInfoDenied:
          type: string
          description: Status message prefix shown when a sponsor denies the request
          default: Your request was denied by
        sponsorInfoPending:
          type: string
          description: Status message prefix shown after a sponsor notification is sent
          default: Your notification has been sent to
        sponsorName:
          type: string
          description: Label for Sponsor Name
          default: Sponsor Name
        sponsorNameError:
          type: string
          description: Error message shown when the sponsor name is missing
          default: Please provide sponsor name
        sponsorNotePending:
          type: string
          description: Additional status text shown while sponsor approval is pending
          default: Please wait for them to acknowledge.
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
          default: Request Wi-Fi Access
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
          default: Your request was approved
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
          default: Your request was denied
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
          default: Notification Sent
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
          default: Request Wi-Fi Access
        sponsorsError:
          type: string
          description: Error message shown when no sponsor is selected
          default: Please select a sponsor
        sponsorsFieldLabel:
          type: string
          description: Label for the sponsor selection field
          default: Sponsors
        sv-SE:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale28'
          - description: Localized portal template strings for Swedish in Sweden
        th-TH:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale29'
          - description: Localized portal template strings for Thai in Thailand
        tos:
          type: boolean
          description: Whether the portal requires Terms of Service acceptance
          default: true
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
          default: I accept the Terms of Service
        tosError:
          type: string
          description: Error message when tos not accepted
          default: Please review and accept the Terms of Service
        tosLink:
          type: string
          description: Label of the link to go to tos
          default: Terms of Service
        tosText:
          type: string
          description: Text of the Terms of Service
          default: << provide your Terms of Service here >>
        tr-TR:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale30'
          - description: Localized portal template strings for Turkish in Turkey
        uk-UA:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale31'
          - description: Localized portal template strings for Ukrainian in Ukraine
        vi-VN:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale32'
          - description: Localized portal template strings for Vietnamese in Vietnam
        zh-Hans:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale33'
          - description: Localized portal template strings for Simplified Chinese
        zh-Hant:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale34'
          - description: Localized portal template strings for Traditional Chinese
      description: Portal template settings for the WLAN guest portal
    wlan_portal_template_setting_locale:
      title: wlan_portal_template_setting_locale
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for a specific language
    wlan_qos:
      title: wlan_qos
      type: object
      properties:
        class:
          allOf:
          - $ref: '#/components/schemas/wlan_qos_class2'
          - description: 'QoS traffic class applied when WLAN QoS override is enabled. enum: `background`, `best_effort`, `video`, `voice`.'
            examples:
            - best_effort
        overwrite:
          type: boolean
          description: Whether to overwrite QoS
          default: false
      description: QoS override settings for WLAN client traffic
    wlan_qos_class:
      title: wlan_qos_class
      enum:
      - background
      - best_effort
      - video
      - voice
      type: string
      description: 'enum: `background`, `best_effort`, `video`, `voice`'
      examples:
      - best_effort
    wlan_roam_mode:
      title: wlan_roam_mode
      enum:
      - 11r
      - NONE
      - OKC
      type: string
      description: 'enum: `11r`, `OKC`, `NONE`'
      examples:
      - NONE
    wlan_schedule:
      title: wlan_schedule
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether the WLAN operating schedule is enabled
          default: false
        hours:
          allOf:
          - $ref: '#/components/schemas/hours2'
          - description: Time ranges when the WLAN is scheduled to operate
      description: WLAN operating schedule, default is disabled
    wxlan_rule:
      title: wxlan_rule
      required:
      - order
      - src_wxtags
      type: object
      properties:
        action:
          allOf:
          - $ref: '#/components/schemas/wxlan_rule_action2'
          - description: Allow or block behavior applied by this WxLAN rule
            examples:
            - allow
        apply_tags:
          type: array
          items:
            type: string
          description: WxLAN tag identifiers applied when this rule matches
        blocked_apps:
          type: array
          items:
            type: string
          description: Application keys always blocked by this rule, regardless of the rule action
          examples:
          - - mist
            - all-videos
        created_time:
          type: number
          description: Time when this WxLAN rule was created, in epoch seconds
          readOnly: true
        dst_allow_wxtags:
          type: array
          items:
            type: string
          description: Destination WxLAN tag identifiers explicitly allowed by this rule
          examples:
          - - fff34466-eec0-3756-6765-381c728a6037
            - eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3
        dst_deny_wxtags:
          type: array
          items:
            type: string
          description: Destination WxLAN tag identifiers explicitly denied by this rule
          examples:
          - - aaa34466-eec0-3756-6765-381c728a6037
            - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
        dst_wxtags:
          type: array
          items:
            type: string
          description: Destination WxLAN tag identifiers matched by this rule
          examples:
          - - aaa34466-eec0-3756-6765-381c728a6037
            - bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3
        enabled:
          type: boolean
          description: Whether this WxLAN rule is enabled
          default: true
        for_site:
          type: boolean
          description: Whether this WxLAN rule is scoped to a site
          readOnly: true
        id:
          type: string
          description: Unique identifier for this WxLAN rule
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        modified_time:
          type: number
          description: Time when this WxLAN rule was last modified, in epoch seconds
          readOnly: true
        order:
          minimum: -1
          type: integer
          description: Lookup priority for WxLAN rules; larger positive values match first, and -1 means LAST. Uniqueness is not checked
          contentEncoding: int32
          examples:
          - 1
        org_id:
          type: string
          description: Owning organization associated with this WxLAN rule
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        site_id:
          type: string
          description: Mist site associated with this WxLAN rule, when site-scoped
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        src_wxtags:
          type: array
          items:
            type: string
          description: Source WxLAN tag identifiers that must match for this rule to apply
          examples:
          - - 8bfc2490-d726-3587-038d-cb2e71bd2330
            - 3aa8e73f-9f46-d827-8d6a-567bb7e67fc9
        template_id:
          type: string
          description: Only for Org Level WxRule
          contentEncoding: uuid
          examples:
          - 6aa54cbd-e039-4878-846a-04f270de8a5c
      description: WxLAN policy rule controlling traffic between WxLAN tags
    wxlan_rule_action:
      title: wxlan_rule_action
      enum:
      - allow
      - block
      type: string
      description: 'type of action, allow / block. enum: `allow`, `block`'
      examples:
      - allow
    wxlan_tag:
      title: wxlan_tag
      required:
      - name
      - type
      type: object
      properties:
        created_time:
          type: number
          description: Time when this WxLAN tag was created, in epoch seconds
          readOnly: true
        for_site:
          type: boolean
          description: Whether this WxLAN tag is scoped to a site
          readOnly: true
        id:
          type: string
          description: Unique identifier for this WxLAN tag
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        last_ips:
          type: array
          items:
            type: string
          description: Most recent IP addresses observed for this WxLAN tag
          readOnly: true
        mac:
          type:
          - string
          - 'null'
          description: If `type`==`client`, Client MAC address
        match:
          allOf:
          - $ref: '#/components/schemas/wxlan_tag_match2'
          - description: 'Required if `type`==`match`; attribute compared against `values`. enum: `ap_id`, `app`, `asset_mac`, `client_mac`, `hostname`, `ip_range_subnet`, `port`, `psk_name`, `psk_role`, `radius_attr`, `radius_class`, `radius_group`, `radius_username`, `sdkclient_uuid`, `wlan_id`.'
        modified_time:
          type: number
          description: Time when this WxLAN tag was last modified, in epoch seconds
          readOnly: true
        name:
          type: string
          description: Display name of the WxLAN tag
        op:
          allOf:
          - $ref: '#/components/schemas/wxlan_tag_operation2'
          - description: 'Required if `type`==`match`; whether `values` are inclusive or exclusive matches. enum: `in`, `not_in`.'
        org_id:
          type: string
          description: Owning organization associated with this WxLAN tag
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        resource_mac:
          type:
          - string
          - 'null'
          description: MAC address of the discovered resource associated with this tag, when applicable
        services:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Names of services associated with this WxLAN tag
        site_id:
          type: string
          description: Mist site associated with this WxLAN tag, when site-scoped
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        specs:
          type: array
          items:
            $ref: '#/components/schemas/wxlan_tag_spec'
          description: Traffic match specifications used when `type`==`spec`
        subnet:
          type: string
          description: CIDR subnet associated with this WxLAN tag when `type`==`subnet`
        type:
          allOf:
          - $ref: '#/components/schemas/wxlan_tag_type2'
          - description: 'Kind of WxLAN tag and how it is populated. enum: `client`, `match`, `resource`, `spec`, `subnet`, `vlan`.'
        values:
          type: array
          items:
            type: string
          description: Comparison values for the selected `match` attribute when `type`==`match`
        vlan_id:
          oneOf:
          - type: string
          - maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
          description: Identifier of the VLAN associated with this WxLAN tag when `type`==`vlan`
          examples:
          - '1055'
      description: >-
        WxLAN Tag
          * type:
            * client: created manually (e.g. on wireless client table, when they spot a device of interest, they can create a wxlan tag for it
            * resource: created automatically when we discover a network resource
            * subnet: create automatically when a subnet is discovered
          * match:
            * wlan_id, ap_id: values are a list of Wlan / Device ids
            * client_mac: values are a list of MAC addresses
          * radius_group: this is a smart tag that matches RADIUS-Filter-ID, Airespace-ACL-Name (VendorID=14179, VendorType=6) / Aruba-User-Role (VendorID=14823, VendorType=1)
          * radius_username: this matches the ATTR-User-Name(1)
          * radius_class: the matches the ATTR-Class(25)
          * radius_attr: the values are [ "6=1" , "26=10.2.3.4" ], this support other RADIUS attributes where we know the type
          * radius_vendor: the values are [ "14179.10=1" , "14178.16=1.2.3.4" ], this matches vendor attributes and will be dynamically evaluated
    wxlan_tag_match:
      title: wxlan_tag_match
      enum:
      - ap_id
      - app
      - asset_mac
      - client_mac
      - hostname
      - ip_range_subnet
      - port
      - psk_name
      - psk_role
      - radius_attr
      - radius_class
      - radius_group
      - radius_username
      - sdkclient_uuid
      - wlan_id
      type: string
      description: 'required if `type`==`match`. enum: `ap_id`, `app`, `asset_mac`, `client_mac`, `hostname`, `ip_range_subnet`, `port`, `psk_name`, `psk_role`, `radius_attr`, `radius_class`, `radius_group`, `radius_username`, `sdkclient_uuid`, `wlan_id`'
    wxlan_tag_operation:
      title: wxlan_tag_operation
      enum:
      - in
      - not_in
      type: string
      description: 'required if `type`==`match`, type of tag (inclusive/exclusive). enum: `in`, `not_in`'
    wxlan_tag_spec:
      title: wxlan_tag_spec
      type: object
      properties:
        port_range:
          type: string
          description: Matched destination port, "0" means any
          default: '0'
        protocol:
          type: string
          description: tcp / udp / icmp / gre / any / ":protocol_number", `protocol_number` is between 1-254
          default: any
        subnets:
          type: array
          items:
            type: string
          description: Destination subnets or IP addresses matched by this WxLAN tag spec
          default: []
          examples:
          - - 0.0.0.0/0
      description: Traffic match specification used by a WxLAN tag
    wxlan_tag_type:
      title: wxlan_tag_type
      enum:
      - client
      - match
      - resource
      - spec
      - subnet
      - vlan
      type: string
      description: 'enum: `client`, `match`, `resource`, `spec`, `subnet`, `vlan`'
    wxlan_tunnel:
      title: wxlan_tunnel
      required:
      - name
      type: object
      properties:
        created_time:
          type: number
          description: Time when this WxLAN tunnel was created, in epoch seconds
          readOnly: true
        dmvpn:
          allOf:
          - $ref: '#/components/schemas/wxlan_tunnel_dmvpn2'
          - description: Settings for Dynamic Multipoint VPN on this WxLAN tunnel
        for_mgmt:
          type: boolean
          description: Determined during creation time and cannot be toggled. A management tunnel cannot be used by wxlan rule or by wlan
          default: false
        for_site:
          type: boolean
          description: Whether this WxLAN tunnel is scoped to a site
          readOnly: true
        hello_interval:
          maximum: 300
          minimum: 1
          type: integer
          description: In seconds, used as heartbeat to detect if a tunnel is alive. AP will try another peer after missing N hellos specified by hello_retries.
          contentEncoding: int32
          default: 60
        hello_retries:
          maximum: 30
          minimum: 2
          type: integer
          description: Number of missed hello messages before the AP tries another tunnel peer
          contentEncoding: int32
          default: 7
        hostname:
          type: string
          description: >-
            Optional, overwrite the hostname in SCCRQ control message, default is or null, %H and %M can be used, which will be replace with corresponding values:
              * %H: name of the ap if provided (and will be stripped so it can be used for hostname) and fallbacks to MAC
              * %M: MAC (e.g. 5c5b350e0060)
        id:
          type: string
          description: Unique identifier for this WxLAN tunnel
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        ipsec:
          allOf:
          - $ref: '#/components/schemas/wxlan_tunnel_ipsec2'
          - description: Security settings for IPsec on this WxLAN tunnel; requires DMVPN to be enabled
        is_static:
          type: boolean
          description: Whether it’s static/unmanaged (i.e. no control session). As the session configurations are not compatible, cannot be toggled.
          default: false
        modified_time:
          type: number
          description: Time when this WxLAN tunnel was last modified, in epoch seconds
          readOnly: true
        mtu:
          maximum: 1500
          minimum: 0
          type: integer
          description: 0 to enable PMTU, 552-1500 to start PMTU with a lower MTU
          contentEncoding: int32
          default: 0
        name:
          type: string
          description: The name of the tunnel
        org_id:
          type: string
          description: Owning organization associated with this WxLAN tunnel
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        peers:
          type: array
          items:
            type: string
          description: Remote peer IP addresses or hostnames for this tunnel
        router_id:
          type: string
          description: Optional, overwrite the router-id in SCCRQ control message, default is "" or null, can also be an IPv4 address
        secret:
          type: string
          description: Shared secret used for tunnel authentication, ‘’ if no auth is used
        sessions:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/wxlan_tunnel_session'
          description: L2TPv3 sessions established for this tunnel
        site_id:
          type: string
          description: Mist site associated with this WxLAN tunnel, when site-scoped
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        udp_port:
          type: integer
          description: UDP port if `use_udp`==`true`
          contentEncoding: int32
        use_udp:
          type: boolean
          description: Whether to use UDP instead of IP (proto=115, which is default of L2TPv3)
          default: false
      description: WxLAN tunnel configuration for L2TPv3 or DMVPN connectivity
    wxlan_tunnel_dmvpn:
      title: wxlan_tunnel_dmvpn
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether DMVPN is enabled
          default: false
        holding_time:
          type: integer
          description: Optional; the holding time for NHRP ‘registration requests’  and ‘resolution replies’ sent from the Mist AP (in seconds); default 600
          contentEncoding: int32
        host_routes:
          type: array
          items:
            type: string
          description: IPv4 DMVPN peer host routes to which traffic is forwarded
      description: Dynamic Multipoint VPN configurations
    wxlan_tunnel_ipsec:
      title: wxlan_tunnel_ipsec
      required:
      - psk
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether ipsec is enabled, requires DMVPN be enabled
          default: false
        psk:
          type: string
          description: Pre-shared key used for IPsec on this WxLAN tunnel
      description: IPSec-related configurations; requires DMVPN be enabled
    wxlan_tunnel_session:
      title: wxlan_tunnel_session
      type: object
      properties:
        ap_as_session_id:
          type: string
          description: If `use_ap_as_session_ids`==`true`, only apmac is supported right now. This is the name WLAN should use for wxtunnel_remote_id
        comment:
          type: string
          description: Optional, user-specified string for display purpose
        enable_cookie:
          type: boolean
          description: Whether L2TPv3 cookie support is enabled for this session
        ethertype:
          allOf:
          - $ref: '#/components/schemas/wxlan_tunnel_session_ethertype2'
          - description: 'Frame type carried by this tunnel session. enum: `ethernet`, `vlan`.'
        local_session_id:
          maximum: 2147483647
          minimum: 1
          type: integer
          description: Identifier for the local L2TPv3 session, from 1 to 2147483647
          contentEncoding: int32
        pseudo_802.1ad_enabled:
          type: boolean
          description: Optional. Enables the pseudo 802.1ad QinQ mode where the AP device drops the outer vlan tag (QinQ). This mode is useful when tunneling Mist AP’s to some aggregation routers.
          default: false
        remote_id:
          type: string
          description: Remote-id of the session, has to be unique in the same tunnel
        remote_session_id:
          maximum: 2147483647
          minimum: 1
          type: integer
          description: Identifier for the remote L2TPv3 session, from 1 to 2147483647
          contentEncoding: int32
        use_ap_as_session_ids:
          type: boolean
          description: Whether to use AP (last 4 bytes of MAC currently) as session ids
          default: false
      description: L2TPv3 session established inside a WxLAN tunnel
    wxlan_tunnel_session_ethertype:
      title: wxlan_tunnel_session_ethertype
      enum:
      - ethernet
      - vlan
      type: string
      description: 'Frame type carried by this tunnel session. enum: `ethernet`, `vlan`'
    wxtag_client:
      title: wxtag_client
      required:
      - mac
      - since
      type: object
      properties:
        mac:
          type: string
          description: Client MAC address associated with the WxLAN tag entry
          examples:
          - 5684dae9ac8b
        since:
          type: number
          description: Time when the client became associated with the WxLAN tag, in epoch seconds
          examples:
          - 1428939600
      description: Client associated with a WxLAN tag
    zigbee_join_response:
      title: zigbee_join_response
      type: object
      properties:
        session_id:
          type: string
          description: Session ID for the Zigbee join operation
          contentEncoding: uuid
          examples:
          - 19e73828-937f-05e6-f709-e29efdb0a82b
      description: Response containing the session identifier for a Zigbee join operation
    zigbee_trail_response:
      title: zigbee_trail_response
      type: object
      properties:
        session:
          type: string
          description: Session ID the UI can use to stream trail results
          contentEncoding: uuid
          examples:
          - 7a5f7796-83ee-11e5-95c6-1258369c38a9
      description: Response containing the session identifier for a Zigbee event or packet trail operation
    zone:
      title: zone
      type: object
      properties:
        created_time:
          type: number
          description: Time when this zone was created, in epoch seconds
          readOnly: true
        for_site:
          type: boolean
          description: Whether this zone is scoped to a site
          readOnly: true
        id:
          type: string
          description: Unique identifier for this zone
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        map_id:
          type: string
          description: Map where this zone is defined
          contentEncoding: uuid
          readOnly: true
        modified_time:
          type: number
          description: Time when this zone was last modified, in epoch seconds
          readOnly: true
        name:
          type: string
          description: Display name of the zone
        org_id:
          type: string
          description: Owning organization associated with this zone
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        site_id:
          type: string
          description: Mist site associated with this zone
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        vertices:
          type: array
          items:
            $ref: '#/components/schemas/zone_vertex'
          description: Polygon vertices that define the zone boundary
          examples:
          - - x: 732
              y: 1821
            - x: 732.5
              y: 1731
            - x: 837.5
              y: 1731.5
            - x: 839
              y: 1821
      description: Zone defined on a site map
    zone_scope:
      title: zone_scope
      enum:
      - map
      - rssizone
      - site
      - zone
      type: string
      description: 'enum: `map`, `rssizone`, `site`, `zone`'
    zone_type:
      title: zone_type
      enum:
      - rssizones
      - zones
      type: string
      description: 'Zone collection type, either regular zones or RSSI zones. enum: `rssizones`, `zones`'
    zone_vertex:
      title: zone_vertex
      required:
      - x
      - y
      type: object
      properties:
        x:
          type: number
          description: Horizontal pixel coordinate of the zone vertex
        y:
          type: number
          description: Vertical pixel coordinate of the zone vertex
      description: Zone polygon vertex expressed in map pixels
    zone_vertex_m:
      title: zone_vertex_m
      required:
      - x
      - y
      type: object
      properties:
        x:
          type: number
          description: Horizontal coordinate of the zone vertex, in meters
        y:
          type: number
          description: Vertical coordinate of the zone vertex, in meters
      description: Zone polygon vertex expressed in meters
    aamw_profile_action1:
      title: aamw_profile_action1
      enum:
      - block
      - permit
      type: string
      description: 'Action to take for files that meet or exceed the malware verdict threshold. enum: `block`, `permit`.'
    aamw_profile_action3:
      title: aamw_profile_action3
      enum:
      - block
      - permit
      type: string
      description: 'Action to take when Sky ATP cannot obtain a malware verdict. enum: `block`, `permit`.'
    aamw_profile_category_category2:
      title: aamw_profile_category_category2
      enum:
      - archive
      - document
      - pdf
      - executable
      - rich_application
      - library
      - os_package
      - mobile
      - java
      - configuration
      - script
      type: string
      description: 'File category covered by this Advanced Anti Malware profile. enum: `archive`, `document`, `pdf`, `executable`, `rich_application`, `library`, `os_package`, `mobile`, `java`, `configuration`, `script`.'
    account_juniper_info1:
      title: account_juniper_info1
      type: object
      properties:
        accounts:
          type: array
          items:
            $ref: '#/components/schemas/juniper_account'
          description: List of linked Juniper account records
      description: Linked Juniper account information for this organization
    account_skyatp_cloud_name1:
      title: account_skyatp_cloud_name1
      enum:
      - www.amerskyatp.com
      - www.apacskyatp.com
      - www.euroskyatp.com
      - www.canadaskyatp.com
      type: string
      description: 'Sky ATP cloud endpoint used for the integration. enum: `www.amerskyatp.com`, `www.apacskyatp.com`, `www.euroskyatp.com`, `www.canadaskyatp.com`.'
      examples:
      - www.amerskyatp.com
    account_skyatp_cloud_name2:
      title: account_skyatp_cloud_name2
      enum:
      - www.amerskyatp.com
      - www.apacskyatp.com
      - www.euroskyatp.com
      - www.canadaskyatp.com
      type: string
      description: 'Sky ATP cloud endpoint configured for the integration. enum: `www.amerskyatp.com`, `www.apacskyatp.com`, `www.euroskyatp.com`, `www.canadaskyatp.com`.'
      examples:
      - www.amerskyatp.com
    account_skyatp_data_secintel2:
      title: account_skyatp_data_secintel2
      type: object
      properties:
        third_party_threat_feeds:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Third-party threat feed names enabled for SecIntel
      description: Juniper SecIntel threat feed configuration provided by Sky ATP
    acl_tag_type2:
      title: acl_tag_type2
      enum:
      - any
      - aruba_user_role
      - dynamic_gbp
      - gbp_resource
      - mac
      - network
      - port_usage
      - radius_group
      - resource
      - static_gbp
      - subnet
      type: string
      description: 'Classifier type that determines which ACL tag fields are evaluated. enum: `any`, `aruba_user_role`, `dynamic_gbp`, `gbp_resource`, `mac`, `network`, `port_usage`, `radius_group`, `resource`, `static_gbp`, `subnet`.'
    admin_compliance_status2:
      title: admin_compliance_status2
      enum:
      - blocked
      - restricted
      type: string
      description: 'Trade compliance status for this administrator. enum: `blocked`, `restricted`.'
    admin_privilege_role2:
      title: admin_privilege_role2
      enum:
      - admin
      - helpdesk
      - installer
      - read
      - write
      type: string
      description: 'Access role granted by this privilege. enum: `admin`, `helpdesk`, `installer`, `read`, `write`.'
    admin_privilege_scope2:
      title: admin_privilege_scope2
      enum:
      - msp
      - org
      - orggroup
      - site
      - sitegroup
      type: string
      description: 'Object scope where this privilege applies. enum: `msp`, `org`, `orggroup`, `site`, `sitegroup`.'
    alarm_status2:
      title: alarm_status2
      enum:
      - open
      - resolved
      type: string
      description: 'Current lifecycle status of this alarm. enum: `open`, `resolved`.'
    allow_deny2:
      title: allow_deny2
      enum:
      - allow
      - deny
      type: string
      description: Allow or deny action for traffic matched by this service policy
    allow_deny4:
      title: allow_deny4
      enum:
      - allow
      - deny
      type: string
      description: Allow or deny decision applied to traffic matching the destination tag
    antenna_select1:
      title: antenna_select1
      enum:
      - external
      - internal
      type: string
      description: 'Internal or external antenna selection for AP models with selectable antennas. enum: ``, `external`, `internal`.'
      examples:
      - external
    antenna_select2:
      title: antenna_select2
      enum:
      - external
      - internal
      type: string
      description: 'Selectable antenna mode reported for the AP. enum: ``, `external`, `internal`.'
      examples:
      - external
    ap_aeroscout1:
      title: ap_aeroscout1
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether to enable aeroscout config
          default: false
        host:
          type:
          - string
          - 'null'
          description: Required if enabled, aeroscout server host
          examples:
          - aero.pvt.net
        locate_connected:
          type: boolean
          description: Whether to enable the feature to allow wireless clients data received and sent to AES server for location calculation
          default: false
        port:
          type:
          - integer
          - 'null'
          description: Optional if enabled, Aeroscout server port. Defaults to 1144
          contentEncoding: int32
          default: 1144
      description: Location integration settings for AeroScout on this access point
    ap_aeroscout2:
      title: ap_aeroscout2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether to enable aeroscout config
          default: false
        host:
          type:
          - string
          - 'null'
          description: Required if enabled, aeroscout server host
          examples:
          - aero.pvt.net
        locate_connected:
          type: boolean
          description: Whether to enable the feature to allow wireless clients data received and sent to AES server for location calculation
          default: false
        port:
          type:
          - integer
          - 'null'
          description: Optional if enabled, Aeroscout server port. Defaults to 1144
          contentEncoding: int32
          default: 1144
      description: Location integration defaults for AeroScout in this AP profile
    ap_airista1:
      title: ap_airista1
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether to enable Airista config
          default: false
        host:
          type:
          - string
          - 'null'
          description: Required if enabled, Airista server host
          examples:
          - airista.pvt.net
        port:
          type:
          - integer
          - 'null'
          description: Optional if enabled, Airista server port. Defaults to 1144
          contentEncoding: int32
          default: 1144
      description: Location integration settings for Airista on this access point
    ap_airista2:
      title: ap_airista2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether to enable Airista config
          default: false
        host:
          type:
          - string
          - 'null'
          description: Required if enabled, Airista server host
          examples:
          - airista.pvt.net
        port:
          type:
          - integer
          - 'null'
          description: Optional if enabled, Airista server port. Defaults to 1144
          contentEncoding: int32
          default: 1144
      description: Location integration defaults for Airista in this AP profile
    ap_centrak1:
      title: ap_centrak1
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether to enable Centrak config
          default: false
      description: Location integration settings for Centrak on this access point
    ap_client_bridge_auth_type2:
      title: ap_client_bridge_auth_type2
      enum:
      - open
      - psk
      type: string
      description: 'Authentication mode for the client bridge connection. enum: `open`, `psk`.'
      examples:
      - psk
    ap_client_bridge_auth2:
      title: ap_client_bridge_auth2
      type: object
      properties:
        psk:
          maxLength: 63
          minLength: 8
          type: string
          description: Pre-shared key used when `type`==`psk` for client bridge authentication
          examples:
          - foryoureyesonly
        type:
          allOf:
          - $ref: '#/components/schemas/ap_client_bridge_auth_type2'
          - minLength: 1
            description: 'Authentication mode for the client bridge connection. enum: `open`, `psk`.'
            examples:
            - psk
      description: Credentials and security mode used when the AP connects as a wireless client bridge
    ap_client_bridge1:
      title: ap_client_bridge1
      type: object
      properties:
        auth:
          allOf:
          - $ref: '#/components/schemas/ap_client_bridge_auth2'
          - description: Credentials and security mode used when the AP connects as a wireless client bridge
        enabled:
          type: boolean
          description: >-
            When acted as client bridge:
              * only 5G radio can be used
              * will not serve as AP on any radios
          default: false
        ssid:
          minLength: 1
          type: string
          description: Uplink SSID used by the AP when client bridge mode is enabled
          examples:
          - Uplink-SSID
      description: Wireless client bridge settings for this access point
    ap_esl_config1:
      title: ap_esl_config1
      type: object
      properties:
        cacert:
          type: string
          description: Only if `type`==`imagotag` or `type`==`native`
          examples:
          - >
            --BEGIN CERTIFICATE--

            MIIDXTCCAkWgAwIBAgIJAL5b1z4f3k2TMA0GCSqGSIb3DQEBCwUAMIGVMQsw
        channel:
          type: integer
          description: Only if `type`==`imagotag` or `type`==`native`
          contentEncoding: int32
          examples:
          - 3
        enabled:
          type: boolean
          description: usb_config is ignored if esl_config enabled
          default: false
        host:
          type: string
          description: Only if `type`==`imagotag` or `type`==`native`
          examples:
          - 1.1.1.1
        port:
          type: integer
          description: Only if `type`==`imagotag` or `type`==`native`
          contentEncoding: int32
          examples:
          - 0
        type:
          allOf:
          - $ref: '#/components/schemas/ap_esl_type2'
          - description: 'ESL integration type to enable on the AP. enum: `hanshow`, `imagotag`, `native`, `solum`.'
            examples:
            - imagotag
        verify_cert:
          type: boolean
          description: Only if `type`==`imagotag` or `type`==`native`
          examples:
          - true
        vlan_id:
          type: integer
          description: Only if `type`==`solum` or `type`==`hanshow`
          contentEncoding: int32
          default: 1
      description: Electronic shelf label integration settings for this access point
    ap_esl_config2:
      title: ap_esl_config2
      type: object
      properties:
        cacert:
          type: string
          description: Only if `type`==`imagotag` or `type`==`native`
          examples:
          - >
            --BEGIN CERTIFICATE--

            MIIDXTCCAkWgAwIBAgIJAL5b1z4f3k2TMA0GCSqGSIb3DQEBCwUAMIGVMQsw
        channel:
          type: integer
          description: Only if `type`==`imagotag` or `type`==`native`
          contentEncoding: int32
          examples:
          - 3
        enabled:
          type: boolean
          description: usb_config is ignored if esl_config enabled
          default: false
        host:
          type: string
          description: Only if `type`==`imagotag` or `type`==`native`
          examples:
          - 1.1.1.1
        port:
          type: integer
          description: Only if `type`==`imagotag` or `type`==`native`
          contentEncoding: int32
          examples:
          - 0
        type:
          allOf:
          - $ref: '#/components/schemas/ap_esl_type2'
          - description: 'ESL integration type to enable on the AP. enum: `hanshow`, `imagotag`, `native`, `solum`.'
            examples:
            - imagotag
        verify_cert:
          type: boolean
          description: Only if `type`==`imagotag` or `type`==`native`
          examples:
          - true
        vlan_id:
          type: integer
          description: Only if `type`==`solum` or `type`==`hanshow`
          contentEncoding: int32
          default: 1
      description: Electronic shelf label integration defaults in this AP profile
    ap_esl_type2:
      title: ap_esl_type2
      enum:
      - hanshow
      - imagotag
      - native
      - solum
      type: string
      description: 'ESL integration type to enable on the AP. enum: `hanshow`, `imagotag`, `native`, `solum`.'
      examples:
      - imagotag
    ap_iot_input1:
      title: ap_iot_input1
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether to enable a pin
          default: false
        name:
          type: string
          description: Optional; descriptive pin name
          examples:
          - motion
        pullup:
          allOf:
          - $ref: '#/components/schemas/ap_iot_pullup1'
          - description: 'Selects the pull-up resistor mode applied to the input pin. enum: `external`, `internal`, `none`.'
      description: Digital input pin DI2 settings
    ap_iot_input3:
      title: ap_iot_input3
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether to enable a pin
          default: false
        name:
          type: string
          description: Optional; descriptive pin name
          examples:
          - motion
        pullup:
          allOf:
          - $ref: '#/components/schemas/ap_iot_pullup1'
          - description: 'Selects the pull-up resistor mode applied to the input pin. enum: `external`, `internal`, `none`.'
      description: Digital input pin DI1 settings
    ap_iot_output1:
      title: ap_iot_output1
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether to enable a pin
          default: false
        name:
          type: string
          description: Optional; descriptive pin name
          examples:
          - motion
        output:
          type: boolean
          description: Whether the pin is configured as an output. DO and A1-A4 can be repurposed by changing
          examples:
          - true
        pullup:
          allOf:
          - $ref: '#/components/schemas/ap_iot_pullup3'
          - description: 'Selects the pull-up resistor mode applied to the output pin. enum: `external`, `internal`, `none`.'
        value:
          type: integer
          description: Output pin signal level, default 0
          contentEncoding: int32
          examples:
          - 0
      description: Analog-capable IoT pin A2 output settings
    ap_iot_output2:
      title: ap_iot_output2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether to enable a pin
          default: false
        name:
          type: string
          description: Optional; descriptive pin name
          examples:
          - motion
        output:
          type: boolean
          description: Whether the pin is configured as an output. DO and A1-A4 can be repurposed by changing
          examples:
          - true
        pullup:
          allOf:
          - $ref: '#/components/schemas/ap_iot_pullup3'
          - description: 'Selects the pull-up resistor mode applied to the output pin. enum: `external`, `internal`, `none`.'
        value:
          type: integer
          description: Output pin signal level, default 0
          contentEncoding: int32
          examples:
          - 0
      description: Analog-capable IoT pin A3 output settings
    ap_iot_output3:
      title: ap_iot_output3
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether to enable a pin
          default: false
        name:
          type: string
          description: Optional; descriptive pin name
          examples:
          - motion
        output:
          type: boolean
          description: Whether the pin is configured as an output. DO and A1-A4 can be repurposed by changing
          examples:
          - true
        pullup:
          allOf:
          - $ref: '#/components/schemas/ap_iot_pullup3'
          - description: 'Selects the pull-up resistor mode applied to the output pin. enum: `external`, `internal`, `none`.'
        value:
          type: integer
          description: Output pin signal level, default 0
          contentEncoding: int32
          examples:
          - 0
      description: Analog-capable IoT pin A4 output settings
    ap_iot_output4:
      title: ap_iot_output4
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether to enable a pin
          default: false
        name:
          type: string
          description: Optional; descriptive pin name
          examples:
          - motion
        output:
          type: boolean
          description: Whether the pin is configured as an output. DO and A1-A4 can be repurposed by changing
          examples:
          - true
        pullup:
          allOf:
          - $ref: '#/components/schemas/ap_iot_pullup3'
          - description: 'Selects the pull-up resistor mode applied to the output pin. enum: `external`, `internal`, `none`.'
        value:
          type: integer
          description: Output pin signal level, default 0
          contentEncoding: int32
          examples:
          - 0
      description: Digital output pin DO settings
    ap_iot_output6:
      title: ap_iot_output6
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether to enable a pin
          default: false
        name:
          type: string
          description: Optional; descriptive pin name
          examples:
          - motion
        output:
          type: boolean
          description: Whether the pin is configured as an output. DO and A1-A4 can be repurposed by changing
          examples:
          - true
        pullup:
          allOf:
          - $ref: '#/components/schemas/ap_iot_pullup3'
          - description: 'Selects the pull-up resistor mode applied to the output pin. enum: `external`, `internal`, `none`.'
        value:
          type: integer
          description: Output pin signal level, default 0
          contentEncoding: int32
          examples:
          - 0
      description: Analog-capable IoT pin A1 output settings
    ap_iot_pullup1:
      title: ap_iot_pullup1
      enum:
      - external
      - internal
      - none
      type: string
      description: 'Selects the pull-up resistor mode applied to the input pin. enum: `external`, `internal`, `none`.'
    ap_iot_pullup3:
      title: ap_iot_pullup3
      enum:
      - external
      - internal
      - none
      type: string
      description: 'Selects the pull-up resistor mode applied to the output pin. enum: `external`, `internal`, `none`.'
    ap_iot2:
      title: ap_iot2
      type: object
      properties:
        A1:
          allOf:
          - $ref: '#/components/schemas/ap_iot_output6'
          - description: Analog-capable IoT pin A1 output settings
        A2:
          allOf:
          - $ref: '#/components/schemas/ap_iot_output1'
          - description: Analog-capable IoT pin A2 output settings
        A3:
          allOf:
          - $ref: '#/components/schemas/ap_iot_output2'
          - description: Analog-capable IoT pin A3 output settings
        A4:
          allOf:
          - $ref: '#/components/schemas/ap_iot_output3'
          - description: Analog-capable IoT pin A4 output settings
        DI1:
          allOf:
          - $ref: '#/components/schemas/ap_iot_input3'
          - description: Digital input pin DI1 settings
        DI2:
          allOf:
          - $ref: '#/components/schemas/ap_iot_input1'
          - description: Digital input pin DI2 settings
        DO:
          allOf:
          - $ref: '#/components/schemas/ap_iot_output4'
          - description: Digital output pin DO settings
      description: Digital and analog IoT pin defaults in this AP profile
    ap_iot3:
      title: ap_iot3
      type: object
      properties:
        A1:
          allOf:
          - $ref: '#/components/schemas/ap_iot_output6'
          - description: Analog-capable IoT pin A1 output settings
        A2:
          allOf:
          - $ref: '#/components/schemas/ap_iot_output1'
          - description: Analog-capable IoT pin A2 output settings
        A3:
          allOf:
          - $ref: '#/components/schemas/ap_iot_output2'
          - description: Analog-capable IoT pin A3 output settings
        A4:
          allOf:
          - $ref: '#/components/schemas/ap_iot_output3'
          - description: Analog-capable IoT pin A4 output settings
        DI1:
          allOf:
          - $ref: '#/components/schemas/ap_iot_input3'
          - description: Digital input pin DI1 settings
        DI2:
          allOf:
          - $ref: '#/components/schemas/ap_iot_input1'
          - description: Digital input pin DI2 settings
        DO:
          allOf:
          - $ref: '#/components/schemas/ap_iot_output4'
          - description: Digital output pin DO settings
      description: Digital and analog IoT pin settings for this access point
    ap_ip_config2:
      title: ap_ip_config2
      type: object
      properties:
        dns:
          type: array
          items:
            type: string
          description: If `type`==`static`. DNS server IP addresses for AP management traffic
          examples:
          - - 8.8.8.8
            - 4.4.4.4
        dns_suffix:
          type: array
          items:
            type: string
          description: If `type`==`static`. DNS search suffixes applied to AP management lookups
          examples:
          - - .mist.local
            - .mist.com
        gateway:
          type: string
          description: Required if `type`==`static`. IPv4 default gateway for AP management traffic
          contentEncoding: ipv4
          examples:
          - 10.2.1.254
        gateway6:
          type: string
          description: Required if `type6`==`static`. IPv6 default gateway for AP management traffic when static IPv6 addressing is used
          contentEncoding: ipv6
          examples:
          - 2607:f8b0:4005:808::1
        ip:
          type: string
          description: Required if `type`==`static`. Static IPv4 address for the AP management interface
          contentEncoding: ipv4
          examples:
          - 10.2.1.1
        ip6:
          type: string
          description: Required if `type6`==`static`. Static IPv6 address for the AP management interface
          contentEncoding: ipv6
          examples:
          - 2607:f8b0:4005:808::2004
        mtu:
          type: integer
          description: Maximum transmission unit for AP management traffic
          contentEncoding: int32
          examples:
          - 0
        netmask:
          type: string
          description: Required if `type`==`static`. IPv4 netmask for the AP management interface
          examples:
          - 255.255.255.0
        netmask6:
          type: string
          description: Required if `type6`==`static`. IPv6 prefix length for the AP management interface
          examples:
          - /32
        type:
          allOf:
          - $ref: '#/components/schemas/ip_type13'
          - description: 'IPv4 address assignment mode for AP management traffic. enum: `dhcp`, `static`.'
            examples:
            - static
        type6:
          allOf:
          - $ref: '#/components/schemas/ip_type64'
          - description: 'IPv6 address assignment mode for AP management traffic. enum: `autoconf`, `dhcp`, `disabled`, `static`.'
            examples:
            - static
        vlan_id:
          type: integer
          description: Management VLAN ID, default is 1 (untagged)
          contentEncoding: int32
          default: 1
          examples:
          - 1
      description: Management IP addressing defaults in this AP profile
    ap_ip_config3:
      title: ap_ip_config3
      type: object
      properties:
        dns:
          type: array
          items:
            type: string
          description: If `type`==`static`. DNS server IP addresses for AP management traffic
          examples:
          - - 8.8.8.8
            - 4.4.4.4
        dns_suffix:
          type: array
          items:
            type: string
          description: If `type`==`static`. DNS search suffixes applied to AP management lookups
          examples:
          - - .mist.local
            - .mist.com
        gateway:
          type: string
          description: Required if `type`==`static`. IPv4 default gateway for AP management traffic
          contentEncoding: ipv4
          examples:
          - 10.2.1.254
        gateway6:
          type: string
          description: Required if `type6`==`static`. IPv6 default gateway for AP management traffic when static IPv6 addressing is used
          contentEncoding: ipv6
          examples:
          - 2607:f8b0:4005:808::1
        ip:
          type: string
          description: Required if `type`==`static`. Static IPv4 address for the AP management interface
          contentEncoding: ipv4
          examples:
          - 10.2.1.1
        ip6:
          type: string
          description: Required if `type6`==`static`. Static IPv6 address for the AP management interface
          contentEncoding: ipv6
          examples:
          - 2607:f8b0:4005:808::2004
        mtu:
          type: integer
          description: Maximum transmission unit for AP management traffic
          contentEncoding: int32
          examples:
          - 0
        netmask:
          type: string
          description: Required if `type`==`static`. IPv4 netmask for the AP management interface
          examples:
          - 255.255.255.0
        netmask6:
          type: string
          description: Required if `type6`==`static`. IPv6 prefix length for the AP management interface
          examples:
          - /32
        type:
          allOf:
          - $ref: '#/components/schemas/ip_type13'
          - description: 'IPv4 address assignment mode for AP management traffic. enum: `dhcp`, `static`.'
            examples:
            - static
        type6:
          allOf:
          - $ref: '#/components/schemas/ip_type64'
          - description: 'IPv6 address assignment mode for AP management traffic. enum: `autoconf`, `dhcp`, `disabled`, `static`.'
            examples:
            - static
        vlan_id:
          type: integer
          description: Management VLAN ID, default is 1 (untagged)
          contentEncoding: int32
          default: 1
          examples:
          - 1
      description: IP configuration applied to the AP management interface
    ap_ip_config4:
      title: ap_ip_config4
      type: object
      properties:
        dns:
          type: array
          items:
            type: string
          description: If `type`==`static`. DNS server IP addresses for AP management traffic
          examples:
          - - 8.8.8.8
            - 4.4.4.4
        dns_suffix:
          type: array
          items:
            type: string
          description: If `type`==`static`. DNS search suffixes applied to AP management lookups
          examples:
          - - .mist.local
            - .mist.com
        gateway:
          type: string
          description: Required if `type`==`static`. IPv4 default gateway for AP management traffic
          contentEncoding: ipv4
          examples:
          - 10.2.1.254
        gateway6:
          type: string
          description: Required if `type6`==`static`. IPv6 default gateway for AP management traffic when static IPv6 addressing is used
          contentEncoding: ipv6
          examples:
          - 2607:f8b0:4005:808::1
        ip:
          type: string
          description: Required if `type`==`static`. Static IPv4 address for the AP management interface
          contentEncoding: ipv4
          examples:
          - 10.2.1.1
        ip6:
          type: string
          description: Required if `type6`==`static`. Static IPv6 address for the AP management interface
          contentEncoding: ipv6
          examples:
          - 2607:f8b0:4005:808::2004
        mtu:
          type: integer
          description: Maximum transmission unit for AP management traffic
          contentEncoding: int32
          examples:
          - 0
        netmask:
          type: string
          description: Required if `type`==`static`. IPv4 netmask for the AP management interface
          examples:
          - 255.255.255.0
        netmask6:
          type: string
          description: Required if `type6`==`static`. IPv6 prefix length for the AP management interface
          examples:
          - /32
        type:
          allOf:
          - $ref: '#/components/schemas/ip_type13'
          - description: 'IPv4 address assignment mode for AP management traffic. enum: `dhcp`, `static`.'
            examples:
            - static
        type6:
          allOf:
          - $ref: '#/components/schemas/ip_type64'
          - description: 'IPv6 address assignment mode for AP management traffic. enum: `autoconf`, `dhcp`, `disabled`, `static`.'
            examples:
            - static
        vlan_id:
          type: integer
          description: Management VLAN ID, default is 1 (untagged)
          contentEncoding: int32
          default: 1
          examples:
          - 1
      description: Management IP addressing settings for this access point
    ap_led2:
      title: ap_led2
      type: object
      properties:
        brightness:
          maximum: 255
          minimum: 0
          type: integer
          description: Indicator LED brightness level from 0 to 255
          contentEncoding: int32
          default: 255
          examples:
          - 255
        enabled:
          type: boolean
          description: Whether the AP indicator LED is enabled
          default: true
      description: Indicator light behavior defaults in this AP profile
    ap_led3:
      title: ap_led3
      type: object
      properties:
        brightness:
          maximum: 255
          minimum: 0
          type: integer
          description: Indicator LED brightness level from 0 to 255
          contentEncoding: int32
          default: 255
          examples:
          - 255
        enabled:
          type: boolean
          description: Whether the AP indicator LED is enabled
          default: true
      description: AP LED behavior configured for the site
    ap_led4:
      title: ap_led4
      type: object
      properties:
        brightness:
          maximum: 255
          minimum: 0
          type: integer
          description: Indicator LED brightness level from 0 to 255
          contentEncoding: int32
          default: 255
          examples:
          - 255
        enabled:
          type: boolean
          description: Whether the AP indicator LED is enabled
          default: true
      description: Light indicator state for the AP
    ap_led5:
      title: ap_led5
      type: object
      properties:
        brightness:
          maximum: 255
          minimum: 0
          type: integer
          description: Indicator LED brightness level from 0 to 255
          contentEncoding: int32
          default: 255
          examples:
          - 255
        enabled:
          type: boolean
          description: Whether the AP indicator LED is enabled
          default: true
      description: Indicator light behavior settings for this access point
    ap_mesh_role2:
      title: ap_mesh_role2
      enum:
      - base
      - remote
      type: string
      description: Mesh role for this AP, either base or remote
      examples:
      - base
    ap_mesh2:
      title: ap_mesh2
      type: object
      properties:
        bands:
          type: array
          items:
            $ref: '#/components/schemas/dot11_band'
          description: Radio bands allowed for AP mesh links
        enabled:
          type: boolean
          description: Whether mesh is enabled on this AP
          default: false
        group:
          maximum: 9
          minimum: 1
          type:
          - integer
          - 'null'
          description: Mesh group, base AP(s) will only allow remote AP(s) in the same mesh group to join, 1-9, optional
          contentEncoding: int32
          examples:
          - 1
        role:
          allOf:
          - $ref: '#/components/schemas/ap_mesh_role2'
          - description: Mesh role for this AP, either base or remote
            examples:
            - base
        use_wpa3_on_5:
          type: boolean
          description: Whether to use WPA3 on the 5 GHz band for mesh links
          default: false
      description: Wireless mesh role and band defaults in this AP profile
    ap_mesh3:
      title: ap_mesh3
      type: object
      properties:
        bands:
          type: array
          items:
            $ref: '#/components/schemas/dot11_band'
          description: Radio bands allowed for AP mesh links
        enabled:
          type: boolean
          description: Whether mesh is enabled on this AP
          default: false
        group:
          maximum: 9
          minimum: 1
          type:
          - integer
          - 'null'
          description: Mesh group, base AP(s) will only allow remote AP(s) in the same mesh group to join, 1-9, optional
          contentEncoding: int32
          examples:
          - 1
        role:
          allOf:
          - $ref: '#/components/schemas/ap_mesh_role2'
          - description: Mesh role for this AP, either base or remote
            examples:
            - base
        use_wpa3_on_5:
          type: boolean
          description: Whether to use WPA3 on the 5 GHz band for mesh links
          default: false
      description: Wireless mesh role and band settings for this access point
    ap_mqtt_broker_proto2:
      title: ap_mqtt_broker_proto2
      enum:
      - ssl
      - tcp
      type: string
      description: 'MQTT broker transport protocol. enum: `ssl`, `tcp`.'
    ap_mqtt_format2:
      title: ap_mqtt_format2
      enum:
      - json
      - raw
      type: string
      description: 'Payload format for published messages. enum: `json`, `raw`.'
    ap_mqtt2:
      title: ap_mqtt2
      type: object
      properties:
        broker_host:
          type: string
          description: MQTT broker hostname or IP address; required when `enabled` is `true`
        broker_port:
          type: integer
          description: MQTT broker port; defaults to `1883` for `tcp` and `8883` for `ssl`
          contentEncoding: int32
        broker_proto:
          allOf:
          - $ref: '#/components/schemas/ap_mqtt_broker_proto2'
          - description: 'MQTT broker transport protocol. enum: `ssl`, `tcp`.'
        default_topic:
          type: string
          description: Optional catch-all MQTT topic; BLE advertisements matching no AssetFilter are published here
          examples:
          - mist/asset/raw
        enabled:
          type: boolean
          description: Whether to enable MQTT publishing
          default: false
        format:
          allOf:
          - $ref: '#/components/schemas/ap_mqtt_format2'
          - description: 'Payload format for published messages. enum: `json`, `raw`.'
        password:
          type: string
          description: Optional MQTT password; masked in GET responses
          contentEncoding: password
        username:
          type: string
          description: Optional MQTT username
      description: MQTT broker publishing settings for this AP profile
    ap_mqtt3:
      title: ap_mqtt3
      type: object
      properties:
        broker_host:
          type: string
          description: MQTT broker hostname or IP address; required when `enabled` is `true`
        broker_port:
          type: integer
          description: MQTT broker port; defaults to `1883` for `tcp` and `8883` for `ssl`
          contentEncoding: int32
        broker_proto:
          allOf:
          - $ref: '#/components/schemas/ap_mqtt_broker_proto2'
          - description: 'MQTT broker transport protocol. enum: `ssl`, `tcp`.'
        default_topic:
          type: string
          description: Optional catch-all MQTT topic; BLE advertisements matching no AssetFilter are published here
          examples:
          - mist/asset/raw
        enabled:
          type: boolean
          description: Whether to enable MQTT publishing
          default: false
        format:
          allOf:
          - $ref: '#/components/schemas/ap_mqtt_format2'
          - description: 'Payload format for published messages. enum: `json`, `raw`.'
        password:
          type: string
          description: Optional MQTT password; masked in GET responses
          contentEncoding: password
        username:
          type: string
          description: Optional MQTT username
      description: MQTT broker publishing settings for this access point
    ap_port_config_dynamic_vlan_type2:
      title: ap_port_config_dynamic_vlan_type2
      enum:
      - airespace-interface-name
      - standard
      type: string
      description: 'Mapping mode for interpreting dynamic VLAN attributes returned by RADIUS. enum: `airespace-interface-name`, `standard`.'
    ap_port_config_dynamic_vlan2:
      title: ap_port_config_dynamic_vlan2
      type: object
      properties:
        default_vlan_id:
          maximum: 4094
          minimum: 1
          type: integer
          description: Fallback VLAN ID used when RADIUS does not return a dynamic VLAN match
          contentEncoding: int32
          examples:
          - 999
        enabled:
          type: boolean
          description: Whether dynamic VLAN assignment is enabled for this AP port
        type:
          allOf:
          - $ref: '#/components/schemas/ap_port_config_dynamic_vlan_type2'
          - description: 'Mapping mode for interpreting dynamic VLAN attributes returned by RADIUS. enum: `airespace-interface-name`, `standard`.'
        vlans:
          type: object
          additionalProperties:
            type: string
            nullable: true
          description: Mapping entries for RADIUS-assigned VLAN values on this AP port. For `type`==`airespace-interface-name`, the property key is the Airespace interface name returned by RADIUS (e.g. "guest"), and the value is the corresponding VLAN ID (e.g. 100). For `type`==`standard`, the property key is the VLAN ID number returned by RADIUS, and the value is ignored.
          examples:
          - 1-10: null
            user: 10
      description: RADIUS-assigned VLAN settings for AP port authentication
    ap_port_config_forwarding2:
      title: ap_port_config_forwarding2
      enum:
      - all
      - limited
      - mxtunnel
      - site_mxedge
      - wxtunnel
      type: string
      description: 'Traffic forwarding mode for this AP Ethernet port. enum: `all`, `limited`, `mxtunnel`, `site_mxedge`, `wxtunnel`.'
      examples:
      - all
    ap_port_config_mac_auth_protocol2:
      title: ap_port_config_mac_auth_protocol2
      enum:
      - eap-md5
      - eap-peap
      - pap
      type: string
      description: 'Protocol used for MAC authentication when `enable_mac_auth` is `true`. enum: `eap-md5`, `eap-peap`, `pap`.'
    ap_port_config_port_auth2:
      title: ap_port_config_port_auth2
      enum:
      - dot1x
      - none
      type: string
      description: 'Authentication mode for this AP Ethernet port. enum: `dot1x`, `none`.'
      examples:
      - none
    ap_pwr_config2:
      title: ap_pwr_config2
      type: object
      properties:
        base:
          type: integer
          description: Additional power to request during negotiating with PSE over PoE, in mW
          contentEncoding: int32
          default: 0
          examples:
          - 2000
        prefer_usb_over_wifi:
          type: boolean
          description: Whether to enable power out to peripheral, meanwhile will reduce power to Wi-Fi (only for AP45 at power mode)
          default: false
      description: Power negotiation and peripheral power defaults in this AP profile
    ap_pwr_config3:
      title: ap_pwr_config3
      type: object
      properties:
        base:
          type: integer
          description: Additional power to request during negotiating with PSE over PoE, in mW
          contentEncoding: int32
          default: 0
          examples:
          - 2000
        prefer_usb_over_wifi:
          type: boolean
          description: Whether to enable power out to peripheral, meanwhile will reduce power to Wi-Fi (only for AP45 at power mode)
          default: false
      description: Power negotiation and peripheral power settings for this access point
    ap_radio_antenna_mode2:
      title: ap_radio_antenna_mode2
      enum:
      - 1x1
      - 2x2
      - 3x3
      - 4x4
      - default
      type: string
      description: 'Selected radio chain mode for AP models that support antenna mode control. enum: `1x1`, `2x2`, `3x3`, `4x4`, `default`.'
    ap_radio_band51:
      title: ap_radio_band51
      type: object
      properties:
        allow_rrm_disable:
          type: boolean
          description: Whether RRM may disable the 5 GHz radio when optimizing RF settings
          default: false
        ant_gain:
          maximum: 10
          minimum: 0
          type:
          - integer
          - 'null'
          description: External antenna gain for the 5 GHz radio
          contentEncoding: int32
          default: 0
        antenna_beam_pattern:
          allOf:
          - $ref: '#/components/schemas/radio_band_antenna_beam_pattern3'
          - description: 'Beam pattern used by the 5 GHz radio antenna. enum: `narrow`, `medium`, `wide`.'
        antenna_mode:
          allOf:
          - $ref: '#/components/schemas/radio_band_antenna_mode1'
          - description: 'Radio chain mode for the 5 GHz radio. enum: `1x1`, `2x2`, `3x3`, `4x4`, `default`.'
            examples:
            - default
        bandwidth:
          allOf:
          - $ref: '#/components/schemas/dot11_bandwidth52'
          - description: 'Channel width configured for the 5 GHz radio. enum: `0`, `20`, `40`, `80`.'
            examples:
            - 40
        channel:
          type:
          - integer
          - 'null'
          description: For Device. (primary) channel for the band, 0 means using the Site Setting
          contentEncoding: int32
          examples:
          - 100
        channels:
          type:
          - array
          - 'null'
          items:
            type: integer
            contentEncoding: int32
          description: Allowed channel list for the 5 GHz radio; null or an empty array uses automatic selection
          default: []
        disabled:
          type: boolean
          description: Whether to disable the radio
          default: false
        power:
          maximum: 25
          minimum: 0
          type:
          - integer
          - 'null'
          description: Radio Tx power, in dBm. Can be an integer 0-25 for static power configuration, or `null` or unset for auto power mode
          contentEncoding: int32
          examples:
          - 6
        power_max:
          maximum: 17
          minimum: 5
          type:
          - integer
          - 'null'
          description: When power=null/unset, max tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        power_min:
          maximum: 17
          minimum: 5
          type:
          - integer
          - 'null'
          description: When power=null/unset, min tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        preamble:
          allOf:
          - $ref: '#/components/schemas/radio_band_preamble1'
          - description: '802.11 preamble mode used by the 5 GHz radio. enum: `auto`, `long`, `short`.'
      description: 5 GHz settings used when the 2.4 GHz radio operates in 5 GHz mode
    ap_radio_band53:
      title: ap_radio_band53
      type: object
      properties:
        allow_rrm_disable:
          type: boolean
          description: Whether RRM may disable the 5 GHz radio when optimizing RF settings
          default: false
        ant_gain:
          maximum: 10
          minimum: 0
          type:
          - integer
          - 'null'
          description: External antenna gain for the 5 GHz radio
          contentEncoding: int32
          default: 0
        antenna_beam_pattern:
          allOf:
          - $ref: '#/components/schemas/radio_band_antenna_beam_pattern3'
          - description: 'Beam pattern used by the 5 GHz radio antenna. enum: `narrow`, `medium`, `wide`.'
        antenna_mode:
          allOf:
          - $ref: '#/components/schemas/radio_band_antenna_mode1'
          - description: 'Radio chain mode for the 5 GHz radio. enum: `1x1`, `2x2`, `3x3`, `4x4`, `default`.'
            examples:
            - default
        bandwidth:
          allOf:
          - $ref: '#/components/schemas/dot11_bandwidth52'
          - description: 'Channel width configured for the 5 GHz radio. enum: `0`, `20`, `40`, `80`.'
            examples:
            - 40
        channel:
          type:
          - integer
          - 'null'
          description: For Device. (primary) channel for the band, 0 means using the Site Setting
          contentEncoding: int32
          examples:
          - 100
        channels:
          type:
          - array
          - 'null'
          items:
            type: integer
            contentEncoding: int32
          description: Allowed channel list for the 5 GHz radio; null or an empty array uses automatic selection
          default: []
        disabled:
          type: boolean
          description: Whether to disable the radio
          default: false
        power:
          maximum: 25
          minimum: 0
          type:
          - integer
          - 'null'
          description: Radio Tx power, in dBm. Can be an integer 0-25 for static power configuration, or `null` or unset for auto power mode
          contentEncoding: int32
          examples:
          - 6
        power_max:
          maximum: 17
          minimum: 5
          type:
          - integer
          - 'null'
          description: When power=null/unset, max tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        power_min:
          maximum: 17
          minimum: 5
          type:
          - integer
          - 'null'
          description: When power=null/unset, min tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        preamble:
          allOf:
          - $ref: '#/components/schemas/radio_band_preamble1'
          - description: '802.11 preamble mode used by the 5 GHz radio. enum: `auto`, `long`, `short`.'
      description: 5 GHz radio settings for this access point
    ap_radio_band62:
      title: ap_radio_band62
      type: object
      properties:
        allow_rrm_disable:
          type: boolean
          description: Whether RRM may disable the 6 GHz radio when optimizing RF settings
          default: false
        ant_gain:
          maximum: 10
          minimum: 0
          type:
          - integer
          - 'null'
          description: External antenna gain for the 6 GHz radio
          contentEncoding: int32
          default: 0
        antenna_beam_pattern:
          allOf:
          - $ref: '#/components/schemas/radio_band_antenna_beam_pattern1'
          - description: 'Beam pattern used by the 6 GHz radio antenna. enum: `narrow`, `medium`, `wide`.'
        antenna_mode:
          allOf:
          - $ref: '#/components/schemas/radio_band_antenna_mode2'
          - description: 'Radio chain mode for the 6 GHz radio. enum: `1x1`, `2x2`, `3x3`, `4x4`, `default`.'
            examples:
            - default
        bandwidth:
          allOf:
          - $ref: '#/components/schemas/dot11_bandwidth62'
          - description: 'Channel width configured for the 6 GHz radio. enum: `0`, `20`, `40`, `80`, `160`.'
            examples:
            - 80
        channel:
          type:
          - integer
          - 'null'
          description: For Device. (primary) channel for the band, 0 means using the Site Setting
          contentEncoding: int32
          examples:
          - 0
        channels:
          type:
          - array
          - 'null'
          items:
            type: integer
            contentEncoding: int32
          description: Allowed channel list for the 6 GHz radio; null or an empty array uses automatic selection
          default: []
        disabled:
          type: boolean
          description: Whether to disable the radio
          default: false
        power:
          maximum: 25
          minimum: 0
          type:
          - integer
          - 'null'
          description: Radio Tx power, in dBm. Can be an integer 0-25 for static power configuration, or `null` or unset for auto power mode
          contentEncoding: int32
          examples:
          - 7
        power_max:
          maximum: 18
          minimum: 5
          type:
          - integer
          - 'null'
          description: When power=null/unset, max tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        power_min:
          maximum: 18
          minimum: 5
          type:
          - integer
          - 'null'
          description: When power=null/unset, min tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        preamble:
          allOf:
          - $ref: '#/components/schemas/radio_band_preamble2'
          - description: '802.11 preamble mode used by the 6 GHz radio. enum: `auto`, `long`, `short`.'
        standard_power:
          type: boolean
          description: For 6GHz Only, standard-power operation, AFC (Automatic Frequency Coordination) will be performed, and we'll fall back to Low Power Indoor if AFC failed
          default: false
      description: 6 GHz radio settings for this access point
    ap_radio_band242:
      title: ap_radio_band242
      type: object
      properties:
        allow_rrm_disable:
          type: boolean
          description: Whether RRM may disable the 2.4 GHz radio when optimizing RF settings
          default: false
        ant_gain:
          maximum: 10
          minimum: 0
          type:
          - integer
          - 'null'
          description: External antenna gain for the 2.4 GHz radio
          contentEncoding: int32
          default: 0
        antenna_mode:
          allOf:
          - $ref: '#/components/schemas/radio_band_antenna_mode4'
          - description: 'Radio chain mode for the 2.4 GHz radio. enum: `1x1`, `2x2`, `3x3`, `4x4`, `default`.'
            examples:
            - default
        bandwidth:
          allOf:
          - $ref: '#/components/schemas/dot11_bandwidth242'
          - description: 'Channel width configured for the 2.4 GHz radio. enum: `0`, `20`, `40`.'
            examples:
            - 20
        channel:
          maximum: 13
          minimum: 1
          type:
          - integer
          - 'null'
          description: For Device. (primary) channel for the band, 0 means using the Site Setting
          contentEncoding: int32
          examples:
          - 6
        channels:
          type:
          - array
          - 'null'
          items:
            type: integer
            contentEncoding: int32
          description: Allowed channel list for the 2.4 GHz radio; null or an empty array uses automatic selection
          default: []
        disabled:
          type: boolean
          description: Whether to disable the radio
          default: false
        power:
          maximum: 25
          minimum: 0
          type:
          - integer
          - 'null'
          description: Radio Tx power, in dBm. Can be an integer 0-25 for static power configuration, or `null` or unset for auto power mode
          contentEncoding: int32
          examples:
          - 3
        power_max:
          maximum: 18
          minimum: 3
          type:
          - integer
          - 'null'
          description: When power=null/unset, max tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        power_min:
          maximum: 18
          minimum: 3
          type:
          - integer
          - 'null'
          description: When power=null/unset, min tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        preamble:
          allOf:
          - $ref: '#/components/schemas/radio_band_preamble4'
          - description: '802.11 preamble mode used by the 2.4 GHz radio. enum: `auto`, `long`, `short`.'
      description: 2.4 GHz radio settings for this access point
    ap_radio_stat1:
      title: ap_radio_stat1
      type: object
      properties:
        bandwidth:
          allOf:
          - $ref: '#/components/schemas/dot11_bandwidth8'
          - description: 'Current channel width reported for this radio. enum: `0`, `20`, `40`, `80`, `160`.'
            examples:
            - 20
        channel:
          type:
          - integer
          - 'null'
          description: Current channel the radio is running on
          contentEncoding: int32
          readOnly: true
        dynamic_chaining_enabled:
          type:
          - boolean
          - 'null'
          description: Use dynamic chaining for downlink
          readOnly: true
        mac:
          type:
          - string
          - 'null'
          description: Radio base MAC address; a base radio MAC can represent up to 16 BSSIDs (e.g. 5c5b350001a0-5c5b350001af)
          readOnly: true
        noise_floor:
          type:
          - integer
          - 'null'
          description: Measured noise floor for this radio, in dBm
          contentEncoding: int32
          readOnly: true
          examples:
          - -90
        num_clients:
          type:
          - integer
          - 'null'
          description: Number of clients currently connected on this radio
          contentEncoding: int32
          readOnly: true
        num_wlans:
          type: integer
          description: How many WLANs are applied to the radio
          contentEncoding: int32
        power:
          type:
          - integer
          - 'null'
          description: Transmit power (in dBm)
          contentEncoding: int32
          readOnly: true
        rx_bytes:
          type:
          - integer
          - 'null'
          description: Received byte count reported for this radio
          contentEncoding: int64
          readOnly: true
          examples:
          - 8515104416
        rx_pkts:
          type:
          - integer
          - 'null'
          description: Received packet count reported for this radio
          contentEncoding: int64
          readOnly: true
          examples:
          - 57770567
        tx_bytes:
          type:
          - integer
          - 'null'
          description: Transmitted byte count reported for this radio
          contentEncoding: int64
          readOnly: true
          examples:
          - 211217389682
        tx_pkts:
          type:
          - integer
          - 'null'
          description: Transmitted packet count reported for this radio
          contentEncoding: int64
          readOnly: true
          examples:
          - 812204062
        usage:
          type:
          - string
          - 'null'
          description: Operating band reported for this radio, such as 24, 5, or 6
          readOnly: true
          examples:
          - '24'
        util_all:
          type:
          - integer
          - 'null'
          description: All utilization in percentage
          contentEncoding: int32
          readOnly: true
        util_non_wifi:
          type:
          - integer
          - 'null'
          description: Reception of "No Packets" utilization in percentage, received frames with invalid PLCPs and CRS glitches as noise
          contentEncoding: int32
          readOnly: true
        util_rx_in_bss:
          type:
          - integer
          - 'null'
          description: Reception of "In BSS" utilization in percentage, only frames that are received from AP/STAs within the BSS
          contentEncoding: int32
          readOnly: true
        util_rx_other_bss:
          type:
          - integer
          - 'null'
          description: Reception of "Other BSS" utilization in percentage, all frames received from AP/STAs that are outside the BSS
          contentEncoding: int32
          readOnly: true
        util_tx:
          type:
          - integer
          - 'null'
          description: Transmission utilization in percentage
          contentEncoding: int32
          readOnly: true
        util_undecodable_wifi:
          type:
          - integer
          - 'null'
          description: Reception of "UnDecodable Wifi" utilization in percentage, only Preamble, PLCP header is decoded, Rest is undecodable in this radio
          contentEncoding: int32
          readOnly: true
        util_unknown_wifi:
          type:
          - integer
          - 'null'
          description: Reception of "No Category" utilization in percentage, all 802.11 frames that are corrupted at the receiver
          contentEncoding: int32
          readOnly: true
      description: 2.4 GHz radio statistics reported by the AP
    ap_radio_stat2:
      title: ap_radio_stat2
      type: object
      properties:
        bandwidth:
          allOf:
          - $ref: '#/components/schemas/dot11_bandwidth8'
          - description: 'Current channel width reported for this radio. enum: `0`, `20`, `40`, `80`, `160`.'
            examples:
            - 20
        channel:
          type:
          - integer
          - 'null'
          description: Current channel the radio is running on
          contentEncoding: int32
          readOnly: true
        dynamic_chaining_enabled:
          type:
          - boolean
          - 'null'
          description: Use dynamic chaining for downlink
          readOnly: true
        mac:
          type:
          - string
          - 'null'
          description: Radio base MAC address; a base radio MAC can represent up to 16 BSSIDs (e.g. 5c5b350001a0-5c5b350001af)
          readOnly: true
        noise_floor:
          type:
          - integer
          - 'null'
          description: Measured noise floor for this radio, in dBm
          contentEncoding: int32
          readOnly: true
          examples:
          - -90
        num_clients:
          type:
          - integer
          - 'null'
          description: Number of clients currently connected on this radio
          contentEncoding: int32
          readOnly: true
        num_wlans:
          type: integer
          description: How many WLANs are applied to the radio
          contentEncoding: int32
        power:
          type:
          - integer
          - 'null'
          description: Transmit power (in dBm)
          contentEncoding: int32
          readOnly: true
        rx_bytes:
          type:
          - integer
          - 'null'
          description: Received byte count reported for this radio
          contentEncoding: int64
          readOnly: true
          examples:
          - 8515104416
        rx_pkts:
          type:
          - integer
          - 'null'
          description: Received packet count reported for this radio
          contentEncoding: int64
          readOnly: true
          examples:
          - 57770567
        tx_bytes:
          type:
          - integer
          - 'null'
          description: Transmitted byte count reported for this radio
          contentEncoding: int64
          readOnly: true
          examples:
          - 211217389682
        tx_pkts:
          type:
          - integer
          - 'null'
          description: Transmitted packet count reported for this radio
          contentEncoding: int64
          readOnly: true
          examples:
          - 812204062
        usage:
          type:
          - string
          - 'null'
          description: Operating band reported for this radio, such as 24, 5, or 6
          readOnly: true
          examples:
          - '24'
        util_all:
          type:
          - integer
          - 'null'
          description: All utilization in percentage
          contentEncoding: int32
          readOnly: true
        util_non_wifi:
          type:
          - integer
          - 'null'
          description: Reception of "No Packets" utilization in percentage, received frames with invalid PLCPs and CRS glitches as noise
          contentEncoding: int32
          readOnly: true
        util_rx_in_bss:
          type:
          - integer
          - 'null'
          description: Reception of "In BSS" utilization in percentage, only frames that are received from AP/STAs within the BSS
          contentEncoding: int32
          readOnly: true
        util_rx_other_bss:
          type:
          - integer
          - 'null'
          description: Reception of "Other BSS" utilization in percentage, all frames received from AP/STAs that are outside the BSS
          contentEncoding: int32
          readOnly: true
        util_tx:
          type:
          - integer
          - 'null'
          description: Transmission utilization in percentage
          contentEncoding: int32
          readOnly: true
        util_undecodable_wifi:
          type:
          - integer
          - 'null'
          description: Reception of "UnDecodable Wifi" utilization in percentage, only Preamble, PLCP header is decoded, Rest is undecodable in this radio
          contentEncoding: int32
          readOnly: true
        util_unknown_wifi:
          type:
          - integer
          - 'null'
          description: Reception of "No Category" utilization in percentage, all 802.11 frames that are corrupted at the receiver
          contentEncoding: int32
          readOnly: true
      description: 5 GHz radio statistics reported by the AP
    ap_radio_stat3:
      title: ap_radio_stat3
      type: object
      properties:
        bandwidth:
          allOf:
          - $ref: '#/components/schemas/dot11_bandwidth8'
          - description: 'Current channel width reported for this radio. enum: `0`, `20`, `40`, `80`, `160`.'
            examples:
            - 20
        channel:
          type:
          - integer
          - 'null'
          description: Current channel the radio is running on
          contentEncoding: int32
          readOnly: true
        dynamic_chaining_enabled:
          type:
          - boolean
          - 'null'
          description: Use dynamic chaining for downlink
          readOnly: true
        mac:
          type:
          - string
          - 'null'
          description: Radio base MAC address; a base radio MAC can represent up to 16 BSSIDs (e.g. 5c5b350001a0-5c5b350001af)
          readOnly: true
        noise_floor:
          type:
          - integer
          - 'null'
          description: Measured noise floor for this radio, in dBm
          contentEncoding: int32
          readOnly: true
          examples:
          - -90
        num_clients:
          type:
          - integer
          - 'null'
          description: Number of clients currently connected on this radio
          contentEncoding: int32
          readOnly: true
        num_wlans:
          type: integer
          description: How many WLANs are applied to the radio
          contentEncoding: int32
        power:
          type:
          - integer
          - 'null'
          description: Transmit power (in dBm)
          contentEncoding: int32
          readOnly: true
        rx_bytes:
          type:
          - integer
          - 'null'
          description: Received byte count reported for this radio
          contentEncoding: int64
          readOnly: true
          examples:
          - 8515104416
        rx_pkts:
          type:
          - integer
          - 'null'
          description: Received packet count reported for this radio
          contentEncoding: int64
          readOnly: true
          examples:
          - 57770567
        tx_bytes:
          type:
          - integer
          - 'null'
          description: Transmitted byte count reported for this radio
          contentEncoding: int64
          readOnly: true
          examples:
          - 211217389682
        tx_pkts:
          type:
          - integer
          - 'null'
          description: Transmitted packet count reported for this radio
          contentEncoding: int64
          readOnly: true
          examples:
          - 812204062
        usage:
          type:
          - string
          - 'null'
          description: Operating band reported for this radio, such as 24, 5, or 6
          readOnly: true
          examples:
          - '24'
        util_all:
          type:
          - integer
          - 'null'
          description: All utilization in percentage
          contentEncoding: int32
          readOnly: true
        util_non_wifi:
          type:
          - integer
          - 'null'
          description: Reception of "No Packets" utilization in percentage, received frames with invalid PLCPs and CRS glitches as noise
          contentEncoding: int32
          readOnly: true
        util_rx_in_bss:
          type:
          - integer
          - 'null'
          description: Reception of "In BSS" utilization in percentage, only frames that are received from AP/STAs within the BSS
          contentEncoding: int32
          readOnly: true
        util_rx_other_bss:
          type:
          - integer
          - 'null'
          description: Reception of "Other BSS" utilization in percentage, all frames received from AP/STAs that are outside the BSS
          contentEncoding: int32
          readOnly: true
        util_tx:
          type:
          - integer
          - 'null'
          description: Transmission utilization in percentage
          contentEncoding: int32
          readOnly: true
        util_undecodable_wifi:
          type:
          - integer
          - 'null'
          description: Reception of "UnDecodable Wifi" utilization in percentage, only Preamble, PLCP header is decoded, Rest is undecodable in this radio
          contentEncoding: int32
          readOnly: true
        util_unknown_wifi:
          type:
          - integer
          - 'null'
          description: Reception of "No Category" utilization in percentage, all 802.11 frames that are corrupted at the receiver
          contentEncoding: int32
          readOnly: true
      description: 6 GHz radio statistics reported by the AP
    ap_radio2:
      title: ap_radio2
      type: object
      properties:
        allow_rrm_disable:
          type: boolean
          description: Whether RRM can be disabled for individual radio-band settings
          default: false
        ant_gain_24:
          minimum: 0
          type: integer
          description: Antenna gain for 2.4G - for models with external antenna only
          contentEncoding: int32
          examples:
          - 4
        ant_gain_5:
          minimum: 0
          type: integer
          description: Antenna gain for 5G - for models with external antenna only
          contentEncoding: int32
          examples:
          - 5
        ant_gain_6:
          minimum: 0
          type: integer
          description: Antenna gain for 6G - for models with external antenna only
          contentEncoding: int32
          examples:
          - 5
        antenna_mode:
          allOf:
          - $ref: '#/components/schemas/ap_radio_antenna_mode2'
          - description: 'Selected radio chain mode for AP models that support antenna mode control. enum: `1x1`, `2x2`, `3x3`, `4x4`, `default`.'
        antenna_select:
          allOf:
          - $ref: '#/components/schemas/antenna_select1'
          - description: 'Internal or external antenna selection for AP models with selectable antennas. enum: ``, `external`, `internal`.'
            examples:
            - external
        band_24:
          allOf:
          - $ref: '#/components/schemas/ap_radio_band242'
          - description: 2.4 GHz radio settings for this access point
        band_24_usage:
          allOf:
          - $ref: '#/components/schemas/radio_band_24_usage4'
          - description: 'Radio usage mode for the 2.4 GHz-capable radio. enum: `24`, `5`, `6`, `auto`.'
        band_5:
          allOf:
          - $ref: '#/components/schemas/ap_radio_band53'
          - description: 5 GHz radio settings for this access point
        band_5_on_24_radio:
          allOf:
          - $ref: '#/components/schemas/ap_radio_band51'
          - description: 5 GHz settings used when the 2.4 GHz radio operates in 5 GHz mode
        band_6:
          allOf:
          - $ref: '#/components/schemas/ap_radio_band62'
          - description: 6 GHz radio settings for this access point
        full_automatic_rrm:
          type: boolean
          description: Let RRM control everything, only the `channels` and `ant_gain` will be honored (i.e. disabled/bandwidth/power/band_24_usage are all controlled by RRM)
          default: false
        indoor_use:
          type: boolean
          description: To make an outdoor operate indoor. For an outdoor-ap, some channels are disallowed by default, this allows the user to use it as an indoor-ap
          default: false
        rrm_managed:
          type: boolean
          description: Enable RRM to manage all radio settings (ignores all band_xxx configs)
        scanning_enabled:
          type: boolean
          description: Whether scanning radio is enabled
          examples:
          - true
      description: Radio configuration defaults in this AP profile
    ap_radio3:
      title: ap_radio3
      type: object
      properties:
        allow_rrm_disable:
          type: boolean
          description: Whether RRM can be disabled for individual radio-band settings
          default: false
        ant_gain_24:
          minimum: 0
          type: integer
          description: Antenna gain for 2.4G - for models with external antenna only
          contentEncoding: int32
          examples:
          - 4
        ant_gain_5:
          minimum: 0
          type: integer
          description: Antenna gain for 5G - for models with external antenna only
          contentEncoding: int32
          examples:
          - 5
        ant_gain_6:
          minimum: 0
          type: integer
          description: Antenna gain for 6G - for models with external antenna only
          contentEncoding: int32
          examples:
          - 5
        antenna_mode:
          allOf:
          - $ref: '#/components/schemas/ap_radio_antenna_mode2'
          - description: 'Selected radio chain mode for AP models that support antenna mode control. enum: `1x1`, `2x2`, `3x3`, `4x4`, `default`.'
        antenna_select:
          allOf:
          - $ref: '#/components/schemas/antenna_select1'
          - description: 'Internal or external antenna selection for AP models with selectable antennas. enum: ``, `external`, `internal`.'
            examples:
            - external
        band_24:
          allOf:
          - $ref: '#/components/schemas/ap_radio_band242'
          - description: 2.4 GHz radio settings for this access point
        band_24_usage:
          allOf:
          - $ref: '#/components/schemas/radio_band_24_usage4'
          - description: 'Radio usage mode for the 2.4 GHz-capable radio. enum: `24`, `5`, `6`, `auto`.'
        band_5:
          allOf:
          - $ref: '#/components/schemas/ap_radio_band53'
          - description: 5 GHz radio settings for this access point
        band_5_on_24_radio:
          allOf:
          - $ref: '#/components/schemas/ap_radio_band51'
          - description: 5 GHz settings used when the 2.4 GHz radio operates in 5 GHz mode
        band_6:
          allOf:
          - $ref: '#/components/schemas/ap_radio_band62'
          - description: 6 GHz radio settings for this access point
        full_automatic_rrm:
          type: boolean
          description: Let RRM control everything, only the `channels` and `ant_gain` will be honored (i.e. disabled/bandwidth/power/band_24_usage are all controlled by RRM)
          default: false
        indoor_use:
          type: boolean
          description: To make an outdoor operate indoor. For an outdoor-ap, some channels are disallowed by default, this allows the user to use it as an indoor-ap
          default: false
        rrm_managed:
          type: boolean
          description: Enable RRM to manage all radio settings (ignores all band_xxx configs)
        scanning_enabled:
          type: boolean
          description: Whether scanning radio is enabled
          examples:
          - true
      description: AP radio configuration for the site
    ap_radio4:
      title: ap_radio4
      type: object
      properties:
        allow_rrm_disable:
          type: boolean
          description: Whether RRM can be disabled for individual radio-band settings
          default: false
        ant_gain_24:
          minimum: 0
          type: integer
          description: Antenna gain for 2.4G - for models with external antenna only
          contentEncoding: int32
          examples:
          - 4
        ant_gain_5:
          minimum: 0
          type: integer
          description: Antenna gain for 5G - for models with external antenna only
          contentEncoding: int32
          examples:
          - 5
        ant_gain_6:
          minimum: 0
          type: integer
          description: Antenna gain for 6G - for models with external antenna only
          contentEncoding: int32
          examples:
          - 5
        antenna_mode:
          allOf:
          - $ref: '#/components/schemas/ap_radio_antenna_mode2'
          - description: 'Selected radio chain mode for AP models that support antenna mode control. enum: `1x1`, `2x2`, `3x3`, `4x4`, `default`.'
        antenna_select:
          allOf:
          - $ref: '#/components/schemas/antenna_select1'
          - description: 'Internal or external antenna selection for AP models with selectable antennas. enum: ``, `external`, `internal`.'
            examples:
            - external
        band_24:
          allOf:
          - $ref: '#/components/schemas/ap_radio_band242'
          - description: 2.4 GHz radio settings for this access point
        band_24_usage:
          allOf:
          - $ref: '#/components/schemas/radio_band_24_usage4'
          - description: 'Radio usage mode for the 2.4 GHz-capable radio. enum: `24`, `5`, `6`, `auto`.'
        band_5:
          allOf:
          - $ref: '#/components/schemas/ap_radio_band53'
          - description: 5 GHz radio settings for this access point
        band_5_on_24_radio:
          allOf:
          - $ref: '#/components/schemas/ap_radio_band51'
          - description: 5 GHz settings used when the 2.4 GHz radio operates in 5 GHz mode
        band_6:
          allOf:
          - $ref: '#/components/schemas/ap_radio_band62'
          - description: 6 GHz radio settings for this access point
        full_automatic_rrm:
          type: boolean
          description: Let RRM control everything, only the `channels` and `ant_gain` will be honored (i.e. disabled/bandwidth/power/band_24_usage are all controlled by RRM)
          default: false
        indoor_use:
          type: boolean
          description: To make an outdoor operate indoor. For an outdoor-ap, some channels are disallowed by default, this allows the user to use it as an indoor-ap
          default: false
        rrm_managed:
          type: boolean
          description: Enable RRM to manage all radio settings (ignores all band_xxx configs)
        scanning_enabled:
          type: boolean
          description: Whether scanning radio is enabled
          examples:
          - true
      description: Radio configuration overrides for this access point
    ap_redundancy1:
      title: ap_redundancy1
      type: object
      properties:
        modules:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ap_redundancy_module'
          description: Per-module AP redundancy counts keyed by switch node ID
        num_aps:
          type: integer
          description: Total number of APs considered for switch redundancy
          contentEncoding: int32
          examples:
          - 15
        num_aps_with_switch_redundancy:
          type: integer
          description: Number of APs that have switch redundancy coverage
          contentEncoding: int32
          examples:
          - 8
      description: AP switch redundancy summary for APs connected through the discovered switch
    ap_redundancy2:
      title: ap_redundancy2
      type: object
      properties:
        modules:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ap_redundancy_module'
          description: Per-module AP redundancy counts keyed by switch node ID
        num_aps:
          type: integer
          description: Total number of APs considered for switch redundancy
          contentEncoding: int32
          examples:
          - 15
        num_aps_with_switch_redundancy:
          type: integer
          description: Number of APs that have switch redundancy coverage
          contentEncoding: int32
          examples:
          - 8
      description: AP redundancy statistics associated with the gateway
    ap_stat_mesh_uplink1:
      title: ap_stat_mesh_uplink1
      type: object
      properties:
        band:
          type: string
          description: Radio band used by this mesh uplink
          examples:
          - '5'
        channel:
          type: integer
          description: Radio channel used by this mesh uplink
          contentEncoding: int32
          examples:
          - 36
        idle_time:
          type: integer
          description: Seconds since traffic was last observed on this mesh uplink
          contentEncoding: int32
          examples:
          - 3
        last_seen:
          type:
          - number
          - 'null'
          description: Timestamp when this mesh uplink was last observed
          readOnly: true
          examples:
          - 1470417522
        proto:
          type: string
          description: 802.11 protocol reported for this mesh uplink
          examples:
          - n
        rssi:
          type: integer
          description: Received signal strength for this mesh uplink, in dBm
          contentEncoding: int32
          examples:
          - -65
        rx_bps:
          type:
          - integer
          - 'null'
          description: Inbound throughput on this mesh uplink, in bits per second
          contentEncoding: int64
          readOnly: true
          examples:
          - 60003
        rx_bytes:
          type:
          - integer
          - 'null'
          description: Inbound byte count for this mesh uplink
          contentEncoding: int64
          readOnly: true
          examples:
          - 8515104416
        rx_packets:
          type:
          - integer
          - 'null'
          description: Inbound packet count for this mesh uplink
          contentEncoding: int64
          readOnly: true
          examples:
          - 57770567
        rx_rate:
          type:
          - number
          - 'null'
          description: Inbound data rate reported for this mesh uplink
          readOnly: true
        rx_retries:
          type:
          - integer
          - 'null'
          description: Inbound retry count reported for this mesh uplink
          contentEncoding: int32
          readOnly: true
        site_id:
          type: string
          description: Site associated with this mesh uplink statistic
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        snr:
          type: integer
          description: Signal-to-noise ratio for this mesh uplink, in dB
          contentEncoding: int32
          examples:
          - 31
        tx_bps:
          type:
          - integer
          - 'null'
          description: Outbound throughput on this mesh uplink, in bits per second
          contentEncoding: int64
          readOnly: true
          examples:
          - 634301
        tx_bytes:
          type:
          - integer
          - 'null'
          description: Outbound byte count for this mesh uplink
          contentEncoding: int64
          readOnly: true
          examples:
          - 211217389682
        tx_packets:
          type:
          - integer
          - 'null'
          description: Outbound packet count for this mesh uplink
          contentEncoding: int64
          readOnly: true
          examples:
          - 812204062
        tx_rate:
          type:
          - number
          - 'null'
          description: Outbound data rate reported for this mesh uplink
          readOnly: true
        tx_retries:
          type:
          - integer
          - 'null'
          description: Outbound retry count reported for this mesh uplink
          contentEncoding: int32
          readOnly: true
        uplink_ap_id:
          type: string
          description: Identifier of the upstream AP for this mesh uplink
          contentEncoding: uuid
          examples:
          - 00000000-0000-0000-1000-5c5b35000010
      description: Mesh uplink status for the AP
    ap_switch_setting1:
      title: ap_switch_setting1
      type: object
      properties:
        enable_vlan:
          type: boolean
          description: Whether VLAN tagging is enabled for this AP switch-config port
        port_vlan_id:
          anyOf:
          - maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
          - type: string
          description: Native VLAN ID for this AP switch-config port
        vlan_ids:
          type: array
          items:
            maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
          description: Allowed VLAN IDs for this AP switch-config port
      description: VLAN settings for AP eth1
    ap_switch_setting2:
      title: ap_switch_setting2
      type: object
      properties:
        enable_vlan:
          type: boolean
          description: Whether VLAN tagging is enabled for this AP switch-config port
        port_vlan_id:
          anyOf:
          - maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
          - type: string
          description: Native VLAN ID for this AP switch-config port
        vlan_ids:
          type: array
          items:
            maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
          description: Allowed VLAN IDs for this AP switch-config port
      description: VLAN settings for AP eth2
    ap_switch_setting3:
      title: ap_switch_setting3
      type: object
      properties:
        enable_vlan:
          type: boolean
          description: Whether VLAN tagging is enabled for this AP switch-config port
        port_vlan_id:
          anyOf:
          - maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
          - type: string
          description: Native VLAN ID for this AP switch-config port
        vlan_ids:
          type: array
          items:
            maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
          description: Allowed VLAN IDs for this AP switch-config port
      description: VLAN settings for AP eth3
    ap_switch_setting4:
      title: ap_switch_setting4
      type: object
      properties:
        enable_vlan:
          type: boolean
          description: Whether VLAN tagging is enabled for this AP switch-config port
        port_vlan_id:
          anyOf:
          - maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
          - type: string
          description: Native VLAN ID for this AP switch-config port
        vlan_ids:
          type: array
          items:
            maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
          description: Allowed VLAN IDs for this AP switch-config port
      description: VLAN settings for the AP module port
    ap_switch_setting5:
      title: ap_switch_setting5
      type: object
      properties:
        enable_vlan:
          type: boolean
          description: Whether VLAN tagging is enabled for this AP switch-config port
        port_vlan_id:
          anyOf:
          - maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
          - type: string
          description: Native VLAN ID for this AP switch-config port
        vlan_ids:
          type: array
          items:
            maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
          description: Allowed VLAN IDs for this AP switch-config port
      description: VLAN settings for WDS traffic on the AP
    ap_switch_setting7:
      title: ap_switch_setting7
      type: object
      properties:
        enable_vlan:
          type: boolean
          description: Whether VLAN tagging is enabled for this AP switch-config port
        port_vlan_id:
          anyOf:
          - maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
          - type: string
          description: Native VLAN ID for this AP switch-config port
        vlan_ids:
          type: array
          items:
            maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
          description: Allowed VLAN IDs for this AP switch-config port
      description: VLAN settings for AP eth0
    ap_switch1:
      title: ap_switch1
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether deprecated AP switch VLAN control is enabled
          default: false
        eth0:
          allOf:
          - $ref: '#/components/schemas/ap_switch_setting7'
          - description: VLAN settings for AP eth0
        eth1:
          allOf:
          - $ref: '#/components/schemas/ap_switch_setting1'
          - description: VLAN settings for AP eth1
        eth2:
          allOf:
          - $ref: '#/components/schemas/ap_switch_setting2'
          - description: VLAN settings for AP eth2
        eth3:
          allOf:
          - $ref: '#/components/schemas/ap_switch_setting3'
          - description: VLAN settings for AP eth3
        module:
          allOf:
          - $ref: '#/components/schemas/ap_switch_setting4'
          - description: VLAN settings for the AP module port
        wds:
          allOf:
          - $ref: '#/components/schemas/ap_switch_setting5'
          - description: VLAN settings for WDS traffic on the AP
      description: Deprecated AP switch configuration defaults in this profile
      deprecated: true
    ap_template_matching2:
      title: ap_template_matching2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether AP matching is enabled for this AP template
        rules:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/ap_template_matching_rule'
          description: AP matching entries that select access points and apply AP port configuration
      description: Rules used to select access points for this AP template
    ap_template_wifi2:
      title: ap_template_wifi2
      type: object
      properties:
        cisco_enabled:
          type: boolean
          description: Whether Cisco-specific Wi-Fi compatibility behavior is enabled
        disable_11k:
          type: boolean
          description: Whether 802.11k neighbor reports are disabled
          default: false
        disable_radios_when_power_constrained:
          type: boolean
          description: Whether AP radios are disabled when power is constrained
        enable_arp_spoof:
          type: boolean
          description: Whether ARP spoofing checks are enabled when proxy ARP is used
        enable_shared_radio_scanning:
          type: boolean
          description: Whether shared radio scanning is enabled for AP radio scanning
          default: false
        enabled:
          type: boolean
          description: Whether Wi-Fi settings in this AP template are enabled
          default: true
        locate_connected:
          type: boolean
          description: Whether location tracking is enabled for connected clients
          default: false
        locate_unconnected:
          type: boolean
          description: Whether location tracking is enabled for unconnected clients
          default: false
        mesh_allow_dfs:
          type: boolean
          description: Whether mesh links may use DFS channels, which can add CAC delays during scanning
          default: false
        mesh_enable_crm:
          type: boolean
          description: Whether CRM is enabled for mesh networking in this AP template
        mesh_enabled:
          type: boolean
          description: Whether mesh networking is enabled by this AP template
        proxy_arp:
          type: boolean
          description: Whether proxy ARP is enabled for Wi-Fi clients
          default: false
      description: Wi-Fi and mesh settings applied by this AP template
    ap_uplink_port_config2:
      title: ap_uplink_port_config2
      type: object
      properties:
        dot1x:
          type: boolean
          description: Whether to do 802.1x against uplink switch. When enabled, AP cert will be used to do EAP-TLS and the Org's CA Cert has to be provisioned at the switch
          default: false
        keep_wlans_up_if_down:
          type: boolean
          description: By default, WLANs are disabled when uplink is down. In some scenario, like SiteSurvey, one would want the AP to keep sending beacons.
          default: false
      description: Authentication and failover defaults for AP uplink ports
    ap_uplink_port_config3:
      title: ap_uplink_port_config3
      type: object
      properties:
        dot1x:
          type: boolean
          description: Whether to do 802.1x against uplink switch. When enabled, AP cert will be used to do EAP-TLS and the Org's CA Cert has to be provisioned at the switch
          default: false
        keep_wlans_up_if_down:
          type: boolean
          description: By default, WLANs are disabled when uplink is down. In some scenario, like SiteSurvey, one would want the AP to keep sending beacons.
          default: false
      description: AP uplink port configuration for the site
    ap_uplink_port_config4:
      title: ap_uplink_port_config4
      type: object
      properties:
        dot1x:
          type: boolean
          description: Whether to do 802.1x against uplink switch. When enabled, AP cert will be used to do EAP-TLS and the Org's CA Cert has to be provisioned at the switch
          default: false
        keep_wlans_up_if_down:
          type: boolean
          description: By default, WLANs are disabled when uplink is down. In some scenario, like SiteSurvey, one would want the AP to keep sending beacons.
          default: false
      description: Authentication and failover behavior for AP uplink ports
    ap_usb_type2:
      title: ap_usb_type2
      enum:
      - hanshow
      - imagotag
      - solum
      type: string
      description: 'USB integration type for this legacy AP USB configuration. enum: `hanshow`, `imagotag`, `solum`.'
      examples:
      - imagotag
    ap_usb2:
      title: ap_usb2
      type: object
      properties:
        cacert:
          type:
          - string
          - 'null'
          description: Only if `type`==`imagotag`. CA certificate used to validate the Imagotag service certificate
        channel:
          type: integer
          description: Only if `type`==`imagotag`, channel selection, not needed by default, required for manual channel override only
          contentEncoding: int32
          examples:
          - 3
        enabled:
          type: boolean
          description: Whether to enable any usb config
        host:
          type: string
          description: Only if `type`==`imagotag`. Imagotag service host or IP address contacted by the AP
          examples:
          - 1.1.1.1
        port:
          type: integer
          description: Only if `type`==`imagotag`. TCP port used to reach the Imagotag service
          contentEncoding: int32
          default: 0
          examples:
          - 0
        type:
          allOf:
          - $ref: '#/components/schemas/ap_usb_type2'
          - description: 'USB integration type for this legacy AP USB configuration. enum: `hanshow`, `imagotag`, `solum`.'
            examples:
            - imagotag
        verify_cert:
          type: boolean
          description: Only if `type`==`imagotag`, whether to turn on SSL verification
        vlan_id:
          type: integer
          description: Only if `type`==`solum` or `type`==`hanshow`
          contentEncoding: int32
          default: 1
      description: Legacy USB integration defaults in this AP profile
    ap_usb3:
      title: ap_usb3
      type: object
      properties:
        cacert:
          type:
          - string
          - 'null'
          description: Only if `type`==`imagotag`. CA certificate used to validate the Imagotag service certificate
        channel:
          type: integer
          description: Only if `type`==`imagotag`, channel selection, not needed by default, required for manual channel override only
          contentEncoding: int32
          examples:
          - 3
        enabled:
          type: boolean
          description: Whether to enable any usb config
        host:
          type: string
          description: Only if `type`==`imagotag`. Imagotag service host or IP address contacted by the AP
          examples:
          - 1.1.1.1
        port:
          type: integer
          description: Only if `type`==`imagotag`. TCP port used to reach the Imagotag service
          contentEncoding: int32
          default: 0
          examples:
          - 0
        type:
          allOf:
          - $ref: '#/components/schemas/ap_usb_type2'
          - description: 'USB integration type for this legacy AP USB configuration. enum: `hanshow`, `imagotag`, `solum`.'
            examples:
            - imagotag
        verify_cert:
          type: boolean
          description: Only if `type`==`imagotag`, whether to turn on SSL verification
        vlan_id:
          type: integer
          description: Only if `type`==`solum` or `type`==`hanshow`
          contentEncoding: int32
          default: 1
      description: Legacy USB integration settings for this access point
    ap_uwb_config2:
      title: ap_uwb_config2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether UWB RTLS integration is enabled
          default: false
        host:
          type: string
          description: RTLS server hostname or IP address
          examples:
          - coriva.example.com
        port:
          maximum: 65535
          minimum: 1
          type: integer
          description: RTLS server port number
          contentEncoding: int32
          examples:
          - 9000
        slot:
          maximum: 15
          minimum: 0
          type: integer
          description: UWB time slot assigned to this AP, 0–15
          contentEncoding: int32
          default: 0
          examples:
          - 0
        type:
          allOf:
          - $ref: '#/components/schemas/ap_uwb_config_type'
          - description: 'UWB integration type. enum: `zigpos`'
      description: UWB RTLS / OMLOX asset-visibility settings; overrides the site-level `uwb_config` and is overridden by device-level `uwb_config`
    ap_uwb_config3:
      title: ap_uwb_config3
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether UWB RTLS integration is enabled
          default: false
        host:
          type: string
          description: RTLS server hostname or IP address
          examples:
          - coriva.example.com
        port:
          maximum: 65535
          minimum: 1
          type: integer
          description: RTLS server port number
          contentEncoding: int32
          examples:
          - 9000
        slot:
          maximum: 15
          minimum: 0
          type: integer
          description: UWB time slot assigned to this AP, 0–15
          contentEncoding: int32
          default: 0
          examples:
          - 0
        type:
          allOf:
          - $ref: '#/components/schemas/ap_uwb_config_type'
          - description: 'UWB integration type. enum: `zigpos`'
      description: UWB RTLS (OMLOX asset visibility) settings for the site, only effective on AP models with a UWB radio and in countries where the UWB radio is permitted. Overridden by the device profile and device-level settings
    ap_uwb_config4:
      title: ap_uwb_config4
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether UWB RTLS integration is enabled
          default: false
        host:
          type: string
          description: RTLS server hostname or IP address
          examples:
          - coriva.example.com
        port:
          maximum: 65535
          minimum: 1
          type: integer
          description: RTLS server port number
          contentEncoding: int32
          examples:
          - 9000
        slot:
          maximum: 15
          minimum: 0
          type: integer
          description: UWB time slot assigned to this AP, 0–15
          contentEncoding: int32
          default: 0
          examples:
          - 0
        type:
          allOf:
          - $ref: '#/components/schemas/ap_uwb_config_type'
          - description: 'UWB integration type. enum: `zigpos`'
      description: UWB RTLS / OMLOX asset-visibility settings; overrides the device profile and site-level `uwb_config`
    ap_zigbee_allow_join2:
      title: ap_zigbee_allow_join2
      enum:
      - always
      - manual
      type: string
      description: 'Join policy for new Zigbee devices on this AP. enum: `always`, `manual`.'
      examples:
      - manual
    ap_zigbee2:
      title: ap_zigbee2
      type: object
      properties:
        allow_join:
          allOf:
          - $ref: '#/components/schemas/ap_zigbee_allow_join2'
          - description: 'Join policy for new Zigbee devices on this AP. enum: `always`, `manual`.'
            examples:
            - manual
        channel:
          maximum: 26
          minimum: 0
          type: integer
          description: Zigbee channel (2.4 GHz). `0` means auto; valid fixed values are 11–26
          contentEncoding: int32
          default: 0
          examples:
          - 0
        enabled:
          type: boolean
          description: Whether to enable Zigbee on this AP
          default: false
        extended_pan_id:
          type:
          - string
          - 'null'
          description: Extended PAN ID in hex string format; only applicable when `pan_id` is also specified
          examples:
          - '1311768467294899695'
        pan_id:
          type:
          - string
          - 'null'
          description: PAN ID in hex string format; if not specified, assigned automatically
          examples:
          - 0x1234
      description: Zigbee radio and network defaults in this AP profile
    ap_zigbee3:
      title: ap_zigbee3
      type: object
      properties:
        allow_join:
          allOf:
          - $ref: '#/components/schemas/ap_zigbee_allow_join2'
          - description: 'Join policy for new Zigbee devices on this AP. enum: `always`, `manual`.'
            examples:
            - manual
        channel:
          maximum: 26
          minimum: 0
          type: integer
          description: Zigbee channel (2.4 GHz). `0` means auto; valid fixed values are 11–26
          contentEncoding: int32
          default: 0
          examples:
          - 0
        enabled:
          type: boolean
          description: Whether to enable Zigbee on this AP
          default: false
        extended_pan_id:
          type:
          - string
          - 'null'
          description: Extended PAN ID in hex string format; only applicable when `pan_id` is also specified
          examples:
          - '1311768467294899695'
        pan_id:
          type:
          - string
          - 'null'
          description: PAN ID in hex string format; if not specified, assigned automatically
          examples:
          - 0x1234
      description: Zigbee radio and network settings for this access point
    app_probing_custom_app_protocol2:
      title: app_probing_custom_app_protocol2
      enum:
      - http
      - icmp
      type: string
      description: 'Probe protocol used by this custom application definition. enum: `http`, `icmp`.'
    app_probing1:
      title: app_probing1
      type: object
      properties:
        apps:
          type: array
          items:
            type: string
          description: Predefined application keys to probe
          examples:
          - - facebook
        custom_apps:
          type: array
          items:
            $ref: '#/components/schemas/app_probing_custom_app'
          description: User-defined application probe definitions
        enabled:
          type: boolean
          description: Whether gateway application probing is enabled
      description: Application probing configuration for gateway monitoring
    arp_table_stats1:
      title: arp_table_stats1
      type: object
      properties:
        arp_table_count:
          type: integer
          description: Number of ARP table entries currently present on the device
          contentEncoding: int32
        max_entries_supported:
          type: integer
          description: Supported ARP table capacity for the device
          contentEncoding: int32
      description: ARP table utilization statistics for the switch
    arp_table_stats2:
      title: arp_table_stats2
      type: object
      properties:
        arp_table_count:
          type: integer
          description: Number of ARP table entries currently present on the device
          contentEncoding: int32
        max_entries_supported:
          type: integer
          description: Supported ARP table capacity for the device
          contentEncoding: int32
      description: ARP table utilization statistics for the gateway
    auto_placement_info_status1:
      title: auto_placement_info_status1
      enum:
      - done
      - error
      - inprogress
      - pending
      type: string
      description: 'Current autoplacement processing state. enum: `done`, `error`, `inprogress`, `pending`.'
    auto_preemption1:
      title: auto_preemption1
      type: object
      properties:
        day_of_week:
          allOf:
          - $ref: '#/components/schemas/day_of_week7'
          - description: 'Scheduled weekday for auto preemption. enum: `any`, `fri`, `mon`, `sat`, `sun`, `thu`, `tue`, `wed`.'
        enabled:
          type: boolean
          description: Whether auto preemption is enabled
          default: false
        time_of_day:
          type: string
          description: Scheduled time of day for auto preemption
          default: any
          examples:
          - 12:00
      description: Preemption behavior for restoring preferred tunnel peers after failover
    avprofile_fallback_action2:
      title: avprofile_fallback_action2
      enum:
      - block
      - log-and-permit
      - permit
      type: string
      description: 'Action to take when antivirus scanning cannot complete. enum: `block`, `log-and-permit`, `permit`.'
    beacon_type2:
      title: beacon_type2
      enum:
      - eddystone-uid
      - eddystone-url
      - ibeacon
      type: string
      description: 'Beacon advertisement format used by this beacon. enum: `eddystone-uid`, `eddystone-url`, `ibeacon`.'
    bgp_config_type2:
      title: bgp_config_type2
      enum:
      - external
      - internal
      type: string
      description: Required if `via`==`lan`, `via`==`tunnel` or `via`==`wan`; BGP session type, internal or external
    bgp_config_via2:
      title: bgp_config_via2
      enum:
      - lan
      - tunnel
      - vpn
      - wan
      type: string
      description: Transport used for this BGP session, such as LAN, tunnel, VPN, or WAN
    bgp_stats_state1:
      title: bgp_stats_state1
      enum:
      - active
      - connect
      - established
      - idle
      - open_config
      - open_sent
      type: string
      description: 'Current state of the BGP session. enum: `active`, `connect`, `established`, `idle`, `open_config`, `open_sent`.'
      examples:
      - established
    ble_config_beacon_rate_mode2:
      title: ble_config_beacon_rate_mode2
      enum:
      - custom
      - default
      type: string
      description: 'Beacon rate mode for Mist BLE beacons; use custom to set beacon_rate. enum: `custom`, `default`.'
      examples:
      - custom
    ble_config_power_mode2:
      title: ble_config_power_mode2
      enum:
      - custom
      - default
      type: string
      description: 'Transmit power mode for the virtual beacon. enum: `custom`, `default`.'
      examples:
      - custom
    ble_config_power_mode3:
      title: ble_config_power_mode3
      enum:
      - custom
      - default
      type: string
      description: 'Transmit power mode for BLE beacons; use custom to set `power`. enum: `custom`, `default`.'
      examples:
      - custom
    ble_config2:
      title: ble_config2
      type: object
      properties:
        beacon_enabled:
          type: boolean
          description: Whether Mist beacons is enabled
          default: true
        beacon_rate:
          type: integer
          description: Required if `beacon_rate_mode`==`custom`, 1-10, in number-beacons-per-second
          contentEncoding: int32
          examples:
          - 3
        beacon_rate_mode:
          allOf:
          - $ref: '#/components/schemas/ble_config_beacon_rate_mode2'
          - description: 'Beacon rate mode for Mist BLE beacons; use custom to set beacon_rate. enum: `custom`, `default`.'
            examples:
            - custom
        beam_disabled:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: AP BLE beam numbers disabled for location advertisements
          examples:
          - - 1
            - 3
            - 6
        custom_ble_packet_enabled:
          type: boolean
          description: Can be enabled if `beacon_enabled`==`true`, whether to send custom packet
          default: false
        custom_ble_packet_frame:
          type: string
          description: The custom frame to be sent out in this beacon. The frame must be a hexstring
          examples:
          - 0x........
        custom_ble_packet_freq_msec:
          minimum: 0
          type: integer
          description: Frequency (msec) of data emitted by custom ble beacon
          contentEncoding: int32
          default: 0
          examples:
          - 300
        eddystone_uid_adv_power:
          maximum: 20
          minimum: -100
          type: integer
          description: Advertised TX Power, -100 to 20 (dBm), omit this attribute to use default
          contentEncoding: int32
          default: 0
          examples:
          - -65
        eddystone_uid_beams:
          type: string
          description: BLE beams used to transmit Eddystone-UID advertisements, expressed as ranges such as `2-4,7`
          examples:
          - 2-4,7
        eddystone_uid_enabled:
          type: boolean
          description: Only if `beacon_enabled`==`false`, Whether Eddystone-UID beacon is enabled
          default: false
        eddystone_uid_freq_msec:
          type: integer
          description: Frequency (msec) of data emit by Eddystone-UID beacon
          contentEncoding: int32
          default: 0
          examples:
          - 200
        eddystone_uid_instance:
          type: string
          description: Eddystone-UID instance for the device
          examples:
          - 5c5b35000001
        eddystone_uid_namespace:
          type: string
          description: Eddystone-UID namespace broadcast by the AP, as a 10-byte hex string
          examples:
          - 2818e3868dec25629ede
        eddystone_url_adv_power:
          maximum: 20
          minimum: -100
          type: integer
          description: Advertised TX Power, -100 to 20 (dBm), omit this attribute to use default
          contentEncoding: int32
          default: 0
          examples:
          - -65
        eddystone_url_beams:
          type: string
          description: BLE beams used to transmit Eddystone-URL advertisements, expressed as ranges such as `2-4,7`
          examples:
          - 2-4,7
        eddystone_url_enabled:
          type: boolean
          description: Only if `beacon_enabled`==`false`, Whether Eddystone-URL beacon is enabled
          default: false
        eddystone_url_freq_msec:
          type: integer
          description: Frequency (msec) of data emitted by Eddystone-URL beacon
          contentEncoding: int32
          default: 0
          examples:
          - 1000
        eddystone_url_url:
          type: string
          description: URL pointed by Eddystone-URL beacon
          examples:
          - https://www.abc.com
        ibeacon_adv_power:
          maximum: 20
          minimum: -100
          type: integer
          description: Advertised TX Power, -100 to 20 (dBm), omit this attribute to use default
          contentEncoding: int32
          default: 0
          examples:
          - -65
        ibeacon_beams:
          type: string
          description: BLE beams used to transmit iBeacon advertisements, expressed as ranges such as `2-4,7`
          examples:
          - 2-4,7
        ibeacon_enabled:
          type: boolean
          description: Can be enabled if `beacon_enabled`==`true`, whether to send iBeacon
          default: false
        ibeacon_freq_msec:
          type: integer
          description: Frequency (msec) of data emit for iBeacon
          contentEncoding: int32
          default: 0
        ibeacon_major:
          maximum: 65535
          minimum: 1
          type:
          - integer
          - 'null'
          description: iBeacon major value broadcast by the AP
          contentEncoding: int32
          examples:
          - 1234
        ibeacon_minor:
          maximum: 65535
          minimum: 1
          type:
          - integer
          - 'null'
          description: iBeacon minor value broadcast by the AP
          contentEncoding: int32
          examples:
          - 1234
        ibeacon_uuid:
          type: string
          description: Optional, if not specified, the same UUID as the beacon will be used
          contentEncoding: uuid
          examples:
          - f3f17139-704a-f03a-2786-0400279e37c3
        power:
          maximum: 10
          minimum: 1
          type: integer
          description: Required if `power_mode`==`custom`; else use `power_mode` as default
          contentEncoding: int32
          default: 9
          examples:
          - 6
        power_mode:
          allOf:
          - $ref: '#/components/schemas/ble_config_power_mode3'
          - description: 'Transmit power mode for BLE beacons; use custom to set `power`. enum: `custom`, `default`.'
            examples:
            - custom
      description: Bluetooth Low Energy beacon and asset defaults in this AP profile
    ble_config3:
      title: ble_config3
      type: object
      properties:
        beacon_enabled:
          type: boolean
          description: Whether Mist beacons is enabled
          default: true
        beacon_rate:
          type: integer
          description: Required if `beacon_rate_mode`==`custom`, 1-10, in number-beacons-per-second
          contentEncoding: int32
          examples:
          - 3
        beacon_rate_mode:
          allOf:
          - $ref: '#/components/schemas/ble_config_beacon_rate_mode2'
          - description: 'Beacon rate mode for Mist BLE beacons; use custom to set beacon_rate. enum: `custom`, `default`.'
            examples:
            - custom
        beam_disabled:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: AP BLE beam numbers disabled for location advertisements
          examples:
          - - 1
            - 3
            - 6
        custom_ble_packet_enabled:
          type: boolean
          description: Can be enabled if `beacon_enabled`==`true`, whether to send custom packet
          default: false
        custom_ble_packet_frame:
          type: string
          description: The custom frame to be sent out in this beacon. The frame must be a hexstring
          examples:
          - 0x........
        custom_ble_packet_freq_msec:
          minimum: 0
          type: integer
          description: Frequency (msec) of data emitted by custom ble beacon
          contentEncoding: int32
          default: 0
          examples:
          - 300
        eddystone_uid_adv_power:
          maximum: 20
          minimum: -100
          type: integer
          description: Advertised TX Power, -100 to 20 (dBm), omit this attribute to use default
          contentEncoding: int32
          default: 0
          examples:
          - -65
        eddystone_uid_beams:
          type: string
          description: BLE beams used to transmit Eddystone-UID advertisements, expressed as ranges such as `2-4,7`
          examples:
          - 2-4,7
        eddystone_uid_enabled:
          type: boolean
          description: Only if `beacon_enabled`==`false`, Whether Eddystone-UID beacon is enabled
          default: false
        eddystone_uid_freq_msec:
          type: integer
          description: Frequency (msec) of data emit by Eddystone-UID beacon
          contentEncoding: int32
          default: 0
          examples:
          - 200
        eddystone_uid_instance:
          type: string
          description: Eddystone-UID instance for the device
          examples:
          - 5c5b35000001
        eddystone_uid_namespace:
          type: string
          description: Eddystone-UID namespace broadcast by the AP, as a 10-byte hex string
          examples:
          - 2818e3868dec25629ede
        eddystone_url_adv_power:
          maximum: 20
          minimum: -100
          type: integer
          description: Advertised TX Power, -100 to 20 (dBm), omit this attribute to use default
          contentEncoding: int32
          default: 0
          examples:
          - -65
        eddystone_url_beams:
          type: string
          description: BLE beams used to transmit Eddystone-URL advertisements, expressed as ranges such as `2-4,7`
          examples:
          - 2-4,7
        eddystone_url_enabled:
          type: boolean
          description: Only if `beacon_enabled`==`false`, Whether Eddystone-URL beacon is enabled
          default: false
        eddystone_url_freq_msec:
          type: integer
          description: Frequency (msec) of data emitted by Eddystone-URL beacon
          contentEncoding: int32
          default: 0
          examples:
          - 1000
        eddystone_url_url:
          type: string
          description: URL pointed by Eddystone-URL beacon
          examples:
          - https://www.abc.com
        ibeacon_adv_power:
          maximum: 20
          minimum: -100
          type: integer
          description: Advertised TX Power, -100 to 20 (dBm), omit this attribute to use default
          contentEncoding: int32
          default: 0
          examples:
          - -65
        ibeacon_beams:
          type: string
          description: BLE beams used to transmit iBeacon advertisements, expressed as ranges such as `2-4,7`
          examples:
          - 2-4,7
        ibeacon_enabled:
          type: boolean
          description: Can be enabled if `beacon_enabled`==`true`, whether to send iBeacon
          default: false
        ibeacon_freq_msec:
          type: integer
          description: Frequency (msec) of data emit for iBeacon
          contentEncoding: int32
          default: 0
        ibeacon_major:
          maximum: 65535
          minimum: 1
          type:
          - integer
          - 'null'
          description: iBeacon major value broadcast by the AP
          contentEncoding: int32
          examples:
          - 1234
        ibeacon_minor:
          maximum: 65535
          minimum: 1
          type:
          - integer
          - 'null'
          description: iBeacon minor value broadcast by the AP
          contentEncoding: int32
          examples:
          - 1234
        ibeacon_uuid:
          type: string
          description: Optional, if not specified, the same UUID as the beacon will be used
          contentEncoding: uuid
          examples:
          - f3f17139-704a-f03a-2786-0400279e37c3
        power:
          maximum: 10
          minimum: 1
          type: integer
          description: Required if `power_mode`==`custom`; else use `power_mode` as default
          contentEncoding: int32
          default: 9
          examples:
          - 6
        power_mode:
          allOf:
          - $ref: '#/components/schemas/ble_config_power_mode3'
          - description: 'Transmit power mode for BLE beacons; use custom to set `power`. enum: `custom`, `default`.'
            examples:
            - custom
      description: Bluetooth Low Energy configuration applied to APs at the site
    ble_config4:
      title: ble_config4
      type: object
      properties:
        beacon_enabled:
          type: boolean
          description: Whether Mist beacons is enabled
          default: true
        beacon_rate:
          type: integer
          description: Required if `beacon_rate_mode`==`custom`, 1-10, in number-beacons-per-second
          contentEncoding: int32
          examples:
          - 3
        beacon_rate_mode:
          allOf:
          - $ref: '#/components/schemas/ble_config_beacon_rate_mode2'
          - description: 'Beacon rate mode for Mist BLE beacons; use custom to set beacon_rate. enum: `custom`, `default`.'
            examples:
            - custom
        beam_disabled:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: AP BLE beam numbers disabled for location advertisements
          examples:
          - - 1
            - 3
            - 6
        custom_ble_packet_enabled:
          type: boolean
          description: Can be enabled if `beacon_enabled`==`true`, whether to send custom packet
          default: false
        custom_ble_packet_frame:
          type: string
          description: The custom frame to be sent out in this beacon. The frame must be a hexstring
          examples:
          - 0x........
        custom_ble_packet_freq_msec:
          minimum: 0
          type: integer
          description: Frequency (msec) of data emitted by custom ble beacon
          contentEncoding: int32
          default: 0
          examples:
          - 300
        eddystone_uid_adv_power:
          maximum: 20
          minimum: -100
          type: integer
          description: Advertised TX Power, -100 to 20 (dBm), omit this attribute to use default
          contentEncoding: int32
          default: 0
          examples:
          - -65
        eddystone_uid_beams:
          type: string
          description: BLE beams used to transmit Eddystone-UID advertisements, expressed as ranges such as `2-4,7`
          examples:
          - 2-4,7
        eddystone_uid_enabled:
          type: boolean
          description: Only if `beacon_enabled`==`false`, Whether Eddystone-UID beacon is enabled
          default: false
        eddystone_uid_freq_msec:
          type: integer
          description: Frequency (msec) of data emit by Eddystone-UID beacon
          contentEncoding: int32
          default: 0
          examples:
          - 200
        eddystone_uid_instance:
          type: string
          description: Eddystone-UID instance for the device
          examples:
          - 5c5b35000001
        eddystone_uid_namespace:
          type: string
          description: Eddystone-UID namespace broadcast by the AP, as a 10-byte hex string
          examples:
          - 2818e3868dec25629ede
        eddystone_url_adv_power:
          maximum: 20
          minimum: -100
          type: integer
          description: Advertised TX Power, -100 to 20 (dBm), omit this attribute to use default
          contentEncoding: int32
          default: 0
          examples:
          - -65
        eddystone_url_beams:
          type: string
          description: BLE beams used to transmit Eddystone-URL advertisements, expressed as ranges such as `2-4,7`
          examples:
          - 2-4,7
        eddystone_url_enabled:
          type: boolean
          description: Only if `beacon_enabled`==`false`, Whether Eddystone-URL beacon is enabled
          default: false
        eddystone_url_freq_msec:
          type: integer
          description: Frequency (msec) of data emitted by Eddystone-URL beacon
          contentEncoding: int32
          default: 0
          examples:
          - 1000
        eddystone_url_url:
          type: string
          description: URL pointed by Eddystone-URL beacon
          examples:
          - https://www.abc.com
        ibeacon_adv_power:
          maximum: 20
          minimum: -100
          type: integer
          description: Advertised TX Power, -100 to 20 (dBm), omit this attribute to use default
          contentEncoding: int32
          default: 0
          examples:
          - -65
        ibeacon_beams:
          type: string
          description: BLE beams used to transmit iBeacon advertisements, expressed as ranges such as `2-4,7`
          examples:
          - 2-4,7
        ibeacon_enabled:
          type: boolean
          description: Can be enabled if `beacon_enabled`==`true`, whether to send iBeacon
          default: false
        ibeacon_freq_msec:
          type: integer
          description: Frequency (msec) of data emit for iBeacon
          contentEncoding: int32
          default: 0
        ibeacon_major:
          maximum: 65535
          minimum: 1
          type:
          - integer
          - 'null'
          description: iBeacon major value broadcast by the AP
          contentEncoding: int32
          examples:
          - 1234
        ibeacon_minor:
          maximum: 65535
          minimum: 1
          type:
          - integer
          - 'null'
          description: iBeacon minor value broadcast by the AP
          contentEncoding: int32
          examples:
          - 1234
        ibeacon_uuid:
          type: string
          description: Optional, if not specified, the same UUID as the beacon will be used
          contentEncoding: uuid
          examples:
          - f3f17139-704a-f03a-2786-0400279e37c3
        power:
          maximum: 10
          minimum: 1
          type: integer
          description: Required if `power_mode`==`custom`; else use `power_mode` as default
          contentEncoding: int32
          default: 9
          examples:
          - 6
        power_mode:
          allOf:
          - $ref: '#/components/schemas/ble_config_power_mode3'
          - description: 'Transmit power mode for BLE beacons; use custom to set `power`. enum: `custom`, `default`.'
            examples:
            - custom
      description: Bluetooth Low Energy beacon and asset settings for this access point
    call_troubleshoot_data1:
      title: call_troubleshoot_data1
      type: object
      properties:
        ap_num_clients:
          type: number
          description: Troubleshooting metric value for AP client count
          examples:
          - -0.6565111
        ap_rtt:
          type: number
          description: Troubleshooting metric value for AP round-trip time
          examples:
          - 0.16559607
        client_cpu:
          type: number
          description: Troubleshooting metric value for client CPU load
          examples:
          - 3.7028809
        client_n_streams:
          type: number
          description: Troubleshooting metric value for the number of client spatial streams
          examples:
          - 0.15803306
        client_radio_band:
          type: number
          description: Troubleshooting metric value for the client radio band
          examples:
          - 0.5576923
        client_rssi:
          type: number
          description: Troubleshooting metric value for client RSSI
          examples:
          - -1.0839354
        client_rx_bytes:
          type: number
          description: Troubleshooting metric value for bytes received by the client
          examples:
          - 2.2622051
        client_rx_rates:
          type: number
          description: Troubleshooting metric value for client receive data rates
          examples:
          - 0.62357205
        client_rx_retries:
          type: number
          description: Troubleshooting metric value for client receive retries
          examples:
          - 0.26726437
        client_tx_bytes:
          type: number
          description: Troubleshooting metric value for bytes transmitted by the client
          examples:
          - 0.15803306
        client_tx_rates:
          type: number
          description: Troubleshooting metric value for client transmit data rates
          examples:
          - 0.62357205
        client_tx_retries:
          type: number
          description: Troubleshooting metric value for client transmit retries
          examples:
          - 0.77553505
        client_vpn_distance:
          type: number
          description: Troubleshooting metric value for client VPN distance
          examples:
          - 1.6474955
        client_wifi_version:
          type: number
          description: Troubleshooting metric value for the client Wi-Fi version
          examples:
          - 0.18267937
        expected:
          type: number
          description: Model baseline value expected for this media direction
          examples:
          - 30.941595
        radio_bandwidth:
          type: number
          description: Troubleshooting metric value for radio channel bandwidth
          examples:
          - -0.06538621
        radio_channel:
          type: number
          description: Troubleshooting metric value for the radio channel
          examples:
          - -0.73391086
        radio_tx_power:
          type: number
          description: Troubleshooting metric value for radio transmit power
          examples:
          - 0.10027129
        radio_util:
          type: number
          description: Troubleshooting metric value for radio utilization
          examples:
          - 12.770318
        radio_util_interference:
          type: number
          description: Troubleshooting metric value for radio interference utilization
          examples:
          - -3.079999
        site_num_clients:
          type: number
          description: Troubleshooting metric value for the number of clients at the site
          examples:
          - 0.017364305
        wan_avg_download_mbps:
          type: number
          description: Troubleshooting metric value for average WAN download throughput
          examples:
          - 1.4803165
        wan_avg_upload_mbps:
          type: number
          description: Troubleshooting metric value for average WAN upload throughput
          examples:
          - -0.038184267
        wan_jitter:
          type: number
          description: Troubleshooting metric value for WAN jitter
          examples:
          - 5.9680853
        wan_max_download_mbps:
          type: number
          description: Troubleshooting metric value for maximum WAN download throughput
          examples:
          - 1.4803165
        wan_max_upload_mbps:
          type: number
          description: Troubleshooting metric value for maximum WAN upload throughput
          examples:
          - -0.038184267
        wan_rtt:
          type: number
          description: Troubleshooting metric value for WAN round-trip time
          examples:
          - 46.77899
      description: Troubleshooting metrics for the outbound audio stream
    call_troubleshoot_data2:
      title: call_troubleshoot_data2
      type: object
      properties:
        ap_num_clients:
          type: number
          description: Troubleshooting metric value for AP client count
          examples:
          - -0.6565111
        ap_rtt:
          type: number
          description: Troubleshooting metric value for AP round-trip time
          examples:
          - 0.16559607
        client_cpu:
          type: number
          description: Troubleshooting metric value for client CPU load
          examples:
          - 3.7028809
        client_n_streams:
          type: number
          description: Troubleshooting metric value for the number of client spatial streams
          examples:
          - 0.15803306
        client_radio_band:
          type: number
          description: Troubleshooting metric value for the client radio band
          examples:
          - 0.5576923
        client_rssi:
          type: number
          description: Troubleshooting metric value for client RSSI
          examples:
          - -1.0839354
        client_rx_bytes:
          type: number
          description: Troubleshooting metric value for bytes received by the client
          examples:
          - 2.2622051
        client_rx_rates:
          type: number
          description: Troubleshooting metric value for client receive data rates
          examples:
          - 0.62357205
        client_rx_retries:
          type: number
          description: Troubleshooting metric value for client receive retries
          examples:
          - 0.26726437
        client_tx_bytes:
          type: number
          description: Troubleshooting metric value for bytes transmitted by the client
          examples:
          - 0.15803306
        client_tx_rates:
          type: number
          description: Troubleshooting metric value for client transmit data rates
          examples:
          - 0.62357205
        client_tx_retries:
          type: number
          description: Troubleshooting metric value for client transmit retries
          examples:
          - 0.77553505
        client_vpn_distance:
          type: number
          description: Troubleshooting metric value for client VPN distance
          examples:
          - 1.6474955
        client_wifi_version:
          type: number
          description: Troubleshooting metric value for the client Wi-Fi version
          examples:
          - 0.18267937
        expected:
          type: number
          description: Model baseline value expected for this media direction
          examples:
          - 30.941595
        radio_bandwidth:
          type: number
          description: Troubleshooting metric value for radio channel bandwidth
          examples:
          - -0.06538621
        radio_channel:
          type: number
          description: Troubleshooting metric value for the radio channel
          examples:
          - -0.73391086
        radio_tx_power:
          type: number
          description: Troubleshooting metric value for radio transmit power
          examples:
          - 0.10027129
        radio_util:
          type: number
          description: Troubleshooting metric value for radio utilization
          examples:
          - 12.770318
        radio_util_interference:
          type: number
          description: Troubleshooting metric value for radio interference utilization
          examples:
          - -3.079999
        site_num_clients:
          type: number
          description: Troubleshooting metric value for the number of clients at the site
          examples:
          - 0.017364305
        wan_avg_download_mbps:
          type: number
          description: Troubleshooting metric value for average WAN download throughput
          examples:
          - 1.4803165
        wan_avg_upload_mbps:
          type: number
          description: Troubleshooting metric value for average WAN upload throughput
          examples:
          - -0.038184267
        wan_jitter:
          type: number
          description: Troubleshooting metric value for WAN jitter
          examples:
          - 5.9680853
        wan_max_download_mbps:
          type: number
          description: Troubleshooting metric value for maximum WAN download throughput
          examples:
          - 1.4803165
        wan_max_upload_mbps:
          type: number
          description: Troubleshooting metric value for maximum WAN upload throughput
          examples:
          - -0.038184267
        wan_rtt:
          type: number
          description: Troubleshooting metric value for WAN round-trip time
          examples:
          - 46.77899
      description: Troubleshooting metrics for the inbound video stream
    call_troubleshoot_data3:
      title: call_troubleshoot_data3
      type: object
      properties:
        ap_num_clients:
          type: number
          description: Troubleshooting metric value for AP client count
          examples:
          - -0.6565111
        ap_rtt:
          type: number
          description: Troubleshooting metric value for AP round-trip time
          examples:
          - 0.16559607
        client_cpu:
          type: number
          description: Troubleshooting metric value for client CPU load
          examples:
          - 3.7028809
        client_n_streams:
          type: number
          description: Troubleshooting metric value for the number of client spatial streams
          examples:
          - 0.15803306
        client_radio_band:
          type: number
          description: Troubleshooting metric value for the client radio band
          examples:
          - 0.5576923
        client_rssi:
          type: number
          description: Troubleshooting metric value for client RSSI
          examples:
          - -1.0839354
        client_rx_bytes:
          type: number
          description: Troubleshooting metric value for bytes received by the client
          examples:
          - 2.2622051
        client_rx_rates:
          type: number
          description: Troubleshooting metric value for client receive data rates
          examples:
          - 0.62357205
        client_rx_retries:
          type: number
          description: Troubleshooting metric value for client receive retries
          examples:
          - 0.26726437
        client_tx_bytes:
          type: number
          description: Troubleshooting metric value for bytes transmitted by the client
          examples:
          - 0.15803306
        client_tx_rates:
          type: number
          description: Troubleshooting metric value for client transmit data rates
          examples:
          - 0.62357205
        client_tx_retries:
          type: number
          description: Troubleshooting metric value for client transmit retries
          examples:
          - 0.77553505
        client_vpn_distance:
          type: number
          description: Troubleshooting metric value for client VPN distance
          examples:
          - 1.6474955
        client_wifi_version:
          type: number
          description: Troubleshooting metric value for the client Wi-Fi version
          examples:
          - 0.18267937
        expected:
          type: number
          description: Model baseline value expected for this media direction
          examples:
          - 30.941595
        radio_bandwidth:
          type: number
          description: Troubleshooting metric value for radio channel bandwidth
          examples:
          - -0.06538621
        radio_channel:
          type: number
          description: Troubleshooting metric value for the radio channel
          examples:
          - -0.73391086
        radio_tx_power:
          type: number
          description: Troubleshooting metric value for radio transmit power
          examples:
          - 0.10027129
        radio_util:
          type: number
          description: Troubleshooting metric value for radio utilization
          examples:
          - 12.770318
        radio_util_interference:
          type: number
          description: Troubleshooting metric value for radio interference utilization
          examples:
          - -3.079999
        site_num_clients:
          type: number
          description: Troubleshooting metric value for the number of clients at the site
          examples:
          - 0.017364305
        wan_avg_download_mbps:
          type: number
          description: Troubleshooting metric value for average WAN download throughput
          examples:
          - 1.4803165
        wan_avg_upload_mbps:
          type: number
          description: Troubleshooting metric value for average WAN upload throughput
          examples:
          - -0.038184267
        wan_jitter:
          type: number
          description: Troubleshooting metric value for WAN jitter
          examples:
          - 5.9680853
        wan_max_download_mbps:
          type: number
          description: Troubleshooting metric value for maximum WAN download throughput
          examples:
          - 1.4803165
        wan_max_upload_mbps:
          type: number
          description: Troubleshooting metric value for maximum WAN upload throughput
          examples:
          - -0.038184267
        wan_rtt:
          type: number
          description: Troubleshooting metric value for WAN round-trip time
          examples:
          - 46.77899
      description: Troubleshooting metrics for the outbound video stream
    call_troubleshoot_data5:
      title: call_troubleshoot_data5
      type: object
      properties:
        ap_num_clients:
          type: number
          description: Troubleshooting metric value for AP client count
          examples:
          - -0.6565111
        ap_rtt:
          type: number
          description: Troubleshooting metric value for AP round-trip time
          examples:
          - 0.16559607
        client_cpu:
          type: number
          description: Troubleshooting metric value for client CPU load
          examples:
          - 3.7028809
        client_n_streams:
          type: number
          description: Troubleshooting metric value for the number of client spatial streams
          examples:
          - 0.15803306
        client_radio_band:
          type: number
          description: Troubleshooting metric value for the client radio band
          examples:
          - 0.5576923
        client_rssi:
          type: number
          description: Troubleshooting metric value for client RSSI
          examples:
          - -1.0839354
        client_rx_bytes:
          type: number
          description: Troubleshooting metric value for bytes received by the client
          examples:
          - 2.2622051
        client_rx_rates:
          type: number
          description: Troubleshooting metric value for client receive data rates
          examples:
          - 0.62357205
        client_rx_retries:
          type: number
          description: Troubleshooting metric value for client receive retries
          examples:
          - 0.26726437
        client_tx_bytes:
          type: number
          description: Troubleshooting metric value for bytes transmitted by the client
          examples:
          - 0.15803306
        client_tx_rates:
          type: number
          description: Troubleshooting metric value for client transmit data rates
          examples:
          - 0.62357205
        client_tx_retries:
          type: number
          description: Troubleshooting metric value for client transmit retries
          examples:
          - 0.77553505
        client_vpn_distance:
          type: number
          description: Troubleshooting metric value for client VPN distance
          examples:
          - 1.6474955
        client_wifi_version:
          type: number
          description: Troubleshooting metric value for the client Wi-Fi version
          examples:
          - 0.18267937
        expected:
          type: number
          description: Model baseline value expected for this media direction
          examples:
          - 30.941595
        radio_bandwidth:
          type: number
          description: Troubleshooting metric value for radio channel bandwidth
          examples:
          - -0.06538621
        radio_channel:
          type: number
          description: Troubleshooting metric value for the radio channel
          examples:
          - -0.73391086
        radio_tx_power:
          type: number
          description: Troubleshooting metric value for radio transmit power
          examples:
          - 0.10027129
        radio_util:
          type: number
          description: Troubleshooting metric value for radio utilization
          examples:
          - 12.770318
        radio_util_interference:
          type: number
          description: Troubleshooting metric value for radio interference utilization
          examples:
          - -3.079999
        site_num_clients:
          type: number
          description: Troubleshooting metric value for the number of clients at the site
          examples:
          - 0.017364305
        wan_avg_download_mbps:
          type: number
          description: Troubleshooting metric value for average WAN download throughput
          examples:
          - 1.4803165
        wan_avg_upload_mbps:
          type: number
          description: Troubleshooting metric value for average WAN upload throughput
          examples:
          - -0.038184267
        wan_jitter:
          type: number
          description: Troubleshooting metric value for WAN jitter
          examples:
          - 5.9680853
        wan_max_download_mbps:
          type: number
          description: Troubleshooting metric value for maximum WAN download throughput
          examples:
          - 1.4803165
        wan_max_upload_mbps:
          type: number
          description: Troubleshooting metric value for maximum WAN upload throughput
          examples:
          - -0.038184267
        wan_rtt:
          type: number
          description: Troubleshooting metric value for WAN round-trip time
          examples:
          - 46.77899
      description: Troubleshooting metrics for the inbound audio stream
    call_troubleshoot_summary_data1:
      title: call_troubleshoot_summary_data1
      type: object
      properties:
        ap_num_clients:
          type: number
          description: Media-direction metric value for AP client count
          examples:
          - -0.6565111
        ap_rtt:
          type: number
          description: Media-direction metric value for AP round-trip time
          examples:
          - 0.16559607
        client_cpu:
          type: number
          description: Media-direction metric value for client CPU load
          examples:
          - 3.7028809
        client_n_streams:
          type: number
          description: Media-direction metric value for the number of client spatial streams
          examples:
          - 0.15803306
        client_radio_band:
          type: number
          description: Media-direction metric value for the client radio band
          examples:
          - 0.5576923
        client_rssi:
          type: number
          description: Media-direction metric value for client RSSI
          examples:
          - -1.0839354
        client_rx_bytes:
          type: number
          description: Media-direction metric value for bytes received by the client
          examples:
          - 2.2622051
        client_rx_rates:
          type: number
          description: Media-direction metric value for client receive data rates
          examples:
          - 0.26726437
        client_tx_bytes:
          type: number
          description: Media-direction metric value for bytes transmitted by the client
          examples:
          - 6.6164713
        client_tx_rates:
          type: number
          description: Media-direction metric value for client transmit data rates
          examples:
          - 0.62357205
        client_tx_retries:
          type: number
          description: Media-direction metric value for client transmit retries
          examples:
          - 1.702031
        client_vpn_distance:
          type: number
          description: Media-direction metric value for client VPN distance
          examples:
          - 1.6474955
        client_wifi_version:
          type: number
          description: Media-direction metric value for the client Wi-Fi version
          examples:
          - 0.18267937
        expected:
          type: number
          description: Model baseline value expected for this media direction
          examples:
          - 30.941595
        radio_bandwidth:
          type: number
          description: Media-direction metric value for radio channel bandwidth
          examples:
          - -0.06538621
        radio_channel:
          type: number
          description: Media-direction metric value for the radio channel
          examples:
          - -0.73391086
        radio_tx_power:
          type: number
          description: Media-direction metric value for radio transmit power
          examples:
          - 0.10027129
        radio_util:
          type: number
          description: Media-direction metric value for radio utilization
          examples:
          - 12.770318
        radio_util_interference:
          type: number
          description: Media-direction metric value for radio interference utilization
          examples:
          - -3.079999
        site_num_clients:
          type: number
          description: Media-direction metric value for the number of clients at the site
          examples:
          - 0.017364305
        site_wan_avg_download_mbps:
          type: number
          description: Media-direction metric value for site WAN average download throughput
          examples:
          - 3.0566701889E-07
        site_wan_avg_upload_mbps:
          type: number
          description: Media-direction metric value for site WAN average upload throughput
          examples:
          - 5.566701889E-08
        site_wan_download_mbps:
          type: number
          description: Media-direction metric value for site WAN download throughput
          examples:
          - 8.0566701889E-07
        site_wan_jitter:
          type: number
          description: Media-direction metric value for site WAN jitter
          examples:
          - 0.7875519659784105
        site_wan_rtt:
          type: number
          description: Media-direction metric value for site WAN round-trip time
          examples:
          - 15.094849904378256
        site_wan_upload_mbps:
          type: number
          description: Media-direction metric value for site WAN upload throughput
          examples:
          - 2.0566701889E-07
        wan_avg_download_mbps:
          type: number
          description: Media-direction metric value for average WAN download throughput
          examples:
          - 1.4803165
        wan_avg_upload_mbps:
          type: number
          description: Media-direction metric value for average WAN upload throughput
          examples:
          - -0.038184267
        wan_jitter:
          type: number
          description: Media-direction metric value for WAN jitter
          examples:
          - 5.9680853
        wan_max_download_mbps:
          type: number
          description: Media-direction metric value for maximum WAN download throughput
          examples:
          - 1.4803165
        wan_max_upload_mbps:
          type: number
          description: Media-direction metric value for maximum WAN upload throughput
          examples:
          - -0.038184267
        wan_rtt:
          type: number
          description: Media-direction metric value for WAN round-trip time
          examples:
          - 46.77899
      description: Troubleshooting metrics for the outbound audio stream
    call_troubleshoot_summary_data2:
      title: call_troubleshoot_summary_data2
      type: object
      properties:
        ap_num_clients:
          type: number
          description: Media-direction metric value for AP client count
          examples:
          - -0.6565111
        ap_rtt:
          type: number
          description: Media-direction metric value for AP round-trip time
          examples:
          - 0.16559607
        client_cpu:
          type: number
          description: Media-direction metric value for client CPU load
          examples:
          - 3.7028809
        client_n_streams:
          type: number
          description: Media-direction metric value for the number of client spatial streams
          examples:
          - 0.15803306
        client_radio_band:
          type: number
          description: Media-direction metric value for the client radio band
          examples:
          - 0.5576923
        client_rssi:
          type: number
          description: Media-direction metric value for client RSSI
          examples:
          - -1.0839354
        client_rx_bytes:
          type: number
          description: Media-direction metric value for bytes received by the client
          examples:
          - 2.2622051
        client_rx_rates:
          type: number
          description: Media-direction metric value for client receive data rates
          examples:
          - 0.26726437
        client_tx_bytes:
          type: number
          description: Media-direction metric value for bytes transmitted by the client
          examples:
          - 6.6164713
        client_tx_rates:
          type: number
          description: Media-direction metric value for client transmit data rates
          examples:
          - 0.62357205
        client_tx_retries:
          type: number
          description: Media-direction metric value for client transmit retries
          examples:
          - 1.702031
        client_vpn_distance:
          type: number
          description: Media-direction metric value for client VPN distance
          examples:
          - 1.6474955
        client_wifi_version:
          type: number
          description: Media-direction metric value for the client Wi-Fi version
          examples:
          - 0.18267937
        expected:
          type: number
          description: Model baseline value expected for this media direction
          examples:
          - 30.941595
        radio_bandwidth:
          type: number
          description: Media-direction metric value for radio channel bandwidth
          examples:
          - -0.06538621
        radio_channel:
          type: number
          description: Media-direction metric value for the radio channel
          examples:
          - -0.73391086
        radio_tx_power:
          type: number
          description: Media-direction metric value for radio transmit power
          examples:
          - 0.10027129
        radio_util:
          type: number
          description: Media-direction metric value for radio utilization
          examples:
          - 12.770318
        radio_util_interference:
          type: number
          description: Media-direction metric value for radio interference utilization
          examples:
          - -3.079999
        site_num_clients:
          type: number
          description: Media-direction metric value for the number of clients at the site
          examples:
          - 0.017364305
        site_wan_avg_download_mbps:
          type: number
          description: Media-direction metric value for site WAN average download throughput
          examples:
          - 3.0566701889E-07
        site_wan_avg_upload_mbps:
          type: number
          description: Media-direction metric value for site WAN average upload throughput
          examples:
          - 5.566701889E-08
        site_wan_download_mbps:
          type: number
          description: Media-direction metric value for site WAN download throughput
          examples:
          - 8.0566701889E-07
        site_wan_jitter:
          type: number
          description: Media-direction metric value for site WAN jitter
          examples:
          - 0.7875519659784105
        site_wan_rtt:
          type: number
          description: Media-direction metric value for site WAN round-trip time
          examples:
          - 15.094849904378256
        site_wan_upload_mbps:
          type: number
          description: Media-direction metric value for site WAN upload throughput
          examples:
          - 2.0566701889E-07
        wan_avg_download_mbps:
          type: number
          description: Media-direction metric value for average WAN download throughput
          examples:
          - 1.4803165
        wan_avg_upload_mbps:
          type: number
          description: Media-direction metric value for average WAN upload throughput
          examples:
          - -0.038184267
        wan_jitter:
          type: number
          description: Media-direction metric value for WAN jitter
          examples:
          - 5.9680853
        wan_max_download_mbps:
          type: number
          description: Media-direction metric value for maximum WAN download throughput
          examples:
          - 1.4803165
        wan_max_upload_mbps:
          type: number
          description: Media-direction metric value for maximum WAN upload throughput
          examples:
          - -0.038184267
        wan_rtt:
          type: number
          description: Media-direction metric value for WAN round-trip time
          examples:
          - 46.77899
      description: Troubleshooting metrics for the inbound video stream
    call_troubleshoot_summary_data3:
      title: call_troubleshoot_summary_data3
      type: object
      properties:
        ap_num_clients:
          type: number
          description: Media-direction metric value for AP client count
          examples:
          - -0.6565111
        ap_rtt:
          type: number
          description: Media-direction metric value for AP round-trip time
          examples:
          - 0.16559607
        client_cpu:
          type: number
          description: Media-direction metric value for client CPU load
          examples:
          - 3.7028809
        client_n_streams:
          type: number
          description: Media-direction metric value for the number of client spatial streams
          examples:
          - 0.15803306
        client_radio_band:
          type: number
          description: Media-direction metric value for the client radio band
          examples:
          - 0.5576923
        client_rssi:
          type: number
          description: Media-direction metric value for client RSSI
          examples:
          - -1.0839354
        client_rx_bytes:
          type: number
          description: Media-direction metric value for bytes received by the client
          examples:
          - 2.2622051
        client_rx_rates:
          type: number
          description: Media-direction metric value for client receive data rates
          examples:
          - 0.26726437
        client_tx_bytes:
          type: number
          description: Media-direction metric value for bytes transmitted by the client
          examples:
          - 6.6164713
        client_tx_rates:
          type: number
          description: Media-direction metric value for client transmit data rates
          examples:
          - 0.62357205
        client_tx_retries:
          type: number
          description: Media-direction metric value for client transmit retries
          examples:
          - 1.702031
        client_vpn_distance:
          type: number
          description: Media-direction metric value for client VPN distance
          examples:
          - 1.6474955
        client_wifi_version:
          type: number
          description: Media-direction metric value for the client Wi-Fi version
          examples:
          - 0.18267937
        expected:
          type: number
          description: Model baseline value expected for this media direction
          examples:
          - 30.941595
        radio_bandwidth:
          type: number
          description: Media-direction metric value for radio channel bandwidth
          examples:
          - -0.06538621
        radio_channel:
          type: number
          description: Media-direction metric value for the radio channel
          examples:
          - -0.73391086
        radio_tx_power:
          type: number
          description: Media-direction metric value for radio transmit power
          examples:
          - 0.10027129
        radio_util:
          type: number
          description: Media-direction metric value for radio utilization
          examples:
          - 12.770318
        radio_util_interference:
          type: number
          description: Media-direction metric value for radio interference utilization
          examples:
          - -3.079999
        site_num_clients:
          type: number
          description: Media-direction metric value for the number of clients at the site
          examples:
          - 0.017364305
        site_wan_avg_download_mbps:
          type: number
          description: Media-direction metric value for site WAN average download throughput
          examples:
          - 3.0566701889E-07
        site_wan_avg_upload_mbps:
          type: number
          description: Media-direction metric value for site WAN average upload throughput
          examples:
          - 5.566701889E-08
        site_wan_download_mbps:
          type: number
          description: Media-direction metric value for site WAN download throughput
          examples:
          - 8.0566701889E-07
        site_wan_jitter:
          type: number
          description: Media-direction metric value for site WAN jitter
          examples:
          - 0.7875519659784105
        site_wan_rtt:
          type: number
          description: Media-direction metric value for site WAN round-trip time
          examples:
          - 15.094849904378256
        site_wan_upload_mbps:
          type: number
          description: Media-direction metric value for site WAN upload throughput
          examples:
          - 2.0566701889E-07
        wan_avg_download_mbps:
          type: number
          description: Media-direction metric value for average WAN download throughput
          examples:
          - 1.4803165
        wan_avg_upload_mbps:
          type: number
          description: Media-direction metric value for average WAN upload throughput
          examples:
          - -0.038184267
        wan_jitter:
          type: number
          description: Media-direction metric value for WAN jitter
          examples:
          - 5.9680853
        wan_max_download_mbps:
          type: number
          description: Media-direction metric value for maximum WAN download throughput
          examples:
          - 1.4803165
        wan_max_upload_mbps:
          type: number
          description: Media-direction metric value for maximum WAN upload throughput
          examples:
          - -0.038184267
        wan_rtt:
          type: number
          description: Media-direction metric value for WAN round-trip time
          examples:
          - 46.77899
      description: Troubleshooting metrics for the outbound video stream
    call_troubleshoot_summary_data5:
      title: call_troubleshoot_summary_data5
      type: object
      properties:
        ap_num_clients:
          type: number
          description: Media-direction metric value for AP client count
          examples:
          - -0.6565111
        ap_rtt:
          type: number
          description: Media-direction metric value for AP round-trip time
          examples:
          - 0.16559607
        client_cpu:
          type: number
          description: Media-direction metric value for client CPU load
          examples:
          - 3.7028809
        client_n_streams:
          type: number
          description: Media-direction metric value for the number of client spatial streams
          examples:
          - 0.15803306
        client_radio_band:
          type: number
          description: Media-direction metric value for the client radio band
          examples:
          - 0.5576923
        client_rssi:
          type: number
          description: Media-direction metric value for client RSSI
          examples:
          - -1.0839354
        client_rx_bytes:
          type: number
          description: Media-direction metric value for bytes received by the client
          examples:
          - 2.2622051
        client_rx_rates:
          type: number
          description: Media-direction metric value for client receive data rates
          examples:
          - 0.26726437
        client_tx_bytes:
          type: number
          description: Media-direction metric value for bytes transmitted by the client
          examples:
          - 6.6164713
        client_tx_rates:
          type: number
          description: Media-direction metric value for client transmit data rates
          examples:
          - 0.62357205
        client_tx_retries:
          type: number
          description: Media-direction metric value for client transmit retries
          examples:
          - 1.702031
        client_vpn_distance:
          type: number
          description: Media-direction metric value for client VPN distance
          examples:
          - 1.6474955
        client_wifi_version:
          type: number
          description: Media-direction metric value for the client Wi-Fi version
          examples:
          - 0.18267937
        expected:
          type: number
          description: Model baseline value expected for this media direction
          examples:
          - 30.941595
        radio_bandwidth:
          type: number
          description: Media-direction metric value for radio channel bandwidth
          examples:
          - -0.06538621
        radio_channel:
          type: number
          description: Media-direction metric value for the radio channel
          examples:
          - -0.73391086
        radio_tx_power:
          type: number
          description: Media-direction metric value for radio transmit power
          examples:
          - 0.10027129
        radio_util:
          type: number
          description: Media-direction metric value for radio utilization
          examples:
          - 12.770318
        radio_util_interference:
          type: number
          description: Media-direction metric value for radio interference utilization
          examples:
          - -3.079999
        site_num_clients:
          type: number
          description: Media-direction metric value for the number of clients at the site
          examples:
          - 0.017364305
        site_wan_avg_download_mbps:
          type: number
          description: Media-direction metric value for site WAN average download throughput
          examples:
          - 3.0566701889E-07
        site_wan_avg_upload_mbps:
          type: number
          description: Media-direction metric value for site WAN average upload throughput
          examples:
          - 5.566701889E-08
        site_wan_download_mbps:
          type: number
          description: Media-direction metric value for site WAN download throughput
          examples:
          - 8.0566701889E-07
        site_wan_jitter:
          type: number
          description: Media-direction metric value for site WAN jitter
          examples:
          - 0.7875519659784105
        site_wan_rtt:
          type: number
          description: Media-direction metric value for site WAN round-trip time
          examples:
          - 15.094849904378256
        site_wan_upload_mbps:
          type: number
          description: Media-direction metric value for site WAN upload throughput
          examples:
          - 2.0566701889E-07
        wan_avg_download_mbps:
          type: number
          description: Media-direction metric value for average WAN download throughput
          examples:
          - 1.4803165
        wan_avg_upload_mbps:
          type: number
          description: Media-direction metric value for average WAN upload throughput
          examples:
          - -0.038184267
        wan_jitter:
          type: number
          description: Media-direction metric value for WAN jitter
          examples:
          - 5.9680853
        wan_max_download_mbps:
          type: number
          description: Media-direction metric value for maximum WAN download throughput
          examples:
          - 1.4803165
        wan_max_upload_mbps:
          type: number
          description: Media-direction metric value for maximum WAN upload throughput
          examples:
          - -0.038184267
        wan_rtt:
          type: number
          description: Media-direction metric value for WAN round-trip time
          examples:
          - 46.77899
      description: Troubleshooting metrics for the inbound audio stream
    capture_gateway_format2:
      title: capture_gateway_format2
      const: stream
      type: string
      description: 'Output format for the gateway packet capture. enum: `stream`.'
      examples:
      - stream
    capture_mxedge_format2:
      title: capture_mxedge_format2
      enum:
      - stream
      - tzsp
      type: string
      description: 'Output format for packet capture data. enum: `stream`, `tzsp`.'
    capture_mxedge_format3:
      title: capture_mxedge_format3
      enum:
      - stream
      - tzsp
      type: string
      description: 'Output format for the Mist Edge packet capture. enum: `stream`, `tzsp`.'
    capture_radiotap_band2:
      title: capture_radiotap_band2
      enum:
      - '24'
      - 24,5,6
      - '5'
      - '6'
      type: string
      description: 'Radio band to capture for radiotap packets. enum: `24`, `24,5,6`, `5`, `6`.'
      examples:
      - '24'
    capture_radiotap_format2:
      title: capture_radiotap_format2
      enum:
      - pcap
      - stream
      type: string
      description: 'Output format for the radiotap packet capture. enum: `pcap`, `stream`.'
      examples:
      - stream
    capture_radiotapwired_band2:
      title: capture_radiotapwired_band2
      enum:
      - '24'
      - 24,5,6
      - '5'
      - '6'
      type: string
      description: 'Radio band to capture for the radiotap portion. enum: `24`, `24,5,6`, `5`, `6`.'
      examples:
      - '24'
    capture_radiotapwired_format2:
      title: capture_radiotapwired_format2
      enum:
      - pcap
      - stream
      type: string
      description: 'Output format for the combined packet capture. enum: `pcap`, `stream`.'
      examples:
      - stream
    capture_scan_aps_band2:
      title: capture_scan_aps_band2
      enum:
      - '24'
      - '5'
      - '6'
      type: string
      description: 'Radio band on which to start the scan capture. enum: `24`, `5`, `6`.'
    capture_scan_band2:
      title: capture_scan_band2
      enum:
      - '24'
      - '5'
      - '6'
      type: string
      description: 'Radio band to capture for scan radio packets. enum: `24`, `5`, `6`.'
      examples:
      - '24'
    capture_scan_format2:
      title: capture_scan_format2
      enum:
      - pcap
      - stream
      type: string
      description: 'Output format for the scan radio packet capture. enum: `pcap`, `stream`.'
      examples:
      - stream
    capture_switch_format2:
      title: capture_switch_format2
      const: stream
      type: string
      description: 'Output format for the switch packet capture. enum: `stream`.'
    capture_wired_format2:
      title: capture_wired_format2
      enum:
      - pcap
      - stream
      type: string
      description: 'Output format for the wired packet capture. enum: `pcap`, `stream`.'
    capture_wireless_band2:
      title: capture_wireless_band2
      enum:
      - '24'
      - '5'
      - '6'
      type: string
      description: 'Radio band to capture for wireless packets. enum: `24`, `5`, `6`.'
    capture_wireless_format2:
      title: capture_wireless_format2
      enum:
      - pcap
      - stream
      type: string
      description: 'Output format for the wireless packet capture. enum: `pcap`, `stream`.'
    claim_type_async2:
      title: claim_type_async2
      enum:
      - all
      - inventory
      type: string
      description: Claim scope; `all` claims licenses synchronously and queues inventory, `inventory` queues inventory only
    claim_type2:
      title: claim_type2
      enum:
      - all
      - inventory
      - license
      type: string
      description: Claim scope, such as all, inventory, or license
    client_key_mgmt1:
      title: client_key_mgmt1
      enum:
      - WPA2-PSK
      - WPA2-PSK/CCMP
      - WPA2-PSK-FT
      - WPA2-PSK-SHA256
      - WPA3-EAP-SHA256
      - WPA3-EAP-SHA256/CCMP
      - WPA3-EAP-FT/GCMP256
      - WPA3-SAE-FT
      - WPA3-SAE-PSK
      type: string
      description: 'Key management protocol used by the client session. enum: `WPA2-PSK`, `WPA2-PSK/CCMP`, `WPA2-PSK-FT`, `WPA2-PSK-SHA256`, `WPA3-EAP-SHA256`, `WPA3-EAP-SHA256/CCMP`, `WPA3-EAP-FT/GCMP256`, `WPA3-SAE-FT`, `WPA3-SAE-PSK`.'
      examples:
      - WPA2-PSK
    config_switch_local_accounts_user_role2:
      title: config_switch_local_accounts_user_role2
      enum:
      - admin
      - helpdesk
      - none
      - read
      type: string
      description: 'Access role granted to the local switch user account. enum: `admin`, `helpdesk`, `none`, `read`.'
    const_app_category_definition_filters2:
      title: const_app_category_definition_filters2
      type: object
      properties:
        srx:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Application signature names for SRX platforms included in this category
        ssr:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Application identifiers for SSR platforms included in this category
      description: Platform-specific application signatures included in this category
      examples:
      - srx:
        - Enhanced_Images_Media
        - Enhanced_Web_Images
        - Enhanced_Image_Servers
    const_device_ap_band52:
      title: const_device_ap_band52
      type: object
      properties:
        max_clients:
          type: integer
          description: Maximum client count supported on the 5 GHz radio
          contentEncoding: int32
          examples:
          - 128
        max_power:
          type: integer
          description: Maximum transmit power for the 5 GHz radio, in dBm
          contentEncoding: int32
          examples:
          - 17
        min_power:
          type: integer
          description: Minimum transmit power for the 5 GHz radio, in dBm
          contentEncoding: int32
          examples:
          - 8
      description: 5 GHz radio capability limits for this AP model
    const_device_ap_band62:
      title: const_device_ap_band62
      type: object
      properties:
        max_clients:
          type: integer
          description: Maximum client count supported on the 6 GHz radio
          contentEncoding: int32
          examples:
          - 128
        max_power:
          type: integer
          description: Maximum transmit power for the 6 GHz radio, in dBm
          contentEncoding: int32
          examples:
          - 17
        min_power:
          type: integer
          description: Minimum transmit power for the 6 GHz radio, in dBm
          contentEncoding: int32
          examples:
          - 8
      description: 6 GHz radio capability limits for this AP model
    const_device_ap_band242:
      title: const_device_ap_band242
      type: object
      properties:
        band5_channels_op:
          type: string
          description: 5 GHz channel set used when this radio operates on 5 GHz
          examples:
          - low
        max_clients:
          type: integer
          description: Maximum client count supported on the 2.4 GHz radio
          contentEncoding: int32
          examples:
          - 128
        max_power:
          type: integer
          description: Maximum transmit power for the 2.4 GHz radio, in dBm
          contentEncoding: int32
          examples:
          - 19
        min_power:
          type: integer
          description: Minimum transmit power for the 2.4 GHz radio, in dBm
          contentEncoding: int32
          examples:
          - 8
      description: 2.4 GHz radio capability limits for this AP model
    const_device_ap_extios_default_dir2:
      title: const_device_ap_extios_default_dir2
      enum:
      - IN
      - OUT
      type: string
      description: 'Default direction for this external I/O port. enum: `IN`, `OUT`.'
    const_device_ap_vble2:
      title: const_device_ap_vble2
      type: object
      properties:
        beacon_rate:
          type: integer
          description: Advertisement rate for the virtual BLE beacon
          contentEncoding: int32
          examples:
          - 4
        beams:
          type: integer
          description: Number of virtual BLE beams supported by the AP model
          contentEncoding: int32
          examples:
          - 9
        power:
          type: integer
          description: Transmit power for virtual BLE beacons, in dBm
          contentEncoding: int32
          examples:
          - 8
      description: Virtual BLE (vBLE) capability settings for this AP model
    const_device_gateway_ports2:
      title: const_device_gateway_ports2
      type: object
      properties:
        display:
          type: string
          description: User-facing interface name for the gateway port
        pci_address:
          type: string
          description: PCI address for the gateway port
        speed:
          type: integer
          description: Port speed for the gateway interface, in Mbps
          contentEncoding: int32
      description: Per-interface metadata for this gateway model
    const_device_switch_default2:
      title: const_device_switch_default2
      type: object
      properties:
        _ports:
          type: string
          description: Default switch port range list for this model
          examples:
          - ge-0/0/0-47, et-0/1/0-3, xe-0/2/0-3, ge-0/2/0-3
      description: Default port mappings for this switch model
    const_insight_metrics_property_example_any_of2:
      title: const_insight_metrics_property_example_any_of2
      type: object
      description: Sample values returned for this insight metric
    cpu_stat1:
      title: cpu_stat1
      type: object
      properties:
        idle:
          type:
          - number
          - 'null'
          description: Percentage of CPU time that is idle
          readOnly: true
        interrupt:
          type:
          - number
          - 'null'
          description: Percentage of CPU time being used by interrupts
          readOnly: true
        load_avg:
          type: array
          items:
            type: number
          description: Load averages for the last 1, 5, and 15 minutes
        system:
          type:
          - number
          - 'null'
          description: Percentage of CPU time being used by system processes
          readOnly: true
        usage:
          type:
          - number
          - 'null'
          description: Overall CPU usage percentage
          readOnly: true
        user:
          type:
          - number
          - 'null'
          description: Percentage of CPU time being used by user processes
          readOnly: true
      description: Processor utilization statistics for the switch module
    cpu_stat2:
      title: cpu_stat2
      type: object
      properties:
        idle:
          type:
          - number
          - 'null'
          description: Percentage of CPU time that is idle
          readOnly: true
        interrupt:
          type:
          - number
          - 'null'
          description: Percentage of CPU time being used by interrupts
          readOnly: true
        load_avg:
          type: array
          items:
            type: number
          description: Load averages for the last 1, 5, and 15 minutes
        system:
          type:
          - number
          - 'null'
          description: Percentage of CPU time being used by system processes
          readOnly: true
        usage:
          type:
          - number
          - 'null'
          description: Overall CPU usage percentage
          readOnly: true
        user:
          type:
          - number
          - 'null'
          description: Percentage of CPU time being used by user processes
          readOnly: true
      description: Processor utilization statistics for the switch
    cpu_stat3:
      title: cpu_stat3
      type: object
      properties:
        idle:
          type:
          - number
          - 'null'
          description: Percentage of CPU time that is idle
          readOnly: true
        interrupt:
          type:
          - number
          - 'null'
          description: Percentage of CPU time being used by interrupts
          readOnly: true
        load_avg:
          type: array
          items:
            type: number
          description: Load averages for the last 1, 5, and 15 minutes
        system:
          type:
          - number
          - 'null'
          description: Percentage of CPU time being used by system processes
          readOnly: true
        usage:
          type:
          - number
          - 'null'
          description: Overall CPU usage percentage
          readOnly: true
        user:
          type:
          - number
          - 'null'
          description: Percentage of CPU time being used by user processes
          readOnly: true
      description: Processor utilization statistics for the secondary HA node
    cpu_stat4:
      title: cpu_stat4
      type: object
      properties:
        idle:
          type:
          - number
          - 'null'
          description: Percentage of CPU time that is idle
          readOnly: true
        interrupt:
          type:
          - number
          - 'null'
          description: Percentage of CPU time being used by interrupts
          readOnly: true
        load_avg:
          type: array
          items:
            type: number
          description: Load averages for the last 1, 5, and 15 minutes
        system:
          type:
          - number
          - 'null'
          description: Percentage of CPU time being used by system processes
          readOnly: true
        usage:
          type:
          - number
          - 'null'
          description: Overall CPU usage percentage
          readOnly: true
        user:
          type:
          - number
          - 'null'
          description: Percentage of CPU time being used by user processes
          readOnly: true
      description: Processor utilization statistics for the gateway or primary HA node
    day_of_week1:
      title: day_of_week1
      enum:
      - any
      - fri
      - mon
      - sat
      - sun
      - thu
      - tue
      - wed
      type: string
      description: 'Scheduled weekday for automatic signature updates. enum: `any`, `fri`, `mon`, `sat`, `sun`, `thu`, `tue`, `wed`.'
    day_of_week3:
      title: day_of_week3
      enum:
      - any
      - fri
      - mon
      - sat
      - sun
      - thu
      - tue
      - wed
      type: string
      description: 'Day of the week for the AP auto-upgrade maintenance window. enum: `any`, `fri`, `mon`, `sat`, `sun`, `thu`, `tue`, `wed`.'
    day_of_week4:
      title: day_of_week4
      enum:
      - any
      - fri
      - mon
      - sat
      - sun
      - thu
      - tue
      - wed
      type: string
      description: 'Weekly AP auto-upgrade day for the maintenance window. enum: `any`, `fri`, `mon`, `sat`, `sun`, `thu`, `tue`, `wed`.'
    day_of_week5:
      title: day_of_week5
      enum:
      - any
      - fri
      - mon
      - sat
      - sun
      - thu
      - tue
      - wed
      type: string
      description: 'Weekly ESL auto-upgrade day for the maintenance window. enum: `any`, `fri`, `mon`, `sat`, `sun`, `thu`, `tue`, `wed`.'
    day_of_week6:
      title: day_of_week6
      enum:
      - any
      - fri
      - mon
      - sat
      - sun
      - thu
      - tue
      - wed
      type: string
      description: 'Day of week when the automatic upgrade window runs. enum: `any`, `fri`, `mon`, `sat`, `sun`, `thu`, `tue`, `wed`.'
    day_of_week7:
      title: day_of_week7
      enum:
      - any
      - fri
      - mon
      - sat
      - sun
      - thu
      - tue
      - wed
      type: string
      description: 'Scheduled weekday for auto preemption. enum: `any`, `fri`, `mon`, `sat`, `sun`, `thu`, `tue`, `wed`.'
    delivery1:
      title: delivery1
      required:
      - enabled
      type: object
      properties:
        additional_emails:
          type: array
          items:
            type: string
          description: Additional email recipients for alarm delivery
        enabled:
          type: boolean
          description: Whether to enable the alarm delivery via emails or not
          examples:
          - true
        to_org_admins:
          type: boolean
          description: Whether to deliver the alarms via emails to Org admins or not
          examples:
          - true
        to_site_admins:
          type: boolean
          description: Whether to deliver the alarms via emails to Site admins or not
          examples:
          - false
      description: Overrides for the alarm template delivery defaults for this alarm rule
    delivery3:
      title: delivery3
      required:
      - enabled
      type: object
      properties:
        additional_emails:
          type: array
          items:
            type: string
          description: Additional email recipients for alarm delivery
        enabled:
          type: boolean
          description: Whether to enable the alarm delivery via emails or not
          examples:
          - true
        to_org_admins:
          type: boolean
          description: Whether to deliver the alarms via emails to Org admins or not
          examples:
          - true
        to_site_admins:
          type: boolean
          description: Whether to deliver the alarms via emails to Site admins or not
          examples:
          - false
      description: Default alarm delivery settings for rules in this template
    device_ap_lacp_config2:
      title: device_ap_lacp_config2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether to enable LACP on supported AP Ethernet uplinks
          default: false
      description: Link aggregation defaults for supported AP Ethernet uplinks
    device_ap_lacp_config3:
      title: device_ap_lacp_config3
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether to enable LACP on supported AP Ethernet uplinks
          default: false
      description: Link aggregation settings for supported AP Ethernet uplinks
    device_search_radius_filter_status1:
      title: device_search_radius_filter_status1
      enum:
      - up
      - down
      - unreachable
      type: string
      description: 'RADIUS authentication server status for this server in device search results. enum: `up`, `down`, `unreachable`.'
    device_type_default_ap1:
      title: device_type_default_ap1
      enum:
      - ap
      - gateway
      - switch
      type: string
      description: 'If only intended to claim a certain device type, specify it here. enum: `ap`, `gateway`, `switch`.'
    device_type_default_ap3:
      title: device_type_default_ap3
      enum:
      - ap
      - gateway
      - switch
      type: string
      description: 'Device type for this inventory record. enum: `ap`, `gateway`, `switch`.'
    device_type_default_ap4:
      title: device_type_default_ap4
      enum:
      - ap
      - gateway
      - switch
      type: string
      description: 'Device type for this inventory search result. enum: `ap`, `gateway`, `switch`.'
    device_type_default_ap5:
      title: device_type_default_ap5
      enum:
      - ap
      - gateway
      - switch
      type: string
      description: 'Device type filter for this naming rule. enum: `ap`, `gateway`, `switch`.'
    device_type_default_ap6:
      title: device_type_default_ap6
      enum:
      - ap
      - gateway
      - switch
      type: string
      description: 'Device type filter that limits which claimed devices this rule applies to. enum: `ap`, `gateway`, `switch`.'
    device_type2:
      title: device_type2
      enum:
      - ap
      - gateway
      - switch
      type: string
      description: 'Device category for the inventory item. enum: `ap`, `gateway`, `switch`.'
    device_type3:
      title: device_type3
      enum:
      - ap
      - gateway
      - switch
      type: string
      description: 'Type of network device that received the CoA command. enum: `ap`, `gateway`, `switch`.'
    device_type4:
      title: device_type4
      enum:
      - ap
      - gateway
      - switch
      type: string
      description: 'Device category that ran the synthetic test. enum: `ap`, `gateway`, `switch`.'
    device_type5:
      title: device_type5
      enum:
      - ap
      - gateway
      - switch
      type: string
      description: 'Device family selected for the organization upgrade. enum: `ap`, `gateway`, `switch`.'
    device_type6:
      title: device_type6
      enum:
      - ap
      - gateway
      - switch
      type: string
      description: 'Device type associated with the event. enum: `ap`, `gateway`, `switch`.'
    dhcp_snooping1:
      title: dhcp_snooping1
      type: object
      properties:
        all_networks:
          type: boolean
          description: Whether DHCP snooping applies to all configured networks
        enable_arp_spoof_check:
          type: boolean
          description: Enable for dynamic ARP inspection check
        enable_ip_source_guard:
          type: boolean
          description: Enable for check for forging source IP address
        enabled:
          type: boolean
          description: Whether DHCP snooping is enabled
        networks:
          type: array
          items:
            type: string
          description: Network names with DHCP snooping enabled when `all_networks`==`false`
      description: DHCP snooping defaults provided by this switch profile
    dhcp_snooping3:
      title: dhcp_snooping3
      type: object
      properties:
        all_networks:
          type: boolean
          description: Whether DHCP snooping applies to all configured networks
        enable_arp_spoof_check:
          type: boolean
          description: Enable for dynamic ARP inspection check
        enable_ip_source_guard:
          type: boolean
          description: Enable for check for forging source IP address
        enabled:
          type: boolean
          description: Whether DHCP snooping is enabled
        networks:
          type: array
          items:
            type: string
          description: Network names with DHCP snooping enabled when `all_networks`==`false`
      description: DHCP snooping defaults provided by this network template
    dhcp_snooping4:
      title: dhcp_snooping4
      type: object
      properties:
        all_networks:
          type: boolean
          description: Whether DHCP snooping applies to all configured networks
        enable_arp_spoof_check:
          type: boolean
          description: Enable for dynamic ARP inspection check
        enable_ip_source_guard:
          type: boolean
          description: Enable for check for forging source IP address
        enabled:
          type: boolean
          description: Whether DHCP snooping is enabled
        networks:
          type: array
          items:
            type: string
          description: Network names with DHCP snooping enabled when `all_networks`==`false`
      description: Layer 2 DHCP snooping settings for the site
    dhcp_snooping5:
      title: dhcp_snooping5
      type: object
      properties:
        all_networks:
          type: boolean
          description: Whether DHCP snooping applies to all configured networks
        enable_arp_spoof_check:
          type: boolean
          description: Enable for dynamic ARP inspection check
        enable_ip_source_guard:
          type: boolean
          description: Enable for check for forging source IP address
        enabled:
          type: boolean
          description: Whether DHCP snooping is enabled
        networks:
          type: array
          items:
            type: string
          description: Network names with DHCP snooping enabled when `all_networks`==`false`
      description: DHCP snooping configuration for this switch
    dhcpd_config_option_type2:
      title: dhcpd_config_option_type2
      enum:
      - boolean
      - hex
      - int16
      - int32
      - ip
      - string
      - uint16
      - uint32
      type: string
      description: 'Data type used to encode this DHCP option value. enum: `boolean`, `hex`, `int16`, `int32`, `ip`, `string`, `uint16`, `uint32`.'
    dhcpd_config_type2:
      title: dhcpd_config_type2
      enum:
      - local
      - none
      - relay
      type: string
      description: 'IPv4 DHCP mode for this network. enum: `local`, `none`, `relay`.'
    dhcpd_config_type62:
      title: dhcpd_config_type62
      enum:
      - local
      - none
      - relay
      type: string
      description: 'IPv6 DHCP mode for this network. enum: `local`, `none`, `relay`.'
    dhcpd_config_vendor_option_type2:
      title: dhcpd_config_vendor_option_type2
      enum:
      - boolean
      - hex
      - int16
      - int32
      - ip
      - string
      - uint16
      - uint32
      type: string
      description: 'Data type used to encode this vendor option value. enum: `boolean`, `hex`, `int16`, `int32`, `ip`, `string`, `uint16`, `uint32`.'
    dhcpd_config1:
      title: dhcpd_config1
      type: object
      properties:
        enabled:
          type: boolean
          description: If set to `false`, disable the DHCP server
          default: true
      additionalProperties:
        allOf:
        - $ref: '#/components/schemas/dhcpd_config_property'
        - description: DHCP server or relay configuration for one network
      description: DHCP server defaults provided by this gateway profile
    dhcpd_config3:
      title: dhcpd_config3
      type: object
      properties:
        enabled:
          type: boolean
          description: If set to `false`, disable the DHCP server
          default: true
      additionalProperties:
        allOf:
        - $ref: '#/components/schemas/dhcpd_config_property'
        - description: DHCP server or relay configuration for one network
      description: DHCP server defaults provided by this gateway template
    dhcpd_config4:
      title: dhcpd_config4
      type: object
      properties:
        enabled:
          type: boolean
          description: If set to `false`, disable the DHCP server
          default: true
      additionalProperties:
        allOf:
        - $ref: '#/components/schemas/dhcpd_config_property'
        - description: DHCP server or relay configuration for one network
      description: DHCP server configuration served by this gateway
    dot11_bandwidth1:
      title: dot11_bandwidth1
      enum:
      - 0
      - 20
      - 40
      - 80
      - 160
      type: integer
      description: 'Channel bandwidth to use for the scan radio packet capture. enum: `0`, `20`, `40`, `80`, `160`.'
      examples:
      - 20
    dot11_band1:
      title: dot11_band1
      enum:
      - '24'
      - '5'
      - 5-dedicated
      - 5-selectable
      - '6'
      - 6-dedicated
      - 6-selectable
      type: string
      description: 'Radio band used for the wireless client event. enum: `24`, `5`, `5-dedicated`, `5-selectable`, `6`, `6-dedicated`, `6-selectable`.'
    dot11_proto1:
      title: dot11_proto1
      enum:
      - a
      - ac
      - ax
      - b
      - be
      - g
      - n
      type: string
      description: '802.11 protocol used by the client session. enum: `a`, `ac`, `ax`, `b`, `be`, `g`, `n`.'
    dot11_band2:
      title: dot11_band2
      enum:
      - '24'
      - '5'
      - 5-dedicated
      - 5-selectable
      - '6'
      - 6-dedicated
      - 6-selectable
      type: string
      description: 'Radio band affected by the RRM event. enum: `24`, `5`, `5-dedicated`, `5-selectable`, `6`, `6-dedicated`, `6-selectable`.'
    dot11_proto2:
      title: dot11_proto2
      enum:
      - a
      - ac
      - ax
      - b
      - be
      - g
      - n
      type: string
      description: '802.11 protocol amendment used by the wireless client. enum: `a`, `ac`, `ax`, `b`, `be`, `g`, `n`.'
    dot11_bandwidth3:
      title: dot11_bandwidth3
      enum:
      - 0
      - 20
      - 40
      - 80
      - 160
      type: integer
      description: 'Channel width after the RRM event, in MHz. enum: `0`, `20`, `40`, `80`, `160`.'
      examples:
      - 20
    dot11_band3:
      title: dot11_band3
      enum:
      - '24'
      - '5'
      - 5-dedicated
      - 5-selectable
      - '6'
      - 6-dedicated
      - 6-selectable
      type: string
      description: 'Wi-Fi radio band used by the wireless client connection. enum: `24`, `5`, `5-dedicated`, `5-selectable`, `6`, `6-dedicated`, `6-selectable`.'
    dot11_bandwidth4:
      title: dot11_bandwidth4
      enum:
      - 0
      - 20
      - 40
      - 80
      - 160
      type: integer
      description: 'Proposed channel width for the radio band, in MHz. enum: `0`, `20`, `40`, `80`, `160`.'
      examples:
      - 20
    dot11_bandwidth7:
      title: dot11_bandwidth7
      enum:
      - 0
      - 20
      - 40
      - 80
      - 160
      type: integer
      description: 'Current channel width for the radio band, in MHz. enum: `0`, `20`, `40`, `80`, `160`.'
      examples:
      - 20
    dot11_bandwidth8:
      title: dot11_bandwidth8
      enum:
      - 0
      - 20
      - 40
      - 80
      - 160
      type: integer
      description: 'Current channel width reported for this radio. enum: `0`, `20`, `40`, `80`, `160`.'
      examples:
      - 20
    dot11_bandwidth52:
      title: dot11_bandwidth52
      enum:
      - 0
      - 20
      - 40
      - 80
      type: integer
      description: 'Channel width configured for the 5 GHz radio. enum: `0`, `20`, `40`, `80`.'
      examples:
      - 40
    dot11_bandwidth62:
      title: dot11_bandwidth62
      enum:
      - 0
      - 20
      - 40
      - 80
      - 160
      type: integer
      description: 'Channel width configured for the 6 GHz radio. enum: `0`, `20`, `40`, `80`, `160`.'
      examples:
      - 80
    dot11_bandwidth242:
      title: dot11_bandwidth242
      enum:
      - 0
      - 20
      - 40
      type: integer
      description: 'Channel width configured for the 2.4 GHz radio. enum: `0`, `20`, `40`.'
      examples:
      - 20
    dswitches_metrics_inactive_wired_vlans1:
      title: dswitches_metrics_inactive_wired_vlans1
      required:
      - details
      - score
      type: object
      properties:
        details:
          type: object
          description: Metric-specific details for inactive wired VLAN findings
        score:
          type: number
          description: Compliance score for the inactive wired VLAN metric
      description: Metric for inactive wired VLANs on discovered switches
    dswitches_metrics_poe_compliance_details2:
      title: dswitches_metrics_poe_compliance_details2
      required:
      - total_aps
      - total_power
      type: object
      properties:
        total_aps:
          type: integer
          description: Number of APs evaluated for PoE compliance
          contentEncoding: int32
        total_power:
          type: number
          description: Aggregate AP PoE power demand across evaluated APs, in mW
      description: Counts and power totals used to calculate the PoE compliance score
    dswitches_metrics_poe_compliance1:
      title: dswitches_metrics_poe_compliance1
      required:
      - details
      - score
      type: object
      properties:
        details:
          allOf:
          - $ref: '#/components/schemas/dswitches_metrics_poe_compliance_details2'
          - description: Counts and power totals used to calculate the PoE compliance score
        score:
          type: number
          description: Compliance score for the PoE compliance metric
      description: Metric for PoE compliance across APs connected to discovered switches
    dswitches_metrics_switch_ap_affinity_details2:
      title: dswitches_metrics_switch_ap_affinity_details2
      required:
      - system_name
      - threshold
      type: object
      properties:
        system_name:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Discovered switch system names reported for the affinity metric
        threshold:
          type: number
          description: APs-per-switch threshold used for the affinity metric
      description: Switch names and threshold used to calculate the affinity score
    dswitches_metrics_switch_ap_affinity1:
      title: dswitches_metrics_switch_ap_affinity1
      required:
      - details
      - score
      type: object
      properties:
        details:
          allOf:
          - $ref: '#/components/schemas/dswitches_metrics_switch_ap_affinity_details2'
          - description: Switch names and threshold used to calculate the affinity score
        score:
          type: number
          description: Compliance score for the switch/AP affinity metric
      description: Metric comparing AP counts against the switch affinity threshold
    dswitches_metrics_version_compliance_details2:
      title: dswitches_metrics_version_compliance_details2
      required:
      - major_versions
      - total_switch_count
      type: object
      properties:
        major_versions:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/dswitches_compliance_major_version'
          description: Per-model major version groupings used for version compliance
        total_switch_count:
          type: integer
          description: Number of discovered switches evaluated for version compliance
          contentEncoding: int32
      description: Version grouping details used to calculate the compliance score
    dswitches_metrics_version_compliance1:
      title: dswitches_metrics_version_compliance1
      required:
      - details
      - score
      type: object
      properties:
        details:
          allOf:
          - $ref: '#/components/schemas/dswitches_metrics_version_compliance_details2'
          - description: Version grouping details used to calculate the compliance score
        score:
          type: number
          description: Compliance score for the discovered-switch version metric
      description: Metric for discovered switch software version compliance
    dynamic_psk_source1:
      title: dynamic_psk_source1
      enum:
      - cloud_psks
      - radius
      type: string
      description: 'Origin used to retrieve per-user PSKs. enum: `cloud_psks`, `radius`.'
      examples:
      - cloud_psks
    event_fastroam_type2:
      title: event_fastroam_type2
      enum:
      - fail
      - none
      - pingpong
      - poor
      - slow
      - success
      type: string
      description: 'Fast-roam result category for the event. enum: `fail`, `none`, `pingpong`, `poor`, `slow`, `success`.'
    event_severity1:
      title: event_severity1
      enum:
      - normal
      - critical
      - high
      - warning
      type: string
      description: 'Event severity level reported for this Mist Edge event. enum: `normal`, `critical`, `high`, `warning`.'
    event_severity2:
      title: event_severity2
      enum:
      - normal
      - critical
      - high
      - warning
      type: string
      description: 'Event severity for the system resource condition. enum: `normal`, `critical`, `high`, `warning`.'
    evpn_config_role2:
      title: evpn_config_role2
      enum:
      - access
      - border
      - collapsed-core
      - core
      - distribution
      - esilag-access
      - none
      type: string
      description: 'EVPN topology role for the switch. enum: `access`, `border`, `collapsed-core`, `core`, `distribution`, `esilag-access`, `none`.'
    evpn_config1:
      title: evpn_config1
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether EVPN configuration is enabled on the switch
          readOnly: true
        role:
          allOf:
          - $ref: '#/components/schemas/evpn_config_role2'
          - description: 'EVPN topology role for the switch. enum: `access`, `border`, `collapsed-core`, `core`, `distribution`, `esilag-access`, `none`.'
          readOnly: true
      description: EVPN defaults applied by this switch profile
    evpn_config3:
      title: evpn_config3
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether EVPN configuration is enabled on the switch
          readOnly: true
        role:
          allOf:
          - $ref: '#/components/schemas/evpn_config_role2'
          - description: 'EVPN topology role for the switch. enum: `access`, `border`, `collapsed-core`, `core`, `distribution`, `esilag-access`, `none`.'
          readOnly: true
      description: EVPN configuration applied to this switch
    evpn_options_overlay2:
      title: evpn_options_overlay2
      type: object
      properties:
        as:
          maximum: 65535
          minimum: 1
          type: integer
          description: Overlay BGP Local AS Number
          contentEncoding: int32
          default: 65000
          examples:
          - 65000
      description: EVPN overlay BGP settings for the topology
    evpn_options_routed_at2:
      title: evpn_options_routed_at2
      enum:
      - core
      - distribution
      - edge
      type: string
      description: 'Topology tier where EVPN virtual gateway routing is placed. enum: `core`, `distribution`, `edge`.'
    evpn_options_underlay2:
      title: evpn_options_underlay2
      type: object
      properties:
        as_base:
          maximum: 65535
          minimum: 1
          type: integer
          description: Underlay BGP Base AS Number
          contentEncoding: int32
          default: 65001
          examples:
          - 65001
        routed_id_prefix:
          type: string
          description: Prefix length used for automatically derived underlay router identifiers
          examples:
          - /24
        subnet:
          type: string
          description: Underlay subnet, by default, `10.255.240.0/20`, or `fd31:5700::/64` for ipv6
          examples:
          - 10.255.240.0/20
        use_ipv6:
          type: boolean
          description: If v6 is desired for underlay
          default: false
      description: EVPN underlay BGP and subnet settings for the topology
    evpn_options1:
      title: evpn_options1
      type: object
      properties:
        auto_loopback_subnet:
          type: string
          description: Optional, for dhcp_relay, unique loopback IPs are required for ERB or IPClos where we can set option-82 server_id-overrides
          default: 172.16.192.0/24
        auto_loopback_subnet6:
          type: string
          description: Optional, for dhcp_relay, unique loopback IPs are required for ERB or IPClos where we can set option-82 server_id-overrides
          default: fd33:ab00:2::/64
        auto_router_id_subnet:
          type: string
          description: Optional, this generates router_id automatically, if specified, `router_id_prefix` is ignored
          default: 172.16.254.0/23
        auto_router_id_subnet6:
          type: string
          description: Optional, this generates router_id automatically, if specified, `router_id_prefix` is ignored
          examples:
          - fd31:5700:1::/64
        core_as_border:
          type: boolean
          description: Optional, for ERB or CLOS, you can either use esilag to upstream routers or to also be the virtual-gateway. When `routed_at` != `core`, whether to do virtual-gateway at core as well
          default: false
        enable_inband_mgmt:
          type: boolean
          description: Whether to route management traffic inband; routes will be propagated to downstream switches
          default: false
        enable_inband_ztp:
          type: boolean
          description: if the mangement traffic goes inbnd, during installation, only the border/core switches are connected to the Internet to allow initial configuration to be pushed down and leave the downstream access switches stay in the Factory Default state enabling inband-ztp allows upstream switches to use LLDP to assign IP and gives Internet to downstream switches in that state
          default: false
        overlay:
          allOf:
          - $ref: '#/components/schemas/evpn_options_overlay2'
          - description: EVPN overlay BGP settings for the topology
        per_vlan_vga_v4_mac:
          type: boolean
          description: Only for by Core-Distribution architecture when `evpn_options.routed_at`==`core`. By default, JUNOS uses 00-00-5e-00-01-01 as the virtual-gateway-address's v4_mac. If enabled, 00-00-5e-00-0X-YY will be used (where XX=vlan_id/256, YY=vlan_id%256)
          default: false
        per_vlan_vga_v6_mac:
          type: boolean
          description: Only for by Core-Distribution architecture when `evpn_options.routed_at`==`core`. By default, JUNOS uses 00-00-5e-00-02-01 as the virtual-gateway-address's v6_mac. If enabled, 00-00-5e-00-1X-YY will be used (where XX=vlan_id/256, YY=vlan_id%256)
          default: false
        routed_at:
          allOf:
          - $ref: '#/components/schemas/evpn_options_routed_at2'
          - description: 'Topology tier where EVPN virtual gateway routing is placed. enum: `core`, `distribution`, `edge`.'
        underlay:
          allOf:
          - $ref: '#/components/schemas/evpn_options_underlay2'
          - description: EVPN underlay BGP and subnet settings for the topology
        vs_instances:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/evpn_options_vs_instance'
          description: Virtual-switch instance mappings used to segregate EVPN networks
          examples:
          - guest:
              networks:
              - guest
            iot:
              networks:
              - iot-wifi
              - iot-lan
      description: Generation options applied to the EVPN topology
    evpn_options3:
      title: evpn_options3
      type: object
      properties:
        auto_loopback_subnet:
          type: string
          description: Optional, for dhcp_relay, unique loopback IPs are required for ERB or IPClos where we can set option-82 server_id-overrides
          default: 172.16.192.0/24
        auto_loopback_subnet6:
          type: string
          description: Optional, for dhcp_relay, unique loopback IPs are required for ERB or IPClos where we can set option-82 server_id-overrides
          default: fd33:ab00:2::/64
        auto_router_id_subnet:
          type: string
          description: Optional, this generates router_id automatically, if specified, `router_id_prefix` is ignored
          default: 172.16.254.0/23
        auto_router_id_subnet6:
          type: string
          description: Optional, this generates router_id automatically, if specified, `router_id_prefix` is ignored
          examples:
          - fd31:5700:1::/64
        core_as_border:
          type: boolean
          description: Optional, for ERB or CLOS, you can either use esilag to upstream routers or to also be the virtual-gateway. When `routed_at` != `core`, whether to do virtual-gateway at core as well
          default: false
        enable_inband_mgmt:
          type: boolean
          description: Whether to route management traffic inband; routes will be propagated to downstream switches
          default: false
        enable_inband_ztp:
          type: boolean
          description: if the mangement traffic goes inbnd, during installation, only the border/core switches are connected to the Internet to allow initial configuration to be pushed down and leave the downstream access switches stay in the Factory Default state enabling inband-ztp allows upstream switches to use LLDP to assign IP and gives Internet to downstream switches in that state
          default: false
        overlay:
          allOf:
          - $ref: '#/components/schemas/evpn_options_overlay2'
          - description: EVPN overlay BGP settings for the topology
        per_vlan_vga_v4_mac:
          type: boolean
          description: Only for by Core-Distribution architecture when `evpn_options.routed_at`==`core`. By default, JUNOS uses 00-00-5e-00-01-01 as the virtual-gateway-address's v4_mac. If enabled, 00-00-5e-00-0X-YY will be used (where XX=vlan_id/256, YY=vlan_id%256)
          default: false
        per_vlan_vga_v6_mac:
          type: boolean
          description: Only for by Core-Distribution architecture when `evpn_options.routed_at`==`core`. By default, JUNOS uses 00-00-5e-00-02-01 as the virtual-gateway-address's v6_mac. If enabled, 00-00-5e-00-1X-YY will be used (where XX=vlan_id/256, YY=vlan_id%256)
          default: false
        routed_at:
          allOf:
          - $ref: '#/components/schemas/evpn_options_routed_at2'
          - description: 'Topology tier where EVPN virtual gateway routing is placed. enum: `core`, `distribution`, `edge`.'
        underlay:
          allOf:
          - $ref: '#/components/schemas/evpn_options_underlay2'
          - description: EVPN underlay BGP and subnet settings for the topology
        vs_instances:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/evpn_options_vs_instance'
          description: Virtual-switch instance mappings used to segregate EVPN networks
          examples:
          - guest:
              networks:
              - guest
            iot:
              networks:
              - iot-wifi
              - iot-lan
      description: Fabric EVPN options for the site
    evpn_topology_switch_config_dhcpd_config2:
      title: evpn_topology_switch_config_dhcpd_config2
      type: object
      properties:
        enabled:
          type: boolean
          description: If DHCPD is enabled on the switch
      description: Switch DHCP server configuration for the topology member
    evpn_topology_switch_config_vrf_config2:
      title: evpn_topology_switch_config_vrf_config2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether to enable VRF (when supported on the device)
      description: Routing instance and VRF settings for the topology member
    evpn_topology_switch_config1:
      title: evpn_topology_switch_config1
      type: object
      properties:
        dhcpd_config:
          allOf:
          - $ref: '#/components/schemas/evpn_topology_switch_config_dhcpd_config2'
          - description: Switch DHCP server configuration for the topology member
        networks:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_network'
          description: EVPN network definitions for the topology member
        other_ip_configs:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/junos_other_ip_config'
          description: Additional interface IP configurations for the topology member
        port_config:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/junos_port_config'
          description: Switch port configuration for the topology member
        port_usages:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_port_usage'
          description: Switch port usage definitions for the topology member
        router_id:
          type: string
          description: Used for OSPF / BGP / EVPN
          examples:
          - 10.2.1.10
        vrf_config:
          allOf:
          - $ref: '#/components/schemas/evpn_topology_switch_config_vrf_config2'
          - description: Routing instance and VRF settings for the topology member
      description: Per-switch configuration supplied for this topology member. Use the [Update Site Device]($e/Sites%20Devices/updateSiteDevice) endpoint to update the switch configuration.
    evpn_topology_switch_role2:
      title: evpn_topology_switch_role2
      enum:
      - access
      - border
      - collapsed-core
      - core
      - distribution
      - esilag-access
      - none
      type: string
      description: 'EVPN topology role for this switch. enum: `access`, `border`, `collapsed-core`, `core`, `distribution`, `esilag-access`, `none`.'
    fwupdate_stat_status2:
      title: fwupdate_stat_status2
      enum:
      - inprogress
      - failed
      - upgraded
      - success
      - scheduled
      - error
      type: string
      description: 'Current firmware update status. enum: `inprogress`, `failed`, `upgraded`, `success`, `scheduled`, `error`.'
    fwupdate_stat1:
      title: fwupdate_stat1
      type: object
      properties:
        progress:
          maximum: 100
          minimum: 0
          type:
          - integer
          - 'null'
          description: Firmware update progress percentage, or null when unavailable
          contentEncoding: int32
          readOnly: true
          examples:
          - 10
        status:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/fwupdate_stat_status2'
          - description: 'Current firmware update status. enum: `inprogress`, `failed`, `upgraded`, `success`, `scheduled`, `error`.'
          readOnly: true
        status_id:
          type:
          - integer
          - 'null'
          description: Numeric firmware update status identifier
          contentEncoding: int32
          readOnly: true
          examples:
          - 5
        timestamp:
          type: number
          description: Time when the firmware update status was last updated
          readOnly: true
        will_retry:
          type:
          - boolean
          - 'null'
          description: Whether the firmware update process will retry after the current status
          readOnly: true
          examples:
          - false
      description: Firmware update status included with the tunnel statistics, when available
    fwupdate_stat2:
      title: fwupdate_stat2
      type: object
      properties:
        progress:
          maximum: 100
          minimum: 0
          type:
          - integer
          - 'null'
          description: Firmware update progress percentage, or null when unavailable
          contentEncoding: int32
          readOnly: true
          examples:
          - 10
        status:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/fwupdate_stat_status2'
          - description: 'Current firmware update status. enum: `inprogress`, `failed`, `upgraded`, `success`, `scheduled`, `error`.'
          readOnly: true
        status_id:
          type:
          - integer
          - 'null'
          description: Numeric firmware update status identifier
          contentEncoding: int32
          readOnly: true
          examples:
          - 5
        timestamp:
          type: number
          description: Time when the firmware update status was last updated
          readOnly: true
        will_retry:
          type:
          - boolean
          - 'null'
          description: Whether the firmware update process will retry after the current status
          readOnly: true
          examples:
          - false
      description: Firmware update status for the AP
    fwupdate_stat3:
      title: fwupdate_stat3
      type: object
      properties:
        progress:
          maximum: 100
          minimum: 0
          type:
          - integer
          - 'null'
          description: Firmware update progress percentage, or null when unavailable
          contentEncoding: int32
          readOnly: true
          examples:
          - 10
        status:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/fwupdate_stat_status2'
          - description: 'Current firmware update status. enum: `inprogress`, `failed`, `upgraded`, `success`, `scheduled`, `error`.'
          readOnly: true
        status_id:
          type:
          - integer
          - 'null'
          description: Numeric firmware update status identifier
          contentEncoding: int32
          readOnly: true
          examples:
          - 5
        timestamp:
          type: number
          description: Time when the firmware update status was last updated
          readOnly: true
        will_retry:
          type:
          - boolean
          - 'null'
          description: Whether the firmware update process will retry after the current status
          readOnly: true
          examples:
          - false
      description: Firmware update status for the switch
    fwupdate_stat4:
      title: fwupdate_stat4
      type: object
      properties:
        progress:
          maximum: 100
          minimum: 0
          type:
          - integer
          - 'null'
          description: Firmware update progress percentage, or null when unavailable
          contentEncoding: int32
          readOnly: true
          examples:
          - 10
        status:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/fwupdate_stat_status2'
          - description: 'Current firmware update status. enum: `inprogress`, `failed`, `upgraded`, `success`, `scheduled`, `error`.'
          readOnly: true
        status_id:
          type:
          - integer
          - 'null'
          description: Numeric firmware update status identifier
          contentEncoding: int32
          readOnly: true
          examples:
          - 5
        timestamp:
          type: number
          description: Time when the firmware update status was last updated
          readOnly: true
        will_retry:
          type:
          - boolean
          - 'null'
          description: Whether the firmware update process will retry after the current status
          readOnly: true
          examples:
          - false
      description: Firmware update status for the gateway
    fwupdate_stat5:
      title: fwupdate_stat5
      type: object
      properties:
        progress:
          maximum: 100
          minimum: 0
          type:
          - integer
          - 'null'
          description: Firmware update progress percentage, or null when unavailable
          contentEncoding: int32
          readOnly: true
          examples:
          - 10
        status:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/fwupdate_stat_status2'
          - description: 'Current firmware update status. enum: `inprogress`, `failed`, `upgraded`, `success`, `scheduled`, `error`.'
          readOnly: true
        status_id:
          type:
          - integer
          - 'null'
          description: Numeric firmware update status identifier
          contentEncoding: int32
          readOnly: true
          examples:
          - 5
        timestamp:
          type: number
          description: Time when the firmware update status was last updated
          readOnly: true
        will_retry:
          type:
          - boolean
          - 'null'
          description: Whether the firmware update process will retry after the current status
          readOnly: true
          examples:
          - false
      description: Firmware or package update status for the Mist Edge
    gateway_compliance_version1:
      title: gateway_compliance_version1
      type: object
      properties:
        major_version:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/gateway_compliance_major_version_properties'
          description: Per-model gateway major-version compliance details
        score:
          type: number
          description: Gateway software version compliance score
          examples:
          - 99.9
        type:
          type: string
          description: Device type represented by the gateway compliance metric
          examples:
          - gateway
      description: Gateway software version compliance metric
    gateway_matching2:
      title: gateway_matching2
      type: object
      properties:
        enable:
          type: boolean
          description: Whether gateway matching is enabled
        rules:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/gateway_matching_rule'
          description: Gateway matching rules evaluated for this configuration
      description: Matching rules that select gateways for this template
    gateway_matching3:
      title: gateway_matching3
      type: object
      properties:
        enable:
          type: boolean
          description: Whether gateway matching is enabled
        rules:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/gateway_matching_rule'
          description: Gateway matching rules evaluated for this configuration
      description: Matching rules that select gateways for this profile
    gateway_mgmt_auto_signature_update2:
      title: gateway_mgmt_auto_signature_update2
      type: object
      properties:
        day_of_week:
          allOf:
          - $ref: '#/components/schemas/day_of_week1'
          - description: 'Scheduled weekday for automatic signature updates. enum: `any`, `fri`, `mon`, `sat`, `sun`, `thu`, `tue`, `wed`.'
        enable:
          type: boolean
          description: Whether automatic security signature updates are enabled
          default: true
        time_of_day:
          type: string
          description: Optional, Mist will decide the timing
      description: Schedule for automatic security signature updates
    gateway_mgmt_host_out_policy_syslog1:
      title: gateway_mgmt_host_out_policy_syslog1
      type: object
      properties:
        path_preference:
          type: string
          description: Preferred path name used by default for gateway syslog traffic
          examples:
          - broadband_wans
        servers:
          type: array
          items:
            $ref: '#/components/schemas/gateway_mgmt_host_out_policy_syslog_server'
          description: Per-server host-out path policies for gateway syslog traffic
      description: Path preference policy for gateway-originated syslog traffic
    gateway_mgmt_host_out_policy1:
      title: gateway_mgmt_host_out_policy1
      type: object
      properties:
        path_preference:
          type: string
          description: Preferred path name for this gateway-originated service traffic
      description: Path preference policy for gateway-originated DNS traffic
    gateway_mgmt_host_out_policy2:
      title: gateway_mgmt_host_out_policy2
      type: object
      properties:
        path_preference:
          type: string
          description: Preferred path name for this gateway-originated service traffic
      description: Path preference policy for gateway-originated NTP traffic
    gateway_mgmt2:
      title: gateway_mgmt2
      type: object
      properties:
        admin_sshkeys:
          type: array
          items:
            type: string
          description: SSR-only SSH public keys for administrative access
          examples:
          - - ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAA...Wxa6p6UW0ZbcP john@host
        app_probing:
          allOf:
          - $ref: '#/components/schemas/app_probing1'
          - description: Application probing configuration for gateway monitoring
        app_usage:
          type: boolean
          description: Consumes uplink bandwidth, requires WA license
        auto_signature_update:
          allOf:
          - $ref: '#/components/schemas/gateway_mgmt_auto_signature_update2'
          - description: Schedule for automatic security signature updates
        config_revert_timer:
          maximum: 30
          minimum: 1
          type: integer
          description: Rollback timer for commit confirmed
          contentEncoding: int32
          default: 10
        disable_console:
          type: boolean
          description: For SSR and SRX, disable console port
          default: false
        disable_idp_pcap:
          type: boolean
          description: For SRX only, disable IDP packet capture
          default: false
        disable_oob:
          type: boolean
          description: For SSR and SRX, disable management interface
          default: false
        disable_usb:
          type: boolean
          description: For SSR and SRX, disable usb interface
          default: false
        fips_enabled:
          type: boolean
          description: Whether FIPS mode is enabled on the gateway
          default: false
        probe_hosts:
          type: array
          items:
            type: string
          description: IPv4 probe targets used for gateway connectivity checks
          examples:
          - - 8.8.8.8
        probe_hostsv6:
          type: array
          items:
            type: string
          description: IPv6 probe targets used for gateway connectivity checks
          examples:
          - - 2001:4860:4860::8888
        protect_re:
          allOf:
          - $ref: '#/components/schemas/protect_re1'
          - description: Control-plane protection settings for the gateway
        root_password:
          type: string
          description: SRX only. Root password for local gateway access
          contentEncoding: password
        security_log_source_address:
          type: string
          description: IPv4 source address used for gateway security log traffic
          contentEncoding: ipv4
          examples:
          - 192.168.1.1
        security_log_source_interface:
          type: string
          description: Source interface used for gateway security log traffic
          examples:
          - ge-0/0/1.0
      description: Management-plane defaults provided by this gateway template
    gateway_mgmt3:
      title: gateway_mgmt3
      type: object
      properties:
        admin_sshkeys:
          type: array
          items:
            type: string
          description: SSR-only SSH public keys for administrative access
          examples:
          - - ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAA...Wxa6p6UW0ZbcP john@host
        app_probing:
          allOf:
          - $ref: '#/components/schemas/app_probing1'
          - description: Application probing configuration for gateway monitoring
        app_usage:
          type: boolean
          description: Consumes uplink bandwidth, requires WA license
        auto_signature_update:
          allOf:
          - $ref: '#/components/schemas/gateway_mgmt_auto_signature_update2'
          - description: Schedule for automatic security signature updates
        config_revert_timer:
          maximum: 30
          minimum: 1
          type: integer
          description: Rollback timer for commit confirmed
          contentEncoding: int32
          default: 10
        disable_console:
          type: boolean
          description: For SSR and SRX, disable console port
          default: false
        disable_idp_pcap:
          type: boolean
          description: For SRX only, disable IDP packet capture
          default: false
        disable_oob:
          type: boolean
          description: For SSR and SRX, disable management interface
          default: false
        disable_usb:
          type: boolean
          description: For SSR and SRX, disable usb interface
          default: false
        fips_enabled:
          type: boolean
          description: Whether FIPS mode is enabled on the gateway
          default: false
        probe_hosts:
          type: array
          items:
            type: string
          description: IPv4 probe targets used for gateway connectivity checks
          examples:
          - - 8.8.8.8
        probe_hostsv6:
          type: array
          items:
            type: string
          description: IPv6 probe targets used for gateway connectivity checks
          examples:
          - - 2001:4860:4860::8888
        protect_re:
          allOf:
          - $ref: '#/components/schemas/protect_re1'
          - description: Control-plane protection settings for the gateway
        root_password:
          type: string
          description: SRX only. Root password for local gateway access
          contentEncoding: password
        security_log_source_address:
          type: string
          description: IPv4 source address used for gateway security log traffic
          contentEncoding: ipv4
          examples:
          - 192.168.1.1
        security_log_source_interface:
          type: string
          description: Source interface used for gateway security log traffic
          examples:
          - ge-0/0/1.0
      description: Management access settings for gateways at the site
    gateway_mgmt4:
      title: gateway_mgmt4
      type: object
      properties:
        admin_sshkeys:
          type: array
          items:
            type: string
          description: SSR-only SSH public keys for administrative access
          examples:
          - - ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAA...Wxa6p6UW0ZbcP john@host
        app_probing:
          allOf:
          - $ref: '#/components/schemas/app_probing1'
          - description: Application probing configuration for gateway monitoring
        app_usage:
          type: boolean
          description: Consumes uplink bandwidth, requires WA license
        auto_signature_update:
          allOf:
          - $ref: '#/components/schemas/gateway_mgmt_auto_signature_update2'
          - description: Schedule for automatic security signature updates
        config_revert_timer:
          maximum: 30
          minimum: 1
          type: integer
          description: Rollback timer for commit confirmed
          contentEncoding: int32
          default: 10
        disable_console:
          type: boolean
          description: For SSR and SRX, disable console port
          default: false
        disable_idp_pcap:
          type: boolean
          description: For SRX only, disable IDP packet capture
          default: false
        disable_oob:
          type: boolean
          description: For SSR and SRX, disable management interface
          default: false
        disable_usb:
          type: boolean
          description: For SSR and SRX, disable usb interface
          default: false
        fips_enabled:
          type: boolean
          description: Whether FIPS mode is enabled on the gateway
          default: false
        probe_hosts:
          type: array
          items:
            type: string
          description: IPv4 probe targets used for gateway connectivity checks
          examples:
          - - 8.8.8.8
        probe_hostsv6:
          type: array
          items:
            type: string
          description: IPv6 probe targets used for gateway connectivity checks
          examples:
          - - 2001:4860:4860::8888
        protect_re:
          allOf:
          - $ref: '#/components/schemas/protect_re1'
          - description: Control-plane protection settings for the gateway
        root_password:
          type: string
          description: SRX only. Root password for local gateway access
          contentEncoding: password
        security_log_source_address:
          type: string
          description: IPv4 source address used for gateway security log traffic
          contentEncoding: ipv4
          examples:
          - 192.168.1.1
        security_log_source_interface:
          type: string
          description: Source interface used for gateway security log traffic
          examples:
          - ge-0/0/1.0
      description: Management-plane settings for this gateway
    gateway_oob_ip_config_node12:
      title: gateway_oob_ip_config_node12
      type: object
      properties:
        gateway:
          type: string
          description: Default gateway for the node1 out-of-band management interface when `type`==`static`
        ip:
          type: string
          description: Static IPv4 address for the node1 out-of-band management interface when `type`==`static`
        netmask:
          type: string
          description: IPv4 netmask or prefix length for the node1 out-of-band management interface when `type`==`static`; used only if `subnet` is not specified in `networks`
        type:
          allOf:
          - $ref: '#/components/schemas/ip_type5'
          - description: 'IP assignment mode for the node1 out-of-band management interface. enum: `dhcp`, `static`.'
            examples:
            - static
        use_mgmt_vrf:
          type: boolean
          description: If supported on the platform. If enabled, DNS will be using this routing-instance, too
          default: false
        use_mgmt_vrf_for_host_out:
          type: boolean
          description: Whether to use `mgmt_junos` for host-out traffic (NTP/TACPLUS/RADIUS/SYSLOG/SNMP), if alternative source network/ip is desired
          default: false
        vlan_id:
          oneOf:
          - type: string
          - maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
          description: VLAN ID used for node1 out-of-band management traffic
      description: Out-of-band management IP configuration override for node1 in an HA cluster
    gateway_oob_ip_config1:
      title: gateway_oob_ip_config1
      type: object
      properties:
        gateway:
          type: string
          description: Default gateway for the out-of-band management interface when `type`==`static`
        ip:
          type: string
          description: Static IPv4 address for the out-of-band management interface when `type`==`static`
        netmask:
          type: string
          description: IPv4 netmask or prefix length for the out-of-band management interface when `type`==`static`
        node1:
          allOf:
          - $ref: '#/components/schemas/gateway_oob_ip_config_node12'
          - description: Out-of-band management IP configuration override for node1 in an HA cluster
        type:
          allOf:
          - $ref: '#/components/schemas/ip_type2'
          - description: 'IP assignment mode for the out-of-band management interface. enum: `dhcp`, `static`.'
            examples:
            - static
        use_mgmt_vrf:
          type: boolean
          description: If supported on the platform. If enabled, DNS will be using this routing-instance, too
          default: false
        use_mgmt_vrf_for_host_out:
          type: boolean
          description: For host-out traffic (NTP/TACPLUS/RADIUS/SYSLOG/SNMP), if alternative source network/ip is desired
          default: false
        vlan_id:
          oneOf:
          - type: string
          - maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
          description: VLAN ID used for out-of-band management traffic
      description: Out-of-band management IP defaults in this gateway profile
    gateway_oob_ip_config3:
      title: gateway_oob_ip_config3
      type: object
      properties:
        gateway:
          type: string
          description: Default gateway for the out-of-band management interface when `type`==`static`
        ip:
          type: string
          description: Static IPv4 address for the out-of-band management interface when `type`==`static`
        netmask:
          type: string
          description: IPv4 netmask or prefix length for the out-of-band management interface when `type`==`static`
        node1:
          allOf:
          - $ref: '#/components/schemas/gateway_oob_ip_config_node12'
          - description: Out-of-band management IP configuration override for node1 in an HA cluster
        type:
          allOf:
          - $ref: '#/components/schemas/ip_type2'
          - description: 'IP assignment mode for the out-of-band management interface. enum: `dhcp`, `static`.'
            examples:
            - static
        use_mgmt_vrf:
          type: boolean
          description: If supported on the platform. If enabled, DNS will be using this routing-instance, too
          default: false
        use_mgmt_vrf_for_host_out:
          type: boolean
          description: For host-out traffic (NTP/TACPLUS/RADIUS/SYSLOG/SNMP), if alternative source network/ip is desired
          default: false
        vlan_id:
          oneOf:
          - type: string
          - maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
          description: VLAN ID used for out-of-band management traffic
      description: Out-of-band management IP defaults in this gateway template
    gateway_oob_ip_config4:
      title: gateway_oob_ip_config4
      type: object
      properties:
        gateway:
          type: string
          description: Default gateway for the out-of-band management interface when `type`==`static`
        ip:
          type: string
          description: Static IPv4 address for the out-of-band management interface when `type`==`static`
        netmask:
          type: string
          description: IPv4 netmask or prefix length for the out-of-band management interface when `type`==`static`
        node1:
          allOf:
          - $ref: '#/components/schemas/gateway_oob_ip_config_node12'
          - description: Out-of-band management IP configuration override for node1 in an HA cluster
        type:
          allOf:
          - $ref: '#/components/schemas/ip_type2'
          - description: 'IP assignment mode for the out-of-band management interface. enum: `dhcp`, `static`.'
            examples:
            - static
        use_mgmt_vrf:
          type: boolean
          description: If supported on the platform. If enabled, DNS will be using this routing-instance, too
          default: false
        use_mgmt_vrf_for_host_out:
          type: boolean
          description: For host-out traffic (NTP/TACPLUS/RADIUS/SYSLOG/SNMP), if alternative source network/ip is desired
          default: false
        vlan_id:
          oneOf:
          - type: string
          - maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
          description: VLAN ID used for out-of-band management traffic
      description: Out-of-band management IP configuration for this gateway
    gateway_path_strategy2:
      title: gateway_path_strategy2
      enum:
      - ecmp
      - ordered
      - weighted
      type: string
      description: 'Selection strategy used to evaluate the candidate paths. enum: `ecmp`, `ordered`, `weighted`.'
    gateway_path_type2:
      title: gateway_path_type2
      enum:
      - local
      - tunnel
      - vpn
      - wan
      type: string
      description: Gateway path source type, such as local network, WAN interface, VPN path, or tunnel
    gateway_port_config_ip_config2:
      title: gateway_port_config_ip_config2
      type: object
      properties:
        dns:
          type: array
          items:
            type: string
          description: Resolver server IP addresses used by this interface, except on out-of-band interfaces such as vme, em0, or fxp0
        dns_suffix:
          type: array
          items:
            type: string
          description: DNS search suffixes used by this interface, except on out-of-band interfaces such as vme, em0, or fxp0
        gateway:
          type: string
          description: Except for out-of_band interface (vme/em0/fxp0). Interface Default Gateway IP address (i.e. "192.168.1.1") or a Variable (i.e. "{{myvar}}")
          examples:
          - 192.168.1.1
        gateway6:
          type: string
          description: Except for out-of_band interface (vme/em0/fxp0). Interface Default Gateway IPv6 Address (i.e. "2001:db8::1") or a Variable (i.e. "{{myvar}}")
          examples:
          - 2001:db8::1
        ip:
          type: string
          description: Interface IP address (i.e. "192.168.1.8") or a Variable (i.e. "{{myvar}}")
          contentEncoding: ipv4
          examples:
          - 192.168.1.8
        ip6:
          type: string
          description: Interface IPv6 Address (i.e. "2001:db8::123") or a Variable (i.e. "{{myvar}}")
          contentEncoding: ipv6
          examples:
          - 2001:db8::123
        netmask:
          type: string
          description: Used only if `subnet` is not specified in `networks`. Interface Netmask (i.e. "/24") or a Variable (i.e. "{{myvar}}")
          examples:
          - /24
        netmask6:
          type: string
          description: Used only if `subnet` is not specified in `networks`. Interface IPv6 Netmask (i.e. "/64") or a Variable (i.e. "{{myvar}}")
          examples:
          - /64
        network:
          type: string
          description: Optional, the network to be used for mgmt
        poser_password:
          type: string
          description: Password used for PPPoE when `type`==`pppoe`
          contentEncoding: password
        pppoe_auth:
          allOf:
          - $ref: '#/components/schemas/gateway_wan_ppoe_auth2'
          - description: 'Authentication protocol used for PPPoE when `type`==`pppoe`. enum: `chap`, `none`, `pap`.'
        pppoe_username:
          type: string
          description: Username used for PPPoE when `type`==`pppoe`
        type:
          allOf:
          - $ref: '#/components/schemas/gateway_wan_type2'
          - description: 'IPv4 assignment mode for this gateway port interface. enum: `dhcp`, `pppoe`, `static`.'
        type6:
          allOf:
          - $ref: '#/components/schemas/gateway_wan_type62'
          - description: 'IPv6 assignment mode for this gateway port interface. enum: `autoconf`, `dhcp`, `static`.'
      description: Layer 3 IP configuration for the port
    gateway_port_config_wan_speedtest_mode2:
      title: gateway_port_config_wan_speedtest_mode2
      enum:
      - auto
      - enabled
      - disabled
      type: string
      description: 'Controls whether Marvis or the scheduler can run speed tests on this WAN port. enum: `auto`, `enabled`, `disabled`.'
      examples:
      - auto
    gateway_port_dsl_type2:
      title: gateway_port_dsl_type2
      enum:
      - adsl
      - vdsl
      type: string
      description: 'If `wan_type`==`dsl`. DSL technology used by the WAN port. enum: `adsl`, `vdsl`.'
    gateway_port_duplex2:
      title: gateway_port_duplex2
      enum:
      - auto
      - full
      - half
      type: string
      description: 'Ethernet duplex mode configured on the port. enum: `auto`, `full`, `half`.'
      examples:
      - full
    gateway_port_lte_auth2:
      title: gateway_port_lte_auth2
      enum:
      - chap
      - none
      - pap
      type: string
      description: 'If `wan_type`==`lte`. Authentication method used by the LTE uplink. enum: `chap`, `none`, `pap`.'
    gateway_port_mirroring_port_mirror2:
      title: gateway_port_mirroring_port_mirror2
      type: object
      properties:
        family_type:
          type: string
          description: Packet family used for this port mirroring rule
        ingress_port_ids:
          type: array
          items:
            type: string
          description: Source gateway port IDs whose ingress traffic is mirrored
        output_port_id:
          type: string
          description: Destination gateway port ID that receives mirrored traffic
          examples:
          - ge-0/0/5
        rate:
          type: integer
          description: Sampling rate applied to mirrored traffic
          contentEncoding: int32
        run_length:
          minimum: 0
          type: integer
          description: Number of bytes copied from each mirrored packet
          contentEncoding: int32
      description: Mirroring rule that copies ingress traffic from source ports to an output port
    gateway_port_mirroring2:
      title: gateway_port_mirroring2
      type: object
      properties:
        port_mirror:
          allOf:
          - $ref: '#/components/schemas/gateway_port_mirroring_port_mirror2'
          - description: Mirroring rule that copies ingress traffic from source ports to an output port
      description: Port mirroring configuration for this gateway
    gateway_port_usage2:
      title: gateway_port_usage2
      enum:
      - ha_control
      - ha_data
      - lan
      - wan
      type: string
      description: 'Logical usage assigned to the port. enum: `ha_control`, `ha_data`, `lan`, `wan`.'
    gateway_port_vpn_path_bfd_profile2:
      title: gateway_port_vpn_path_bfd_profile2
      enum:
      - broadband
      - lte
      type: string
      description: 'BFD profile used for this VPN path when the VPN `type`==`hub_spoke`. enum: `broadband`, `lte`.'
    gateway_port_vpn_path_role2:
      title: gateway_port_vpn_path_role2
      enum:
      - hub
      - mesh
      - spoke
      type: string
      description: 'Gateway role for this VPN path; valid values depend on the VPN `type`. enum: `hub`, `mesh`, `spoke`.'
    gateway_port_wan_arp_policer2:
      title: gateway_port_wan_arp_policer2
      enum:
      - default
      - max
      - recommended
      type: string
      description: 'Only when `wan_type`==`broadband`. ARP policer profile applied to the WAN port. enum: `default`, `max`, `recommended`.'
    gateway_port_wan_source_nat2:
      title: gateway_port_wan_source_nat2
      type: object
      properties:
        disabled:
          type: boolean
          description: Or to disable the source-nat
          default: false
        nat6_pool:
          type: string
          description: If alternative nat_pool is desired
          examples:
          - 2601:1700:43c0:dc0:20c:29ff:fea7:93bc/126
        nat_pool:
          type: string
          description: If alternative nat_pool is desired
          examples:
          - 64.2.4.0/30
      description: Source NAT settings applied to traffic leaving this WAN port
    gateway_port_wan_type2:
      title: gateway_port_wan_type2
      enum:
      - broadband
      - dsl
      - lte
      type: string
      description: 'Only if `usage`==`wan`. WAN uplink type configured on the port. enum: `broadband`, `dsl`, `lte`.'
    gateway_template_type2:
      title: gateway_template_type2
      enum:
      - spoke
      - standalone
      type: string
      description: 'Gateway template deployment type. enum: `spoke`, `standalone`.'
      examples:
      - standalone
    gateway_template1:
      title: gateway_template1
      required:
      - name
      type: object
      properties:
        additional_config_cmds:
          type: array
          items:
            type: string
          description: Additional CLI configuration commands provided by this gateway template
        bgp_config:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/bgp_config'
          description: BGP routing defaults for this gateway template. Property key is the BGP session name
        created_time:
          type: number
          description: Timestamp when the gateway template was created
          readOnly: true
        dhcpd_config:
          allOf:
          - $ref: '#/components/schemas/dhcpd_config3'
          - description: DHCP server defaults provided by this gateway template
        dnsOverride:
          type: boolean
          description: Whether DNS server and suffix settings in this template override inherited values
          default: false
        dns_servers:
          type: array
          items:
            type: string
          description: DNS servers provided by this gateway template
        dns_suffix:
          type: array
          items:
            type: string
          description: DNS search suffixes provided by this gateway template
        extra_routes:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/gateway_extra_route'
          description: Additional IPv4 route defaults in this gateway template
        extra_routes6:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/gateway_extra_route6'
          description: Additional IPv6 route defaults in this gateway template
          examples:
          - 2a02:1234:420a:10c9::/64:
              via: 2a02:1234:200a::100
        gateway_matching:
          allOf:
          - $ref: '#/components/schemas/gateway_matching2'
          - description: Matching rules that select gateways for this template
        gateway_mgmt:
          allOf:
          - $ref: '#/components/schemas/gateway_mgmt2'
          - description: Management-plane defaults provided by this gateway template
        id:
          type: string
          description: Unique identifier of the gateway template
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        idp_profiles:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/idp_profile'
          description: Intrusion detection and prevention profile defaults in this gateway template
        ip_configs:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/gateway_ip_config_property'
          description: Gateway interface IP configuration defaults by network name
        modified_time:
          type: number
          description: Timestamp when the gateway template was last modified
          readOnly: true
        name:
          type: string
          description: Display name of the gateway template
          examples:
          - gw_template
        networks:
          type: array
          items:
            $ref: '#/components/schemas/network'
          description: Layer 3 networks configured by this gateway template
        ntpOverride:
          type: boolean
          description: Whether NTP servers in this template override inherited values
          default: false
        ntp_servers:
          type: array
          items:
            type: string
          description: NTP servers provided by this gateway template
        oob_ip_config:
          allOf:
          - $ref: '#/components/schemas/gateway_oob_ip_config3'
          - description: Out-of-band management IP defaults in this gateway template
        org_id:
          type: string
          description: Organization that owns this gateway template
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        path_preferences:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/gateway_path_preferences'
          description: Property key is the path name
        port_config:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/gateway_port_config'
          description: Property key is the Port Name (i.e. "ge-0/0/0"), the Ports Range (i.e. "ge-0/0/0-10"), the List of Ports (i.e. "ge-0/0/0,ge-1/0/0", only allowed for Aggregated or Redundant interfaces) or a Variable (i.e. "{{myvar}}").
        router_id:
          type: string
          description: Auto assigned if not set
          examples:
          - 10.2.1.10
        routing_policies:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/gw_routing_policy'
          description: Routing policy defaults applied by this gateway template
        service_policies:
          type: array
          items:
            $ref: '#/components/schemas/service_policy'
          description: Traffic service policy defaults enforced by this gateway template
        tunnel_configs:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/tunnel_config'
          description: Property key is the tunnel name
        tunnel_provider_options:
          allOf:
          - $ref: '#/components/schemas/tunnel_provider_options2'
          - description: Provider-specific tunnel options defined by this gateway template
        type:
          allOf:
          - $ref: '#/components/schemas/gateway_template_type2'
          - description: 'Gateway template deployment type. enum: `spoke`, `standalone`.'
            examples:
            - standalone
        url_filtering_deny_msg:
          type: string
          description: When a service policy denies a app_category, what message to show in user's browser
          default: Access to this URL Category has been blocked
          examples:
          - Access to this URL Category has been blocked
        vrf_config:
          allOf:
          - $ref: '#/components/schemas/vrf_config4'
          - description: VRF defaults applied by this gateway template
        vrf_instances:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/gateway_vrf_instance'
          description: VRF instances configured by this gateway template
          examples:
          - CORP_VRF:
              networks:
              - CORP_NET
              - MGMT_NET
      description: Template settings applied to site gateways
    gateway_traffic_shaping1:
      title: gateway_traffic_shaping1
      type: object
      properties:
        class_percentages:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: Traffic class bandwidth percentages for high, medium, low, and best-effort queues
        enabled:
          type: boolean
          description: Whether traffic shaping is enabled
          default: false
        max_tx_kbps:
          type: integer
          description: Maximum transmit bandwidth for the interface, in Kbps
          contentEncoding: int32
      description: Traffic shaping settings applied to this VPN path
    gateway_traffic_shaping3:
      title: gateway_traffic_shaping3
      type: object
      properties:
        class_percentages:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: Traffic class bandwidth percentages for high, medium, low, and best-effort queues
        enabled:
          type: boolean
          description: Whether traffic shaping is enabled
          default: false
        max_tx_kbps:
          type: integer
          description: Maximum transmit bandwidth for the interface, in Kbps
          contentEncoding: int32
      description: Traffic shaping settings applied to the port
    gateway_wan_ppoe_auth2:
      title: gateway_wan_ppoe_auth2
      enum:
      - chap
      - none
      - pap
      type: string
      description: 'Authentication protocol used for PPPoE when `type`==`pppoe`. enum: `chap`, `none`, `pap`.'
    gateway_wan_probe_override_http2:
      title: gateway_wan_probe_override_http2
      type: object
      properties:
        accepted_status_codes:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: HTTP response status codes that indicate a successful probe. Defaults to 200 if not specified.
          examples:
          - - 204
        urls:
          type: array
          items:
            type: string
          description: HTTP or HTTPS URLs to probe
          examples:
          - - http://www.google.com/generate_204
            - https://www.google.com/generate_204
      description: HTTP probe settings; success from any ICMP or HTTP probe indicates the WAN is up
    gateway_wan_probe_override_probe_profile2:
      title: gateway_wan_probe_override_probe_profile2
      enum:
      - broadband
      - lte
      type: string
      description: 'WAN probe profile used for health checks on this port. enum: `broadband`, `lte`.'
    gateway_wan_probe_override2:
      title: gateway_wan_probe_override2
      type: object
      properties:
        hostnames:
          uniqueItems: true
          type: array
          items:
            type: string
          description: List of hostnames used as probe destinations; applicable for both IPv4 and IPv6
        http:
          allOf:
          - $ref: '#/components/schemas/gateway_wan_probe_override_http2'
          - description: HTTP probe settings; success from any ICMP or HTTP probe indicates the WAN is up
        ip6s:
          uniqueItems: true
          type: array
          items:
            type: string
          description: List of IPv6 probe host addresses used by this WAN override
        ips:
          uniqueItems: true
          type: array
          items:
            type: string
          description: List of IPv4 probe host addresses used by this WAN override
        probe_profile:
          allOf:
          - $ref: '#/components/schemas/gateway_wan_probe_override_probe_profile2'
          - description: 'WAN probe profile used for health checks on this port. enum: `broadband`, `lte`.'
      description: Optional WAN health probe override settings for this port
    gateway_wan_type2:
      title: gateway_wan_type2
      enum:
      - dhcp
      - pppoe
      - static
      type: string
      description: 'IPv4 assignment mode for this gateway port interface. enum: `dhcp`, `pppoe`, `static`.'
    gateway_wan_type62:
      title: gateway_wan_type62
      enum:
      - autoconf
      - dhcp
      - static
      type: string
      description: 'IPv6 assignment mode for this gateway port interface. enum: `autoconf`, `dhcp`, `static`.'
    guest1:
      title: guest1
      type: object
      properties:
        access_code_email:
          type: string
          description: If `auth_method`==`email`, the email address where the authorization code has been sent to
          readOnly: true
        ap_mac:
          type: string
          description: MAC address of the AP used during guest registration
          readOnly: true
        auth_method:
          type: string
          description: Guest authentication method used for the authorization
          readOnly: true
        authorized:
          type: boolean
          description: Whether the guest is currently authorized
          default: true
        authorized_expiring_time:
          type: number
          description: Unix timestamp when the guest authorization expires
          readOnly: true
          examples:
          - 1480704955
        authorized_time:
          type: number
          description: Unix timestamp when the guest was authorized
          readOnly: true
          examples:
          - 1480704355
        company:
          type: string
          description: Optional company name provided by the guest during registration
          examples:
          - abc
        email:
          type: string
          description: Optional email address provided by the guest during registration
          contentEncoding: email
          examples:
          - john@abc.com
        field1:
          type: string
          description: Optional custom field 1 value provided by the guest during registration
        field2:
          type: string
          description: Optional custom field 2 value provided by the guest during registration
        field3:
          type: string
          description: Optional custom field 3 value provided by the guest during registration
        field4:
          type: string
          description: Optional custom field 4 value provided by the guest during registration
        mac:
          type: string
          description: Device MAC address captured during guest registration
          readOnly: true
        minutes:
          maximum: 259200
          minimum: 0
          type: integer
          description: Authorization duration, in minutes. Default is 1440 minutes (1 day), maximum is 259200 (180 days)
          contentEncoding: int32
          default: 1440
        name:
          type: string
          description: Optional name provided by the guest during registration
          readOnly: true
          examples:
          - John Smith
        random_mac:
          type: boolean
          description: Whether the guest device used a randomized MAC address to connect to the SSID
          readOnly: true
        ssid:
          type: string
          description: Name of the SSID
          readOnly: true
          examples:
          - Guest-SSID
        wlan_id:
          type: string
          description: Identifier of the WLAN used for the guest authorization
          contentEncoding: uuid
          readOnly: true
          examples:
          - 6748cfa6-4e12-11e6-9188-0242ac110007
      description: Portal guest details for the wireless client
    gw_routing_policy_term_action2:
      title: gw_routing_policy_term_action2
      type: object
      properties:
        accept:
          type: boolean
          description: Whether to accept routes that match this term. Precedence is `accept` > `next_term` > `next_policy`; routes are rejected if all three are false
        add_community:
          type: array
          items:
            type: string
          description: BGP communities to add to routes that match this term
        add_target_vrfs:
          type: array
          items:
            type: string
          description: SSR target VRFs to add when leaking routes from hub to spoke
        community:
          type: array
          items:
            type: string
          description: BGP communities to set when this term is used as an export policy
        exclude_as_path:
          type: array
          items:
            type: string
          description: AS path values to exclude when this term is used as an export policy
        exclude_community:
          type: array
          items:
            type: string
          description: BGP communities to exclude from routes that match this term
        export_communities:
          type: array
          items:
            type: string
          description: BGP communities allowed for export when this term is used as an export policy
        local_preference:
          anyOf:
          - type: string
          - maximum: 4294967295
            minimum: 1
            type: integer
            contentEncoding: int32
          description: Preference value to set when this term is used as an import policy
        next_policy:
          type: boolean
          description: When true, continue evaluating the next routing policy in the chain after this term matches; default is false
          default: false
        next_term:
          type: boolean
          description: When true, continue evaluating the next term in the same routing policy after this term matches; default is false
          default: false
        prepend_as_path:
          type: array
          items:
            type: string
          description: AS path values to prepend when this term is used as an export policy
      description: Policy actions applied when this routing policy term matches
    gw_routing_policy_term_matching_route_exists2:
      title: gw_routing_policy_term_matching_route_exists2
      type: object
      properties:
        route:
          type: string
          description: Prefix that must exist for this condition to match
          examples:
          - 192.168.0.0/24
        vrf_name:
          type: string
          description: Name of the VRF instance where the route is checked; can also be a VPN or WAN name when applicable
          default: default
      description: Existing route condition that must be satisfied before this term matches
    gw_routing_policy_term_matching_vpn_path_sla2:
      title: gw_routing_policy_term_matching_vpn_path_sla2
      type: object
      properties:
        max_jitter:
          type:
          - integer
          - 'null'
          description: Maximum jitter threshold allowed for the VPN path
          contentEncoding: int32
        max_latency:
          type:
          - integer
          - 'null'
          description: Maximum latency threshold allowed for the VPN path
          contentEncoding: int32
          examples:
          - 1500
        max_loss:
          type:
          - integer
          - 'null'
          description: Maximum packet-loss threshold allowed for the VPN path
          contentEncoding: int32
          examples:
          - 30
      description: SLA thresholds used when matching a VPN path
    gw_routing_policy_term_matching2:
      title: gw_routing_policy_term_matching2
      type: object
      properties:
        as_path:
          type: array
          items:
            $ref: '#/components/schemas/bgp_as'
          description: AS path values that routes must match
        community:
          type: array
          items:
            type: string
          description: BGP communities that routes must match
        network:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Configured network names that routes must match
        prefix:
          type: array
          items:
            type: string
          description: Route prefixes that routes must match
        protocol:
          type: array
          items:
            $ref: '#/components/schemas/gw_routing_policy_term_matching_protocol_enum'
          description: Routing protocols that routes must match
        route_exists:
          allOf:
          - $ref: '#/components/schemas/gw_routing_policy_term_matching_route_exists2'
          - description: Existing route condition that must be satisfied before this term matches
        vpn_neighbor_mac:
          type: array
          items:
            type: string
          description: Overlay neighbor MAC addresses used as match criteria for BGP sessions with `via`==`vpn`
        vpn_path:
          type: array
          items:
            type: string
          description: Overlay path names used as match criteria for BGP sessions with `via`==`vpn`
        vpn_path_sla:
          allOf:
          - $ref: '#/components/schemas/gw_routing_policy_term_matching_vpn_path_sla2'
          - description: SLA thresholds used when matching a VPN path
      description: Route match criteria that must be satisfied before actions are applied
    ha_cluster_node_enum2:
      title: ha_cluster_node_enum2
      enum:
      - node0
      - node1
      type: string
      description: 'HA cluster node on which to create the shell session. enum: `node0`, `node1`.'
    ha_cluster_node_enum3:
      title: ha_cluster_node_enum3
      enum:
      - node0
      - node1
      type: string
      description: 'HA cluster node on which to clear ARP entries. enum: `node0`, `node1`.'
    ha_cluster_node_enum4:
      title: ha_cluster_node_enum4
      enum:
      - node0
      - node1
      type: string
      description: 'HA cluster node on which to clear BGP sessions. enum: `node0`, `node1`.'
    ha_cluster_node_enum5:
      title: ha_cluster_node_enum5
      enum:
      - node0
      - node1
      type: string
      description: 'HA cluster node on which to clear sessions. enum: `node0`, `node1`.'
    ha_cluster_node_enum6:
      title: ha_cluster_node_enum6
      enum:
      - node0
      - node1
      type: string
      description: 'HA cluster node from which to send ping packets. enum: `node0`, `node1`.'
    ha_cluster_node_enum7:
      title: ha_cluster_node_enum7
      enum:
      - node0
      - node1
      type: string
      description: 'HA cluster node on which to release the DHCP lease. enum: `node0`, `node1`.'
    ha_cluster_node_enum8:
      title: ha_cluster_node_enum8
      enum:
      - node0
      - node1
      type: string
      description: 'HA cluster node on which to release DHCP leases. enum: `node0`, `node1`.'
    ha_cluster_node_enum9:
      title: ha_cluster_node_enum9
      enum:
      - node0
      - node1
      type: string
      description: 'HA cluster node from which to send the service ping. enum: `node0`, `node1`.'
    ha_cluster_node_enum10:
      title: ha_cluster_node_enum10
      enum:
      - node0
      - node1
      type: string
      description: 'HA cluster node to run the command on, required for Gateways. enum: `node0`, `node1`.'
    ha_cluster_node_enum11:
      title: ha_cluster_node_enum11
      enum:
      - node0
      - node1
      type: string
      description: 'HA cluster node on which to show the BGP summary. enum: `node0`, `node1`.'
    ha_cluster_node_enum12:
      title: ha_cluster_node_enum12
      enum:
      - node0
      - node1
      type: string
      description: 'HA cluster node on which to show DHCP leases. enum: `node0`, `node1`.'
    ha_cluster_node_enum13:
      title: ha_cluster_node_enum13
      enum:
      - node0
      - node1
      type: string
      description: 'HA cluster node on which to show the forwarding table. enum: `node0`, `node1`.'
    ha_cluster_node_enum14:
      title: ha_cluster_node_enum14
      enum:
      - node0
      - node1
      type: string
      description: 'HA cluster node on which to show the OSPF database. enum: `node0`, `node1`.'
    ha_cluster_node_enum15:
      title: ha_cluster_node_enum15
      enum:
      - node0
      - node1
      type: string
      description: 'HA cluster node on which to show OSPF interfaces. enum: `node0`, `node1`.'
    ha_cluster_node_enum16:
      title: ha_cluster_node_enum16
      enum:
      - node0
      - node1
      type: string
      description: 'HA cluster node on which to show OSPF neighbors. enum: `node0`, `node1`.'
    ha_cluster_node_enum17:
      title: ha_cluster_node_enum17
      enum:
      - node0
      - node1
      type: string
      description: 'HA cluster node on which to show the OSPF summary. enum: `node0`, `node1`.'
    ha_cluster_node_enum18:
      title: ha_cluster_node_enum18
      enum:
      - node0
      - node1
      type: string
      description: 'HA cluster node on which to show the service path. enum: `node0`, `node1`.'
    ha_cluster_node_enum19:
      title: ha_cluster_node_enum19
      enum:
      - node0
      - node1
      type: string
      description: 'HA cluster node on which to show active sessions. enum: `node0`, `node1`.'
    ha_cluster_node_enum20:
      title: ha_cluster_node_enum20
      enum:
      - node0
      - node1
      type: string
      description: 'HA cluster node from which to run traceroute. enum: `node0`, `node1`.'
    ha_cluster_node_enum21:
      title: ha_cluster_node_enum21
      enum:
      - node0
      - node1
      type: string
      description: 'HA cluster node associated with this alarm event when applicable. enum: `node0`, `node1`.'
    ha_cluster_node_enum22:
      title: ha_cluster_node_enum22
      enum:
      - node0
      - node1
      type: string
      description: 'HA cluster node on which to run the device operation. enum: `node0`, `node1`.'
    ha_cluster_node1:
      title: ha_cluster_node1
      type: object
      properties:
        node:
          allOf:
          - $ref: '#/components/schemas/ha_cluster_node_enum22'
          - description: 'HA cluster node on which to run the device operation. enum: `node0`, `node1`.'
      description: HA cluster node on which to show routes
    hours1:
      title: hours1
      type: object
      properties:
        fri:
          type: string
          description: Operating hour range for Friday
          examples:
          - 09:00-17:00
        mon:
          type: string
          description: Operating hour range for Monday
          examples:
          - 09:00-17:00
        sat:
          type: string
          description: Operating hour range for Saturday
          examples:
          - 09:00-17:00
        sun:
          type: string
          description: Operating hour range for Sunday
          examples:
          - 09:00-17:00
        thu:
          type: string
          description: Operating hour range for Thursday
          examples:
          - 09:00-17:00
        tue:
          type: string
          description: Operating hour range for Tuesday
          examples:
          - 09:00-17:00
        wed:
          type: string
          description: Operating hour range for Wednesday
          examples:
          - 09:00-17:00
      description: Day-of-week hour ranges when configuration pushes are allowed
    hours2:
      title: hours2
      type: object
      properties:
        fri:
          type: string
          description: Operating hour range for Friday
          examples:
          - 09:00-17:00
        mon:
          type: string
          description: Operating hour range for Monday
          examples:
          - 09:00-17:00
        sat:
          type: string
          description: Operating hour range for Saturday
          examples:
          - 09:00-17:00
        sun:
          type: string
          description: Operating hour range for Sunday
          examples:
          - 09:00-17:00
        thu:
          type: string
          description: Operating hour range for Thursday
          examples:
          - 09:00-17:00
        tue:
          type: string
          description: Operating hour range for Tuesday
          examples:
          - 09:00-17:00
        wed:
          type: string
          description: Operating hour range for Wednesday
          examples:
          - 09:00-17:00
      description: Time ranges when the WLAN is scheduled to operate
    hours3:
      title: hours3
      type: object
      properties:
        fri:
          type: string
          description: Operating hour range for Friday
          examples:
          - 09:00-17:00
        mon:
          type: string
          description: Operating hour range for Monday
          examples:
          - 09:00-17:00
        sat:
          type: string
          description: Operating hour range for Saturday
          examples:
          - 09:00-17:00
        sun:
          type: string
          description: Operating hour range for Sunday
          examples:
          - 09:00-17:00
        thu:
          type: string
          description: Operating hour range for Thursday
          examples:
          - 09:00-17:00
        tue:
          type: string
          description: Operating hour range for Tuesday
          examples:
          - 09:00-17:00
        wed:
          type: string
          description: Operating hour range for Wednesday
          examples:
          - 09:00-17:00
      description: Schedule during which engagement analytics rules apply
    idp_config2:
      title: idp_config2
      type: object
      properties:
        alert_only:
          type: boolean
          description: Whether to alert without enforcing IDP prevention actions
        enabled:
          type: boolean
          description: Whether IDP inspection is enabled for the policy
          default: false
        idpprofile_id:
          type: string
          description: org_level IDP Profile can be used, this takes precedence over `profile`
          contentEncoding: uuid
          examples:
          - 89b9d208-84a4-fa8f-af57-78f92c639cf2
        profile:
          type: string
          description: 'enum: `Custom`, `strict` (default), `standard` or keys from idp_profiles'
          default: strict
      description: Intrusion detection and prevention settings applied by this service policy
    idp_machine_cert_lookup_field1:
      title: idp_machine_cert_lookup_field1
      enum:
      - automatic
      - cn
      - dns
      type: string
      description: 'Client certificate field used to look up machine groups in identity providers. enum: `automatic`, `cn`, `dns`.'
    idp_profile_action2:
      title: idp_profile_action2
      enum:
      - alert
      - close
      - drop
      type: string
      description: 'Enforcement action applied when this overwrite rule matches. enum: `alert`, `close`, `drop`.'
      examples:
      - alert
    idp_profile_base_profile2:
      title: idp_profile_base_profile2
      enum:
      - critical
      - standard
      - strict
      type: string
      description: 'Built-in IDP baseline profile inherited before applying overwrites. enum: `critical`, `standard`, `strict`.'
      examples:
      - strict
    idp_profile_matching2:
      title: idp_profile_matching2
      type: object
      properties:
        attack_name:
          type: array
          items:
            type: string
          description: Signature names matched by the IDP profile overwrite
        dst_subnet:
          type: array
          items:
            type: string
          description: Destination subnets matched by the IDP profile overwrite
        severity:
          type: array
          items:
            $ref: '#/components/schemas/idp_profile_matching_severity_value'
          description: Threat levels matched by the IDP profile overwrite
      description: Criteria that select signatures for this overwrite rule
    idp_user_cert_lookup_field1:
      title: idp_user_cert_lookup_field1
      enum:
      - automatic
      - cn
      - email
      - upn
      type: string
      description: 'Client certificate field used to look up user groups in identity providers. enum: `automatic`, `cn`, `email`, `upn`.'
    if_stat_property_servp_info2:
      title: if_stat_property_servp_info2
      type: object
      properties:
        asn:
          type: string
          description: Autonomous System Number associated with the service provider
        city:
          type: string
          description: Detected city for the service provider address
        country_code:
          type: string
          description: ISO country code for the service provider address
        latitude:
          type: number
          description: Geographic latitude for the service provider address
        longitude:
          type: number
          description: Geographic longitude for the service provider address
        org:
          type: string
          description: Service provider organization name
        region_code:
          type: string
          description: Administrative region code for the service provider address
      description: Service-provider and geolocation details for this interface
    installer_device_ble_stat2:
      title: installer_device_ble_stat2
      type: object
      properties:
        major:
          type: integer
          description: iBeacon major value reported by the device
          contentEncoding: int32
          examples:
          - 12345
        minors:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: iBeacon minor values reported by the device
        uuid:
          type: string
          description: iBeacon UUID advertised by the device
          contentEncoding: uuid
          examples:
          - ada72f8f-1643-e5c6-94db-f2a5636f1a64
      description: BLE beacon statistics reported by the device
    inventory_update_operation2:
      title: inventory_update_operation2
      enum:
      - assign
      - delete
      - downgrade_to_jsi
      - unassign
      - upgrade_to_mist
      type: string
      description: 'Inventory operation to apply to the listed devices. enum: `assign`, `delete`, `downgrade_to_jsi`, `unassign`, `upgrade_to_mist`.'
    iotproxy_visionline2:
      title: iotproxy_visionline2
      type: object
      properties:
        access_id:
          type: string
          description: Access ID for the Visionline service
          examples:
          - 790e6c1790e6c18541d
        cacerts:
          type: array
          items:
            type: string
          description: PEM-encoded CA certificates used to verify the Visionline collector's TLS certificate. Required when the collector uses a self-signed certificate
        enabled:
          type: boolean
          description: Whether the Visionline integration is enabled
          default: false
        host:
          type: string
          description: Collector hostname or IP address for Visionline
          examples:
          - visionline_collector1.local
        password:
          type: string
          description: Visionline service password used by the IoT proxy
          contentEncoding: password
        port:
          type: integer
          description: TCP port of the Visionline collector
          contentEncoding: int32
          default: 443
        username:
          type: string
          description: Visionline service username used by the IoT proxy
          examples:
          - card_administrator
      description: Site access-control integration settings for Visionline
    iotproxy1:
      title: iotproxy1
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether the site IoT proxy is enabled
          default: false
        visionline:
          allOf:
          - $ref: '#/components/schemas/iotproxy_visionline2'
          - description: Site access-control integration settings for Visionline
      description: Proxy settings for IoT traffic at the site
    ip_stat1:
      title: ip_stat1
      type: object
      properties:
        dhcp_server:
          type:
          - string
          - 'null'
          description: Reported DHCP server IPv4 address for the interface, when available
          readOnly: true
          examples:
          - 192.168.95.1
        dns:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Reported DNS server addresses for the interface
        dns_suffix:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Reported DNS search suffixes for the interface
        gateway:
          type:
          - string
          - 'null'
          description: Current IPv4 default gateway for the interface, when available
          readOnly: true
        gateway6:
          type:
          - string
          - 'null'
          description: Current IPv6 default gateway for the interface, when available
          readOnly: true
          examples:
          - fdad:b0bc:f29e::1
        ip:
          type:
          - string
          - 'null'
          description: Current IPv4 address for the interface, when available
          readOnly: true
          examples:
          - 10.3.3.1
        ip6:
          type:
          - string
          - 'null'
          description: Current IPv6 address for the interface, when available
          readOnly: true
          examples:
          - fdad:b0bc:f29e::3d16
        ips:
          type: object
          additionalProperties:
            type: string
            nullable: true
          description: Per-VLAN IP address summaries keyed by VLAN name
        netmask:
          type:
          - string
          - 'null'
          description: Current IPv4 subnet mask for the interface, when available
          readOnly: true
          examples:
          - 255.255.255.0
        netmask6:
          type:
          - string
          - 'null'
          description: Current IPv6 prefix length for the interface, when available
          readOnly: true
          examples:
          - /64
      description: Read-only IP addressing status reported by the AP
    ip_stat2:
      title: ip_stat2
      type: object
      properties:
        dhcp_server:
          type:
          - string
          - 'null'
          description: Reported DHCP server IPv4 address for the interface, when available
          readOnly: true
          examples:
          - 192.168.95.1
        dns:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Reported DNS server addresses for the interface
        dns_suffix:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Reported DNS search suffixes for the interface
        gateway:
          type:
          - string
          - 'null'
          description: Current IPv4 default gateway for the interface, when available
          readOnly: true
        gateway6:
          type:
          - string
          - 'null'
          description: Current IPv6 default gateway for the interface, when available
          readOnly: true
          examples:
          - fdad:b0bc:f29e::1
        ip:
          type:
          - string
          - 'null'
          description: Current IPv4 address for the interface, when available
          readOnly: true
          examples:
          - 10.3.3.1
        ip6:
          type:
          - string
          - 'null'
          description: Current IPv6 address for the interface, when available
          readOnly: true
          examples:
          - fdad:b0bc:f29e::3d16
        ips:
          type: object
          additionalProperties:
            type: string
            nullable: true
          description: Per-VLAN IP address summaries keyed by VLAN name
        netmask:
          type:
          - string
          - 'null'
          description: Current IPv4 subnet mask for the interface, when available
          readOnly: true
          examples:
          - 255.255.255.0
        netmask6:
          type:
          - string
          - 'null'
          description: Current IPv6 prefix length for the interface, when available
          readOnly: true
          examples:
          - /64
      description: Layer 3 address statistics for the switch
    ip_stat3:
      title: ip_stat3
      type: object
      properties:
        dhcp_server:
          type:
          - string
          - 'null'
          description: Reported DHCP server IPv4 address for the interface, when available
          readOnly: true
          examples:
          - 192.168.95.1
        dns:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Reported DNS server addresses for the interface
        dns_suffix:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Reported DNS search suffixes for the interface
        gateway:
          type:
          - string
          - 'null'
          description: Current IPv4 default gateway for the interface, when available
          readOnly: true
        gateway6:
          type:
          - string
          - 'null'
          description: Current IPv6 default gateway for the interface, when available
          readOnly: true
          examples:
          - fdad:b0bc:f29e::1
        ip:
          type:
          - string
          - 'null'
          description: Current IPv4 address for the interface, when available
          readOnly: true
          examples:
          - 10.3.3.1
        ip6:
          type:
          - string
          - 'null'
          description: Current IPv6 address for the interface, when available
          readOnly: true
          examples:
          - fdad:b0bc:f29e::3d16
        ips:
          type: object
          additionalProperties:
            type: string
            nullable: true
          description: Per-VLAN IP address summaries keyed by VLAN name
        netmask:
          type:
          - string
          - 'null'
          description: Current IPv4 subnet mask for the interface, when available
          readOnly: true
          examples:
          - 255.255.255.0
        netmask6:
          type:
          - string
          - 'null'
          description: Current IPv6 prefix length for the interface, when available
          readOnly: true
          examples:
          - /64
      description: Layer 3 address statistics for the secondary HA node
    ip_stat4:
      title: ip_stat4
      type: object
      properties:
        dhcp_server:
          type:
          - string
          - 'null'
          description: Reported DHCP server IPv4 address for the interface, when available
          readOnly: true
          examples:
          - 192.168.95.1
        dns:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Reported DNS server addresses for the interface
        dns_suffix:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Reported DNS search suffixes for the interface
        gateway:
          type:
          - string
          - 'null'
          description: Current IPv4 default gateway for the interface, when available
          readOnly: true
        gateway6:
          type:
          - string
          - 'null'
          description: Current IPv6 default gateway for the interface, when available
          readOnly: true
          examples:
          - fdad:b0bc:f29e::1
        ip:
          type:
          - string
          - 'null'
          description: Current IPv4 address for the interface, when available
          readOnly: true
          examples:
          - 10.3.3.1
        ip6:
          type:
          - string
          - 'null'
          description: Current IPv6 address for the interface, when available
          readOnly: true
          examples:
          - fdad:b0bc:f29e::3d16
        ips:
          type: object
          additionalProperties:
            type: string
            nullable: true
          description: Per-VLAN IP address summaries keyed by VLAN name
        netmask:
          type:
          - string
          - 'null'
          description: Current IPv4 subnet mask for the interface, when available
          readOnly: true
          examples:
          - 255.255.255.0
        netmask6:
          type:
          - string
          - 'null'
          description: Current IPv6 prefix length for the interface, when available
          readOnly: true
          examples:
          - /64
      description: Layer 3 address statistics for the gateway or primary HA node
    ip_type1:
      title: ip_type1
      enum:
      - dhcp
      - static
      type: string
      description: 'IP assignment mode for this Junos IP configuration. enum: `dhcp`, `static`.'
      examples:
      - static
    ip_type2:
      title: ip_type2
      enum:
      - dhcp
      - static
      type: string
      description: 'IP assignment mode for the out-of-band management interface. enum: `dhcp`, `static`.'
      examples:
      - static
    ip_type3:
      title: ip_type3
      enum:
      - dhcp
      - static
      type: string
      description: 'IPv4 assignment mode for the additional Junos L3 presence. enum: `dhcp`, `static`.'
      examples:
      - static
    ip_type4:
      title: ip_type4
      enum:
      - dhcp
      - static
      type: string
      description: 'IPv4 address assignment mode for this gateway network interface. enum: `dhcp`, `static`.'
      examples:
      - static
    ip_type5:
      title: ip_type5
      enum:
      - dhcp
      - static
      type: string
      description: 'IP assignment mode for the node1 out-of-band management interface. enum: `dhcp`, `static`.'
      examples:
      - static
    ip_type9:
      title: ip_type9
      enum:
      - dhcp
      - static
      type: string
      description: 'IPv4 address assignment mode for out-of-band management. enum: `dhcp`, `static`.'
      examples:
      - static
    ip_type10:
      title: ip_type10
      enum:
      - dhcp
      - static
      type: string
      description: 'IPv6 address assignment mode for out-of-band management. enum: `dhcp`, `static`.'
      examples:
      - static
    ip_type11:
      title: ip_type11
      enum:
      - dhcp
      - static
      type: string
      description: 'IP assignment mode for in-band switch management. enum: `dhcp`, `static`.'
      examples:
      - static
    ip_type12:
      title: ip_type12
      enum:
      - dhcp
      - static
      type: string
      description: 'IP assignment mode for out-of-band switch management. enum: `dhcp`, `static`.'
      examples:
      - static
    ip_type13:
      title: ip_type13
      enum:
      - dhcp
      - static
      type: string
      description: 'IPv4 address assignment mode for AP management traffic. enum: `dhcp`, `static`.'
      examples:
      - static
    ip_type61:
      title: ip_type61
      enum:
      - autoconf
      - dhcp
      - disabled
      - static
      type: string
      description: 'IPv6 assignment mode for the additional Junos L3 presence. enum: `autoconf`, `dhcp`, `disabled`, `static`.'
      examples:
      - static
    ip_type62:
      title: ip_type62
      enum:
      - autoconf
      - dhcp
      - disabled
      - static
      type: string
      description: 'IPv6 address assignment mode for this gateway network interface. enum: `autoconf`, `dhcp`, `disabled`, `static`.'
      examples:
      - static
    ip_type64:
      title: ip_type64
      enum:
      - autoconf
      - dhcp
      - disabled
      - static
      type: string
      description: 'IPv6 address assignment mode for AP management traffic. enum: `autoconf`, `dhcp`, `disabled`, `static`.'
      examples:
      - static
    juniper_srx_auto_upgrade1:
      title: juniper_srx_auto_upgrade1
      type: object
      properties:
        custom_versions:
          type: object
          additionalProperties:
            type: string
          description: Per-SRX-model firmware versions to deploy instead of the default version
        enabled:
          type: boolean
          description: Whether SRX auto-upgrade is enabled for newly onboarded devices
          default: false
        snapshot:
          type: boolean
          description: Whether to take a snapshot during the SRX upgrade process
          default: false
        version:
          type: string
          description: Firmware version to deploy (e.g. 23.4R2-S5.5). Optional, used when custom_versions not specified
          examples:
          - 23.4R2-S5.5
      description: SRX auto-upgrade settings applied when Juniper SRX devices are first onboarded
    juniper_srx_auto_upgrade2:
      title: juniper_srx_auto_upgrade2
      type: object
      properties:
        custom_versions:
          type: object
          additionalProperties:
            type: string
          description: Per-SRX-model firmware versions to deploy instead of the default version
        enabled:
          type: boolean
          description: Whether SRX auto-upgrade is enabled for newly onboarded devices
          default: false
        snapshot:
          type: boolean
          description: Whether to take a snapshot during the SRX upgrade process
          default: false
        version:
          type: string
          description: Firmware version to deploy (e.g. 23.4R2-S5.5). Optional, used when custom_versions not specified
          examples:
          - 23.4R2-S5.5
      description: SRX auto-upgrade settings applied when SRX devices are onboarded
    junos_ip_config1:
      title: junos_ip_config1
      type: object
      properties:
        dns:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Configured DNS server addresses for Junos management traffic
        dns_suffix:
          uniqueItems: true
          type: array
          items:
            type: string
          description: DNS search suffixes configured for Junos management traffic
        gateway:
          type: string
          description: Default gateway IPv4 address for this Junos IP configuration
        ip:
          type: string
          description: Configured IPv4 address for this Junos IP configuration
        netmask:
          type: string
          description: Used only if `subnet` is not specified in `networks`
        network:
          type: string
          description: Management network for this IP configuration; used as the default source network for outbound SSH, DNS, NTP, TACACS+, RADIUS, syslog, and SNMP
        type:
          allOf:
          - $ref: '#/components/schemas/ip_type1'
          - description: 'IP assignment mode for this Junos IP configuration. enum: `dhcp`, `static`.'
            examples:
            - static
      description: Management IP addressing defaults in this switch profile
    junos_ip_config3:
      title: junos_ip_config3
      type: object
      properties:
        dns:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Configured DNS server addresses for Junos management traffic
        dns_suffix:
          uniqueItems: true
          type: array
          items:
            type: string
          description: DNS search suffixes configured for Junos management traffic
        gateway:
          type: string
          description: Default gateway IPv4 address for this Junos IP configuration
        ip:
          type: string
          description: Configured IPv4 address for this Junos IP configuration
        netmask:
          type: string
          description: Used only if `subnet` is not specified in `networks`
        network:
          type: string
          description: Management network for this IP configuration; used as the default source network for outbound SSH, DNS, NTP, TACACS+, RADIUS, syslog, and SNMP
        type:
          allOf:
          - $ref: '#/components/schemas/ip_type1'
          - description: 'IP assignment mode for this Junos IP configuration. enum: `dhcp`, `static`.'
            examples:
            - static
      description: Management IP addressing settings for this switch
    junos_port_config_duplex2:
      title: junos_port_config_duplex2
      enum:
      - auto
      - full
      - half
      type: string
      description: 'Link duplex mode for this Junos port. enum: `auto`, `full`, `half`.'
    junos_port_config_speed1:
      title: junos_port_config_speed1
      enum:
      - 10m
      - 100m
      - 1g
      - 2.5g
      - 5g
      - 10g
      - 25g
      - 40g
      - 100g
      - auto
      type: string
      description: 'Link speed for this Junos port. enum: `10m`, `100m`, `1g`, `2.5g`, `5g`, `10g`, `25g`, `40g`, `100g`, `auto`.'
    junos_port_config_speed3:
      title: junos_port_config_speed3
      enum:
      - 10m
      - 100m
      - 1g
      - 2.5g
      - 5g
      - 10g
      - 25g
      - 40g
      - 100g
      - auto
      type: string
      description: 'Link speed for this local port configuration. enum: `10m`, `100m`, `1g`, `2.5g`, `5g`, `10g`, `25g`, `40g`, `100g`, `auto`.'
    l2tp_state1:
      title: l2tp_state1
      enum:
      - established
      - established_with_session
      - idle
      - wait-ctrl-conn
      - wait-ctrl-reply
      type: string
      description: 'L2TP session state reported by the AP. enum: `established`, `established_with_session`, `idle`, `wait-ctrl-conn`, `wait-ctrl-reply`.'
      examples:
      - established
    l2tp_state2:
      title: l2tp_state2
      enum:
      - established
      - established_with_session
      - idle
      - wait-ctrl-conn
      - wait-ctrl-reply
      type: string
      description: 'L2TP tunnel state reported by the AP. enum: `established`, `established_with_session`, `idle`, `wait-ctrl-conn`, `wait-ctrl-reply`.'
      examples:
      - established
    last_trouble1:
      title: last_trouble1
      type: object
      properties:
        code:
          type: string
          description: Trouble code; definitions are listed at [List Ap Led Definition]($e/Constants%20Definitions/listApLedDefinition)
          examples:
          - '03'
        timestamp:
          type: number
          description: Time when the last trouble code was reported
          readOnly: true
      description: Most recent AP trouble indicator and timestamp
    last_trouble2:
      title: last_trouble2
      type: object
      properties:
        code:
          type: string
          description: Trouble code; definitions are listed at [List Ap Led Definition]($e/Constants%20Definitions/listApLedDefinition)
          examples:
          - '03'
        timestamp:
          type: number
          description: Time when the last trouble code was reported
          readOnly: true
      description: Most recent trouble-code summary reported for the switch
    lat_lng2:
      title: lat_lng2
      required:
      - lat
      - lng
      type: object
      properties:
        lat:
          type: number
          description: Geographic latitude in decimal degrees
          examples:
          - 37.295833
        lng:
          type: number
          description: Geographic longitude in decimal degrees
          examples:
          - -122.032946
      description: Latitude and longitude for the site location
    lat_lng4:
      title: lat_lng4
      required:
      - lat
      - lng
      type: object
      properties:
        lat:
          type: number
          description: Geographic latitude in decimal degrees
          examples:
          - 37.295833
        lng:
          type: number
          description: Geographic longitude in decimal degrees
          examples:
          - -122.032946
      description: Geographic coordinates of the installer site
    latlng_br1:
      title: latlng_br1
      type: object
      properties:
        lat:
          type: string
          description: Bottom-right latitude for the Google map bounds
        lng:
          type: string
          description: Bottom-right longitude for the Google map bounds
      description: When `type`==`google`, bottom-right map bounds coordinate
    latlng_tl1:
      title: latlng_tl1
      type: object
      properties:
        lat:
          type: string
          description: Top-left latitude for the Google map bounds
        lng:
          type: string
          description: Top-left longitude for the Google map bounds
      description: When `type`==`google`, top-left map bounds coordinate
    mac_table_stats1:
      title: mac_table_stats1
      type: object
      properties:
        mac_table_count:
          type: integer
          description: Number of learned MAC table entries currently present
          contentEncoding: int32
        max_mac_entries_supported:
          type: integer
          description: Maximum number of MAC table entries supported
          contentEncoding: int32
      description: Layer 2 MAC table utilization statistics for the switch
    map_import_json_vendor_name2:
      title: map_import_json_vendor_name2
      enum:
      - ekahau
      - ibwave
      type: string
      description: 'Map import vendor for the uploaded JSON. enum: `ekahau`, `ibwave`.'
      examples:
      - ekahau
    map_import_json1:
      title: map_import_json1
      required:
      - vendor_name
      type: object
      properties:
        import_all_floorplans:
          type: boolean
          description: Whether to import all floorplans from the uploaded map JSON
          default: false
        import_height:
          type: boolean
          description: Whether to import height metadata from the uploaded map JSON
          default: true
        import_orientation:
          type: boolean
          description: Whether to import orientation metadata from the uploaded map JSON
          default: true
        vendor_name:
          allOf:
          - $ref: '#/components/schemas/map_import_json_vendor_name2'
          - description: 'Map import vendor for the uploaded JSON. enum: `ekahau`, `ibwave`.'
            examples:
            - ekahau
      description: Import options for the site map file
    map_node_position2:
      title: map_node_position2
      required:
      - x
      - y
      type: object
      properties:
        x:
          type: number
          description: Horizontal coordinate of the map node
          examples:
          - 746
        y:
          type: number
          description: Vertical coordinate of the map node
          examples:
          - 104
      description: Coordinates of this map node
    map_org_import_file_json_vendor_name2:
      title: map_org_import_file_json_vendor_name2
      enum:
      - ekahau
      - ibwave
      type: string
      description: 'Map import vendor for the uploaded file. enum: `ekahau`, `ibwave`.'
      examples:
      - ekahau
    map_org_import_file_json2:
      title: map_org_import_file_json2
      required:
      - vendor_name
      type: object
      properties:
        import_all_floorplans:
          type: boolean
          description: Whether to import all floorplans from the uploaded map file
          default: false
        import_height:
          type: boolean
          description: Whether to import height metadata from the uploaded map file
          default: true
        import_orientation:
          type: boolean
          description: Whether to import orientation metadata from the uploaded map file
          default: true
        site_id:
          type: string
          description: Target site for imported floorplans, when specified
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        vendor_name:
          allOf:
          - $ref: '#/components/schemas/map_org_import_file_json_vendor_name2'
          - description: 'Map import vendor for the uploaded file. enum: `ekahau`, `ibwave`.'
            examples:
            - ekahau
      description: Import options for the organization map file
    map_site_replace_file_json_transform2:
      title: map_site_replace_file_json_transform2
      type: object
      properties:
        rotation:
          type: number
          description: Whether to rotate the replacing image, in degrees
          default: 0
        scale:
          type: number
          description: Whether to scale the replacing image
          default: 1
          examples:
          - 0.98
        x:
          type: number
          description: Where the (0, 0) of the new image is relative to the original map
          default: 0
          examples:
          - 3.16
        y:
          type: number
          description: Where the (0, 0) of the new image is relative to the original map
          default: 0
          examples:
          - 12
      description: Coordinate transform to apply when replacing the map image
    map_site_replace_file_json2:
      title: map_site_replace_file_json2
      type: object
      properties:
        transform:
          allOf:
          - $ref: '#/components/schemas/map_site_replace_file_json_transform2'
          - description: Coordinate transform to apply when replacing the map image
      description: Replacement transform options for the map image
    map_type2:
      title: map_type2
      enum:
      - google
      - image
      type: string
      description: Map type, such as `image` or `google`
      examples:
      - image
    map_view2:
      title: map_view2
      enum:
      - hybrid
      - roadmap
      - satellite
      - terrain
      type: string
      description: 'If `type`==`google`, map tile view to display. enum: `hybrid`, `roadmap`, `satellite`, `terrain`.'
    map_wall_path2:
      title: map_wall_path2
      type: object
      properties:
        coordinate:
          type: string
          description: Wall path coordinate space
          examples:
          - actual
        nodes:
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/map_node'
          description: Path nodes that define the wall geometry
      description: Wall path geometry for this map
    map_wayfinding_micello2:
      title: map_wayfinding_micello2
      type: object
      properties:
        account_key:
          type: string
          description: Micello account key used for wayfinding
          examples:
          - adasdf
        default_level_id:
          type: integer
          description: Default Micello floor or level identifier for wayfinding
          contentEncoding: int32
          examples:
          - 5
        map_id:
          type: string
          description: Micello map identifier used for wayfinding
          examples:
          - c660f81dd250c
      description: External Micello wayfinding integration settings for this map
    map_wayfinding_path2:
      title: map_wayfinding_path2
      type: object
      properties:
        coordinate:
          type: string
          description: Wayfinding path coordinate space
          examples:
          - actual
        nodes:
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/map_node'
          description: Path nodes used for wayfinding routes
      description: Wayfinding path geometry for this map
    map_wayfinding2:
      title: map_wayfinding2
      type: object
      properties:
        micello:
          allOf:
          - $ref: '#/components/schemas/map_wayfinding_micello2'
          - description: External Micello wayfinding integration settings for this map
        snap_to_path:
          type: boolean
          description: Whether wayfinding should snap routes to configured paths
      description: Navigation pathfinding settings for this map
    marvis_auto_operations2:
      title: marvis_auto_operations2
      type: object
      properties:
        ap_insufficient_capacity:
          type: boolean
          description: Whether Marvis may remediate AP insufficient-capacity issues automatically
          default: false
        ap_loop:
          type: boolean
          description: Whether Marvis may remediate AP loop issues automatically
          default: false
        ap_non_compliant:
          type: boolean
          description: Whether Marvis may remediate AP non-compliance automatically
          default: false
        bounce_port_for_abnormal_poe_client:
          type: boolean
          description: Whether Marvis may bounce switch ports for abnormal PoE clients
          default: false
        disable_port_when_ddos_protocol_violation:
          type: boolean
          description: Whether Marvis may disable a port when DDOS protocol violations are detected
          default: false
        disable_port_when_rogue_dhcp_server_detected:
          type: boolean
          description: Whether Marvis may disable a port when a rogue DHCP server is detected
          default: false
        gateway_non_compliant:
          type: boolean
          description: Whether Marvis may remediate non-compliant gateways automatically
          default: false
        switch_misconfigured_port:
          type: boolean
          description: Whether Marvis may remediate misconfigured switch ports automatically
          default: false
        switch_port_stuck:
          type: boolean
          description: Whether Marvis may remediate stuck switch ports automatically
          default: false
      description: Automatic remediation operations controlled by Marvis
    marvis_client_location2:
      title: marvis_client_location2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether location collection is enabled for Marvis Client
      description: Client location collection settings for Marvis Client
    marvis_client_telemetry2:
      title: marvis_client_telemetry2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether telemetry collection is enabled for Marvis Client
      description: Client telemetry collection settings for Marvis Client
    marvis_self_driving_domain1:
      title: marvis_self_driving_domain1
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether self-driving automation is enabled for this domain
          default: false
      description: Self-driving automation settings for the wired domain
    marvis_self_driving_domain2:
      title: marvis_self_driving_domain2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether self-driving automation is enabled for this domain
          default: false
      description: Self-driving automation settings for the wireless domain
    marvis_self_driving_domain4:
      title: marvis_self_driving_domain4
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether self-driving automation is enabled for this domain
          default: false
      description: Self-driving automation settings for the WAN domain
    marvis_self_driving1:
      title: marvis_self_driving1
      type: object
      properties:
        wan:
          allOf:
          - $ref: '#/components/schemas/marvis_self_driving_domain4'
          - description: Self-driving automation settings for the WAN domain
        wired:
          allOf:
          - $ref: '#/components/schemas/marvis_self_driving_domain1'
          - description: Self-driving automation settings for the wired domain
        wireless:
          allOf:
          - $ref: '#/components/schemas/marvis_self_driving_domain2'
          - description: Self-driving automation settings for the wireless domain
      description: Self-driving network automation settings by domain
    marvis1:
      title: marvis1
      type: object
      properties:
        auto_operations:
          allOf:
          - $ref: '#/components/schemas/marvis_auto_operations2'
          - description: Automatic remediation operations controlled by Marvis
      description: AI assistant settings for Marvis at the site
    memory_stat1:
      title: memory_stat1
      required:
      - usage
      type: object
      properties:
        usage:
          type: number
          description: Current memory utilization percentage for the device or master Routing Engine
      description: Utilization statistics for switch module memory
    memory_stat2:
      title: memory_stat2
      required:
      - usage
      type: object
      properties:
        usage:
          type: number
          description: Current memory utilization percentage for the device or master Routing Engine
      description: Utilization statistics for switch memory
    memory_stat3:
      title: memory_stat3
      required:
      - usage
      type: object
      properties:
        usage:
          type: number
          description: Current memory utilization percentage for the device or master Routing Engine
      description: Secondary-node memory utilization statistics for the gateway
    memory_stat4:
      title: memory_stat4
      required:
      - usage
      type: object
      properties:
        usage:
          type: number
          description: Current memory utilization percentage for the device or master Routing Engine
      description: Utilization statistics for gateway memory
    memory_stat5:
      title: memory_stat5
      required:
      - usage
      type: object
      properties:
        usage:
          type: number
          description: Current memory utilization percentage for the device or master Routing Engine
      description: Utilization statistics for gateway module memory
    mist_nacedge1:
      title: mist_nacedge1
      type: object
      properties:
        auth_ttl:
          maximum: 2592000
          minimum: 60
          type: integer
          description: Cache of last auth result; in seconds
          contentEncoding: int32
          default: 604800
        caching_site_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: List of site UUIDs whose auth requests should be cached by NAC Edges assigned to this site
          examples:
          - - 4ac1dcf4-9d8b-7910-ac87-6ad873648a5c
            - 7dc1acf4-9d8b-7910-ac87-6ad873648a5c
        default_dot1x_vlan:
          type: string
          description: Default vlan for all dot1x devices, if different from default_vlan
          examples:
          - '20'
        default_vlan:
          type: string
          description: Default vlan to assign for devices not in the cache
          examples:
          - test_vlan
        enabled:
          type: boolean
          description: Whether Mist Site Survivability is enabled for the site
        mxedge_hosts:
          type: array
          items:
            type: string
          description: NAC Edge hostnames used for the Site Survivability feature
          examples:
          - - mxedge1.local
      description: NAC Edge service settings for the site Mist Edge cluster
    module_stat_item_poe1:
      title: module_stat_item_poe1
      type: object
      properties:
        max_power:
          type: number
          description: Total PoE power budget available to the module, in watts
          examples:
          - 250
        power_draw:
          type: number
          description: Current PoE power draw on the module, in watts
          examples:
          - 120.3
        status:
          type: string
          description: Operational status of PoE on the module
      description: Power over Ethernet telemetry for the switch module
    module_stat_item_poe2:
      title: module_stat_item_poe2
      type: object
      properties:
        max_power:
          type: number
          description: Total PoE power budget available to the module, in watts
          examples:
          - 250
        power_draw:
          type: number
          description: Current PoE power draw on the module, in watts
          examples:
          - 120.3
        status:
          type: string
          description: Operational status of PoE on the module
      description: Power over Ethernet telemetry for the gateway module
    msp_license_action_operation2:
      title: msp_license_action_operation2
      enum:
      - amend
      - annotate
      - delete
      - unamend
      type: string
      description: 'License operation to perform for this MSP request. enum: `amend`, `annotate`, `delete`, `unamend`.'
    msp_org_change_operation2:
      title: msp_org_change_operation2
      enum:
      - assign
      - unassign
      type: string
      description: 'Assignment operation to apply to the listed org IDs. enum: `assign`, `unassign`.'
    msp_tier2:
      title: msp_tier2
      enum:
      - advanced
      - base
      type: string
      description: 'Service tier for the MSP account. enum: `advanced`, `base`.'
    mxcluster_nac_client_vendor2:
      title: mxcluster_nac_client_vendor2
      enum:
      - aruba
      - cisco-aironet
      - cisco-dnac
      - cisco-ios
      - cisco-meraki
      - brocade
      - generic
      - juniper
      - paloalto
      type: string
      description: 'RADIUS client vendor profile for this IP or subnet. enum: `aruba`, `cisco-aironet`, `cisco-dnac`, `cisco-ios`, `cisco-meraki`, `brocade`, `generic`, `juniper`, `paloalto`.'
      examples:
      - cisco-ios
    mxcluster_nac2:
      title: mxcluster_nac2
      type: object
      properties:
        acct_server_port:
          type: integer
          description: RADIUS accounting port used by Mist NAC on the cluster
          contentEncoding: int32
          default: 1813
        auth_server_port:
          type: integer
          description: RADIUS authentication port used by Mist NAC on the cluster
          contentEncoding: int32
          default: 1812
        client_ips:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/mxcluster_nac_client_ip'
          description: Property key is the RADIUS Client IP/Subnet.
        enabled:
          type: boolean
          description: Whether Mist NAC is enabled on the cluster
          default: false
        secret:
          type: string
          description: Shared RADIUS secret used by Mist NAC clients
          examples:
          - testing123
      description: RADIUS settings for Mist NAC on the site Mist Edge cluster
    mxcluster_nac3:
      title: mxcluster_nac3
      type: object
      properties:
        acct_server_port:
          type: integer
          description: RADIUS accounting port used by Mist NAC on the cluster
          contentEncoding: int32
          default: 1813
        auth_server_port:
          type: integer
          description: RADIUS authentication port used by Mist NAC on the cluster
          contentEncoding: int32
          default: 1812
        client_ips:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/mxcluster_nac_client_ip'
          description: Property key is the RADIUS Client IP/Subnet.
        enabled:
          type: boolean
          description: Whether Mist NAC is enabled on the cluster
          default: false
        secret:
          type: string
          description: Shared RADIUS secret used by Mist NAC clients
          examples:
          - testing123
      description: NAC settings for the Mist Edge cluster
    mxcluster_nacedge2:
      title: mxcluster_nacedge2
      type: object
      properties:
        auth_ttl:
          maximum: 2592000
          minimum: 60
          type: integer
          description: Cache TTL for last auth result in seconds
          contentEncoding: int32
          default: 604800
        caching_site_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: List of site UUIDs whose auth requests should be cached by NAC Edges in this cluster
          examples:
          - - 4ac1dcf4-9d8b-7910-ac87-6ad873648a5c
            - 7dc1acf4-9d8b-7910-ac87-6ad873648a5c
        default_dot1x_vlan:
          type: string
          description: Default VLAN for all dot1x devices, if different from default_vlan
          examples:
          - '20'
        default_vlan:
          type: string
          description: Default VLAN to assign for devices not in the cache
          examples:
          - testVlan
        enabled:
          type: boolean
          description: Whether NAC Edge survivability is enabled for this cluster
          default: false
        nac_edge_hosts:
          type: array
          items:
            type: string
          description: NAC Edge hostnames used by APs for survivability authentication
          examples:
          - - nac-west-1.corp.com
            - nac-west-2.corp.com
      description: NAC Edge survivability settings for the cluster; requires `mist_nac` to be enabled
    mxcluster_rad_auth_server_keywrap_format2:
      title: mxcluster_rad_auth_server_keywrap_format2
      enum:
      - ascii
      - hex
      type: string
      description: 'Encoding format for Mist AP RADIUS keywrap keys. enum: `ascii`, `hex`.'
    mxcluster_radsec_nas_ip_source2:
      title: mxcluster_radsec_nas_ip_source2
      enum:
      - any
      - oob
      - oob6
      - tunnel
      - tunnel6
      type: string
      description: 'Source used to populate NAS-IP-Address and NAS-IPv6-Address attributes. enum: `any`, `oob`, `oob6`, `tunnel`, `tunnel6`.'
    mxcluster_radsec_server_selection2:
      title: mxcluster_radsec_server_selection2
      enum:
      - ordered
      - unordered
      type: string
      description: 'RADIUS server selection strategy for RadSec failover. enum: `ordered`, `unordered`.'
    mxcluster_radsec_src_ip_source2:
      title: mxcluster_radsec_src_ip_source2
      enum:
      - any
      - oob
      - oob6
      - tunnel
      - tunnel6
      type: string
      description: 'Connection source interface or address used when reaching RADIUS servers. enum: `any`, `oob`, `oob6`, `tunnel`, `tunnel6`.'
    mxcluster_radsec_tls2:
      title: mxcluster_radsec_tls2
      type: object
      properties:
        keypair:
          type: string
          description: Name or identifier of the TLS keypair used by RadSec
      description: TLS keypair settings for RadSec on the Mist Edge cluster
    mxcluster_radsec2:
      title: mxcluster_radsec2
      type: object
      properties:
        acct_servers:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/mxcluster_radsec_acct_server'
          description: RADIUS accounting servers used by the RadSec proxy
        auth_servers:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/mxcluster_radsec_auth_server'
          description: RADIUS authentication servers used by the RadSec proxy
        enabled:
          type: boolean
          description: Whether to enable service on Mist Edge i.e. RADIUS proxy over TLS
        match_ssid:
          type: boolean
          description: Whether to match ssid in request message to select from a subset of RADIUS servers
        nas_ip_source:
          allOf:
          - $ref: '#/components/schemas/mxcluster_radsec_nas_ip_source2'
          - description: 'Source used to populate NAS-IP-Address and NAS-IPv6-Address attributes. enum: `any`, `oob`, `oob6`, `tunnel`, `tunnel6`.'
        proxy_hosts:
          type: array
          items:
            type: string
          description: AP-reachable hostnames or IP addresses advertised as RadSec TLS servers
        server_selection:
          allOf:
          - $ref: '#/components/schemas/mxcluster_radsec_server_selection2'
          - description: 'RADIUS server selection strategy for RadSec failover. enum: `ordered`, `unordered`.'
        src_ip_source:
          allOf:
          - $ref: '#/components/schemas/mxcluster_radsec_src_ip_source2'
          - description: 'Connection source interface or address used when reaching RADIUS servers. enum: `any`, `oob`, `oob6`, `tunnel`, `tunnel6`.'
      description: TLS-secured RADIUS proxy settings for the site Mist Edge cluster
    mxcluster_radsec3:
      title: mxcluster_radsec3
      type: object
      properties:
        acct_servers:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/mxcluster_radsec_acct_server'
          description: RADIUS accounting servers used by the RadSec proxy
        auth_servers:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/mxcluster_radsec_auth_server'
          description: RADIUS authentication servers used by the RadSec proxy
        enabled:
          type: boolean
          description: Whether to enable service on Mist Edge i.e. RADIUS proxy over TLS
        match_ssid:
          type: boolean
          description: Whether to match ssid in request message to select from a subset of RADIUS servers
        nas_ip_source:
          allOf:
          - $ref: '#/components/schemas/mxcluster_radsec_nas_ip_source2'
          - description: 'Source used to populate NAS-IP-Address and NAS-IPv6-Address attributes. enum: `any`, `oob`, `oob6`, `tunnel`, `tunnel6`.'
        proxy_hosts:
          type: array
          items:
            type: string
          description: AP-reachable hostnames or IP addresses advertised as RadSec TLS servers
        server_selection:
          allOf:
          - $ref: '#/components/schemas/mxcluster_radsec_server_selection2'
          - description: 'RADIUS server selection strategy for RadSec failover. enum: `ordered`, `unordered`.'
        src_ip_source:
          allOf:
          - $ref: '#/components/schemas/mxcluster_radsec_src_ip_source2'
          - description: 'Connection source interface or address used when reaching RADIUS servers. enum: `any`, `oob`, `oob6`, `tunnel`, `tunnel6`.'
      description: TLS RADIUS proxy settings for the Mist Edge cluster
    mxcluster_tunterm_hosts_selection2:
      title: mxcluster_tunterm_hosts_selection2
      enum:
      - ordered
      - shuffle
      - shuffle-by-site
      type: string
      description: 'Selection strategy for ordering tunnel termination hosts. enum: `ordered`, `shuffle`, `shuffle-by-site`.'
    mxedge_das2:
      title: mxedge_das2
      type: object
      properties:
        coa_servers:
          type: array
          items:
            $ref: '#/components/schemas/mxedge_das_coa_server'
          description: Dynamic authorization clients allowed to send CoA or Disconnect-Message requests
        enabled:
          type: boolean
          description: Whether cloud-assisted DAS is enabled for the Mist Edge cluster
          default: false
      description: DAS service settings for the site Mist Edge cluster
    mxedge_das3:
      title: mxedge_das3
      type: object
      properties:
        coa_servers:
          type: array
          items:
            $ref: '#/components/schemas/mxedge_das_coa_server'
          description: Dynamic authorization clients allowed to send CoA or Disconnect-Message requests
        enabled:
          type: boolean
          description: Whether cloud-assisted DAS is enabled for the Mist Edge cluster
          default: false
      description: Dynamic authorization service settings for the cluster
    mxedge_event_sys_info2:
      title: mxedge_event_sys_info2
      type: object
      properties:
        resource:
          type: string
          description: System resource referenced by the event
        severity:
          allOf:
          - $ref: '#/components/schemas/event_severity2'
          - description: 'Event severity for the system resource condition. enum: `normal`, `critical`, `high`, `warning`.'
      description: System resource usage details associated with the event
    mxedge_mgmt_oob_ip_type2:
      title: mxedge_mgmt_oob_ip_type2
      enum:
      - dhcp
      - disabled
      - static
      type: string
      description: 'IPv4 address assignment mode for out-of-band management. enum: `dhcp`, `disabled`, `static`.'
    mxedge_mgmt_oob_ip_type62:
      title: mxedge_mgmt_oob_ip_type62
      enum:
      - autoconf
      - dhcp
      - disabled
      - static
      type: string
      description: 'IPv6 address assignment mode for out-of-band management. enum: `autoconf`, `dhcp`, `disabled`, `static`.'
    mxedge_mgmt1:
      title: mxedge_mgmt1
      type: object
      properties:
        config_auto_revert:
          type: boolean
          description: Whether the Mist Edge automatically reverts configuration changes if connectivity is lost
          default: false
        fips_enabled:
          type: boolean
          description: Whether FIPS mode is enabled on the Mist Edge
          default: false
        mist_password:
          type: string
          description: Password for the Mist service account on the Mist Edge
          examples:
          - MIST_PASSWORD
        oob_ip_type:
          allOf:
          - $ref: '#/components/schemas/mxedge_mgmt_oob_ip_type2'
          - description: 'IPv4 address assignment mode for out-of-band management. enum: `dhcp`, `disabled`, `static`.'
        oob_ip_type6:
          allOf:
          - $ref: '#/components/schemas/mxedge_mgmt_oob_ip_type62'
          - description: 'IPv6 address assignment mode for out-of-band management. enum: `autoconf`, `dhcp`, `disabled`, `static`.'
        root_password:
          type: string
          description: Root account password for the Mist Edge
          contentEncoding: password
          examples:
          - ROOT_PASSWORD
      description: Management credentials and settings for the Mist Edge
    mxedge_mgmt3:
      title: mxedge_mgmt3
      type: object
      properties:
        config_auto_revert:
          type: boolean
          description: Whether the Mist Edge automatically reverts configuration changes if connectivity is lost
          default: false
        fips_enabled:
          type: boolean
          description: Whether FIPS mode is enabled on the Mist Edge
          default: false
        mist_password:
          type: string
          description: Password for the Mist service account on the Mist Edge
          examples:
          - MIST_PASSWORD
        oob_ip_type:
          allOf:
          - $ref: '#/components/schemas/mxedge_mgmt_oob_ip_type2'
          - description: 'IPv4 address assignment mode for out-of-band management. enum: `dhcp`, `disabled`, `static`.'
        oob_ip_type6:
          allOf:
          - $ref: '#/components/schemas/mxedge_mgmt_oob_ip_type62'
          - description: 'IPv6 address assignment mode for out-of-band management. enum: `autoconf`, `dhcp`, `disabled`, `static`.'
        root_password:
          type: string
          description: Root account password for the Mist Edge
          contentEncoding: password
          examples:
          - ROOT_PASSWORD
      description: Management settings for Mist Edge devices
    mxedge_mgmt4:
      title: mxedge_mgmt4
      type: object
      properties:
        config_auto_revert:
          type: boolean
          description: Whether the Mist Edge automatically reverts configuration changes if connectivity is lost
          default: false
        fips_enabled:
          type: boolean
          description: Whether FIPS mode is enabled on the Mist Edge
          default: false
        mist_password:
          type: string
          description: Password for the Mist service account on the Mist Edge
          examples:
          - MIST_PASSWORD
        oob_ip_type:
          allOf:
          - $ref: '#/components/schemas/mxedge_mgmt_oob_ip_type2'
          - description: 'IPv4 address assignment mode for out-of-band management. enum: `dhcp`, `disabled`, `static`.'
        oob_ip_type6:
          allOf:
          - $ref: '#/components/schemas/mxedge_mgmt_oob_ip_type62'
          - description: 'IPv6 address assignment mode for out-of-band management. enum: `autoconf`, `dhcp`, `disabled`, `static`.'
        root_password:
          type: string
          description: Root account password for the Mist Edge
          contentEncoding: password
          examples:
          - ROOT_PASSWORD
      description: Mist Edge management access settings for the site
    mxedge_mgmt5:
      title: mxedge_mgmt5
      type: object
      properties:
        config_auto_revert:
          type: boolean
          description: Whether the Mist Edge automatically reverts configuration changes if connectivity is lost
          default: false
        fips_enabled:
          type: boolean
          description: Whether FIPS mode is enabled on the Mist Edge
          default: false
        mist_password:
          type: string
          description: Password for the Mist service account on the Mist Edge
          examples:
          - MIST_PASSWORD
        oob_ip_type:
          allOf:
          - $ref: '#/components/schemas/mxedge_mgmt_oob_ip_type2'
          - description: 'IPv4 address assignment mode for out-of-band management. enum: `dhcp`, `disabled`, `static`.'
        oob_ip_type6:
          allOf:
          - $ref: '#/components/schemas/mxedge_mgmt_oob_ip_type62'
          - description: 'IPv6 address assignment mode for out-of-band management. enum: `autoconf`, `dhcp`, `disabled`, `static`.'
        root_password:
          type: string
          description: Root account password for the Mist Edge
          contentEncoding: password
          examples:
          - ROOT_PASSWORD
      description: Out-of-band management settings for Mist Edges in the cluster
    mxedge_oob_ip_config2:
      title: mxedge_oob_ip_config2
      type: object
      properties:
        autoconf6:
          type: boolean
          description: Whether IPv6 autoconfiguration is enabled on the out-of-band management interface
          default: true
        dhcp6:
          type: boolean
          description: Whether DHCPv6 is enabled on the out-of-band management interface
          default: true
        dns:
          type: array
          items:
            type: string
          description: Name server addresses for out-of-band management
          default:
          - 8.8.8.8
          - 8.8.4.4
          - 2001:4860:4860::8888
          - 2001:4860:4860::8844
          examples:
          - - 8.8.8.8
            - 4.4.4.4
            - 2001:4860:4860::8888
            - 2001:4860:4860::8844
        gateway:
          type: string
          description: If `type`=`static`, IPv4 default gateway for the out-of-band management interface
          examples:
          - 10.2.1.254
        gateway6:
          type: string
          description: If `type6`=`static`, IPv6 default gateway for the out-of-band management interface
          examples:
          - 2601:1700:43c0:dc0::1
        ip:
          type: string
          description: If `type`=`static`, IPv4 address for the out-of-band management interface
          examples:
          - 10.2.1.2
        ip6:
          type: string
          description: If `type6`=`static`, IPv6 address for the out-of-band management interface
          examples:
          - 2601:1700:43c0:dc0:20c:29ff:fea7:93bc
        netmask:
          type: string
          description: If `type`=`static`, IPv4 netmask for the out-of-band management interface
          examples:
          - 255.255.255.0
        netmask6:
          type: string
          description: If `type6`=`static`, IPv6 prefix length for the out-of-band management interface
          examples:
          - /64
        type:
          allOf:
          - $ref: '#/components/schemas/ip_type9'
          - description: 'IPv4 address assignment mode for out-of-band management. enum: `dhcp`, `static`.'
            examples:
            - static
        type6:
          allOf:
          - $ref: '#/components/schemas/ip_type10'
          - description: 'IPv6 address assignment mode for out-of-band management. enum: `dhcp`, `static`.'
            examples:
            - static
      description: Configured out-of-band management IP settings for the Mist Edge
    mxedge_oob_ip_config3:
      title: mxedge_oob_ip_config3
      type: object
      properties:
        autoconf6:
          type: boolean
          description: Whether IPv6 autoconfiguration is enabled on the out-of-band management interface
          default: true
        dhcp6:
          type: boolean
          description: Whether DHCPv6 is enabled on the out-of-band management interface
          default: true
        dns:
          type: array
          items:
            type: string
          description: Name server addresses for out-of-band management
          default:
          - 8.8.8.8
          - 8.8.4.4
          - 2001:4860:4860::8888
          - 2001:4860:4860::8844
          examples:
          - - 8.8.8.8
            - 4.4.4.4
            - 2001:4860:4860::8888
            - 2001:4860:4860::8844
        gateway:
          type: string
          description: If `type`=`static`, IPv4 default gateway for the out-of-band management interface
          examples:
          - 10.2.1.254
        gateway6:
          type: string
          description: If `type6`=`static`, IPv6 default gateway for the out-of-band management interface
          examples:
          - 2601:1700:43c0:dc0::1
        ip:
          type: string
          description: If `type`=`static`, IPv4 address for the out-of-band management interface
          examples:
          - 10.2.1.2
        ip6:
          type: string
          description: If `type6`=`static`, IPv6 address for the out-of-band management interface
          examples:
          - 2601:1700:43c0:dc0:20c:29ff:fea7:93bc
        netmask:
          type: string
          description: If `type`=`static`, IPv4 netmask for the out-of-band management interface
          examples:
          - 255.255.255.0
        netmask6:
          type: string
          description: If `type6`=`static`, IPv6 prefix length for the out-of-band management interface
          examples:
          - /64
        type:
          allOf:
          - $ref: '#/components/schemas/ip_type9'
          - description: 'IPv4 address assignment mode for out-of-band management. enum: `dhcp`, `static`.'
            examples:
            - static
        type6:
          allOf:
          - $ref: '#/components/schemas/ip_type10'
          - description: 'IPv6 address assignment mode for out-of-band management. enum: `dhcp`, `static`.'
            examples:
            - static
      description: Out-of-band management IP configuration for the Mist Edge
    mxedge_tunterm_dhcpd_config_type2:
      title: mxedge_tunterm_dhcpd_config_type2
      const: relay
      type: string
      description: 'DHCP handling mode for this tunneled VLAN. enum: `relay`.'
    mxedge_tunterm_dhcpd_config2:
      title: mxedge_tunterm_dhcpd_config2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether DHCP relay is enabled for Mist Tunneled VLANs
          default: false
        servers:
          type: array
          items:
            type: string
          description: DHCP relay server addresses used when `type`==`relay`
        type:
          allOf:
          - $ref: '#/components/schemas/mxedge_tunterm_dhcpd_type2'
          - description: 'DHCP handling mode for the global tunnel termination config. enum: `relay`.'
      additionalProperties:
        allOf:
        - $ref: '#/components/schemas/mxedge_tunterm_dhcpd_config_property'
        - description: Per-VLAN DHCP relay settings for a Mist Tunneled VLAN
      description: DHCP relay or server settings for Mist Tunneled VLANs
    mxedge_tunterm_dhcpd_type2:
      title: mxedge_tunterm_dhcpd_type2
      const: relay
      type: string
      description: 'DHCP handling mode for the global tunnel termination config. enum: `relay`.'
    mxedge_tunterm_igmp_snooping_config2:
      title: mxedge_tunterm_igmp_snooping_config2
      type: object
      properties:
        enabled:
          oneOf:
          - type: boolean
            default: false
          - type: string
            default: 'False'
          description: Whether IGMP snooping is enabled for the configured VLANs
        querier:
          allOf:
          - $ref: '#/components/schemas/mxedge_tunterm_igmp_snooping_querier2'
          - description: IGMP querier settings used with tunnel termination snooping
        vlan_ids:
          anyOf:
          - type: array
            items:
              maximum: 4096
              minimum: 0
              type: integer
              contentEncoding: int32
          - type: string
          description: List of VLAN IDs where tunnel termination performs IGMP snooping
      description: IGMP snooping settings for Mist Tunneled VLANs
    mxedge_tunterm_igmp_snooping_querier2:
      title: mxedge_tunterm_igmp_snooping_querier2
      type: object
      properties:
        max_response_time:
          type: integer
          description: Querier's query response interval, in tenths-of-seconds
          contentEncoding: int32
          examples:
          - 10
        mtu:
          type: integer
          description: The MTU we use (needed when forming large IGMPv3 Reports)
          contentEncoding: int32
          examples:
          - 1500
        query_interval:
          type: integer
          description: Querier's query interval, in seconds
          contentEncoding: int32
          examples:
          - 125
        robustness:
          maximum: 7
          minimum: 1
          type: integer
          description: IGMP querier robustness variable
          contentEncoding: int32
        version:
          type: integer
          description: Querier's maximum protocol version
          contentEncoding: int32
          examples:
          - 3
      description: IGMP querier settings used with tunnel termination snooping
    mxedge_tunterm_ip_config2:
      title: mxedge_tunterm_ip_config2
      required:
      - gateway
      - ip
      - netmask
      type: object
      properties:
        gateway:
          type: string
          description: IPv4 gateway for the Mist Tunnel interface
          examples:
          - 10.2.1.254
        gateway6:
          type: string
          description: IPv6 gateway for the Mist Tunnel interface
          examples:
          - 2001:1010:1010:1010::1
        ip:
          type: string
          description: Address on the untagged Mist Tunnel interface, in IPv4 format
          examples:
          - 10.2.1.1
        ip6:
          type: string
          description: Address on the Mist Tunnel interface, in IPv6 format
          examples:
          - 2001:1010:1010:1010::2
        netmask:
          type: string
          description: Subnet mask for the Mist Tunnel IPv4 address
          examples:
          - 255.255.255.0
        netmask6:
          type: string
          description: Prefix length for the Mist Tunnel IPv6 address
          examples:
          - /64
      description: Tunnel termination IP configuration for the Mist Edge
    mxedge_tunterm_multicast_mdns2:
      title: mxedge_tunterm_multicast_mdns2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether mDNS forwarding is enabled for the configured VLANs
        vlan_ids:
          uniqueItems: true
          type: array
          items:
            type: string
          description: List of VLAN IDs where mDNS forwarding is enabled
      description: Settings for mDNS forwarding on tunnel termination VLANs
    mxedge_tunterm_multicast_ssdp2:
      title: mxedge_tunterm_multicast_ssdp2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether SSDP forwarding is enabled for the configured VLANs
        vlan_ids:
          uniqueItems: true
          type: array
          items:
            type: string
          description: List of VLAN IDs where SSDP forwarding is enabled
      description: Settings for SSDP forwarding on tunnel termination VLANs
    mxedge_tunterm_switch_configs2:
      title: mxedge_tunterm_switch_configs2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether custom tunnel termination switch VLAN settings are enabled
      additionalProperties:
        allOf:
        - $ref: '#/components/schemas/mxedge_tunterm_switch_config'
        - description: Switch VLAN settings for one tunnel termination port
      description: Switch VLAN settings for tunnel termination
    mxedge_upgrade_channel1:
      title: mxedge_upgrade_channel1
      enum:
      - alpha
      - beta
      - stable
      type: string
      description: 'Upgrade channel to use for qualified versions. enum: `alpha`, `beta`, `stable`.'
    mxedge_upgrade_multi_allow_downgrades2:
      title: mxedge_upgrade_multi_allow_downgrades2
      type: object
      properties:
        mxagent:
          type: boolean
          description: Whether downgrades are allowed for the mxagent service
          default: false
        mxdas:
          type: boolean
          description: Whether downgrades are allowed for the mxdas service
          default: false
        mxocproxy:
          type: boolean
          description: Whether downgrades are allowed for the mxocproxy service
          default: false
        radsecproxy:
          type: boolean
          description: Whether downgrades are allowed for the radsecproxy service
          default: false
        tunterm:
          type: boolean
          description: Whether downgrades are allowed for the tunterm service
          default: false
      description: Per-service downgrade permission settings for this upgrade
    mxedge_upgrade_response_counts1:
      title: mxedge_upgrade_response_counts1
      required:
      - failed
      - queued
      - success
      - upgrading
      type: object
      properties:
        failed:
          type: integer
          description: Number of Mist Edge upgrades that failed
          contentEncoding: int32
        queued:
          type: integer
          description: Number of Mist Edge upgrades waiting to run
          contentEncoding: int32
        success:
          type: integer
          description: Number of Mist Edge upgrades completed successfully
          contentEncoding: int32
        upgrading:
          type: integer
          description: Number of Mist Edge upgrades currently in progress
          contentEncoding: int32
      description: Per-status counts of Mist Edge targets in this upgrade
    mxedge_upgrade_strategy2:
      title: mxedge_upgrade_strategy2
      enum:
      - canary
      - big_bang
      - serial
      type: string
      description: 'Upgrade rollout strategy for the selected Mist Edges. enum: `canary`, `big_bang`, `serial`.'
    mxedge_upgrade_version2:
      title: mxedge_upgrade_version2
      required:
      - mxagent
      - tunterm
      type: object
      properties:
        mxagent:
          type: string
          description: Target version for the mxagent service
        mxdas:
          type: string
          description: Target version for the mxdas service
          default: current
        mxocproxy:
          type: string
          description: Target version for the mxocproxy service
          default: current
        radsecproxy:
          type: string
          description: Target version for the radsecproxy service
          default: current
        tunterm:
          type: string
          description: Target version for the tunterm service
      description: Per-service target versions for the upgrade request
    mxedge_versions2:
      title: mxedge_versions2
      type: object
      properties:
        mxagent:
          type: string
          description: Reported version of the mxagent service
          readOnly: true
        tunterm:
          type: string
          description: Reported version of the tunnel termination service
          readOnly: true
      description: Service version information reported by the Mist Edge
    mxtunnel_ipsec2:
      title: mxtunnel_ipsec2
      type: object
      properties:
        dns_servers:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Name server addresses advertised for IPsec tunnel clients
        dns_suffix:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Search suffixes advertised for IPsec tunnel clients
        enabled:
          type: boolean
          description: Whether IPsec support is enabled for this Mist Tunnel
        extra_routes:
          type: array
          items:
            $ref: '#/components/schemas/mxtunnel_ipsec_extra_route'
          description: Additional routes advertised for the IPsec tunnel
        split_tunnel:
          type: boolean
          description: Whether split tunneling is enabled for IPsec clients
        use_mxedge:
          type: boolean
          description: Whether IPsec termination uses Mist Edge
      description: Security settings for IPsec support on this Mist Tunnel
    mxtunnel_protocol2:
      title: mxtunnel_protocol2
      enum:
      - ip
      - udp
      type: string
      description: 'Encapsulation protocol used for the site Mist Tunnel. enum: `ip`, `udp`.'
    mxtunnel_protocol3:
      title: mxtunnel_protocol3
      enum:
      - ip
      - udp
      type: string
      description: 'Encapsulation protocol used for the Mist Tunnel. enum: `ip`, `udp`.'
    nac_access_type2:
      title: nac_access_type2
      enum:
      - wireless
      - wired
      - vty
      type: string
      description: 'Access type for the NAC client event. enum: `wireless`, `wired`, `vty`.'
      examples:
      - wireless
    nac_access_type3:
      title: nac_access_type3
      enum:
      - wireless
      - wired
      - vty
      type: string
      description: 'Access type of the port where the NAC event occurred. enum: `wireless`, `wired`, `vty`.'
      examples:
      - wireless
    nac_access_type4:
      title: nac_access_type4
      enum:
      - wireless
      - wired
      - vty
      type: string
      description: 'Network access type for the NAC client. enum: `wireless`, `wired`, `vty`.'
      examples:
      - wireless
    nac_auth_type2:
      title: nac_auth_type2
      enum:
      - cert
      - device-auth
      - eap-teap
      - eap-tls
      - eap-ttls
      - idp
      - mab
      - eap-peap
      type: string
      description: 'Authentication method used for the NAC event. enum: `cert`, `device-auth`, `eap-teap`, `eap-tls`, `eap-ttls`, `idp`, `mab`, `eap-peap`.'
      examples:
      - eap-tls
    nac_auth_type3:
      title: nac_auth_type3
      enum:
      - cert
      - device-auth
      - eap-teap
      - eap-tls
      - eap-ttls
      - idp
      - mab
      - eap-peap
      type: string
      description: 'NAC authentication method that must match the request. enum: `cert`, `device-auth`, `eap-teap`, `eap-tls`, `eap-ttls`, `idp`, `mab`, `eap-peap`.'
      examples:
      - eap-tls
    nac_auth_type4:
      title: nac_auth_type4
      enum:
      - cert
      - device-auth
      - eap-teap
      - eap-tls
      - eap-ttls
      - idp
      - mab
      - eap-peap
      type: string
      description: 'Authentication method used for the NAC accounting session. enum: `cert`, `device-auth`, `eap-teap`, `eap-tls`, `eap-ttls`, `idp`, `mab`, `eap-peap`.'
      examples:
      - eap-tls
    nac_auth_type5:
      title: nac_auth_type5
      enum:
      - cert
      - device-auth
      - eap-teap
      - eap-tls
      - eap-ttls
      - idp
      - mab
      - eap-peap
      type: string
      description: 'Authentication method used by the NAC client. enum: `cert`, `device-auth`, `eap-teap`, `eap-tls`, `eap-ttls`, `idp`, `mab`, `eap-peap`.'
      examples:
      - eap-tls
    nac_client_last_status2:
      title: nac_client_last_status2
      enum:
      - permitted
      - session_started
      - session_stopped
      - denied
      type: string
      description: 'Most recent NAC authentication status for the client. enum: `permitted`, `session_started`, `session_stopped`, `denied`.'
      examples:
      - permitted
    nac_coa_type2:
      title: nac_coa_type2
      enum:
      - reauth
      - disconnect
      type: string
      description: 'Change of Authorization action sent for MDM posture changes. enum: `reauth`, `disconnect`.'
    nac_coa_type3:
      title: nac_coa_type3
      enum:
      - reauth
      - disconnect
      type: string
      description: 'Change of Authorization command to send to the NAC client. enum: `reauth`, `disconnect`.'
    nac_portal_access_type2:
      title: nac_portal_access_type2
      enum:
      - wireless
      - wireless+wired
      type: string
      description: 'If `type`==`marvis_client`, whether onboarding applies to wireless clients or both wireless and wired clients. enum: `wireless`, `wireless+wired`.'
    nac_portal_eap_type2:
      title: nac_portal_eap_type2
      enum:
      - wpa2
      - wpa3
      type: string
      description: 'EAP mode used when onboarding wireless clients through the NAC portal. enum: `wpa2`, `wpa3`.'
    nac_portal_guest_portal_auth2:
      title: nac_portal_guest_portal_auth2
      enum:
      - external
      - multi
      - none
      type: string
      description: 'Mode presented by the NAC guest portal for user authentication. enum: `external`, `multi`, `none`.'
    nac_portal_guest_portal2:
      title: nac_portal_guest_portal2
      type: object
      properties:
        auth:
          allOf:
          - $ref: '#/components/schemas/nac_portal_guest_portal_auth2'
          - description: 'Mode presented by the NAC guest portal for user authentication. enum: `external`, `multi`, `none`.'
        expire:
          type: integer
          description: If `auth`==`none` or `auth`==`multi`, whether to expire the guest after a certain time
          contentEncoding: int32
          examples:
          - 1440
        external_portal_url:
          type: string
          description: If `auth`==`external`, the URL to redirect the user to for authentication
          examples:
          - https://yourorg.com/external-guest-portal
        force_reconnect:
          type: boolean
          description: Disconnect client (workaround for reauth issues)
        forward:
          type: boolean
          description: If `auth`==`none` or `auth`==`multi`, whether to forward the user to the guest portal after authentication
          examples:
          - true
        forward_url:
          type: string
          description: If `auth`==`none` or `auth`==`multi`, URL to forward the user to after authentication
          examples:
          - https://yourorg.com/guest-portal-redirect
        max_num_devices:
          maximum: 100
          minimum: 0
          type: integer
          description: Maximum number of clients allowed per guest. 0 (default, unlimited), 1-100 range
          contentEncoding: int32
          default: 0
          examples:
          - 10
        privacy:
          type: boolean
          description: If `auth`==`none` or `auth`==`multi`, whether to show the privacy policy
          examples:
          - true
      description: Guest portal settings used when `type`==`guest_portal`
    nac_portal_sso_idp_sign_algo2:
      title: nac_portal_sso_idp_sign_algo2
      enum:
      - sha1
      - sha256
      - sha384
      - sha512
      type: string
      description: 'Signing algorithm expected for SAML assertions from the identity provider. enum: `sha1`, `sha256`, `sha384`, `sha512`.'
    nac_portal_sso2:
      title: nac_portal_sso2
      type: object
      properties:
        idp_cert:
          type: string
          description: Identity provider certificate used to verify signed SAML responses
          examples:
          - '-----BEGIN CERTIFICATE-----\n<redacted>\n-----END CERTIFICATE-----'
        idp_sign_algo:
          allOf:
          - $ref: '#/components/schemas/nac_portal_sso_idp_sign_algo2'
          - description: 'Signing algorithm expected for SAML assertions from the identity provider. enum: `sha1`, `sha256`, `sha384`, `sha512`.'
        idp_sso_url:
          type: string
          description: Identity provider Single Sign-On URL for SAML authentication
          examples:
          - https://yourorg.onelogin.com/trust/saml2/http-post/sso/138130
        issuer:
          type: string
          description: Identity provider issuer URL for SAML authentication
          examples:
          - https://app.onelogin.com/saml/metadata/138130
        nameid_format:
          type: string
          description: SAML NameID format expected from the identity provider
          examples:
          - email
        sso_role_matching:
          type: array
          items:
            $ref: '#/components/schemas/nac_portal_sso_role_matching'
          description: Rules that map SSO role values from the identity provider to NAC portal roles
        use_sso_role_for_cert:
          type: boolean
          description: Whether to include the matched SSO role in the issued certificate subject for later policy matching
      description: SAML SSO settings for NAC portal authentication and role mapping
    nac_portal_type2:
      title: nac_portal_type2
      enum:
      - guest_admin
      - guest_portal
      - marvis_client
      type: string
      description: 'NAC portal mode, such as guest admin, guest portal, or Marvis client onboarding. enum: `guest_admin`, `guest_portal`, `marvis_client`.'
    nac_rule_action2:
      title: nac_rule_action2
      enum:
      - allow
      - block
      type: string
      description: Allow or block decision applied when the NAC rule matches
      examples:
      - allow
    nac_rule_guest_auth_state2:
      title: nac_rule_guest_auth_state2
      enum:
      - authorized
      - unknown
      type: string
      description: 'Guest portal authorization state condition for the rule. enum: `authorized`, `unknown`.'
      examples:
      - authorized
    nac_rule_matching1:
      title: nac_rule_matching1
      type: object
      properties:
        auth_type:
          allOf:
          - $ref: '#/components/schemas/nac_auth_type3'
          - description: 'NAC authentication method that must match the request. enum: `cert`, `device-auth`, `eap-teap`, `eap-tls`, `eap-ttls`, `idp`, `mab`, `eap-peap`.'
            examples:
            - eap-tls
        family:
          type: array
          items:
            type: string
          description: Client device family values that must match the request
        mfg:
          type: array
          items:
            type: string
          description: Client device manufacturer values that must match the request
        model:
          type: array
          items:
            type: string
          description: Client device model values that must match the request
        nactags:
          type: array
          items:
            type: string
          description: NAC tag IDs whose match criteria must be satisfied by the request
          examples:
          - - 041d5d36-716c-4cfb-4988-3857c6aa14a2
            - a809a97f-d599-f812-eb8c-c3f84aabf6ba
        os_type:
          type: array
          items:
            type: string
          description: Client OS type values that must match the request
        port_types:
          type: array
          items:
            $ref: '#/components/schemas/nac_rule_matching_port_type'
          description: Wired or wireless access types that must match the request
          examples:
          - - wired
        site_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Site IDs where the rule criteria apply
          examples:
          - - bb19fc3e-4124-4b57-80d9-c3f6edce47c4
            - bb19fc3e-6564-4b57-80d9-c3f6edce47c1
        sitegroup_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Site group IDs where the rule criteria apply
          examples:
          - - bb19fc3e-4124-4b57-80d9-c3f6edce47c4
            - bb19fc3e-6564-4b57-80d9-c3f6edce47c1
        vendor:
          type: array
          items:
            type: string
          description: Client device vendor values that must match the request
      description: Criteria that must not match for the NAC rule to apply
    nac_rule_matching3:
      title: nac_rule_matching3
      type: object
      properties:
        auth_type:
          allOf:
          - $ref: '#/components/schemas/nac_auth_type3'
          - description: 'NAC authentication method that must match the request. enum: `cert`, `device-auth`, `eap-teap`, `eap-tls`, `eap-ttls`, `idp`, `mab`, `eap-peap`.'
            examples:
            - eap-tls
        family:
          type: array
          items:
            type: string
          description: Client device family values that must match the request
        mfg:
          type: array
          items:
            type: string
          description: Client device manufacturer values that must match the request
        model:
          type: array
          items:
            type: string
          description: Client device model values that must match the request
        nactags:
          type: array
          items:
            type: string
          description: NAC tag IDs whose match criteria must be satisfied by the request
          examples:
          - - 041d5d36-716c-4cfb-4988-3857c6aa14a2
            - a809a97f-d599-f812-eb8c-c3f84aabf6ba
        os_type:
          type: array
          items:
            type: string
          description: Client OS type values that must match the request
        port_types:
          type: array
          items:
            $ref: '#/components/schemas/nac_rule_matching_port_type'
          description: Wired or wireless access types that must match the request
          examples:
          - - wired
        site_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Site IDs where the rule criteria apply
          examples:
          - - bb19fc3e-4124-4b57-80d9-c3f6edce47c4
            - bb19fc3e-6564-4b57-80d9-c3f6edce47c1
        sitegroup_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Site group IDs where the rule criteria apply
          examples:
          - - bb19fc3e-4124-4b57-80d9-c3f6edce47c4
            - bb19fc3e-6564-4b57-80d9-c3f6edce47c1
        vendor:
          type: array
          items:
            type: string
          description: Client device vendor values that must match the request
      description: Criteria that must match for the NAC rule to apply
    nac_tag_match2:
      title: nac_tag_match2
      enum:
      - cert_cn
      - cert_eku
      - cert_issuer
      - cert_san
      - cert_serial
      - cert_sub
      - cert_template
      - client_mac
      - edr_status
      - gbp_tag
      - hostname
      - idp_role
      - ingress_vlan
      - mdm_status
      - nas_ip
      - radius_group
      - realm
      - ssid
      - user_name
      - usermac_label
      type: string
      description: 'If `type`==`match`, client or authentication attribute used for rule matching. enum: `cert_cn`, `cert_eku`, `cert_issuer`, `cert_san`, `cert_serial`, `cert_sub`, `cert_template`, `client_mac`, `edr_status`, `gbp_tag`, `hostname`, `idp_role`, `ingress_vlan`, `mdm_status`, `nas_ip`, `radius_group`, `realm`, `ssid`, `user_name`, `usermac_label`.'
    nac_tag_type2:
      title: nac_tag_type2
      enum:
      - egress_vlan_names
      - gbp_tag
      - match
      - radius_attrs
      - radius_group
      - radius_vendor_attrs
      - redirect_nacportal_id
      - session_timeout
      - username_attr
      - vlan
      type: string
      description: 'NAC tag type that determines whether the tag is a matcher or a result attribute. enum: `egress_vlan_names`, `gbp_tag`, `match`, `radius_attrs`, `radius_group`, `radius_vendor_attrs`, `redirect_nacportal_id`, `session_timeout`, `username_attr`, `vlan`.'
    nac_tag_username_attr2:
      title: nac_tag_username_attr2
      enum:
      - automatic
      - cn
      - dns
      - email
      - upn
      type: string
      description: 'If `type`==`username_attr`, attribute used to derive the username returned by the NAC rule. enum: `automatic`, `cn`, `dns`, `email`, `upn`.'
    network_internal_access2:
      title: network_internal_access2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether internal access is enabled for this network
      description: Internal access settings for this network
    network_internet_access2:
      title: network_internet_access2
      type: object
      properties:
        create_simple_service_policy:
          type: boolean
          description: Whether Mist should create simple service policies for restricted internet access
          default: false
        destination_nat:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/network_internet_access_destination_nat_property'
          description: Destination NAT rules for direct internet access
        enabled:
          type: boolean
          description: Whether direct internet access is enabled for this network
        restricted:
          type: boolean
          description: By default, all access is allowed, to only allow certain traffic, make `restricted`=`true` and define service_policies
          default: false
        static_nat:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/network_internet_access_static_nat_property'
          description: Static NAT rules for direct internet access
      description: Direct internet access and NAT settings for this network
    network_multicast2:
      title: network_multicast2
      type: object
      properties:
        disable_igmp:
          type: boolean
          description: If the network will only be the source of the multicast traffic, IGMP can be disabled
          default: false
        enabled:
          type: boolean
          description: Whether multicast support is enabled for this network
          default: false
        groups:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/network_multicast_group'
          description: Multicast group-to-RP mappings for this network
      description: Settings for multicast routing on this network
    network_source_nat2:
      title: network_source_nat2
      type: object
      properties:
        external_ip:
          type: string
          description: External source NAT IP or subnet used when spoke hosts must be reachable from the hub
          examples:
          - 172.16.0.8/30
      description: Source NAT settings used when non-routed spoke hosts must be reachable from the hub
    oauth_ping_identity_region1:
      title: oauth_ping_identity_region1
      enum:
      - asia
      - au
      - ca
      - eu
      - us
      type: string
      description: 'Ping Identity region for OAuth SSO when `oauth_type`==`ping_identity`. enum: `asia`, `au`, `ca`, `eu`, `us`.'
    oauth_provider_domain1:
      title: oauth_provider_domain1
      enum:
      - okta.com
      - oktapreview.com
      - okta-emea.com
      - okta-gov.com
      - okta.mil
      - mtls.okta.com
      type: string
      description: 'Provider domain for Okta OAuth SSO when `oauth_type`==`okta`. enum: `okta.com`, `oktapreview.com`, `okta-emea.com`, `okta-gov.com`, `okta.mil`, `mtls.okta.com`.'
      examples:
      - okta.com
    org_e911_report_status2:
      title: org_e911_report_status2
      enum:
      - disabled
      - scheduled
      - available
      type: string
      description: 'Current generation state of the E911 AP BSSID report. enum: `disabled`, `scheduled`, `available`.'
    org_license_action_operation2:
      title: org_license_action_operation2
      enum:
      - amend
      - annotate
      - delete
      - unamend
      type: string
      description: 'License action operation to perform. enum: `amend`, `annotate`, `delete`, `unamend`.'
    org_setting_api_policy2:
      title: org_setting_api_policy2
      type: object
      properties:
        enforce_src_ips_for_tokens:
          type: boolean
          description: Optional. When `true`, Org API tokens without their own `src_ips` also respect the org policy `src_ips`. Default is `false`.
          default: false
        no_reveal:
          type: boolean
          description: >-
            By default, API hides password/secrets when the user doesn't have write access
              * `true`: API will hide passwords/secrets for all users
              * `false`: API will hide passwords/secrets for read-only users
          default: false
        src_ips:
          maxItems: 10
          type: array
          items:
            type: string
          description: Optional list of IP addresses or CIDR subnets from which org API access is allowed. At most 10 entries. The source IP of the request making this update must be within one of the specified subnets.
          examples:
          - - 63.3.56.0/24
            - 63.3.55.4
      description: Policy for hiding API secrets and passwords in responses
    org_setting_auto_device_naming_rule_src2:
      title: org_setting_auto_device_naming_rule_src2
      enum:
      - lldp_port_desc
      - mac
      type: string
      description: 'Device attribute used to generate the name. enum: `lldp_port_desc`, `mac`.'
    org_setting_auto_device_naming2:
      title: org_setting_auto_device_naming2
      type: object
      properties:
        enable:
          type: boolean
          description: Whether automatic device naming is enabled
        rules:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/org_setting_auto_device_naming_rule'
          description: List of rules used to derive device names automatically
      description: Automatic device naming rules for claimed devices
    org_setting_auto_deviceprofile_assignment2:
      title: org_setting_auto_deviceprofile_assignment2
      type: object
      properties:
        enable:
          type: boolean
          description: Whether automatic device profile assignment is enabled
        rules:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/org_setting_auto_assignment_rule'
          description: Assignment rules evaluated for automatic device profile selection
      description: Automatic device profile assignment rules for claimed devices
    org_setting_auto_site_assignment_src2:
      title: org_setting_auto_site_assignment_src2
      enum:
      - ext_ip
      - dns_suffix
      - geoip
      - lldp_port_desc
      - lldp_system_name
      - model
      - name
      - subnet
      type: string
      description: 'Source attribute used to evaluate the automatic assignment rule. enum: `ext_ip`, `dns_suffix`, `geoip`, `lldp_port_desc`, `lldp_system_name`, `model`, `name`, `subnet`.'
    org_setting_auto_site_assignment2:
      title: org_setting_auto_site_assignment2
      type: object
      properties:
        enable:
          type: boolean
          description: Whether automatic site assignment is enabled
        rules:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/org_setting_auto_assignment_rule'
          description: Assignment rules evaluated for automatic site selection
      description: Automatic site assignment rules for claimed devices
    org_setting_auto_upgrade2:
      title: org_setting_auto_upgrade2
      type: object
      properties:
        custom_versions:
          type: object
          additionalProperties:
            type: string
          description: Per-AP-model firmware versions or channels used for auto-upgrade
          examples:
          - AP21: alpha
            AP41: 0.1.5135
            AP61: 0.1.7215
        day_of_week:
          allOf:
          - $ref: '#/components/schemas/day_of_week3'
          - description: 'Day of the week for the AP auto-upgrade maintenance window. enum: `any`, `fri`, `mon`, `sat`, `sun`, `thu`, `tue`, `wed`.'
        enabled:
          type: boolean
          description: Whether AP auto-upgrade is enabled. Note that Mist may auto-upgrade APs if the running version is no longer supported.
          default: false
        time_of_day:
          type: string
          description: '`any` or HH:MM (24-hour format). Upgrade will happen within up to 1 hour from this time.'
          examples:
          - 12:00
        version:
          allOf:
          - $ref: '#/components/schemas/site_auto_upgrade_version3'
          - description: 'Firmware release channel or specific version used for AP auto-upgrade. enum: `beta`, `custom`, `stable`.'
            examples:
            - beta
      description: AP automatic firmware upgrade policy for the organization
    org_setting_device_cert2:
      title: org_setting_device_cert2
      type: object
      properties:
        cert:
          type: string
          description: PEM-encoded common device certificate used by organization settings
          examples:
          - '-----BEGIN CERTIFICATE-----\nMIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE\n-----END CERTIFICATE-----'
        key:
          type: string
          description: Private key paired with the common device certificate
          examples:
          - '-----BEGIN PRI...'
      description: Common device certificate used by organization settings
    org_setting_gateway_mgmt_app_probing2:
      title: org_setting_gateway_mgmt_app_probing2
      type: object
      properties:
        apps:
          type: array
          items:
            type: string
          description: Predefined application keys to probe from managed gateways
          examples:
          - - facebook
      description: Application probing configuration applied to managed gateways
    org_setting_gateway_mgmt_host_in_policies2:
      title: org_setting_gateway_mgmt_host_in_policies2
      type: object
      properties:
        icmp:
          allOf:
          - $ref: '#/components/schemas/org_setting_gateway_mgmt_host_in_policy3'
          - description: Host-in access policy for ICMP traffic to managed gateways
        snmp:
          allOf:
          - $ref: '#/components/schemas/org_setting_gateway_mgmt_host_in_policy1'
          - description: Host-in access policy for SNMP traffic to managed gateways
      description: Host-in access policies for gateway management services such as ICMP and SNMP
    org_setting_gateway_mgmt_host_in_policy1:
      title: org_setting_gateway_mgmt_host_in_policy1
      type: object
      properties:
        tenants:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Tenant names this host-in policy applies to
      description: Host-in access policy for SNMP traffic to managed gateways
    org_setting_gateway_mgmt_host_in_policy3:
      title: org_setting_gateway_mgmt_host_in_policy3
      type: object
      properties:
        tenants:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Tenant names this host-in policy applies to
      description: Host-in access policy for ICMP traffic to managed gateways
    org_setting_gateway_mgmt_host_out_policies2:
      title: org_setting_gateway_mgmt_host_out_policies2
      type: object
      properties:
        dns:
          allOf:
          - $ref: '#/components/schemas/gateway_mgmt_host_out_policy1'
          - description: Path preference policy for gateway-originated DNS traffic
        ntp:
          allOf:
          - $ref: '#/components/schemas/gateway_mgmt_host_out_policy2'
          - description: Path preference policy for gateway-originated NTP traffic
        syslog:
          allOf:
          - $ref: '#/components/schemas/gateway_mgmt_host_out_policy_syslog1'
          - description: Path preference policy for gateway-originated syslog traffic
      description: Path preference policies for gateway-originated management traffic
    org_setting_gateway_mgmt_overlay_ip2:
      title: org_setting_gateway_mgmt_overlay_ip2
      type: object
      properties:
        ip:
          type: string
          description: When it's going overlay, a routable IP to overlay will be required
        node1_ip:
          type: string
          description: For SSR HA cluster, another IP for node1 will be required, too
      description: Overlay IP addresses used when gateway management traffic uses the overlay
    org_setting_gateway_mgmt2:
      title: org_setting_gateway_mgmt2
      type: object
      properties:
        app_probing:
          allOf:
          - $ref: '#/components/schemas/org_setting_gateway_mgmt_app_probing2'
          - description: Application probing configuration applied to managed gateways
        app_usage:
          type: boolean
          description: For SRX only, whether gateway application usage collection is enabled; requires App Track license
        fips_enabled:
          type: boolean
          description: Whether FIPS mode is enabled for managed gateways
          default: false
        host_in_policies:
          allOf:
          - $ref: '#/components/schemas/org_setting_gateway_mgmt_host_in_policies2'
          - description: Host-in access policies for gateway management services such as ICMP and SNMP
        host_out_policies:
          allOf:
          - $ref: '#/components/schemas/org_setting_gateway_mgmt_host_out_policies2'
          - description: Path preference policies for gateway-originated management traffic
        overlay_ip:
          allOf:
          - $ref: '#/components/schemas/org_setting_gateway_mgmt_overlay_ip2'
          - description: Overlay IP addresses used when gateway management traffic uses the overlay
      description: Gateway management defaults for the organization
    org_setting_installer2:
      title: org_setting_installer2
      type: object
      properties:
        allow_all_devices:
          type: boolean
          description: Whether installers may work with all eligible devices
        allow_all_sites:
          type: boolean
          description: Whether installers may work with all sites
        extra_site_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Additional site IDs that installers may access
        grace_period:
          type: integer
          description: Grace period, in days, during which installers can modify recent sites or devices
          contentEncoding: int32
      description: Access settings for organization installer workflows
    org_setting_jcloud_ra2:
      title: org_setting_jcloud_ra2
      type: object
      properties:
        org_apitoken:
          type: string
          description: JCloud Routing Assurance Org Token
        org_apitoken_name:
          type: string
          description: JCloud Routing Assurance Org Token Name
        org_id:
          type: string
          description: JCloud Routing Assurance Org ID
      description: Routing Assurance integration settings for JCloud
    org_setting_jcloud2:
      title: org_setting_jcloud2
      type: object
      properties:
        org_apitoken:
          type: string
          description: JCloud organization API token used by this Mist organization
        org_apitoken_name:
          type: string
          description: Display name for the JCloud organization API token
        org_id:
          type: string
          description: JCloud organization identifier linked to this Mist organization
      description: Integration settings for JCloud
    org_setting_juniper_srx2:
      title: org_setting_juniper_srx2
      type: object
      properties:
        auto_upgrade:
          allOf:
          - $ref: '#/components/schemas/juniper_srx_auto_upgrade1'
          - description: SRX auto-upgrade settings applied when Juniper SRX devices are first onboarded
      description: SRX integration settings for Juniper devices
    org_setting_junos_shell_access_admin2:
      title: org_setting_junos_shell_access_admin2
      enum:
      - admin
      - none
      - viewer
      type: string
      description: 'Shell access level used for administrator web-shell sessions. enum: `admin`, `none`, `viewer`.'
    org_setting_junos_shell_access_helpdesk2:
      title: org_setting_junos_shell_access_helpdesk2
      enum:
      - admin
      - none
      - viewer
      type: string
      description: 'Shell access level used for helpdesk web-shell sessions. enum: `admin`, `none`, `viewer`.'
    org_setting_junos_shell_access_read2:
      title: org_setting_junos_shell_access_read2
      enum:
      - admin
      - none
      - viewer
      type: string
      description: 'Shell access level used for read-only web-shell sessions. enum: `admin`, `none`, `viewer`.'
    org_setting_junos_shell_access_write2:
      title: org_setting_junos_shell_access_write2
      enum:
      - admin
      - none
      - viewer
      type: string
      description: 'Shell access level used for write-role web-shell sessions. enum: `admin`, `none`, `viewer`.'
    org_setting_junos_shell_access2:
      title: org_setting_junos_shell_access2
      type: object
      properties:
        admin:
          allOf:
          - $ref: '#/components/schemas/org_setting_junos_shell_access_admin2'
          - description: 'Shell access level used for administrator web-shell sessions. enum: `admin`, `none`, `viewer`.'
        helpdesk:
          allOf:
          - $ref: '#/components/schemas/org_setting_junos_shell_access_helpdesk2'
          - description: 'Shell access level used for helpdesk web-shell sessions. enum: `admin`, `none`, `viewer`.'
        read:
          allOf:
          - $ref: '#/components/schemas/org_setting_junos_shell_access_read2'
          - description: 'Shell access level used for read-only web-shell sessions. enum: `admin`, `none`, `viewer`.'
        write:
          allOf:
          - $ref: '#/components/schemas/org_setting_junos_shell_access_write2'
          - description: 'Shell access level used for write-role web-shell sessions. enum: `admin`, `none`, `viewer`.'
      description: Role-based Junos web-shell access settings
    org_setting_marvis2:
      title: org_setting_marvis2
      type: object
      properties:
        disable_proactive_monitoring:
          type: boolean
          description: 'Disable proactive monitoring in Marvis. NOTE: support access must be enabled for the org (`allow_mist`=`true`) for proactive monitoring to function.'
          default: false
        self_driving:
          allOf:
          - $ref: '#/components/schemas/marvis_self_driving1'
          - description: Self-driving network automation settings by domain
      description: AI assistant and self-driving feature settings for Marvis
    org_setting_mgmt2:
      title: org_setting_mgmt2
      type: object
      properties:
        mxtunnel_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Mist Tunnel IDs selected for management connectivity
        use_mxtunnel:
          type: boolean
          description: Whether to use Mist Tunnel for mgmt connectivity, this takes precedence over use_wxtunnel
          default: false
        use_wxtunnel:
          type: boolean
          description: Whether to use wxtunnel for mgmt connectivity
          default: false
      description: Tunnel settings for organization management connectivity
    org_setting_mist_nac_fingerprinting_wireless_coa2:
      title: org_setting_mist_nac_fingerprinting_wireless_coa2
      enum:
      - reauth
      - disconnect
      type: string
      description: 'Change of Authorization action sent to wireless clients when fingerprints change. enum: `reauth`, `disconnect`.'
    org_setting_mist_nac_fingerprinting2:
      title: org_setting_mist_nac_fingerprinting2
      type: object
      properties:
        enabled:
          type: boolean
          description: enable/disable writes to NAC DDB fingerprint table
          default: false
        generate_coa:
          type: boolean
          description: enable/disable CoA triggers on fingerprint change for wired clients, always port-bounce
          default: false
        generate_wireless_coa:
          type: boolean
          description: enable/disable CoA triggers on fingerprint change for wireless clients
          default: false
        wireless_coa_type:
          allOf:
          - $ref: '#/components/schemas/org_setting_mist_nac_fingerprinting_wireless_coa2'
          - description: 'Change of Authorization action sent to wireless clients when fingerprints change. enum: `reauth`, `disconnect`.'
      description: Client fingerprinting settings used by Mist NAC
    org_setting_mist_nac_ip_version2:
      title: org_setting_mist_nac_ip_version2
      enum:
      - v4
      - v6
      type: string
      description: 'IP version used by NAS devices and Mist Edge proxies to reach Mist NAC. enum: `v4`, `v6`.'
    org_setting_mist_nac_mdm2:
      title: org_setting_mist_nac_mdm2
      type: object
      properties:
        coa_type:
          allOf:
          - $ref: '#/components/schemas/nac_coa_type2'
          - description: 'Change of Authorization action sent for MDM posture changes. enum: `reauth`, `disconnect`.'
      description: Mobile Device Management CoA settings for Mist NAC
    org_setting_mist_nac2:
      title: org_setting_mist_nac2
      type: object
      properties:
        allow_teap_machine_auth_only:
          type: boolean
          description: allow clients to connect even when the user cert failed. TEAP authenticates both Machine Cert and User Cert. When enabled, clients who only succeed Machine Cert authentication will be accepted.
          default: false
        cacerts:
          type: array
          items:
            type: string
          description: CA certificates trusted by Mist NAC for certificate-based authentication
        default_idp_id:
          type: string
          description: use this IDP when no explicit realm present in the incoming username/CN OR when no IDP is explicitly mapped to the incoming realm.
        disable_rsae_algorithms:
          type: boolean
          description: to disable RSAE_PSS_SHA256, RSAE_PSS_SHA384, RSAE_PSS_SHA512 from server side. see https://www.openssl.org/docs/man3.0/man1/openssl-ciphers.html
          default: false
        eap_ssl_security_level:
          maximum: 4
          minimum: 1
          type: integer
          description: eap ssl security level, see https://www.openssl.org/docs/man1.1.1/man3/SSL_CTX_set_security_level.html#DEFAULT-CALLBACK-BEHAVIOUR
          contentEncoding: int32
          default: 2
        enable_eap_md5_for_mab:
          type: boolean
          description: 'Enable EAP-MD5 for MAB. WARNING: Not FIPS compliant, use only if required for legacy device support.'
          default: false
        eu_only:
          type: boolean
          description: By default, NAC POD failover considers all NAC pods available around the globe, i.e. EU, US, or APAC based, failover happens based on geo IP of the originating site. For strict GDPR compliance NAC POD failover would only happen between the PODs located within the EU environment, and no authentication would take place outside of EU. This is an org setting that is applicable to WLANs, switch templates, Mist Edge clusters that have mist_nac enabled
          default: false
        fingerprinting:
          allOf:
          - $ref: '#/components/schemas/org_setting_mist_nac_fingerprinting2'
          - description: Client fingerprinting settings used by Mist NAC
        idp_machine_cert_lookup_field:
          allOf:
          - $ref: '#/components/schemas/idp_machine_cert_lookup_field1'
          - description: 'Client certificate field used to look up machine groups in identity providers. enum: `automatic`, `cn`, `dns`.'
        idp_user_cert_lookup_field:
          allOf:
          - $ref: '#/components/schemas/idp_user_cert_lookup_field1'
          - description: 'Client certificate field used to look up user groups in identity providers. enum: `automatic`, `cn`, `email`, `upn`.'
        idps:
          type: array
          items:
            $ref: '#/components/schemas/org_setting_mist_nac_idp'
          description: Identity provider mappings used by Mist NAC realm matching
        mdm:
          allOf:
          - $ref: '#/components/schemas/org_setting_mist_nac_mdm2'
          - description: Mobile Device Management CoA settings for Mist NAC
        server_cert:
          allOf:
          - $ref: '#/components/schemas/org_setting_mist_nac_server_cert'
          - description: RADIUS server certificate presented by Mist NAC during EAP-TLS
        use_ip_version:
          allOf:
          - $ref: '#/components/schemas/org_setting_mist_nac_ip_version2'
          - description: 'IP version used by NAS devices and Mist Edge proxies to reach Mist NAC. enum: `v4`, `v6`.'
        use_ssl_port:
          type: boolean
          description: By default, NAS devices (switches/aps) and proxies(mxedge) are configured to use port TCP2083(RadSec) to reach mist-nac. Set `use_ssl_port`==`true` to override that port with TCP43 (ssl), This is an org level setting that is applicable to wlans, switch_templates, and mxedge_clusters that have mist-nac enabled
          default: false
        usermac_expiry:
          maximum: 1095
          minimum: 0
          type: integer
          description: Allow customer to configure an expiry time for usermacs by attaching an `inactive_endpoint` label to those which have been inactive for the configured period of time (in days). 0 means no expiry
          contentEncoding: int32
          default: 0
          examples:
          - 30
      description: NAC settings for Mist Access Assurance
    org_setting_pcap2:
      title: org_setting_pcap2
      type: object
      properties:
        bucket:
          type: string
          description: Storage bucket name used for organization packet capture files
          examples:
          - myorg_pcap
        max_pkt_len:
          maximum: 128
          type: integer
          description: Maximum length of non-management packets to capture, in bytes
          contentEncoding: int32
          default: 128
          examples:
          - 128
      description: Packet capture settings for the organization
    org_setting_security2:
      title: org_setting_security2
      type: object
      properties:
        disable_local_ssh:
          type: boolean
          description: Whether to disable local SSH (by default, local SSH is enabled with allow_mist in Org is enabled
        fips_zeroize_password:
          type: string
          description: password required to zeroize devices (FIPS) on site level
          examples:
          - NUKETHESITE
        limit_ssh_access:
          type: boolean
          description: Whether to allow certain SSH keys to SSH into the AP (see Site:Setting)
          default: false
      description: Organization security controls such as local SSH restrictions
    org_setting_switch_mgmt2:
      title: org_setting_switch_mgmt2
      type: object
      properties:
        ap_affinity_threshold:
          type: integer
          description: If the field is set in both site/setting and org/setting, the value from site/setting will be used.
          contentEncoding: int32
          default: 12
          examples:
          - 10
      description: Management settings for switches in this organization
    org_setting_vpn_options2:
      title: org_setting_vpn_options2
      type: object
      properties:
        as_base:
          maximum: 2147483647
          minimum: 1
          type: integer
          description: Base BGP autonomous system number used for generated VPN configurations
          contentEncoding: int32
        enable_ipv6:
          type: boolean
          description: Whether IPv6 is enabled for organization VPN configuration
          default: false
        st_subnet:
          type: string
          description: requiring /12 or bigger to support 16 private IPs for 65535 gateways
          default: 10.224.0.0/12
      description: Options for organization VPN behavior
    org_ui_settings_purpose2:
      title: org_ui_settings_purpose2
      const: marvisdashboard
      type: string
      description: 'UI surface or purpose for this databoard. enum: `marvisdashboard`.'
    org_ui_settings_tile_position2:
      title: org_ui_settings_tile_position2
      type: object
      properties:
        col:
          type: integer
          description: Grid column index for the tile
          contentEncoding: int32
          examples:
          - 1
        colSpan:
          type: integer
          description: Grid column span for the tile
          contentEncoding: int32
          examples:
          - 5
        row:
          type: integer
          description: Grid row index for the tile
          contentEncoding: int32
          examples:
          - 1
        rowSpan:
          type: integer
          description: Grid row span for the tile
          contentEncoding: int32
          examples:
          - 2
      description: Grid position and span for the databoard tile
    ospf_area_network_auth_type2:
      title: ospf_area_network_auth_type2
      enum:
      - md5
      - none
      - password
      type: string
      description: 'Authentication method used by this OSPF network. enum: `md5`, `none`, `password`.'
      examples:
      - md5
    ospf_area_network_interface_type2:
      title: ospf_area_network_interface_type2
      enum:
      - broadcast
      - nbma
      - p2mp
      - p2p
      type: string
      description: 'OSPF interface type used for this network. enum: `broadcast`, `nbma`, `p2mp`, `p2p`.'
    ospf_area_type2:
      title: ospf_area_type2
      enum:
      - default
      - nssa
      - stub
      type: string
      description: 'Area type for this OSPF area. enum: `default`, `nssa`, `stub`.'
      examples:
      - default
    other_device_update_operation2:
      title: other_device_update_operation2
      enum:
      - assign
      - unassign
      type: string
      description: 'Action to perform on the other devices. enum: `assign`, `unassign`.'
    pcap_type1:
      title: pcap_type1
      enum:
      - client
      - gateway
      - new_assoc
      - radiotap
      - radiotap,wired
      - wired
      - wireless
      type: string
      description: 'Packet capture type for the current session. enum: `client`, `gateway`, `new_assoc`, `radiotap`, `radiotap,wired`, `wired`, `wireless`.'
      examples:
      - client
    poe_priority2:
      title: poe_priority2
      enum:
      - low
      - high
      type: string
      description: 'PoE priority configured for the port. enum: `low`, `high`.'
    poe_priority3:
      title: poe_priority3
      enum:
      - low
      - high
      type: string
      description: 'Only if `mode`!=`dynamic`. PoE priority for ports using this port usage. enum: `low`, `high`.'
    port_auth_state1:
      title: port_auth_state1
      enum:
      - authenticated
      - authenticating
      - held
      - init
      type: string
      description: 'Authentication state of the port. enum: ``, `authenticated`, `authenticating`, `held`, `init`.'
    port_stp_role1:
      title: port_stp_role1
      enum:
      - alternate
      - backup
      - designated
      - disabled
      - root
      - root-prevented
      type: string
      description: 'Current spanning tree role of the port. enum: ``, `alternate`, `backup`, `designated`, `disabled`, `root`, `root-prevented`.'
    port_stp_state1:
      title: port_stp_state1
      enum:
      - blocking
      - disabled
      - forwarding
      - learning
      - listening
      type: string
      description: 'Current spanning tree state of the port. enum: ``, `blocking`, `disabled`, `forwarding`, `learning`, `listening`.'
    portal_template_alignment2:
      title: portal_template_alignment2
      enum:
      - center
      - left
      - right
      type: string
      description: 'Logo and text alignment for the PSK portal template. enum: `center`, `left`, `right`.'
    portal_template_alignment3:
      title: portal_template_alignment3
      enum:
      - center
      - left
      - right
      type: string
      description: 'Text and content alignment used by the guest portal template. enum: `center`, `left`, `right`.'
    portal_template_alignment4:
      title: portal_template_alignment4
      enum:
      - center
      - left
      - right
      type: string
      description: 'Text and content alignment for the NAC portal page. enum: `center`, `left`, `right`.'
    privilege_msp_role2:
      title: privilege_msp_role2
      enum:
      - admin
      - helpdesk
      - installer
      - read
      - write
      type: string
      description: 'Access role granted by this MSP privilege. enum: `admin`, `helpdesk`, `installer`, `read`, `write`.'
    privilege_msp_scope2:
      title: privilege_msp_scope2
      enum:
      - msp
      - org
      - orggroup
      type: string
      description: 'MSP hierarchy level where this privilege applies. enum: `msp`, `org`, `orggroup`.'
    privilege_org_role2:
      title: privilege_org_role2
      enum:
      - admin
      - helpdesk
      - installer
      - read
      - write
      type: string
      description: 'Access role granted by this organization privilege. enum: `admin`, `helpdesk`, `installer`, `read`, `write`.'
    privilege_org_scope2:
      title: privilege_org_scope2
      enum:
      - org
      - site
      - sitegroup
      - orgsites
      type: string
      description: 'Organization hierarchy level where this privilege applies. enum: `org`, `site`, `sitegroup`, `orgsites`.'
    protect_re_custom_protocol2:
      title: protect_re_custom_protocol2
      enum:
      - any
      - icmp
      - tcp
      - udp
      type: string
      description: 'Transport protocol matched by this custom Protect RE ACL. enum: `any`, `icmp`, `tcp`, `udp`.'
    protect_re1:
      title: protect_re1
      type: object
      properties:
        allowed_services:
          type: array
          items:
            $ref: '#/components/schemas/protect_re_allowed_service'
          description: Built-in services explicitly allowed by the Protect RE policy
          examples:
          - - icmp
            - ssh
        custom:
          type: array
          items:
            $ref: '#/components/schemas/protect_re_custom'
          description: Additional ACL entries allowed by the Protect RE policy
        enabled:
          type: boolean
          description: >-
            When enabled, all traffic that is not essential to our operation will be dropped

            e.g. ntp / dns / traffic to mist will be allowed by default
                 if dhcpd is enabled, we'll make sure it works
          default: false
        hit_count:
          type: boolean
          description: Whether to enable hit count for Protect_RE policy
          default: false
        trusted_hosts:
          type: array
          items:
            type: string
          description: Trusted host or subnet entries allowed by the Protect RE policy
      description: Control-plane protection settings for the gateway
    protect_re3:
      title: protect_re3
      type: object
      properties:
        allowed_services:
          type: array
          items:
            $ref: '#/components/schemas/protect_re_allowed_service'
          description: Built-in services explicitly allowed by the Protect RE policy
          examples:
          - - icmp
            - ssh
        custom:
          type: array
          items:
            $ref: '#/components/schemas/protect_re_custom'
          description: Additional ACL entries allowed by the Protect RE policy
        enabled:
          type: boolean
          description: >-
            When enabled, all traffic that is not essential to our operation will be dropped

            e.g. ntp / dns / traffic to mist will be allowed by default
                 if dhcpd is enabled, we'll make sure it works
          default: false
        hit_count:
          type: boolean
          description: Whether to enable hit count for Protect_RE policy
          default: false
        trusted_hosts:
          type: array
          items:
            type: string
          description: Trusted host or subnet entries allowed by the Protect RE policy
      description: Control-plane protection settings for the switch
    proxy1:
      title: proxy1
      type: object
      properties:
        disabled:
          type: boolean
          description: Whether this proxy configuration is disabled
          default: false
          examples:
          - true
        url:
          type: string
          description: Proxy URL used to reach Mist
          examples:
          - https://proxy.corp.com:8080/
      description: Network proxy settings used by the Mist Edge
    proxy3:
      title: proxy3
      type: object
      properties:
        disabled:
          type: boolean
          description: Whether this proxy configuration is disabled
          default: false
          examples:
          - true
        url:
          type: string
          description: Proxy URL used to reach Mist
          examples:
          - https://proxy.corp.com:8080/
      description: Network proxy settings for devices at the site
    proxy4:
      title: proxy4
      type: object
      properties:
        disabled:
          type: boolean
          description: Whether this proxy configuration is disabled
          default: false
          examples:
          - true
        url:
          type: string
          description: Proxy URL used to reach Mist
          examples:
          - https://proxy.corp.com:8080/
      description: Network proxy settings used by Mist Edges in the cluster to communicate with the Mist Cloud
    psk_portal_auth2:
      title: psk_portal_auth2
      enum:
      - sponsor
      - sso
      type: string
      description: 'Portal access method, enum: `sponsor`, `sso`'
    psk_portal_passphrase_rules2:
      title: psk_portal_passphrase_rules2
      type: object
      properties:
        alphabets_enabled:
          type: boolean
          description: Whether generated passphrases may include alphabetic characters
          default: true
        length:
          maximum: 63
          minimum: 8
          type: integer
          description: Fixed generated passphrase length used when min and max length are not both valid
          contentEncoding: int32
        max_length:
          maximum: 63
          minimum: 8
          type: integer
          description: Maximum generated passphrase length when paired with a valid `min_length`. If `max_length` or `min_length` is invalid, the portal uses `length`; if `length` is unset or invalid, it uses 8. Valid values are integers from 8 through 63, and `max_length` must be greater than `min_length`
          contentEncoding: int32
        min_length:
          maximum: 63
          minimum: 8
          type: integer
          description: Minimum generated passphrase length when paired with a valid `max_length`. If `max_length` or `min_length` is invalid, the portal uses `length`; if `length` is unset or invalid, it uses 8. Valid values are integers from 8 through 63, and `max_length` must be greater than `min_length`
          contentEncoding: int32
        numerics_enabled:
          type: boolean
          description: Whether generated passphrases may include numeric characters
          default: true
        symbols:
          type: string
          description: Allowed symbol characters for generated passphrases
          examples:
          - ()[]{}_%@#&$
        symbols_enabled:
          type: boolean
          description: Whether generated passphrases may include symbols
          default: true
      description: Generation rules for PSK passphrases created through this portal
    psk_portal_sso_idp_sign_algo2:
      title: psk_portal_sso_idp_sign_algo2
      enum:
      - sha1
      - sha256
      - sha384
      - sha512
      type: string
      description: 'SAML assertion signing algorithm expected from the identity provider. enum: `sha1`, `sha256`, `sha384`, `sha512`.'
    psk_portal_sso2:
      title: psk_portal_sso2
      type: object
      properties:
        allowed_roles:
          type: array
          items:
            type: string
          description: SSO roles allowed to access the PSK portal; if empty, any role is permitted
        idp_cert:
          type: string
          description: Identity provider signing certificate in PEM format
        idp_sign_algo:
          allOf:
          - $ref: '#/components/schemas/psk_portal_sso_idp_sign_algo2'
          - description: 'SAML assertion signing algorithm expected from the identity provider. enum: `sha1`, `sha256`, `sha384`, `sha512`.'
        idp_sso_url:
          type: string
          description: Identity provider SSO URL for SAML login
        issuer:
          type: string
          description: SAML issuer value for the identity provider
        nameid_format:
          type: string
          description: SAML NameID format used for the portal login
        role_mapping:
          type: object
          additionalProperties:
            type: string
          description: Maps PSK portal role names to SSO attribute values
        use_sso_role_for_psk_role:
          type: boolean
          description: Whether to use SSO role mapping for the PSK role and ignore the portal-level `role` field
      description: Single sign-on configuration used when `auth`==`sso`
    psk_portal_template_setting2:
      title: psk_portal_template_setting2
      type: object
      properties:
        alignment:
          allOf:
          - $ref: '#/components/schemas/portal_template_alignment2'
          - description: 'Logo and text alignment for the PSK portal template. enum: `center`, `left`, `right`.'
        color:
          type: string
          description: Primary hex color used by the portal template
          default: '#1074bc'
        logo:
          type:
          - string
          - 'null'
          description: Custom logo with "data:image/png;base64," format. default null, uses Juniper Mist Logo
        poweredBy:
          type: boolean
          description: Whether to hide "Powered by Juniper Mist" and email footers
          default: false
        tos:
          type: boolean
          description: Whether to show Terms of Service
        tosAcceptLabel:
          type: string
          description: Terms of Service accept button label
          default: I accept the Terms of Service
        tosError:
          type: string
          description: Error message shown when the user has not accepted the Terms of Service
          default: Please review and accept the Terms of Service
        tosLink:
          type: string
          description: Terms of Service link label displayed in the portal footer
          default: Terms of Service
        tosText:
          type: string
          description: Terms of Service text displayed in the footer when Terms are enabled
          default: << provide your Terms of Service here >>
        tosUrl:
          type: string
          description: Custom URL for the Terms of Service policy
          examples:
          - https://company.com/wifi-policy
      description: Template settings for customizing the PSK portal UI
    psk_portal_type2:
      title: psk_portal_type2
      enum:
      - admin
      - byod
      type: string
      description: Portal mode for personal PSK onboarding, either admin or BYOD
    psk_usage2:
      title: psk_usage2
      enum:
      - macs
      - multi
      - single
      - usermac_labels
      type: string
      description: 'Binding mode for this PSK, enum: `macs`, `multi`, `single`, `usermac_labels`'
    push_policy_push_window1:
      title: push_policy_push_window1
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether configuration pushes are limited to the configured push window
          default: false
        hours:
          allOf:
          - $ref: '#/components/schemas/hours1'
          - description: Day-of-week hour ranges when configuration pushes are allowed
      description: Allowed time window during which configuration pushes may run
    radio_band_24_usage2:
      title: radio_band_24_usage2
      enum:
      - '24'
      - '5'
      - '6'
      - auto
      type: string
      description: 'Radio usage mode for the 2.4 GHz-capable radio in this RF template. enum: `24`, `5`, `6`, `auto`.'
    radio_band_24_usage3:
      title: radio_band_24_usage3
      enum:
      - '24'
      - '5'
      - '6'
      - auto
      type: string
      description: 'Model-specific radio usage mode for the 2.4 GHz-capable radio. enum: `24`, `5`, `6`, `auto`.'
    radio_band_24_usage4:
      title: radio_band_24_usage4
      enum:
      - '24'
      - '5'
      - '6'
      - auto
      type: string
      description: 'Radio usage mode for the 2.4 GHz-capable radio. enum: `24`, `5`, `6`, `auto`.'
    radio_band_antenna_beam_pattern1:
      title: radio_band_antenna_beam_pattern1
      enum:
      - narrow
      - medium
      - wide
      type: string
      description: 'Beam pattern used by the 6 GHz radio antenna. enum: `narrow`, `medium`, `wide`.'
    radio_band_antenna_beam_pattern3:
      title: radio_band_antenna_beam_pattern3
      enum:
      - narrow
      - medium
      - wide
      type: string
      description: 'Beam pattern used by the 5 GHz radio antenna. enum: `narrow`, `medium`, `wide`.'
    radio_band_antenna_mode1:
      title: radio_band_antenna_mode1
      enum:
      - 1x1
      - 2x2
      - 3x3
      - 4x4
      - default
      type: string
      description: 'Radio chain mode for the 5 GHz radio. enum: `1x1`, `2x2`, `3x3`, `4x4`, `default`.'
      examples:
      - default
    radio_band_antenna_mode2:
      title: radio_band_antenna_mode2
      enum:
      - 1x1
      - 2x2
      - 3x3
      - 4x4
      - default
      type: string
      description: 'Radio chain mode for the 6 GHz radio. enum: `1x1`, `2x2`, `3x3`, `4x4`, `default`.'
      examples:
      - default
    radio_band_antenna_mode4:
      title: radio_band_antenna_mode4
      enum:
      - 1x1
      - 2x2
      - 3x3
      - 4x4
      - default
      type: string
      description: 'Radio chain mode for the 2.4 GHz radio. enum: `1x1`, `2x2`, `3x3`, `4x4`, `default`.'
      examples:
      - default
    radio_band_preamble1:
      title: radio_band_preamble1
      enum:
      - auto
      - long
      - short
      type: string
      description: '802.11 preamble mode used by the 5 GHz radio. enum: `auto`, `long`, `short`.'
    radio_band_preamble2:
      title: radio_band_preamble2
      enum:
      - auto
      - long
      - short
      type: string
      description: '802.11 preamble mode used by the 6 GHz radio. enum: `auto`, `long`, `short`.'
    radio_band_preamble4:
      title: radio_band_preamble4
      enum:
      - auto
      - long
      - short
      type: string
      description: '802.11 preamble mode used by the 2.4 GHz radio. enum: `auto`, `long`, `short`.'
    radius_config2:
      title: radius_config2
      type: object
      properties:
        acct_interim_interval:
          maximum: 65535
          minimum: 0
          type: integer
          description: How frequently should interim accounting be reported, 60-65535. default is 0 (use one specified in Access-Accept request from RADIUS Server). Very frequent messages can affect the performance of the RADIUS server, 600 and up is recommended when enabled
          contentEncoding: int32
          default: 0
        acct_servers:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/radius_acct_server'
          description: RADIUS accounting servers used by this Junos configuration
        auth_servers:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/radius_auth_server'
          description: RADIUS authentication servers used by this Junos configuration
        auth_servers_retries:
          type: integer
          description: Number of RADIUS authentication request retries before failover
          contentEncoding: int32
          default: 3
        auth_servers_timeout:
          type: integer
          description: RADIUS authentication server timeout, in seconds
          contentEncoding: int32
          default: 5
        coa_enabled:
          type: boolean
          description: Whether RADIUS Change of Authorization (CoA) is enabled
          default: false
        coa_port:
          maximum: 65535
          minimum: 1
          type: integer
          description: UDP port used for RADIUS Change of Authorization (CoA)
          contentEncoding: int32
          default: 3799
        network:
          type: string
          description: Use `network` or `source_ip`. Network where the RADIUS server resides; if the network has a static IP, Mist uses it as the source IP
        source_ip:
          type: string
          description: Use `network` or `source_ip`. Explicit source IP address for RADIUS traffic
      description: RADIUS authentication and accounting settings for this AP port
    radius_keywrap_format1:
      title: radius_keywrap_format1
      enum:
      - ascii
      - hex
      type: string
      description: 'Encoding format for RADIUS keywrap KEK and MACK values. enum: `ascii`, `hex`.'
    radsec2:
      title: radsec2
      type: object
      properties:
        coa_enabled:
          type: boolean
          description: Whether RADIUS Change of Authorization (CoA) is enabled for RadSec traffic
          default: false
        enabled:
          type: boolean
          description: Whether RadSec is enabled
        idle_timeout:
          anyOf:
          - type: integer
            contentEncoding: int32
            default: 60
          - type: string
          description: Idle timeout, in seconds, for RadSec connections
        mxcluster_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Mist Edge cluster IDs used as RadSec proxies when the WLAN does not use mxtunnel
        proxy_hosts:
          type: array
          items:
            type: string
          description: RadSec proxy hostnames advertised to APs
        server_name:
          type: string
          description: TLS server name to verify against the CA certificates in Org Setting. Only if not Mist Edge.
          examples:
          - radsec.abc.com
        servers:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/radsec_server'
          description: External RadSec servers. Only if not Mist Edge.
        use_mxedge:
          type: boolean
          description: Whether to use organization Mist Edge instances as RadSec proxies
        use_site_mxedge:
          type: boolean
          description: Whether to use site Mist Edge instances when this WLAN does not use mxtunnel
          default: false
      description: TLS-secured RADIUS transport settings for this WLAN
    radsec3:
      title: radsec3
      type: object
      properties:
        coa_enabled:
          type: boolean
          description: Whether RADIUS Change of Authorization (CoA) is enabled for RadSec traffic
          default: false
        enabled:
          type: boolean
          description: Whether RadSec is enabled
        idle_timeout:
          anyOf:
          - type: integer
            contentEncoding: int32
            default: 60
          - type: string
          description: Idle timeout, in seconds, for RadSec connections
        mxcluster_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Mist Edge cluster IDs used as RadSec proxies when the WLAN does not use mxtunnel
        proxy_hosts:
          type: array
          items:
            type: string
          description: RadSec proxy hostnames advertised to APs
        server_name:
          type: string
          description: TLS server name to verify against the CA certificates in Org Setting. Only if not Mist Edge.
          examples:
          - radsec.abc.com
        servers:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/radsec_server'
          description: External RadSec servers. Only if not Mist Edge.
        use_mxedge:
          type: boolean
          description: Whether to use organization Mist Edge instances as RadSec proxies
        use_site_mxedge:
          type: boolean
          description: Whether to use site Mist Edge instances when this WLAN does not use mxtunnel
          default: false
      description: TLS-secured RADIUS settings for this AP port
    random_mac1:
      title: random_mac1
      enum:
      - 'true'
      - 'false'
      type: string
      description: 'Whether the client used a randomized MAC address. enum: `true`, `false`.'
    random_mac3:
      title: random_mac3
      enum:
      - 'true'
      - 'false'
      type: string
      description: 'Whether the NAC client used a randomized MAC address. enum: `true`, `false`.'
    recaptcha_flavor1:
      title: recaptcha_flavor1
      enum:
      - google
      - hcaptcha
      type: string
      description: CAPTCHA provider used for registration, such as Google reCAPTCHA or hCaptcha
      examples:
      - hcaptcha
    recaptcha_flavor3:
      title: recaptcha_flavor3
      enum:
      - google
      - hcaptcha
      type: string
      description: 'CAPTCHA provider flavor used for recovery verification. enum: `google`, `hcaptcha`.'
      examples:
      - hcaptcha
    recaptcha_flavor4:
      title: recaptcha_flavor4
      enum:
      - google
      - hcaptcha
      type: string
      description: 'CAPTCHA provider flavor used for registration verification. enum: `google`, `hcaptcha`.'
      examples:
      - hcaptcha
    remote_syslog_archive1:
      title: remote_syslog_archive1
      type: object
      properties:
        files:
          anyOf:
          - type: string
          - type: integer
            contentEncoding: int32
          description: Number of archived syslog files to retain
          examples:
          - '20'
        size:
          type: string
          description: Maximum size of each archived syslog file, such as 5m
          examples:
          - 5m
      description: Retention settings for this generated syslog file
    remote_syslog_archive3:
      title: remote_syslog_archive3
      type: object
      properties:
        files:
          anyOf:
          - type: string
          - type: integer
            contentEncoding: int32
          description: Number of archived syslog files to retain
          examples:
          - '20'
        size:
          type: string
          description: Maximum size of each archived syslog file, such as 5m
          examples:
          - 5m
      description: Retention settings for generated syslog archive files
    remote_syslog_console2:
      title: remote_syslog_console2
      type: object
      properties:
        contents:
          type: array
          items:
            $ref: '#/components/schemas/remote_syslog_content'
          description: Syslog facilities and severities forwarded from console logs
      description: Log forwarding filters for console messages sent to remote syslog
    remote_syslog_facility1:
      title: remote_syslog_facility1
      enum:
      - any
      - authorization
      - change-log
      - config
      - conflict-log
      - daemon
      - dfc
      - external
      - firewall
      - ftp
      - interactive-commands
      - kernel
      - ntp
      - pfe
      - security
      - user
      type: string
      description: 'Default syslog facility for messages sent to this server. enum: `any`, `authorization`, `change-log`, `config`, `conflict-log`, `daemon`, `dfc`, `external`, `firewall`, `ftp`, `interactive-commands`, `kernel`, `ntp`, `pfe`, `security`, `user`.'
      examples:
      - config
    remote_syslog_facility3:
      title: remote_syslog_facility3
      enum:
      - any
      - authorization
      - change-log
      - config
      - conflict-log
      - daemon
      - dfc
      - external
      - firewall
      - ftp
      - interactive-commands
      - kernel
      - ntp
      - pfe
      - security
      - user
      type: string
      description: 'Syslog facility to match for this selector. enum: `any`, `authorization`, `change-log`, `config`, `conflict-log`, `daemon`, `dfc`, `external`, `firewall`, `ftp`, `interactive-commands`, `kernel`, `ntp`, `pfe`, `security`, `user`.'
      examples:
      - config
    remote_syslog_server_protocol2:
      title: remote_syslog_server_protocol2
      enum:
      - tcp
      - udp
      type: string
      description: 'Transport protocol used for this remote syslog server. enum: `tcp`, `udp`.'
    remote_syslog_severity1:
      title: remote_syslog_severity1
      enum:
      - alert
      - any
      - critical
      - emergency
      - error
      - info
      - notice
      - warning
      type: string
      description: 'Default syslog severity for messages sent to this server. enum: `alert`, `any`, `critical`, `emergency`, `error`, `info`, `notice`, `warning`.'
    remote_syslog_severity3:
      title: remote_syslog_severity3
      enum:
      - alert
      - any
      - critical
      - emergency
      - error
      - info
      - notice
      - warning
      type: string
      description: 'Syslog severity to match for this selector. enum: `alert`, `any`, `critical`, `emergency`, `error`, `info`, `notice`, `warning`.'
    remote_syslog_time_format2:
      title: remote_syslog_time_format2
      enum:
      - millisecond
      - year
      - year millisecond
      type: string
      description: 'Timestamp format used in forwarded syslog messages. enum: `millisecond`, `year`, `year millisecond`.'
      examples:
      - millisecond
    remote_syslog1:
      title: remote_syslog1
      type: object
      properties:
        archive:
          allOf:
          - $ref: '#/components/schemas/remote_syslog_archive3'
          - description: Retention settings for generated syslog archive files
        cacerts:
          type: array
          items:
            type: string
          description: CA certificates used to verify TLS syslog servers
          examples:
          - - '-----BEGIN CERTIFICATE-----\nMIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE\n-----END CERTIFICATE-----'
            - '-----BEGIN CERTIFICATE-----\nBhMCRVMxFDASBgNVBAoMC1N0YXJ0Q29tIENBMSwwKgYDVn-----END CERTIFICATE-----'
        console:
          allOf:
          - $ref: '#/components/schemas/remote_syslog_console2'
          - description: Log forwarding filters for console messages sent to remote syslog
        enabled:
          type: boolean
          description: Whether remote syslog forwarding is enabled
          default: false
        files:
          type: array
          items:
            $ref: '#/components/schemas/remote_syslog_file_config'
          description: Local syslog file definitions to generate and forward
        network:
          type: string
          description: Source network used for syslog traffic. If `source_address` is configured, Mist uses the VLAN first; otherwise it uses `source_ip`
          examples:
          - default
        send_to_all_servers:
          type: boolean
          description: Whether each log entry is sent to all configured remote syslog servers
          default: false
        servers:
          type: array
          items:
            $ref: '#/components/schemas/remote_syslog_server'
          description: Remote syslog server destinations
          examples:
          - - facility: config
              host: syslogd.internal
              port: 514
              protocol: udp
              severity: info
              tag: ''
        time_format:
          allOf:
          - $ref: '#/components/schemas/remote_syslog_time_format2'
          - description: 'Timestamp format used in forwarded syslog messages. enum: `millisecond`, `year`, `year millisecond`.'
            examples:
            - millisecond
        users:
          type: array
          items:
            $ref: '#/components/schemas/remote_syslog_user'
          description: User-specific syslog logging rules
      description: Remote syslog defaults provided by this switch profile
    remote_syslog2:
      title: remote_syslog2
      type: object
      properties:
        archive:
          allOf:
          - $ref: '#/components/schemas/remote_syslog_archive3'
          - description: Retention settings for generated syslog archive files
        cacerts:
          type: array
          items:
            type: string
          description: CA certificates used to verify TLS syslog servers
          examples:
          - - '-----BEGIN CERTIFICATE-----\nMIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE\n-----END CERTIFICATE-----'
            - '-----BEGIN CERTIFICATE-----\nBhMCRVMxFDASBgNVBAoMC1N0YXJ0Q29tIENBMSwwKgYDVn-----END CERTIFICATE-----'
        console:
          allOf:
          - $ref: '#/components/schemas/remote_syslog_console2'
          - description: Log forwarding filters for console messages sent to remote syslog
        enabled:
          type: boolean
          description: Whether remote syslog forwarding is enabled
          default: false
        files:
          type: array
          items:
            $ref: '#/components/schemas/remote_syslog_file_config'
          description: Local syslog file definitions to generate and forward
        network:
          type: string
          description: Source network used for syslog traffic. If `source_address` is configured, Mist uses the VLAN first; otherwise it uses `source_ip`
          examples:
          - default
        send_to_all_servers:
          type: boolean
          description: Whether each log entry is sent to all configured remote syslog servers
          default: false
        servers:
          type: array
          items:
            $ref: '#/components/schemas/remote_syslog_server'
          description: Remote syslog server destinations
          examples:
          - - facility: config
              host: syslogd.internal
              port: 514
              protocol: udp
              severity: info
              tag: ''
        time_format:
          allOf:
          - $ref: '#/components/schemas/remote_syslog_time_format2'
          - description: 'Timestamp format used in forwarded syslog messages. enum: `millisecond`, `year`, `year millisecond`.'
            examples:
            - millisecond
        users:
          type: array
          items:
            $ref: '#/components/schemas/remote_syslog_user'
          description: User-specific syslog logging rules
      description: Remote syslog defaults provided by this network template
    remote_syslog4:
      title: remote_syslog4
      type: object
      properties:
        archive:
          allOf:
          - $ref: '#/components/schemas/remote_syslog_archive3'
          - description: Retention settings for generated syslog archive files
        cacerts:
          type: array
          items:
            type: string
          description: CA certificates used to verify TLS syslog servers
          examples:
          - - '-----BEGIN CERTIFICATE-----\nMIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE\n-----END CERTIFICATE-----'
            - '-----BEGIN CERTIFICATE-----\nBhMCRVMxFDASBgNVBAoMC1N0YXJ0Q29tIENBMSwwKgYDVn-----END CERTIFICATE-----'
        console:
          allOf:
          - $ref: '#/components/schemas/remote_syslog_console2'
          - description: Log forwarding filters for console messages sent to remote syslog
        enabled:
          type: boolean
          description: Whether remote syslog forwarding is enabled
          default: false
        files:
          type: array
          items:
            $ref: '#/components/schemas/remote_syslog_file_config'
          description: Local syslog file definitions to generate and forward
        network:
          type: string
          description: Source network used for syslog traffic. If `source_address` is configured, Mist uses the VLAN first; otherwise it uses `source_ip`
          examples:
          - default
        send_to_all_servers:
          type: boolean
          description: Whether each log entry is sent to all configured remote syslog servers
          default: false
        servers:
          type: array
          items:
            $ref: '#/components/schemas/remote_syslog_server'
          description: Remote syslog server destinations
          examples:
          - - facility: config
              host: syslogd.internal
              port: 514
              protocol: udp
              severity: info
              tag: ''
        time_format:
          allOf:
          - $ref: '#/components/schemas/remote_syslog_time_format2'
          - description: 'Timestamp format used in forwarded syslog messages. enum: `millisecond`, `year`, `year millisecond`.'
            examples:
            - millisecond
        users:
          type: array
          items:
            $ref: '#/components/schemas/remote_syslog_user'
          description: User-specific syslog logging rules
      description: Syslog forwarding settings for devices at the site
    remote_syslog5:
      title: remote_syslog5
      type: object
      properties:
        archive:
          allOf:
          - $ref: '#/components/schemas/remote_syslog_archive3'
          - description: Retention settings for generated syslog archive files
        cacerts:
          type: array
          items:
            type: string
          description: CA certificates used to verify TLS syslog servers
          examples:
          - - '-----BEGIN CERTIFICATE-----\nMIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE\n-----END CERTIFICATE-----'
            - '-----BEGIN CERTIFICATE-----\nBhMCRVMxFDASBgNVBAoMC1N0YXJ0Q29tIENBMSwwKgYDVn-----END CERTIFICATE-----'
        console:
          allOf:
          - $ref: '#/components/schemas/remote_syslog_console2'
          - description: Log forwarding filters for console messages sent to remote syslog
        enabled:
          type: boolean
          description: Whether remote syslog forwarding is enabled
          default: false
        files:
          type: array
          items:
            $ref: '#/components/schemas/remote_syslog_file_config'
          description: Local syslog file definitions to generate and forward
        network:
          type: string
          description: Source network used for syslog traffic. If `source_address` is configured, Mist uses the VLAN first; otherwise it uses `source_ip`
          examples:
          - default
        send_to_all_servers:
          type: boolean
          description: Whether each log entry is sent to all configured remote syslog servers
          default: false
        servers:
          type: array
          items:
            $ref: '#/components/schemas/remote_syslog_server'
          description: Remote syslog server destinations
          examples:
          - - facility: config
              host: syslogd.internal
              port: 514
              protocol: udp
              severity: info
              tag: ''
        time_format:
          allOf:
          - $ref: '#/components/schemas/remote_syslog_time_format2'
          - description: 'Timestamp format used in forwarded syslog messages. enum: `millisecond`, `year`, `year millisecond`.'
            examples:
            - millisecond
        users:
          type: array
          items:
            $ref: '#/components/schemas/remote_syslog_user'
          description: User-specific syslog logging rules
      description: Remote syslog settings for this switch
    response_async_license_status1:
      title: response_async_license_status1
      enum:
      - prepared
      - ongoing
      - done
      type: string
      description: 'Current asynchronous license claim processing state. enum: `prepared`, `ongoing`, `done`.'
    response_async_license_status3:
      title: response_async_license_status3
      enum:
      - prepared
      - ongoing
      - done
      type: string
      description: 'Current async claim processing state. enum: `prepared`, `ongoing`, `done`.'
    response_auto_map_assignment_info_status2:
      title: response_auto_map_assignment_info_status2
      enum:
      - not_started
      - in_progress
      - completed
      - error
      type: string
      description: 'Current auto map assignment processing state. enum: `not_started`, `in_progress`, `completed`, `error`.'
    response_auto_orientation_info_status2:
      title: response_auto_orientation_info_status2
      enum:
      - pending
      - inprogress
      - done
      - error
      type: string
      description: 'Current auto orientation processing state. enum: `pending`, `inprogress`, `done`, `error`.'
    response_auto_zone_status2:
      title: response_auto_zone_status2
      enum:
      - in_progress
      - awaiting_review
      - not_started
      - error
      type: string
      description: 'Current auto zones service state for the map. enum: `in_progress`, `awaiting_review`, `not_started`, `error`.'
    response_map_import_ap_action2:
      title: response_map_import_ap_action2
      enum:
      - assigned-named-placed
      - assigned-placed
      - ignored
      - named-placed
      - placed
      type: string
      description: 'Import action applied to this AP. enum: `assigned-named-placed`, `assigned-placed`, `ignored`, `named-placed`, `placed`.'
    response_org_inventory_change_op2:
      title: response_org_inventory_change_op2
      enum:
      - assign
      - delete
      - downgrade_to_jsi
      - unassign
      - upgrade_to_mist
      type: string
      description: 'Inventory operation applied to the requested device identifiers. enum: `assign`, `delete`, `downgrade_to_jsi`, `unassign`, `upgrade_to_mist`.'
    response_switch_metrics_active_ports_summary2:
      title: response_switch_metrics_active_ports_summary2
      type: object
      properties:
        details:
          allOf:
          - $ref: '#/components/schemas/switch_metrics_active_ports_summary_details2'
          - description: Port counts used to calculate the active-port summary metric
        score:
          type: integer
          description: Reported metric score for active switch ports
          contentEncoding: int32
        total_switch_count:
          type: integer
          description: Number of switches included in the active-port summary metric
          contentEncoding: int32
      description: Summary metric for active switch ports
    response_switch_metrics_config_success_details2:
      title: response_switch_metrics_config_success_details2
      type: object
      properties:
        config_success_count:
          type: integer
          description: Number of switches with successful configuration status
          contentEncoding: int32
      description: Configuration success counts used to calculate the metric
    response_switch_metrics_version_compliance_details2:
      title: response_switch_metrics_version_compliance_details2
      type: object
      properties:
        major_versions:
          type: array
          items:
            $ref: '#/components/schemas/switch_metrics_compliance_major_version'
          description: Software version groupings found among the evaluated switches
      description: Version groupings used to calculate the compliance metric
    response_switch_metrics_version_compliance2:
      title: response_switch_metrics_version_compliance2
      type: object
      properties:
        details:
          allOf:
          - $ref: '#/components/schemas/response_switch_metrics_version_compliance_details2'
          - description: Version groupings used to calculate the compliance metric
        score:
          type: integer
          description: Reported metric score for switch software version compliance
          contentEncoding: int32
        total_switch_count:
          type: integer
          description: Number of switches included in the version compliance metric
          contentEncoding: int32
      description: Software version compliance metric for switches in the requested scope
    rf_client_type1:
      title: rf_client_type1
      enum:
      - asset
      - client
      - sdkclient
      type: string
      description: 'Target device category for the RF diagnostic recording. enum: `asset`, `client`, `sdkclient`.'
    rf_client_type2:
      title: rf_client_type2
      enum:
      - asset
      - client
      - sdkclient
      type: string
      description: 'Target device category for the recording. enum: `asset`, `client`, `sdkclient`.'
    rftemplate_radio_band51:
      title: rftemplate_radio_band51
      type: object
      properties:
        allow_rrm_disable:
          type: boolean
          description: Whether RRM may disable the 5 GHz radio when optimizing RF settings
          default: false
        ant_gain:
          maximum: 10
          minimum: 0
          type:
          - integer
          - 'null'
          description: External antenna gain for the 5 GHz radio
          contentEncoding: int32
          default: 0
        antenna_mode:
          allOf:
          - $ref: '#/components/schemas/radio_band_antenna_mode1'
          - description: 'Radio chain mode for the 5 GHz radio. enum: `1x1`, `2x2`, `3x3`, `4x4`, `default`.'
            examples:
            - default
        bandwidth:
          allOf:
          - $ref: '#/components/schemas/dot11_bandwidth52'
          - description: 'Channel width configured for the 5 GHz radio. enum: `0`, `20`, `40`, `80`.'
            examples:
            - 40
        channels:
          type:
          - array
          - 'null'
          items:
            type: integer
            contentEncoding: int32
          description: Allowed channel list for the 5 GHz radio; null or an empty array uses automatic selection
          default: []
        disabled:
          type: boolean
          description: Whether to disable the radio
          default: false
        power:
          maximum: 25
          minimum: 0
          type:
          - integer
          - 'null'
          description: Radio Tx power, in dBm. Can be an integer 0-25 for static power configuration, or `null` or unset for auto power mode
          contentEncoding: int32
          examples:
          - 6
        power_max:
          maximum: 17
          minimum: 5
          type:
          - integer
          - 'null'
          description: When power=null/unset, max tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        power_min:
          maximum: 17
          minimum: 5
          type:
          - integer
          - 'null'
          description: When power=null/unset, min tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        preamble:
          allOf:
          - $ref: '#/components/schemas/radio_band_preamble1'
          - description: '802.11 preamble mode used by the 5 GHz radio. enum: `auto`, `long`, `short`.'
      description: 5 GHz settings used when the 2.4 GHz radio operates in 5 GHz mode
    rftemplate_radio_band52:
      title: rftemplate_radio_band52
      type: object
      properties:
        allow_rrm_disable:
          type: boolean
          description: Whether RRM may disable the 5 GHz radio when optimizing RF settings
          default: false
        ant_gain:
          maximum: 10
          minimum: 0
          type:
          - integer
          - 'null'
          description: External antenna gain for the 5 GHz radio
          contentEncoding: int32
          default: 0
        antenna_mode:
          allOf:
          - $ref: '#/components/schemas/radio_band_antenna_mode1'
          - description: 'Radio chain mode for the 5 GHz radio. enum: `1x1`, `2x2`, `3x3`, `4x4`, `default`.'
            examples:
            - default
        bandwidth:
          allOf:
          - $ref: '#/components/schemas/dot11_bandwidth52'
          - description: 'Channel width configured for the 5 GHz radio. enum: `0`, `20`, `40`, `80`.'
            examples:
            - 40
        channels:
          type:
          - array
          - 'null'
          items:
            type: integer
            contentEncoding: int32
          description: Allowed channel list for the 5 GHz radio; null or an empty array uses automatic selection
          default: []
        disabled:
          type: boolean
          description: Whether to disable the radio
          default: false
        power:
          maximum: 25
          minimum: 0
          type:
          - integer
          - 'null'
          description: Radio Tx power, in dBm. Can be an integer 0-25 for static power configuration, or `null` or unset for auto power mode
          contentEncoding: int32
          examples:
          - 6
        power_max:
          maximum: 17
          minimum: 5
          type:
          - integer
          - 'null'
          description: When power=null/unset, max tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        power_min:
          maximum: 17
          minimum: 5
          type:
          - integer
          - 'null'
          description: When power=null/unset, min tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        preamble:
          allOf:
          - $ref: '#/components/schemas/radio_band_preamble1'
          - description: '802.11 preamble mode used by the 5 GHz radio. enum: `auto`, `long`, `short`.'
      description: Model-specific 5 GHz radio settings that override RF template defaults
    rftemplate_radio_band53:
      title: rftemplate_radio_band53
      type: object
      properties:
        allow_rrm_disable:
          type: boolean
          description: Whether RRM may disable the 5 GHz radio when optimizing RF settings
          default: false
        ant_gain:
          maximum: 10
          minimum: 0
          type:
          - integer
          - 'null'
          description: External antenna gain for the 5 GHz radio
          contentEncoding: int32
          default: 0
        antenna_mode:
          allOf:
          - $ref: '#/components/schemas/radio_band_antenna_mode1'
          - description: 'Radio chain mode for the 5 GHz radio. enum: `1x1`, `2x2`, `3x3`, `4x4`, `default`.'
            examples:
            - default
        bandwidth:
          allOf:
          - $ref: '#/components/schemas/dot11_bandwidth52'
          - description: 'Channel width configured for the 5 GHz radio. enum: `0`, `20`, `40`, `80`.'
            examples:
            - 40
        channels:
          type:
          - array
          - 'null'
          items:
            type: integer
            contentEncoding: int32
          description: Allowed channel list for the 5 GHz radio; null or an empty array uses automatic selection
          default: []
        disabled:
          type: boolean
          description: Whether to disable the radio
          default: false
        power:
          maximum: 25
          minimum: 0
          type:
          - integer
          - 'null'
          description: Radio Tx power, in dBm. Can be an integer 0-25 for static power configuration, or `null` or unset for auto power mode
          contentEncoding: int32
          examples:
          - 6
        power_max:
          maximum: 17
          minimum: 5
          type:
          - integer
          - 'null'
          description: When power=null/unset, max tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        power_min:
          maximum: 17
          minimum: 5
          type:
          - integer
          - 'null'
          description: When power=null/unset, min tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        preamble:
          allOf:
          - $ref: '#/components/schemas/radio_band_preamble1'
          - description: '802.11 preamble mode used by the 5 GHz radio. enum: `auto`, `long`, `short`.'
      description: Model-specific 5 GHz settings used when the 2.4 GHz radio operates in 5 GHz mode
    rftemplate_radio_band55:
      title: rftemplate_radio_band55
      type: object
      properties:
        allow_rrm_disable:
          type: boolean
          description: Whether RRM may disable the 5 GHz radio when optimizing RF settings
          default: false
        ant_gain:
          maximum: 10
          minimum: 0
          type:
          - integer
          - 'null'
          description: External antenna gain for the 5 GHz radio
          contentEncoding: int32
          default: 0
        antenna_mode:
          allOf:
          - $ref: '#/components/schemas/radio_band_antenna_mode1'
          - description: 'Radio chain mode for the 5 GHz radio. enum: `1x1`, `2x2`, `3x3`, `4x4`, `default`.'
            examples:
            - default
        bandwidth:
          allOf:
          - $ref: '#/components/schemas/dot11_bandwidth52'
          - description: 'Channel width configured for the 5 GHz radio. enum: `0`, `20`, `40`, `80`.'
            examples:
            - 40
        channels:
          type:
          - array
          - 'null'
          items:
            type: integer
            contentEncoding: int32
          description: Allowed channel list for the 5 GHz radio; null or an empty array uses automatic selection
          default: []
        disabled:
          type: boolean
          description: Whether to disable the radio
          default: false
        power:
          maximum: 25
          minimum: 0
          type:
          - integer
          - 'null'
          description: Radio Tx power, in dBm. Can be an integer 0-25 for static power configuration, or `null` or unset for auto power mode
          contentEncoding: int32
          examples:
          - 6
        power_max:
          maximum: 17
          minimum: 5
          type:
          - integer
          - 'null'
          description: When power=null/unset, max tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        power_min:
          maximum: 17
          minimum: 5
          type:
          - integer
          - 'null'
          description: When power=null/unset, min tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        preamble:
          allOf:
          - $ref: '#/components/schemas/radio_band_preamble1'
          - description: '802.11 preamble mode used by the 5 GHz radio. enum: `auto`, `long`, `short`.'
      description: 5 GHz radio settings in this RF template
    rftemplate_radio_band61:
      title: rftemplate_radio_band61
      type: object
      properties:
        allow_rrm_disable:
          type: boolean
          description: Whether RRM may disable the 6 GHz radio when optimizing RF settings
          default: false
        ant_gain:
          maximum: 10
          minimum: 0
          type:
          - integer
          - 'null'
          description: External antenna gain for the 6 GHz radio
          contentEncoding: int32
          default: 0
        antenna_mode:
          allOf:
          - $ref: '#/components/schemas/radio_band_antenna_mode2'
          - description: 'Radio chain mode for the 6 GHz radio. enum: `1x1`, `2x2`, `3x3`, `4x4`, `default`.'
            examples:
            - default
        bandwidth:
          allOf:
          - $ref: '#/components/schemas/dot11_bandwidth62'
          - description: 'Channel width configured for the 6 GHz radio. enum: `0`, `20`, `40`, `80`, `160`.'
            examples:
            - 80
        channels:
          type:
          - array
          - 'null'
          items:
            type: integer
            contentEncoding: int32
          description: Allowed channel list for the 6 GHz radio; null or an empty array uses automatic selection
          default: []
        disabled:
          type: boolean
          description: Whether to disable the radio
          default: false
        power:
          maximum: 25
          minimum: 0
          type:
          - integer
          - 'null'
          description: Radio Tx power, in dBm. Can be an integer 0-25 for static power configuration, or `null` or unset for auto power mode
          contentEncoding: int32
          examples:
          - 7
        power_max:
          maximum: 17
          minimum: 5
          type:
          - integer
          - 'null'
          description: When power=null/unset, max tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        power_min:
          maximum: 18
          minimum: 5
          type:
          - integer
          - 'null'
          description: When power=null/unset, min tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        preamble:
          allOf:
          - $ref: '#/components/schemas/radio_band_preamble2'
          - description: '802.11 preamble mode used by the 6 GHz radio. enum: `auto`, `long`, `short`.'
        standard_power:
          type: boolean
          description: For 6GHz Only, standard-power operation, AFC (Automatic Frequency Coordination) will be performed, and we'll fall back to Low Power Indoor if AFC failed
          default: false
      description: Model-specific 6 GHz radio settings that override RF template defaults
    rftemplate_radio_band63:
      title: rftemplate_radio_band63
      type: object
      properties:
        allow_rrm_disable:
          type: boolean
          description: Whether RRM may disable the 6 GHz radio when optimizing RF settings
          default: false
        ant_gain:
          maximum: 10
          minimum: 0
          type:
          - integer
          - 'null'
          description: External antenna gain for the 6 GHz radio
          contentEncoding: int32
          default: 0
        antenna_mode:
          allOf:
          - $ref: '#/components/schemas/radio_band_antenna_mode2'
          - description: 'Radio chain mode for the 6 GHz radio. enum: `1x1`, `2x2`, `3x3`, `4x4`, `default`.'
            examples:
            - default
        bandwidth:
          allOf:
          - $ref: '#/components/schemas/dot11_bandwidth62'
          - description: 'Channel width configured for the 6 GHz radio. enum: `0`, `20`, `40`, `80`, `160`.'
            examples:
            - 80
        channels:
          type:
          - array
          - 'null'
          items:
            type: integer
            contentEncoding: int32
          description: Allowed channel list for the 6 GHz radio; null or an empty array uses automatic selection
          default: []
        disabled:
          type: boolean
          description: Whether to disable the radio
          default: false
        power:
          maximum: 25
          minimum: 0
          type:
          - integer
          - 'null'
          description: Radio Tx power, in dBm. Can be an integer 0-25 for static power configuration, or `null` or unset for auto power mode
          contentEncoding: int32
          examples:
          - 7
        power_max:
          maximum: 17
          minimum: 5
          type:
          - integer
          - 'null'
          description: When power=null/unset, max tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        power_min:
          maximum: 18
          minimum: 5
          type:
          - integer
          - 'null'
          description: When power=null/unset, min tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        preamble:
          allOf:
          - $ref: '#/components/schemas/radio_band_preamble2'
          - description: '802.11 preamble mode used by the 6 GHz radio. enum: `auto`, `long`, `short`.'
        standard_power:
          type: boolean
          description: For 6GHz Only, standard-power operation, AFC (Automatic Frequency Coordination) will be performed, and we'll fall back to Low Power Indoor if AFC failed
          default: false
      description: 6 GHz radio settings in this RF template
    rftemplate_radio_band241:
      title: rftemplate_radio_band241
      type: object
      properties:
        allow_rrm_disable:
          type: boolean
          description: Whether RRM may disable the 2.4 GHz radio when optimizing RF settings
          default: false
        ant_gain:
          maximum: 10
          minimum: 0
          type:
          - integer
          - 'null'
          description: External antenna gain for the 2.4 GHz radio
          contentEncoding: int32
          default: 0
        antenna_mode:
          allOf:
          - $ref: '#/components/schemas/radio_band_antenna_mode4'
          - description: 'Radio chain mode for the 2.4 GHz radio. enum: `1x1`, `2x2`, `3x3`, `4x4`, `default`.'
            examples:
            - default
        bandwidth:
          allOf:
          - $ref: '#/components/schemas/dot11_bandwidth242'
          - description: 'Channel width configured for the 2.4 GHz radio. enum: `0`, `20`, `40`.'
            examples:
            - 20
        channels:
          type:
          - array
          - 'null'
          items:
            type: integer
            contentEncoding: int32
          description: Allowed channel list for the 2.4 GHz radio; null or an empty array uses automatic selection
          default: []
        disabled:
          type: boolean
          description: Whether to disable the radio
          default: false
        power:
          maximum: 25
          minimum: 0
          type:
          - integer
          - 'null'
          description: Radio Tx power, in dBm. Can be an integer 0-25 for static power configuration, or `null` or unset for auto power mode
          contentEncoding: int32
          examples:
          - 3
        power_max:
          maximum: 18
          minimum: 3
          type:
          - integer
          - 'null'
          description: When power=null/unset, max tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        power_min:
          maximum: 18
          minimum: 3
          type:
          - integer
          - 'null'
          description: When power=null/unset, min tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        preamble:
          allOf:
          - $ref: '#/components/schemas/radio_band_preamble4'
          - description: '802.11 preamble mode used by the 2.4 GHz radio. enum: `auto`, `long`, `short`.'
      description: Model-specific 2.4 GHz radio settings that override RF template defaults
    rftemplate_radio_band243:
      title: rftemplate_radio_band243
      type: object
      properties:
        allow_rrm_disable:
          type: boolean
          description: Whether RRM may disable the 2.4 GHz radio when optimizing RF settings
          default: false
        ant_gain:
          maximum: 10
          minimum: 0
          type:
          - integer
          - 'null'
          description: External antenna gain for the 2.4 GHz radio
          contentEncoding: int32
          default: 0
        antenna_mode:
          allOf:
          - $ref: '#/components/schemas/radio_band_antenna_mode4'
          - description: 'Radio chain mode for the 2.4 GHz radio. enum: `1x1`, `2x2`, `3x3`, `4x4`, `default`.'
            examples:
            - default
        bandwidth:
          allOf:
          - $ref: '#/components/schemas/dot11_bandwidth242'
          - description: 'Channel width configured for the 2.4 GHz radio. enum: `0`, `20`, `40`.'
            examples:
            - 20
        channels:
          type:
          - array
          - 'null'
          items:
            type: integer
            contentEncoding: int32
          description: Allowed channel list for the 2.4 GHz radio; null or an empty array uses automatic selection
          default: []
        disabled:
          type: boolean
          description: Whether to disable the radio
          default: false
        power:
          maximum: 25
          minimum: 0
          type:
          - integer
          - 'null'
          description: Radio Tx power, in dBm. Can be an integer 0-25 for static power configuration, or `null` or unset for auto power mode
          contentEncoding: int32
          examples:
          - 3
        power_max:
          maximum: 18
          minimum: 3
          type:
          - integer
          - 'null'
          description: When power=null/unset, max tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        power_min:
          maximum: 18
          minimum: 3
          type:
          - integer
          - 'null'
          description: When power=null/unset, min tx power to use, HW-specific values will be used if not set
          contentEncoding: int32
        preamble:
          allOf:
          - $ref: '#/components/schemas/radio_band_preamble4'
          - description: '802.11 preamble mode used by the 2.4 GHz radio. enum: `auto`, `long`, `short`.'
      description: 2.4 GHz radio settings in this RF template
    route_summary_stats1:
      title: route_summary_stats1
      type: object
      properties:
        fib_routes:
          type: integer
          description: Number of routes installed in the forwarding information base
          contentEncoding: int32
        max_unicast_routes_supported:
          type: integer
          description: Supported maximum number of unicast routes
          contentEncoding: int32
        rib_routes:
          type: integer
          description: Number of routes present in the routing information base
          contentEncoding: int32
        total_routes:
          type: integer
          description: Aggregate number of routes reported by the device
          contentEncoding: int32
      description: Route table summary statistics for the switch
    route_summary_stats2:
      title: route_summary_stats2
      type: object
      properties:
        fib_routes:
          type: integer
          description: Number of routes installed in the forwarding information base
          contentEncoding: int32
        max_unicast_routes_supported:
          type: integer
          description: Supported maximum number of unicast routes
          contentEncoding: int32
        rib_routes:
          type: integer
          description: Number of routes present in the routing information base
          contentEncoding: int32
        total_routes:
          type: integer
          description: Aggregate number of routes reported by the device
          contentEncoding: int32
      description: Route table summary statistics for the gateway
    rrm_band_metric1:
      title: rrm_band_metric1
      required:
      - cochannel_neighbors
      - density
      - neighbors
      - noise
      type: object
      properties:
        avg_aps_per_channel:
          type: number
          description: Average number of APs per channel
        channel_distribution_uniformity:
          type: number
          description: Distribution of channel across the Access Points
        cochannel_neighbors:
          type: number
          description: Average number of co-channel neighbors
        density:
          maximum: 1
          minimum: 0
          type: number
          description: defined by how APs can hear from one and another, 0 - 1 (everyone can hear everyone)
        interferences:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/rrm_band_metric_interference'
          description: Property key is the channel number
          examples:
          - '149':
              radar: 0.3
            '153':
              radar: 0.2
        naps_by_channel:
          type: object
          additionalProperties:
            type: number
          description: Number of APs grouped by channel for this band
        naps_by_power:
          type: object
          additionalProperties:
            type: number
          description: Number of APs grouped by transmit power for this band
        neighbors:
          type: number
          description: Average number of neighbors
        noise:
          type: number
          description: Average noise in dBm
      description: Aggregate RRM metrics for the 5 GHz band
    rrm_band_metric2:
      title: rrm_band_metric2
      required:
      - cochannel_neighbors
      - density
      - neighbors
      - noise
      type: object
      properties:
        avg_aps_per_channel:
          type: number
          description: Average number of APs per channel
        channel_distribution_uniformity:
          type: number
          description: Distribution of channel across the Access Points
        cochannel_neighbors:
          type: number
          description: Average number of co-channel neighbors
        density:
          maximum: 1
          minimum: 0
          type: number
          description: defined by how APs can hear from one and another, 0 - 1 (everyone can hear everyone)
        interferences:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/rrm_band_metric_interference'
          description: Property key is the channel number
          examples:
          - '149':
              radar: 0.3
            '153':
              radar: 0.2
        naps_by_channel:
          type: object
          additionalProperties:
            type: number
          description: Number of APs grouped by channel for this band
        naps_by_power:
          type: object
          additionalProperties:
            type: number
          description: Number of APs grouped by transmit power for this band
        neighbors:
          type: number
          description: Average number of neighbors
        noise:
          type: number
          description: Average noise in dBm
      description: Aggregate RRM metrics for the 6 GHz band
    rrm_band_metric4:
      title: rrm_band_metric4
      required:
      - cochannel_neighbors
      - density
      - neighbors
      - noise
      type: object
      properties:
        avg_aps_per_channel:
          type: number
          description: Average number of APs per channel
        channel_distribution_uniformity:
          type: number
          description: Distribution of channel across the Access Points
        cochannel_neighbors:
          type: number
          description: Average number of co-channel neighbors
        density:
          maximum: 1
          minimum: 0
          type: number
          description: defined by how APs can hear from one and another, 0 - 1 (everyone can hear everyone)
        interferences:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/rrm_band_metric_interference'
          description: Property key is the channel number
          examples:
          - '149':
              radar: 0.3
            '153':
              radar: 0.2
        naps_by_channel:
          type: object
          additionalProperties:
            type: number
          description: Number of APs grouped by channel for this band
        naps_by_power:
          type: object
          additionalProperties:
            type: number
          description: Number of APs grouped by transmit power for this band
        neighbors:
          type: number
          description: Average number of neighbors
        noise:
          type: number
          description: Average noise in dBm
      description: Aggregate RRM metrics for the 2.4 GHz band
    rrm_event_pre_bandwidth2:
      title: rrm_event_pre_bandwidth2
      enum:
      - 0
      - 20
      - 40
      - 80
      - 160
      type: integer
      description: 'Channel width before the RRM event, in MHz. enum: `0`, `20`, `40`, `80`, `160`.'
    rrm_event_type2:
      title: rrm_event_type2
      enum:
      - interference-ap-co-channel
      - interference-ap-non-wifi
      - neighbor-ap-down
      - neighbor-ap-recovered
      - radar-detected
      - rrm-radar
      - scheduled-site_rrm
      - triggered-site_rrm
      type: string
      description: 'RRM event type that caused or records the change. enum: `interference-ap-co-channel`, `interference-ap-non-wifi`, `neighbor-ap-down`, `neighbor-ap-recovered`, `radar-detected`, `rrm-radar`, `scheduled-site_rrm`, `triggered-site_rrm`.'
    rrm_status2:
      title: rrm_status2
      enum:
      - ready
      - unknown
      - updating
      type: string
      description: 'Current RRM calculation status. enum: `ready`, `unknown`, `updating`.'
    scan_data_item_band1:
      title: scan_data_item_band1
      enum:
      - '2.4'
      - '5'
      type: string
      description: 'Radio band on which the SDK client scanned the BSSID. enum: `2.4`, `5`.'
    secintel_profile_profile_action2:
      title: secintel_profile_profile_action2
      enum:
      - default
      - standard
      - strict
      type: string
      description: 'Protection level applied to the SecIntel category. enum: `default`, `standard`, `strict`.'
    secintel_profile_profile_category2:
      title: secintel_profile_profile_category2
      enum:
      - CC
      - DNS
      - IH
      type: string
      description: 'SecIntel feed category configured by this profile entry. enum: `CC`, `DNS`, `IH`.'
    service_failover_policy2:
      title: service_failover_policy2
      enum:
      - non_revertible
      - none
      - revertible
      type: string
      description: 'Failover behavior for traffic matched by this service. enum: `non_revertible`, `none`, `revertible`.'
    service_policy_aamw_profile2:
      title: service_policy_aamw_profile2
      enum:
      - docsonly
      - executables
      - standard
      type: string
      description: 'Built-in advanced anti-malware inspection profile to apply. enum: `docsonly`, `executables`, `standard`.'
    service_policy_aamw2:
      title: service_policy_aamw2
      type: object
      properties:
        aamwprofile_id:
          type: string
          description: Organization-level advanced anti-malware profile ID; takes precedence over inline `profile` settings
          contentEncoding: uuid
        enabled:
          type: boolean
          description: Whether advanced anti-malware inspection is enabled for the service policy
          default: false
        profile:
          allOf:
          - $ref: '#/components/schemas/service_policy_aamw_profile2'
          - description: 'Built-in advanced anti-malware inspection profile to apply. enum: `docsonly`, `executables`, `standard`.'
      description: Advanced anti-malware settings applied by this service policy
    service_policy_antivirus1:
      title: service_policy_antivirus1
      type: object
      properties:
        avprofile_id:
          type: string
          description: Organization-level antivirus profile ID; takes precedence over inline `profile` settings
          contentEncoding: uuid
        enabled:
          type: boolean
          description: Whether antivirus inspection is enabled for the service policy
          default: false
        profile:
          type: string
          description: Antivirus profile name to apply, such as `default`, `noftp`, `httponly`, or an AV profile key
      description: Malware and virus inspection settings applied by this service policy
    service_policy_appqoe1:
      title: service_policy_appqoe1
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether application QoE is enabled for the service policy
          default: false
      description: Application QoE settings applied by this service policy
    service_policy_ewf_rule_profile2:
      title: service_policy_ewf_rule_profile2
      enum:
      - critical
      - standard
      - strict
      type: string
      description: 'Enhanced web filtering profile applied by this rule. enum: `critical`, `standard`, `strict`.'
    service_policy_secintel_profile2:
      title: service_policy_secintel_profile2
      enum:
      - default
      - standard
      - strict
      type: string
      description: 'Protection level applied by SecIntel inspection. enum: `default`, `standard`, `strict`.'
    service_policy_secintel1:
      title: service_policy_secintel1
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether SecIntel inspection is enabled for the service policy
          default: false
        profile:
          allOf:
          - $ref: '#/components/schemas/service_policy_secintel_profile2'
          - description: 'Protection level applied by SecIntel inspection. enum: `default`, `standard`, `strict`.'
        secintelprofile_id:
          type: string
          description: Organization-level SecIntel profile ID; takes precedence over inline `profile` settings
      description: Juniper SecIntel threat intelligence settings applied by this service policy
    service_policy_secintel3:
      title: service_policy_secintel3
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether SecIntel inspection is enabled for the service policy
          default: false
        profile:
          allOf:
          - $ref: '#/components/schemas/service_policy_secintel_profile2'
          - description: 'Protection level applied by SecIntel inspection. enum: `default`, `standard`, `strict`.'
        secintelprofile_id:
          type: string
          description: Organization-level SecIntel profile ID; takes precedence over inline `profile` settings
      description: Threat intelligence settings applied by this service policy
    service_policy_skyatp_dns_dga_detection_profile2:
      title: service_policy_skyatp_dns_dga_detection_profile2
      enum:
      - default
      - standard
      - strict
      type: string
      description: 'Sky ATP DNS DGA detection profile to apply. enum: `default`, `standard`, `strict`.'
    service_policy_skyatp_dns_dga_detection2:
      title: service_policy_skyatp_dns_dga_detection2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether Sky ATP DNS DGA detection is enabled
        profile:
          allOf:
          - $ref: '#/components/schemas/service_policy_skyatp_dns_dga_detection_profile2'
          - description: 'Sky ATP DNS DGA detection profile to apply. enum: `default`, `standard`, `strict`.'
      description: Detection settings for DNS DGA threats provided by Sky ATP
    service_policy_skyatp_dns_tunnel_detection_profile2:
      title: service_policy_skyatp_dns_tunnel_detection_profile2
      enum:
      - default
      - standard
      - strict
      type: string
      description: 'Sky ATP DNS tunneling detection profile to apply. enum: `default`, `standard`, `strict`.'
    service_policy_skyatp_dns_tunnel_detection2:
      title: service_policy_skyatp_dns_tunnel_detection2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether Sky ATP DNS tunneling detection is enabled
        profile:
          allOf:
          - $ref: '#/components/schemas/service_policy_skyatp_dns_tunnel_detection_profile2'
          - description: 'Sky ATP DNS tunneling detection profile to apply. enum: `default`, `standard`, `strict`.'
      description: Detection settings for DNS tunneling threats provided by Sky ATP
    service_policy_skyatp_http_inspection_profile2:
      title: service_policy_skyatp_http_inspection_profile2
      enum:
      - standard
      - strict
      type: string
      description: 'Sky ATP HTTP inspection profile to apply. enum: `standard`, `strict`.'
    service_policy_skyatp_http_inspection2:
      title: service_policy_skyatp_http_inspection2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether Sky ATP HTTP inspection is enabled
        profile:
          allOf:
          - $ref: '#/components/schemas/service_policy_skyatp_http_inspection_profile2'
          - description: 'Sky ATP HTTP inspection profile to apply. enum: `standard`, `strict`.'
      description: Web traffic inspection settings provided by Sky ATP
    service_policy_skyatp_iot_device_policy2:
      title: service_policy_skyatp_iot_device_policy2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether Sky ATP IoT device policy inspection is enabled
      description: Device threat policy settings provided by Sky ATP for IoT clients
    service_policy_skyatp2:
      title: service_policy_skyatp2
      type: object
      properties:
        dns_dga_detection:
          allOf:
          - $ref: '#/components/schemas/service_policy_skyatp_dns_dga_detection2'
          - description: Detection settings for DNS DGA threats provided by Sky ATP
        dns_tunnel_detection:
          allOf:
          - $ref: '#/components/schemas/service_policy_skyatp_dns_tunnel_detection2'
          - description: Detection settings for DNS tunneling threats provided by Sky ATP
        http_inspection:
          allOf:
          - $ref: '#/components/schemas/service_policy_skyatp_http_inspection2'
          - description: Web traffic inspection settings provided by Sky ATP
        iot_device_policy:
          allOf:
          - $ref: '#/components/schemas/service_policy_skyatp_iot_device_policy2'
          - description: Device threat policy settings provided by Sky ATP for IoT clients
      description: Threat inspection settings provided by Sky ATP for this service policy
    service_policy_ssl_proxy1:
      title: service_policy_ssl_proxy1
      type: object
      properties:
        ciphers_category:
          allOf:
          - $ref: '#/components/schemas/ssl_proxy_ciphers_category2'
          - description: 'Allowed cipher strength category for SSL proxy inspection. enum: `medium`, `strong`, `weak`.'
        enabled:
          type: boolean
          description: Whether SSL proxy inspection is enabled for the service policy
          default: false
      description: SSL proxy inspection settings applied by this service policy
    service_policy_ssl_proxy3:
      title: service_policy_ssl_proxy3
      type: object
      properties:
        ciphers_category:
          allOf:
          - $ref: '#/components/schemas/ssl_proxy_ciphers_category2'
          - description: 'Allowed cipher strength category for SSL proxy inspection. enum: `medium`, `strong`, `weak`.'
        enabled:
          type: boolean
          description: Whether SSL proxy inspection is enabled for the service policy
          default: false
      description: TLS inspection settings applied by this service policy
    service_policy_syslog2:
      title: service_policy_syslog2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether syslog logging is enabled for the service policy
          default: false
        server_names:
          type: array
          items:
            type: string
          description: Names of syslog servers that receive logs for this service policy
          examples:
          - - dc_syslog_server
      description: Remote logging settings applied by this service policy
    service_traffic_class2:
      title: service_traffic_class2
      enum:
      - best_effort
      - high
      - low
      - medium
      type: string
      description: 'Traffic class applied when `traffic_type`==`custom`. enum: `best_effort`, `high`, `low`, `medium`.'
    service_type2:
      title: service_type2
      enum:
      - app_categories
      - apps
      - custom
      - urls
      type: string
      description: 'Matching mode that determines which app, URL, or custom fields are used. enum: `app_categories`, `apps`, `custom`, `urls`.'
    setting_ssr_auto_upgrade2:
      title: setting_ssr_auto_upgrade2
      type: object
      properties:
        channel:
          allOf:
          - $ref: '#/components/schemas/ssr_upgrade_channel4'
          - description: 'Firmware release channel used for SSR auto-upgrade. enum: `alpha`, `beta`, `stable`.'
        custom_versions:
          type: object
          additionalProperties:
            type: string
          description: Per-model SSR firmware versions used for auto-upgrade
        enabled:
          type: boolean
          description: Whether SSR auto-upgrade is enabled for newly onboarded devices
          default: false
        version:
          type: string
          description: Firmware version to deploy (e.g. 6.3.0-107.r1). Optional, used when custom_versions not specified
          examples:
          - 6.3.0-107.r1
      description: Automatic SSR firmware upgrade settings for newly onboarded devices
    setting_ssr2:
      title: setting_ssr2
      type: object
      properties:
        auto_upgrade:
          allOf:
          - $ref: '#/components/schemas/setting_ssr_auto_upgrade2'
          - description: Automatic SSR firmware upgrade settings for newly onboarded devices
        conductor_hosts:
          type: array
          items:
            type: string
          description: IP addresses or hostnames of conductors used by SSR devices
        conductor_token:
          type: string
          description: Registration token used by SSR devices to connect to the conductor
        disable_stats:
          type: boolean
          description: Whether stats collection is disabled on SSR devices
        proxy:
          allOf:
          - $ref: '#/components/schemas/ssr_proxy2'
          - description: Network proxy settings used by SSR devices to reach Mist
      description: Session Smart Router settings for the site
    setting_ssr3:
      title: setting_ssr3
      type: object
      properties:
        auto_upgrade:
          allOf:
          - $ref: '#/components/schemas/setting_ssr_auto_upgrade2'
          - description: Automatic SSR firmware upgrade settings for newly onboarded devices
        conductor_hosts:
          type: array
          items:
            type: string
          description: IP addresses or hostnames of conductors used by SSR devices
        conductor_token:
          type: string
          description: Registration token used by SSR devices to connect to the conductor
        disable_stats:
          type: boolean
          description: Whether stats collection is disabled on SSR devices
        proxy:
          allOf:
          - $ref: '#/components/schemas/ssr_proxy2'
          - description: Network proxy settings used by SSR devices to reach Mist
      description: Session Smart Router settings for the organization
    simple_alert2:
      title: simple_alert2
      type: object
      properties:
        arp_failure:
          allOf:
          - $ref: '#/components/schemas/simple_alert_arp_failure'
          - description: Thresholds for ARP failure heuristic alerts
        dhcp_failure:
          allOf:
          - $ref: '#/components/schemas/simple_alert_dhcp_failure'
          - description: Thresholds for DHCP failure heuristic alerts
        dns_failure:
          allOf:
          - $ref: '#/components/schemas/simple_alert_dns_failure'
          - description: Thresholds for DNS failure heuristic alerts
      description: Threshold alert settings for the site
    simple_alert3:
      title: simple_alert3
      type: object
      properties:
        arp_failure:
          allOf:
          - $ref: '#/components/schemas/simple_alert_arp_failure'
          - description: Thresholds for ARP failure heuristic alerts
        dhcp_failure:
          allOf:
          - $ref: '#/components/schemas/simple_alert_dhcp_failure'
          - description: Thresholds for DHCP failure heuristic alerts
        dns_failure:
          allOf:
          - $ref: '#/components/schemas/simple_alert_dns_failure'
          - description: Thresholds for DNS failure heuristic alerts
      description: Basic alert delivery settings for the organization
    site_auto_upgrade_version2:
      title: site_auto_upgrade_version2
      enum:
      - beta
      - custom
      - stable
      type: string
      description: 'Firmware release channel or custom version used for AP auto-upgrade. enum: `beta`, `custom`, `stable`.'
      examples:
      - beta
    site_auto_upgrade_version3:
      title: site_auto_upgrade_version3
      enum:
      - beta
      - custom
      - stable
      type: string
      description: 'Firmware release channel or specific version used for AP auto-upgrade. enum: `beta`, `custom`, `stable`.'
      examples:
      - beta
    site_engagement_dwell_tag_names2:
      title: site_engagement_dwell_tag_names2
      type: object
      properties:
        bounce:
          type: string
          description: Display label for bounce visits
          default: Visitor
          examples:
          - Bounce
        engaged:
          type: string
          description: Display label for engaged visits
          default: Associates
          examples:
          - Engaged
        passerby:
          type: string
          description: Display label for passerby visits
          default: Passerby
          examples:
          - Passer By
        stationed:
          type: string
          description: Display label for stationed visits
          default: Assets
          examples:
          - Stationed
      description: Display labels for dwell-time visit categories
    site_engagement_dwell_tags2:
      title: site_engagement_dwell_tags2
      type: object
      properties:
        bounce:
          type:
          - string
          - 'null'
          description: Visit duration range for bounce visits, in seconds
          default: 301-14400
        engaged:
          type:
          - string
          - 'null'
          description: Visit duration range for engaged visits, in seconds
          default: 14401-28800
        passerby:
          type:
          - string
          - 'null'
          description: Visit duration range for passerby visits, in seconds
          default: 1-300
        stationed:
          type:
          - string
          - 'null'
          description: Visit duration range for stationed visits, in seconds
          default: 28801-42000
      description: Visit duration ranges used to assign engagement categories
    site_engagement1:
      title: site_engagement1
      type: object
      properties:
        dwell_tag_names:
          allOf:
          - $ref: '#/components/schemas/site_engagement_dwell_tag_names2'
          - description: Display labels for dwell-time visit categories
        dwell_tags:
          allOf:
          - $ref: '#/components/schemas/site_engagement_dwell_tags2'
          - description: Visit duration ranges used to assign engagement categories
        hours:
          allOf:
          - $ref: '#/components/schemas/hours3'
          - description: Schedule during which engagement analytics rules apply
        max_dwell:
          maximum: 68400
          minimum: 1
          type: integer
          description: Maximum dwell time in seconds considered by engagement analytics
          contentEncoding: int32
          default: 43200
          examples:
          - 43200
        min_dwell:
          minimum: 0
          type: integer
          description: Minimum dwell time in seconds for engagement analytics
          contentEncoding: int32
      description: Dwell-time analytics rules for the site
    site_mxtunnel_protocol2:
      title: site_mxtunnel_protocol2
      enum:
      - ip
      - udp
      type: string
      description: 'Encapsulation protocol used for this additional Mist Tunnel. enum: `ip`, `udp`.'
      examples:
      - udp
    site_mxtunnel_radsec2:
      title: site_mxtunnel_radsec2
      type: object
      properties:
        acct_servers:
          type: array
          items:
            $ref: '#/components/schemas/radius_acct_server'
          description: RADIUS accounting servers used by the site Mist Tunnel RadSec proxy
        auth_servers:
          type: array
          items:
            $ref: '#/components/schemas/radius_auth_server'
          description: RADIUS authentication servers used by the site Mist Tunnel RadSec proxy
        enabled:
          type: boolean
          description: Whether RadSec proxying is enabled for this site Mist Tunnel
          default: false
        use_mxedge:
          type: boolean
          description: Whether RadSec proxying uses Mist Edge
      description: TLS-secured RADIUS proxy settings for the site Mist Tunnel
    site_mxtunnel1:
      title: site_mxtunnel1
      type: object
      properties:
        additional_mxtunnels:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/site_mxtunnel_additional_mxtunnel'
          description: Additional named Mist Tunnel definitions configured for the site
        ap_subnets:
          type: array
          items:
            type: string
          description: AP source subnets allowed to establish Mist Tunnels
        auto_preemption:
          allOf:
          - $ref: '#/components/schemas/auto_preemption1'
          - description: Preemption behavior for restoring preferred tunnel peers after failover
        clusters:
          type: array
          items:
            $ref: '#/components/schemas/site_mxtunnel_cluster'
          description: Tunnel peer clusters used by APs for this site Mist Tunnel
        created_time:
          type: number
          description: Timestamp when the site Mist Tunnel configuration was created
          readOnly: true
        enabled:
          type: boolean
          description: Whether site Mist Tunnel tunneling is enabled
        for_site:
          type: boolean
          description: Whether this Mist Tunnel configuration is scoped to a site
          readOnly: true
        hello_interval:
          maximum: 300
          minimum: 1
          type: integer
          description: In seconds, used as heartbeat to detect if a tunnel is alive. AP will try another peer after missing N hellos specified by hello_retries
          contentEncoding: int32
          default: 60
          examples:
          - 60
        hello_retries:
          maximum: 30
          minimum: 2
          type: integer
          description: Number of missed hello heartbeats before an AP tries another tunnel peer
          contentEncoding: int32
          default: 7
          examples:
          - 3
        hosts:
          type: array
          items:
            type: string
          description: Tunnel peer hostnames or IP addresses reachable from APs
        id:
          type: string
          description: Unique value identifying the site Mist Tunnel configuration
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        modified_time:
          type: number
          description: Timestamp when the site Mist Tunnel configuration was last modified
          readOnly: true
        mtu:
          maximum: 1500
          minimum: 0
          type: integer
          description: 0 to enable MTU, 552-1500 to start MTU with a lower MTU
          contentEncoding: int32
          default: 0
          examples:
          - 1100
        org_id:
          type: string
          description: Identifier of the org that owns the site Mist Tunnel configuration
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        protocol:
          allOf:
          - $ref: '#/components/schemas/mxtunnel_protocol2'
          - description: 'Encapsulation protocol used for the site Mist Tunnel. enum: `ip`, `udp`.'
        radsec:
          allOf:
          - $ref: '#/components/schemas/site_mxtunnel_radsec2'
          - description: TLS-secured RADIUS proxy settings for the site Mist Tunnel
        site_id:
          type: string
          description: Identifier of the site that owns this Mist Tunnel configuration
          contentEncoding: uuid
          readOnly: true
          examples:
          - 441a1214-6928-442a-8e92-e1d34b8ec6a6
        vlan_ids:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: List of VLAN IDs carried by this site Mist Tunnel
      description: Site Mist Tunnel configuration
    site_rogue1:
      title: site_rogue1
      type: object
      properties:
        allowed_vlan_ids:
          type: array
          items:
            maximum: 4096
            minimum: 0
            type: integer
            contentEncoding: int32
          description: VLAN IDs allowed by the rogue detection policy
        enabled:
          type: boolean
          description: Whether rogue detection is enabled
          default: false
        honeypot_enabled:
          type: boolean
          description: Whether honeypot detection is enabled
          default: false
        min_duration:
          maximum: 59
          type: integer
          description: Minimum duration for a bssid to be considered neighbor
          contentEncoding: int32
          default: 10
          examples:
          - 10
        min_rogue_duration:
          maximum: 59
          type: integer
          description: Minimum duration for a bssid to be considered rogue
          contentEncoding: int32
          default: 10
          examples:
          - 10
        min_rogue_rssi:
          minimum: -85
          type: integer
          description: Minimum RSSI for an AP to be considered rogue
          contentEncoding: int32
          default: -80
          examples:
          - -80
        min_rssi:
          minimum: -85
          type: integer
          description: Minimum RSSI for an AP to be considered neighbor (ignoring APs that’s far away)
          contentEncoding: int32
          default: -80
          examples:
          - -80
        whitelisted_bssids:
          type: array
          items:
            type: string
          description: BSSID values or wildcard patterns excluded from rogue detection
          examples:
          - - NeighborSSID
        whitelisted_ssids:
          type: array
          items:
            type: string
          description: SSID names excluded from rogue detection
          examples:
          - - cc:8e:6f:d4:bf:16
            - cc-8e-6f-d4-bf-16
            - cc-73-*
            - cc:82:*
      description: AP threat detection settings for the site
    site_setting_analytic2:
      title: site_setting_analytic2
      type: object
      properties:
        enabled:
          type: boolean
          description: Enable Advanced Analytic feature (using SUB-ANA license)
          default: false
      description: Advanced analytics configuration for the site
    site_setting_ap_matching2:
      title: site_setting_ap_matching2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether AP matching rules are enabled
        rules:
          type: array
          items:
            $ref: '#/components/schemas/site_setting_ap_matching_rule'
          description: Ordered AP matching rules for applying port configuration
      description: Rules that apply model-specific AP port configuration
    site_setting_ap_port_config2:
      title: site_setting_ap_port_config2
      type: object
      properties:
        model_specific:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ap_port_config'
          description: Property key is the AP model (e.g. "AP32")
      description: Ethernet port configuration overrides for APs at the site
    site_setting_ap_synthetic_test2:
      title: site_setting_ap_synthetic_test2
      type: object
      properties:
        additional_vlan_ids:
          anyOf:
          - type: string
          - type: array
            items:
              $ref: '#/components/schemas/vlan_id_with_variable'
          description: VLAN IDs included in addition to the default VLAN set for AP synthetic tests
      description: Synthetic test configuration for APs at the site
    site_setting_auto_placement2:
      title: site_setting_auto_placement2
      type: object
      properties:
        orientation:
          type: integer
          description: AP orientation angle in degrees on the map
          contentEncoding: int32
          examples:
          - 45
        x:
          type: number
          description: Map x-coordinate determined by auto placement
          examples:
          - 30
        y:
          type: number
          description: Map y-coordinate determined by auto placement
          examples:
          - 60
      description: Automatic AP placement settings for the site
    site_setting_auto_upgrade_esl2:
      title: site_setting_auto_upgrade_esl2
      type: object
      properties:
        allow_downgrade:
          type: boolean
          description: If true, it will allow downgrade to a lower version
          default: false
        custom_versions:
          type: object
          additionalProperties:
            type: string
          description: Custom versions for different models. Property key is the model name (e.g. "AP41")
          examples:
          - AP41: 2.4.6
            AP61: 2.5.0
        day_of_week:
          allOf:
          - $ref: '#/components/schemas/day_of_week5'
          - description: 'Weekly ESL auto-upgrade day for the maintenance window. enum: `any`, `fri`, `mon`, `sat`, `sun`, `thu`, `tue`, `wed`.'
        enabled:
          type: boolean
          description: Whether auto upgrade should happen (Note that Mist may auto-upgrade if the version is not supported)
          default: false
        time_of_day:
          type: string
          description: '`any` / HH:MM (24-hour format), upgrade will happen within up to 1-hour from this time'
          examples:
          - 12:00
        version:
          type: string
          description: ESL firmware version used for auto-upgrade
          examples:
          - 2.5.0
      description: Automatic ESL firmware upgrade settings for the site
    site_setting_auto_upgrade2:
      title: site_setting_auto_upgrade2
      type: object
      properties:
        custom_versions:
          type: object
          additionalProperties:
            type: string
          description: Per-AP-model firmware versions or channels used for auto-upgrade
          examples:
          - AP21: alpha
            AP41: 0.1.5135
            AP61: 0.1.7215
        day_of_week:
          allOf:
          - $ref: '#/components/schemas/day_of_week4'
          - description: 'Weekly AP auto-upgrade day for the maintenance window. enum: `any`, `fri`, `mon`, `sat`, `sun`, `thu`, `tue`, `wed`.'
        enabled:
          type: boolean
          description: Whether auto upgrade should happen (Note that Mist may auto-upgrade if the version is not supported)
          default: false
        time_of_day:
          type: string
          description: '`any` / HH:MM (24-hour format), upgrade will happen within up to 1-hour from this time'
          examples:
          - 12:00
        version:
          allOf:
          - $ref: '#/components/schemas/site_auto_upgrade_version2'
          - description: 'Firmware release channel or custom version used for AP auto-upgrade. enum: `beta`, `custom`, `stable`.'
            examples:
            - beta
      description: Automatic AP firmware upgrade settings for the site. Overrides org setting when provided.
    site_setting_config_push_policy2:
      title: site_setting_config_push_policy2
      type: object
      properties:
        no_push:
          type: boolean
          description: Stop any new config from being pushed to the device
          default: false
        push_window:
          allOf:
          - $ref: '#/components/schemas/push_policy_push_window1'
          - description: Allowed time window during which configuration pushes may run
      description: Policy controlling how site configuration pushes are applied
    site_setting_critical_url_monitoring2:
      title: site_setting_critical_url_monitoring2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether critical URL monitoring is enabled
          default: true
        monitors:
          type: array
          items:
            $ref: '#/components/schemas/site_setting_critical_url_monitoring_monitor'
          description: Critical URLs monitored for site health latency
      description: Monitoring configuration for critical URLs at the site
    site_setting_juniper_srx2:
      title: site_setting_juniper_srx2
      type: object
      properties:
        auto_upgrade:
          allOf:
          - $ref: '#/components/schemas/juniper_srx_auto_upgrade2'
          - description: SRX auto-upgrade settings applied when SRX devices are onboarded
        gateways:
          type: array
          items:
            $ref: '#/components/schemas/site_setting_juniper_srx_gateway'
          description: SRX gateways integrated with this site
        send_mist_nac_user_info:
          type: boolean
          description: Whether Mist NAC user information is sent to Juniper SRX gateways
      description: SRX integration settings for the site
    site_setting_mxedge2:
      title: site_setting_mxedge2
      type: object
      properties:
        mist_das:
          allOf:
          - $ref: '#/components/schemas/mxedge_das2'
          - description: DAS service settings for the site Mist Edge cluster
        mist_nac:
          allOf:
          - $ref: '#/components/schemas/mxcluster_nac2'
          - description: RADIUS settings for Mist NAC on the site Mist Edge cluster
        mist_nacedge:
          allOf:
          - $ref: '#/components/schemas/mist_nacedge1'
          - description: NAC Edge service settings for the site Mist Edge cluster
        radsec:
          allOf:
          - $ref: '#/components/schemas/mxcluster_radsec2'
          - description: TLS-secured RADIUS proxy settings for the site Mist Edge cluster
      description: Site Mist Edge service settings
    site_setting_paloalto_networks2:
      title: site_setting_paloalto_networks2
      type: object
      properties:
        gateways:
          type: array
          items:
            $ref: '#/components/schemas/site_setting_paloalto_network_gateway'
          description: Palo Alto Networks gateways integrated with this site
        send_mist_nac_user_info:
          type: boolean
          description: Whether Mist NAC user information is sent to Palo Alto Networks gateways
          default: false
      description: Firewall integration settings for Palo Alto Networks at the site
    site_setting_rtsa2:
      title: site_setting_rtsa2
      type: object
      properties:
        app_waking:
          type: boolean
          description: Whether app wake-up support is enabled for managed mobility
          default: false
        disable_dead_reckoning:
          type: boolean
          description: Whether dead reckoning is disabled for managed mobility
        disable_pressure_sensor:
          type: boolean
          description: Whether pressure sensor use is disabled for managed mobility
          default: false
        enabled:
          type: boolean
          description: Whether managed mobility features are enabled
        track_asset:
          type: boolean
          description: Whether BLE asset tracking is enabled for managed mobility
          default: false
      description: Managed mobility and asset tracking settings for the site
    site_setting_skyatp2:
      title: site_setting_skyatp2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether Sky ATP is enabled for the site
        send_ip_mac_mapping:
          type: boolean
          description: Whether IP-to-MAC mappings are sent to Sky ATP
          default: false
      description: Threat intelligence settings from Sky ATP for the site
    site_setting_switch2:
      title: site_setting_switch2
      type: object
      properties:
        acl_policies:
          type: array
          items:
            $ref: '#/components/schemas/acl_policy'
          description: ACL policy defaults provided by this network template
        acl_tags:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/acl_tag'
          description: ACL tags available to access policies in this network template
        additional_config_cmds:
          type: array
          items:
            type: string
          description: Additional CLI configuration commands provided by this network template
        bgp_config:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_bgp_config'
          description: BGP routing defaults for this network template. Property key is the BGP session name
        created_time:
          type: number
          description: Timestamp when the network template was created
          readOnly: true
        dhcp_snooping:
          allOf:
          - $ref: '#/components/schemas/dhcp_snooping3'
          - description: DHCP snooping defaults provided by this network template
        dns_servers:
          type: array
          items:
            type: string
          description: DNS servers provided by this network template
        dns_suffix:
          type: array
          items:
            type: string
          description: DNS search suffixes provided by this network template
        extra_routes:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/extra_route'
          description: Additional IPv4 route defaults in this network template
          examples:
          - 0.0.0.0/0:
              via: 192.168.1.10
        extra_routes6:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/extra_route6'
          description: Additional IPv6 route defaults in this network template
          examples:
          - 2a02:1234:420a:10c9::/64:
              via: 2a02:1234:200a::100
        id:
          type: string
          description: Unique identifier of the network template
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        import_org_networks:
          type: array
          items:
            type: string
          description: Organization network names imported into this network template
        mist_nac:
          allOf:
          - $ref: '#/components/schemas/switch_mist_nac2'
          - description: Mist NAC defaults applied by this network template
        modified_time:
          type: number
          description: Timestamp when the network template was last modified
          readOnly: true
        multicast_config:
          allOf:
          - $ref: '#/components/schemas/switch_multicast_config1'
          - description: Multicast settings for networks in the master VRF (not assigned to any vrf_instances); PIM is automatically enabled when any master-VRF network has `multicast.enabled`==`true`
        name:
          type: string
          description: Display name of the network template
        networks:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_network'
          description: Layer 3 networks configured by this network template
        ntp_servers:
          type: array
          items:
            type: string
          description: NTP servers provided by this network template
        org_id:
          type: string
          description: Organization that owns this network template
          contentEncoding: uuid
          readOnly: true
          examples:
          - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
        ospf_areas:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ospf_area'
          description: OSPF area defaults provided by this network template
        port_mirroring:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_port_mirroring_property'
          description: Port mirroring defaults provided by this network template
        port_usages:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_port_usage'
          description: Reusable switch port usage profiles provided by this network template
        radius_config:
          allOf:
          - $ref: '#/components/schemas/switch_radius_config3'
          - description: RADIUS authentication and accounting defaults in this network template
        remote_syslog:
          allOf:
          - $ref: '#/components/schemas/remote_syslog2'
          - description: Remote syslog defaults provided by this network template
        remove_existing_configs:
          type: boolean
          description: By default, only the configuration generated by Mist is cleaned up during the configuration process. If `true`, all the existing configuration will be removed.
          default: false
        routing_policies:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/sw_routing_policy'
          description: Routing policy defaults applied by this network template
        snmp_config:
          allOf:
          - $ref: '#/components/schemas/snmp_config2'
          - description: SNMP defaults provided by this network template
        switch_matching:
          allOf:
          - $ref: '#/components/schemas/switch_matching3'
          - description: Matching rules that select switches for this network template
        switch_mgmt:
          allOf:
          - $ref: '#/components/schemas/switch_mgmt3'
          - description: Management-plane defaults provided by this network template
        vrf_config:
          allOf:
          - $ref: '#/components/schemas/vrf_config5'
          - description: VRF defaults applied by this network template
        vrf_instances:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_vrf_instance'
          description: VRF instances configured by this network template
          examples:
          - guest:
              extra_routes:
                0.0.0.0/0:
                  via: 192.168.31.1
              networks:
              - guest
        auto_upgrade:
          allOf:
          - $ref: '#/components/schemas/switch_auto_upgrade1'
          - description: Switch firmware auto-upgrade configuration
      description: Site-level switch feature configuration
    site_setting_tunterm_multicast_config_mdns2:
      title: site_setting_tunterm_multicast_config_mdns2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether mDNS multicast forwarding is enabled
          default: false
        vlan_ids:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: VLAN IDs where mDNS multicast forwarding is enabled
          examples:
          - - 2
            - 3
            - 5
      description: Multicast DNS forwarding settings for tunneled VLANs
    site_setting_tunterm_multicast_config_ssdp2:
      title: site_setting_tunterm_multicast_config_ssdp2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether SSDP multicast forwarding is enabled
          default: false
        vlan_ids:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: VLAN IDs where SSDP multicast forwarding is enabled
          examples:
          - - 2
            - 3
            - 5
      description: Simple Service Discovery Protocol forwarding settings for tunneled VLANs
    site_setting_tunterm_multicast_config2:
      title: site_setting_tunterm_multicast_config2
      type: object
      properties:
        mdns:
          allOf:
          - $ref: '#/components/schemas/site_setting_tunterm_multicast_config_mdns2'
          - description: Multicast DNS forwarding settings for tunneled VLANs
        multicast_all:
          type: boolean
          description: Whether all multicast traffic is forwarded through tunnel termination
          default: false
        ssdp:
          allOf:
          - $ref: '#/components/schemas/site_setting_tunterm_multicast_config_ssdp2'
          - description: Simple Service Discovery Protocol forwarding settings for tunneled VLANs
      description: Multicast settings for tunnel termination at the site
    site_setting_vna2:
      title: site_setting_vna2
      type: object
      properties:
        enabled:
          type: boolean
          description: Enable Virtual Network Assistant (using SUB-VNA license). This applied to AP / Switch / Gateway
          default: false
      description: Virtual Network Assistant settings for the site
    site_setting_wan_vna2:
      title: site_setting_wan_vna2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether WAN VNA is enabled for the site
          default: false
      description: Virtual Network Assistant settings for WAN experiences at the site
    site_setting_wired_vna2:
      title: site_setting_wired_vna2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether Wired VNA is enabled for the site
          default: false
      description: Virtual Network Assistant settings for wired experiences at the site
    site_template_auto_upgrade2:
      title: site_template_auto_upgrade2
      type: object
      properties:
        day_of_week:
          allOf:
          - $ref: '#/components/schemas/day_of_week6'
          - description: 'Day of week when the automatic upgrade window runs. enum: `any`, `fri`, `mon`, `sat`, `sun`, `thu`, `tue`, `wed`.'
        enabled:
          type: boolean
          description: Whether automatic upgrades are enabled for sites using this site template
        time_of_day:
          type: string
          description: Local time of day when the automatic upgrade window starts
        version:
          type: string
          description: Target firmware version installed during automatic upgrades
      description: Automatic upgrade settings applied by this site template
    site_wids2:
      title: site_wids2
      type: object
      properties:
        repeated_auth_failures:
          allOf:
          - $ref: '#/components/schemas/site_wids_repeated_auth_failures'
          - description: Detection settings for repeated authentication failures
      description: Wireless intrusion detection settings for the site
    site_wifi_proxy_arp2:
      title: site_wifi_proxy_arp2
      enum:
      - default
      - disabled
      - enabled
      type: string
      description: 'ARP proxy mode for site Wi-Fi. enum: `default`, `disabled`, `enabled`.'
    site_wifi2:
      title: site_wifi2
      type: object
      properties:
        cisco_enabled:
          type: boolean
          description: Whether Cisco compatibility features are enabled for site Wi-Fi
          default: true
        disable_11k:
          type: boolean
          description: Whether to disable 11k
          default: false
        disable_radios_when_power_constrained:
          type: boolean
          description: Whether AP radios are disabled when AP power is constrained
          default: false
        enable_arp_spoof_check:
          type: boolean
          description: When proxy_arp is enabled, check for arp spoofing.
          default: false
        enable_shared_radio_scanning:
          type: boolean
          description: Whether shared radio scanning is enabled for site Wi-Fi
          default: true
        enabled:
          type: boolean
          description: Enable Wi-Fi feature (using SUB-MAN license)
          default: true
        locate_connected:
          type: boolean
          description: Whether to locate connected clients
          default: true
        locate_unconnected:
          type: boolean
          description: Whether to locate unconnected clients
          default: false
        mesh_allow_dfs:
          type: boolean
          description: Whether to allow Mesh to use DFS channels. For DFS channels, Remote Mesh AP would have to do CAC when scanning for new Base AP, which is slow and will disrupt the connection. If roaming is desired, keep it disabled.
          default: false
        mesh_enable_crm:
          type: boolean
          description: Used to enable/disable CRM
          default: false
        mesh_enabled:
          type: boolean
          description: Whether to enable Mesh feature for the site
          default: false
        mesh_psk:
          type:
          - string
          - 'null'
          description: Optional passphrase of mesh networking, default is generated randomly
        mesh_ssid:
          type:
          - string
          - 'null'
          description: Optional ssid of mesh networking, default is based on site_id
        proxy_arp:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/site_wifi_proxy_arp2'
          - description: 'ARP proxy mode for site Wi-Fi. enum: `default`, `disabled`, `enabled`.'
      description: Wireless LAN configuration settings for the site
    site_zone_occupancy_alert2:
      title: site_zone_occupancy_alert2
      type: object
      properties:
        email_notifiers:
          type: array
          items:
            type: string
          description: Notification email recipients for zone occupancy alerts
          examples:
          - - foo@juniper.net
            - bar@juniper.net
        enabled:
          type: boolean
          description: Indicate whether zone occupancy alert is enabled for the site
          default: false
        threshold:
          maximum: 30
          minimum: 0
          type: integer
          description: Sending zone-occupancy-alert webhook message only if a zone stays non-compliant (i.e. actual occupancy > occupancy_limit) for a minimum duration specified in the threshold, in minutes
          contentEncoding: int32
          default: 5
          examples:
          - 5
      description: Occupancy alert settings for site zones
    sle_classifier_impact2:
      title: sle_classifier_impact2
      required:
      - num_aps
      - num_users
      - total_aps
      - total_users
      type: object
      properties:
        num_aps:
          type: number
          description: Number of APs affected by degraded SLE experience
        num_users:
          type: number
          description: Number of users affected by degraded SLE experience
        total_aps:
          type: number
          description: Total number of APs considered for the classifier
        total_users:
          type: number
          description: Total number of users considered for the classifier
      description: Counts of affected APs and users for this classifier
    sle_classifier_samples2:
      title: sle_classifier_samples2
      required:
      - degraded
      - duration
      - total
      type: object
      properties:
        degraded:
          type: array
          items:
            $ref: '#/components/schemas/number_or_null'
          description: Per-interval degraded SLE values for the classifier
        duration:
          type: array
          items:
            type: number
          description: Per-interval observation durations for the classifier
        total:
          type: array
          items:
            $ref: '#/components/schemas/number_or_null'
          description: Per-interval total SLE values for the classifier
      description: Time-series sample arrays for the classifier trend
    sle_classifier_samples3:
      title: sle_classifier_samples3
      required:
      - degraded
      - duration
      - total
      type: object
      properties:
        degraded:
          type: array
          items:
            $ref: '#/components/schemas/number_or_null'
          description: Per-interval degraded SLE values for the classifier
        duration:
          type: array
          items:
            type: number
          description: Per-interval observation durations for the classifier
        total:
          type: array
          items:
            $ref: '#/components/schemas/number_or_null'
          description: Per-interval total SLE values for the classifier
      description: Time-series sample arrays for the classifier
    sle_classifier_summary_impact2:
      title: sle_classifier_summary_impact2
      required:
      - num_aps
      - num_users
      - total_aps
      - total_users
      type: object
      properties:
        num_aps:
          type: number
          description: Number of APs affected by degraded SLE experience
        num_users:
          type: number
          description: Number of users affected by degraded SLE experience
        total_aps:
          type: number
          description: Total number of APs considered in the summary window
        total_users:
          type: number
          description: Total number of users considered in the summary window
      description: AP and user impact counts for the classifier summary window
    sle_classifier1:
      title: sle_classifier1
      required:
      - impact
      - interval
      - name
      - x_label
      - y_label
      type: object
      properties:
        impact:
          allOf:
          - $ref: '#/components/schemas/sle_classifier_impact2'
          - description: Counts of affected APs and users for this classifier
        interval:
          type: number
          description: Sample interval in seconds for classifier time-series data
        name:
          minLength: 1
          type: string
          description: Classifier name for the SLE metric
        samples:
          allOf:
          - $ref: '#/components/schemas/sle_classifier_samples3'
          - description: Time-series sample arrays for the classifier
        x_label:
          minLength: 1
          type: string
          description: Label for the classifier sample x-axis
        y_label:
          minLength: 1
          type: string
          description: Label for the classifier sample y-axis
      description: Requested SLE classifier detail for the metric
    sle_summary_impact2:
      title: sle_summary_impact2
      required:
      - num_aps
      - num_users
      - total_aps
      - total_users
      type: object
      properties:
        num_aps:
          type: number
          description: Number of APs affected by degraded SLE experience
        num_users:
          type: number
          description: Number of users affected by degraded SLE experience
        total_aps:
          type: number
          description: Total number of APs considered in the summary window
        total_users:
          type: number
          description: Total number of users considered in the summary window
      description: AP and user impact counts for the summary window
    sle_summary_sle_samples2:
      title: sle_summary_sle_samples2
      required:
      - degraded
      - total
      - value
      type: object
      properties:
        degraded:
          type: array
          items:
            $ref: '#/components/schemas/number_or_null'
          description: Per-interval degraded SLE values for the summary
        total:
          type: array
          items:
            $ref: '#/components/schemas/number_or_null'
          description: Per-interval total SLE values for the summary
        value:
          type: array
          items:
            $ref: '#/components/schemas/number_or_null'
          description: Per-interval SLE score values for the summary
      description: Per-interval sample arrays for the SLE metric
    sle_summary_sle2:
      title: sle_summary_sle2
      required:
      - interval
      - name
      - samples
      - x_label
      - y_label
      type: object
      properties:
        interval:
          type: number
          description: Sample interval in seconds for SLE summary data
        name:
          minLength: 1
          type: string
          description: SLE metric name represented by the summary samples
        samples:
          allOf:
          - $ref: '#/components/schemas/sle_summary_sle_samples2'
          - description: Per-interval sample arrays for the SLE metric
        x_label:
          minLength: 1
          type: string
          description: Label for the SLE summary x-axis
        y_label:
          minLength: 1
          type: string
          description: Label for the SLE summary y-axis
      description: Time-series SLE samples for the trend window
    sle_summary_sle3:
      title: sle_summary_sle3
      required:
      - interval
      - name
      - samples
      - x_label
      - y_label
      type: object
      properties:
        interval:
          type: number
          description: Sample interval in seconds for SLE summary data
        name:
          minLength: 1
          type: string
          description: SLE metric name represented by the summary samples
        samples:
          allOf:
          - $ref: '#/components/schemas/sle_summary_sle_samples2'
          - description: Per-interval sample arrays for the SLE metric
        x_label:
          minLength: 1
          type: string
          description: Label for the SLE summary x-axis
        y_label:
          minLength: 1
          type: string
          description: Label for the SLE summary y-axis
      description: Time-series SLE samples for the summary window
    sle_thresholds2:
      title: sle_thresholds2
      type: object
      properties:
        capacity:
          maximum: 50
          minimum: 5
          type: integer
          description: Threshold percentage for capacity SLE scoring
          contentEncoding: int32
          default: 20
        coverage:
          maximum: -60
          minimum: -90
          type: integer
          description: RSSI threshold for coverage SLE scoring, in dBm
          contentEncoding: int32
          default: -72
        throughput:
          maximum: 100
          minimum: 1
          type: integer
          description: Minimum throughput threshold for SLE scoring, in Mbps
          contentEncoding: int32
          default: 10
        time-to-connect:
          maximum: 10
          minimum: 2
          type: integer
          description: Time to connect, in seconds
          contentEncoding: int32
          default: 4
      description: Service level expectation threshold settings for the site
    sle_trend_classifier2:
      title: sle_trend_classifier2
      required:
      - interval
      - name
      - x_label
      - y_label
      type: object
      properties:
        interval:
          type: number
          description: Sample interval in seconds for classifier trend data
        name:
          minLength: 1
          type: string
          description: Classifier name for the SLE metric trend
        samples:
          allOf:
          - $ref: '#/components/schemas/sle_classifier_samples2'
          - description: Time-series sample arrays for the classifier trend
        x_label:
          minLength: 1
          type: string
          description: Label for the classifier trend x-axis
        y_label:
          minLength: 1
          type: string
          description: Label for the classifier trend y-axis
      description: Requested SLE classifier trend detail for the metric
    snmp_config_engine_id_type2:
      title: snmp_config_engine_id_type2
      enum:
      - local
      - use_mac_address
      type: string
      description: 'Method used to derive the SNMP engine ID. enum: `local`, `use_mac_address`.'
    snmp_config_trap_version2:
      title: snmp_config_trap_version2
      enum:
      - all
      - v1
      - v2
      type: string
      description: 'SNMP trap protocol version used by this group. enum: `all`, `v1`, `v2`.'
    snmp_config1:
      title: snmp_config1
      type: object
      properties:
        client_list:
          type: array
          items:
            $ref: '#/components/schemas/snmp_config_client_list'
          description: SNMP client allowlists that can be referenced by communities
        contact:
          type: string
          description: Administrative contact string advertised through SNMP
          examples:
          - cns@juniper.net
        description:
          type: string
          description: Device description string advertised through SNMP
          examples:
          - Juniper QFX Series Switch - 1K_5LA
        enabled:
          type: boolean
          description: Whether SNMP is enabled
          default: true
        engine_id:
          maxLength: 27
          type: string
          description: SNMP engine ID used for SNMPv3
        engine_id_type:
          allOf:
          - $ref: '#/components/schemas/snmp_config_engine_id_type2'
          - description: 'Method used to derive the SNMP engine ID. enum: `local`, `use_mac_address`.'
        location:
          type: string
          description: Physical location string advertised through SNMP
          examples:
          - Las Vegas, NV
        name:
          type: string
          description: System name advertised through SNMP
          examples:
          - TGH-1K-QFX10K
        network:
          type: string
          description: Management network used for SNMP traffic
          default: default
        trap_groups:
          type: array
          items:
            $ref: '#/components/schemas/snmp_config_trap_group'
          description: SNMP trap group definitions
        v2c_config:
          type: array
          items:
            $ref: '#/components/schemas/snmp_config_v2c_config'
          description: SNMPv2c community configuration entries for this SNMP profile
        v3_config:
          allOf:
          - $ref: '#/components/schemas/snmpv3_config2'
          - description: SNMPv3 user, VACM, notify, and target configuration
        views:
          type: array
          items:
            $ref: '#/components/schemas/snmp_config_view'
          description: SNMP MIB view definitions
      description: SNMP defaults provided by this switch profile
    snmp_config2:
      title: snmp_config2
      type: object
      properties:
        client_list:
          type: array
          items:
            $ref: '#/components/schemas/snmp_config_client_list'
          description: SNMP client allowlists that can be referenced by communities
        contact:
          type: string
          description: Administrative contact string advertised through SNMP
          examples:
          - cns@juniper.net
        description:
          type: string
          description: Device description string advertised through SNMP
          examples:
          - Juniper QFX Series Switch - 1K_5LA
        enabled:
          type: boolean
          description: Whether SNMP is enabled
          default: true
        engine_id:
          maxLength: 27
          type: string
          description: SNMP engine ID used for SNMPv3
        engine_id_type:
          allOf:
          - $ref: '#/components/schemas/snmp_config_engine_id_type2'
          - description: 'Method used to derive the SNMP engine ID. enum: `local`, `use_mac_address`.'
        location:
          type: string
          description: Physical location string advertised through SNMP
          examples:
          - Las Vegas, NV
        name:
          type: string
          description: System name advertised through SNMP
          examples:
          - TGH-1K-QFX10K
        network:
          type: string
          description: Management network used for SNMP traffic
          default: default
        trap_groups:
          type: array
          items:
            $ref: '#/components/schemas/snmp_config_trap_group'
          description: SNMP trap group definitions
        v2c_config:
          type: array
          items:
            $ref: '#/components/schemas/snmp_config_v2c_config'
          description: SNMPv2c community configuration entries for this SNMP profile
        v3_config:
          allOf:
          - $ref: '#/components/schemas/snmpv3_config2'
          - description: SNMPv3 user, VACM, notify, and target configuration
        views:
          type: array
          items:
            $ref: '#/components/schemas/snmp_config_view'
          description: SNMP MIB view definitions
      description: SNMP defaults provided by this network template
    snmp_config3:
      title: snmp_config3
      type: object
      properties:
        client_list:
          type: array
          items:
            $ref: '#/components/schemas/snmp_config_client_list'
          description: SNMP client allowlists that can be referenced by communities
        contact:
          type: string
          description: Administrative contact string advertised through SNMP
          examples:
          - cns@juniper.net
        description:
          type: string
          description: Device description string advertised through SNMP
          examples:
          - Juniper QFX Series Switch - 1K_5LA
        enabled:
          type: boolean
          description: Whether SNMP is enabled
          default: true
        engine_id:
          maxLength: 27
          type: string
          description: SNMP engine ID used for SNMPv3
        engine_id_type:
          allOf:
          - $ref: '#/components/schemas/snmp_config_engine_id_type2'
          - description: 'Method used to derive the SNMP engine ID. enum: `local`, `use_mac_address`.'
        location:
          type: string
          description: Physical location string advertised through SNMP
          examples:
          - Las Vegas, NV
        name:
          type: string
          description: System name advertised through SNMP
          examples:
          - TGH-1K-QFX10K
        network:
          type: string
          description: Management network used for SNMP traffic
          default: default
        trap_groups:
          type: array
          items:
            $ref: '#/components/schemas/snmp_config_trap_group'
          description: SNMP trap group definitions
        v2c_config:
          type: array
          items:
            $ref: '#/components/schemas/snmp_config_v2c_config'
          description: SNMPv2c community configuration entries for this SNMP profile
        v3_config:
          allOf:
          - $ref: '#/components/schemas/snmpv3_config2'
          - description: SNMPv3 user, VACM, notify, and target configuration
        views:
          type: array
          items:
            $ref: '#/components/schemas/snmp_config_view'
          description: SNMP MIB view definitions
      description: Management polling settings for SNMP on site devices
    snmp_config5:
      title: snmp_config5
      type: object
      properties:
        client_list:
          type: array
          items:
            $ref: '#/components/schemas/snmp_config_client_list'
          description: SNMP client allowlists that can be referenced by communities
        contact:
          type: string
          description: Administrative contact string advertised through SNMP
          examples:
          - cns@juniper.net
        description:
          type: string
          description: Device description string advertised through SNMP
          examples:
          - Juniper QFX Series Switch - 1K_5LA
        enabled:
          type: boolean
          description: Whether SNMP is enabled
          default: true
        engine_id:
          maxLength: 27
          type: string
          description: SNMP engine ID used for SNMPv3
        engine_id_type:
          allOf:
          - $ref: '#/components/schemas/snmp_config_engine_id_type2'
          - description: 'Method used to derive the SNMP engine ID. enum: `local`, `use_mac_address`.'
        location:
          type: string
          description: Physical location string advertised through SNMP
          examples:
          - Las Vegas, NV
        name:
          type: string
          description: System name advertised through SNMP
          examples:
          - TGH-1K-QFX10K
        network:
          type: string
          description: Management network used for SNMP traffic
          default: default
        trap_groups:
          type: array
          items:
            $ref: '#/components/schemas/snmp_config_trap_group'
          description: SNMP trap group definitions
        v2c_config:
          type: array
          items:
            $ref: '#/components/schemas/snmp_config_v2c_config'
          description: SNMPv2c community configuration entries for this SNMP profile
        v3_config:
          allOf:
          - $ref: '#/components/schemas/snmpv3_config2'
          - description: SNMPv3 user, VACM, notify, and target configuration
        views:
          type: array
          items:
            $ref: '#/components/schemas/snmp_config_view'
          description: SNMP MIB view definitions
      description: SNMP configuration for this switch
    snmp_usm_engine_type2:
      title: snmp_usm_engine_type2
      enum:
      - local_engine
      - remote_engine
      type: string
      description: 'SNMP engine type used for this USM configuration. enum: `local_engine`, `remote_engine`.'
    snmp_usm_user_authentication_type2:
      title: snmp_usm_user_authentication_type2
      enum:
      - authentication-md5
      - authentication-none
      - authentication-sha
      - authentication-sha224
      - authentication-sha256
      - authentication-sha384
      - authentication-sha512
      type: string
      description: 'Authentication protocol used by this SNMPv3 USM user. enum: `authentication-md5`, `authentication-none`, `authentication-sha`, `authentication-sha224`, `authentication-sha256`, `authentication-sha384`, `authentication-sha512`.'
    snmp_usm_user_encryption_type2:
      title: snmp_usm_user_encryption_type2
      enum:
      - privacy-3des
      - privacy-aes128
      - privacy-des
      - privacy-none
      type: string
      description: 'Privacy protocol used by this SNMPv3 USM user. enum: `privacy-3des`, `privacy-aes128`, `privacy-des`, `privacy-none`.'
    snmp_vacm_access_item_prefix_list_item_level2:
      title: snmp_vacm_access_item_prefix_list_item_level2
      enum:
      - authentication
      - none
      - privacy
      type: string
      description: 'Required security level for this VACM access rule. enum: `authentication`, `none`, `privacy`.'
    snmp_vacm_access_item_prefix_list_item_model2:
      title: snmp_vacm_access_item_prefix_list_item_model2
      enum:
      - any
      - usm
      - v1
      - v2c
      type: string
      description: 'Required security model for this VACM access rule. enum: `any`, `usm`, `v1`, `v2c`.'
    snmp_vacm_access_item_type2:
      title: snmp_vacm_access_item_type2
      enum:
      - context_prefix
      - default_context_prefix
      type: string
      description: 'VACM context matching type for this access rule. enum: `context_prefix`, `default_context_prefix`.'
    snmp_vacm_security_model2:
      title: snmp_vacm_security_model2
      enum:
      - usm
      - v1
      - v2c
      type: string
      description: 'Required security model for these VACM group mappings. enum: `usm`, `v1`, `v2c`.'
    snmp_vacm_security_to_group2:
      title: snmp_vacm_security_to_group2
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/snmp_vacm_security_to_group_content_item'
          description: VACM security-name to group mapping entries
        security_model:
          allOf:
          - $ref: '#/components/schemas/snmp_vacm_security_model2'
          - description: 'Required security model for these VACM group mappings. enum: `usm`, `v1`, `v2c`.'
      description: VACM security-name to group mappings
    snmp_vacm2:
      title: snmp_vacm2
      type: object
      properties:
        access:
          type: array
          items:
            $ref: '#/components/schemas/snmp_vacm_access_item'
          description: VACM access rules for SNMPv3
        security_to_group:
          allOf:
          - $ref: '#/components/schemas/snmp_vacm_security_to_group2'
          - description: VACM security-name to group mappings
      description: SNMPv3 VACM access control configuration
    snmpv3_config2:
      title: snmpv3_config2
      type: object
      properties:
        notify:
          type: array
          items:
            $ref: '#/components/schemas/snmpv3_config_notify_items'
          description: SNMPv3 notification definitions used for traps and informs
        notify_filter:
          type: array
          items:
            $ref: '#/components/schemas/snmpv3_config_notify_filter_item'
          description: SNMPv3 notification filter profiles
        target_address:
          type: array
          items:
            $ref: '#/components/schemas/snmpv3_config_target_address_item'
          description: SNMPv3 notification target addresses
        target_parameters:
          type: array
          items:
            $ref: '#/components/schemas/snmpv3_config_target_param'
          description: SNMPv3 target parameter profiles
        usm:
          type: array
          items:
            $ref: '#/components/schemas/snmp_usm'
          description: SNMPv3 USM engine configurations
        vacm:
          allOf:
          - $ref: '#/components/schemas/snmp_vacm2'
          - description: SNMPv3 VACM access control configuration
      description: SNMPv3 user, VACM, notify, and target configuration
    snmpv3_config_notify_type2:
      title: snmpv3_config_notify_type2
      enum:
      - inform
      - trap
      type: string
      description: Delivery mode for this SNMPv3 notification, such as trap or inform
    snmpv3_config_target_param_mess_process_model2:
      title: snmpv3_config_target_param_mess_process_model2
      enum:
      - v1
      - v2c
      - v3
      type: string
      description: 'SNMP message processing model used by this target parameter profile. enum: `v1`, `v2c`, `v3`.'
    snmpv3_config_target_param_security_level2:
      title: snmpv3_config_target_param_security_level2
      enum:
      - authentication
      - none
      - privacy
      type: string
      description: 'Required security level for this target parameter profile. enum: `authentication`, `none`, `privacy`.'
    snmpv3_config_target_param_security_model2:
      title: snmpv3_config_target_param_security_model2
      enum:
      - usm
      - v1
      - v2c
      type: string
      description: 'Required security model for this target parameter profile. enum: `usm`, `v1`, `v2c`.'
    spectrum_analysis_band2:
      title: spectrum_analysis_band2
      enum:
      - '24'
      - '5'
      - '6'
      type: string
      description: 'Radio band to scan during spectrum analysis. enum: `24`, `5`, `6`.'
    spectrum_analysis_format2:
      title: spectrum_analysis_format2
      enum:
      - json
      - stream
      type: string
      description: 'Output format for the spectrum analysis results. enum: `json`, `stream`.'
    ssl_proxy_ciphers_category2:
      title: ssl_proxy_ciphers_category2
      enum:
      - medium
      - strong
      - weak
      type: string
      description: 'Allowed cipher strength category for SSL proxy inspection. enum: `medium`, `strong`, `weak`.'
    sso_idp_sign_algo2:
      title: sso_idp_sign_algo2
      enum:
      - sha1
      - sha256
      - sha384
      - sha512
      type: string
      description: 'SAML assertion signing algorithm. Required if `idp_type`==`saml`. enum: `sha1`, `sha256`, `sha384`, `sha512`.'
    sso_idp_type2:
      title: sso_idp_type2
      enum:
      - ldap
      - mxedge_proxy
      - oauth
      - saml
      - openroaming
      type: string
      description: 'Identity provider type for this SSO configuration. enum: `ldap`, `mxedge_proxy`, `oauth`, `saml`, `openroaming`.'
    sso_ldap_type2:
      title: sso_ldap_type2
      enum:
      - azure
      - custom
      - google
      - okta
      type: string
      description: 'Provider template for LDAP SSO when `idp_type`==`ldap`. enum: `azure`, `custom`, `google`, `okta`.'
    sso_mxedge_proxy2:
      title: sso_mxedge_proxy2
      type: object
      properties:
        acct_servers:
          type: array
          items:
            $ref: '#/components/schemas/sso_mxedge_proxy_acct_server'
          description: RADIUS accounting servers used by the Mist Edge SSO proxy
        auth_servers:
          type: array
          items:
            $ref: '#/components/schemas/sso_mxedge_proxy_auth_server'
          description: RADIUS authentication servers used by the Mist Edge SSO proxy
        mxcluster_id:
          type: string
          description: Mist Edge cluster identifier that provides the SSO proxy
          contentEncoding: uuid
          examples:
          - 572586b7-f97b-a22b-526c-8b97a3f609c4
        operator_name:
          type: string
          description: Operator name as RADIUS attribute while proxying
        proxy_hosts:
          type: array
          items:
            type: string
          description: Public hostnames or IP addresses that clients use to reach the Mist Edge SSO proxy
          examples:
          - - mxedge1.corp.com
            - 63.1.3.5
        ssids:
          type: array
          items:
            type: string
          description: Eduroam SSIDs handled by the Mist Edge SSO proxy
          examples:
          - - eduroam_test, eduroam_main
      description: Mist Edge proxy settings used when `idp_type`==`mxedge_proxy`
    sso_nameid_format2:
      title: sso_nameid_format2
      enum:
      - email
      - unspecified
      type: string
      description: 'SAML NameID format used when `idp_type`==`saml`. enum: `email`, `unspecified`.'
    sso_oauth_type2:
      title: sso_oauth_type2
      enum:
      - azure
      - azure-gov
      - okta
      - ping_identity
      type: string
      description: 'Provider type for OAuth SSO when `idp_type`==`oauth`. enum: `azure`, `azure-gov`, `okta`, `ping_identity`.'
    ssr_proxy2:
      title: ssr_proxy2
      type: object
      properties:
        disabled:
          type: boolean
          description: Whether the SSR proxy configuration is disabled
          default: false
          examples:
          - true
        url:
          type: string
          description: Proxy URL that SSR devices use to reach Mist
          examples:
          - https://proxy.corp.com:8080/
      description: Network proxy settings used by SSR devices to reach Mist
    ssr_upgrade_channel1:
      title: ssr_upgrade_channel1
      enum:
      - alpha
      - beta
      - stable
      type: string
      description: 'Firmware release channel to use for the SSR upgrade. enum: `alpha`, `beta`, `stable`.'
    ssr_upgrade_channel4:
      title: ssr_upgrade_channel4
      enum:
      - alpha
      - beta
      - stable
      type: string
      description: 'Firmware release channel used for SSR auto-upgrade. enum: `alpha`, `beta`, `stable`.'
    ssr_upgrade_strategy2:
      title: ssr_upgrade_strategy2
      enum:
      - big_bang
      - serial
      type: string
      description: 'Upgrade rollout strategy for the targeted SSR devices. enum: `big_bang`, `serial`.'
    stats_ap_auto_placement_info_probability_surface2:
      title: stats_ap_auto_placement_info_probability_surface2
      type: object
      properties:
        radius:
          type: number
          description: The RADIUS representing placement uncertainty, measured in pixels
          examples:
          - 2.1
        radius_m:
          type: number
          description: The RADIUS representing placement uncertainty, measured in meters
        x:
          type: number
          description: Potential placement center X coordinate, in pixels
          examples:
          - 17
      description: Uncertainty area for the AP auto placement result
    stats_ap_auto_placement_info2:
      title: stats_ap_auto_placement_info2
      type: object
      properties:
        cluster_number:
          type: integer
          description: All APs sharing a given cluster number can be placed relative to each other
          contentEncoding: int32
          examples:
          - 0
        orientation_stats:
          type: integer
          description: The orientation of an AP
          contentEncoding: int32
          examples:
          - 0
        probability_surface:
          allOf:
          - $ref: '#/components/schemas/stats_ap_auto_placement_info_probability_surface2'
          - description: Uncertainty area for the AP auto placement result
      description: Additional diagnostics for the AP auto placement result
    stats_ap_auto_placement2:
      title: stats_ap_auto_placement2
      type: object
      properties:
        info:
          allOf:
          - $ref: '#/components/schemas/stats_ap_auto_placement_info2'
          - description: Additional diagnostics for the AP auto placement result
        recommended_anchor:
          type: boolean
          description: Flag to represent if AP is recommended as an anchor by auto placement service
        status:
          type: string
          description: Current auto placement status for the AP
          examples:
          - localized
        status_detail:
          type: string
          description: Additional info about placement status
          examples:
          - localized
        x:
          type: number
          description: Auto-placed X coordinate, in pixels
          examples:
          - 53.5
        x_m:
          type: number
          description: Auto-placed X coordinate, in meters
          examples:
          - 5.35
        y:
          type: number
          description: Auto-placed Y coordinate, in pixels
          examples:
          - 173.1
        y_m:
          type: number
          description: Auto-placed Y coordinate, in meters
          examples:
          - 17.31
      description: Auto placement result and status for the AP
    stats_ap_auto_upgrade2:
      title: stats_ap_auto_upgrade2
      type: object
      properties:
        lastcheck:
          type:
          - integer
          - 'null'
          description: Time when the AP last checked for auto-upgrade, in epoch seconds
          contentEncoding: int64
          readOnly: true
          examples:
          - 1720594762
      description: Automatic firmware upgrade status for the switch
    stats_ap_auto_upgrade3:
      title: stats_ap_auto_upgrade3
      type: object
      properties:
        lastcheck:
          type:
          - integer
          - 'null'
          description: Time when the AP last checked for auto-upgrade, in epoch seconds
          contentEncoding: int64
          readOnly: true
          examples:
          - 1720594762
      description: Automatic firmware upgrade status for the gateway
    stats_ap_auto_upgrade4:
      title: stats_ap_auto_upgrade4
      type: object
      properties:
        lastcheck:
          type:
          - integer
          - 'null'
          description: Time when the AP last checked for auto-upgrade, in epoch seconds
          contentEncoding: int64
          readOnly: true
          examples:
          - 1720594762
      description: Automatic firmware upgrade status for the AP
    stats_ap_ble2:
      title: stats_ap_ble2
      type: object
      properties:
        beacon_enabled:
          type:
          - boolean
          - 'null'
          description: Whether Mist BLE beacon transmission is enabled
          readOnly: true
        beacon_rate:
          type:
          - integer
          - 'null'
          description: Mist BLE beacon transmit rate, in beacons per second
          contentEncoding: int32
          readOnly: true
          examples:
          - 3
        eddystone_uid_enabled:
          type:
          - boolean
          - 'null'
          description: Whether Eddystone-UID beacon transmission is enabled
          readOnly: true
          examples:
          - false
        eddystone_uid_freq_msec:
          type:
          - integer
          - 'null'
          description: Interval for Eddystone-UID advertisements, in milliseconds
          contentEncoding: int32
          readOnly: true
          examples:
          - 2000
        eddystone_uid_instance:
          type:
          - string
          - 'null'
          description: Eddystone-UID instance value broadcast by the AP
          readOnly: true
          examples:
          - 5c5b35000001
        eddystone_uid_namespace:
          type:
          - string
          - 'null'
          description: Eddystone-UID namespace value broadcast by the AP
          readOnly: true
          examples:
          - 2818e3868dec25629ede
        eddystone_url_enabled:
          type:
          - boolean
          - 'null'
          description: Whether Eddystone-URL beacon transmission is enabled
          readOnly: true
          examples:
          - true
        eddystone_url_freq_msec:
          type:
          - integer
          - 'null'
          description: Interval for Eddystone-URL advertisements, in milliseconds
          contentEncoding: int32
          readOnly: true
          examples:
          - 100
        eddystone_url_url:
          type:
          - string
          - 'null'
          description: URL broadcast by the Eddystone-URL beacon
          readOnly: true
          examples:
          - https://www.abc.com
        ibeacon_enabled:
          type:
          - boolean
          - 'null'
          description: Whether iBeacon transmission is enabled
          readOnly: true
          examples:
          - true
        ibeacon_freq_msec:
          type:
          - integer
          - 'null'
          description: Interval for iBeacon advertisements, in milliseconds
          contentEncoding: int32
          readOnly: true
          examples:
          - 2000
        ibeacon_major:
          maximum: 65535
          minimum: 1
          type:
          - integer
          - 'null'
          description: Major value broadcast in iBeacon advertisements
          contentEncoding: int32
          examples:
          - 1234
        ibeacon_minor:
          maximum: 65535
          minimum: 1
          type:
          - integer
          - 'null'
          description: Minor value broadcast in iBeacon advertisements
          contentEncoding: int32
          examples:
          - 1234
        ibeacon_uuid:
          type:
          - string
          - 'null'
          description: UUID value broadcast in iBeacon advertisements
          contentEncoding: uuid
          examples:
          - f3f17139-704a-f03a-2786-0400279e37c3
        major:
          type:
          - integer
          - 'null'
          description: Reported iBeacon major value for BLE statistics
          contentEncoding: int32
          readOnly: true
          examples:
          - 12345
        minors:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: Reported iBeacon minor values for BLE statistics
        power:
          type:
          - integer
          - 'null'
          description: BLE transmit power setting reported by the AP
          contentEncoding: int32
          readOnly: true
          examples:
          - 10
        rx_bytes:
          type:
          - integer
          - 'null'
          description: BLE bytes received by the AP
          contentEncoding: int64
          readOnly: true
          examples:
          - 8515104416
        rx_pkts:
          type:
          - integer
          - 'null'
          description: BLE packets received by the AP
          contentEncoding: int64
          readOnly: true
          examples:
          - 57770567
        tx_bytes:
          type:
          - integer
          - 'null'
          description: BLE bytes transmitted by the AP
          contentEncoding: int64
          readOnly: true
          examples:
          - 211217389682
        tx_pkts:
          type:
          - integer
          - 'null'
          description: BLE packets transmitted by the AP
          contentEncoding: int64
          readOnly: true
          examples:
          - 812204062
        tx_resets:
          type:
          - integer
          - 'null'
          description: Resets due to tx hung
          contentEncoding: int32
          readOnly: true
          examples:
          - 0
        uuid:
          type:
          - string
          - 'null'
          description: Beacon UUID reported by BLE statistics
          contentEncoding: uuid
          readOnly: true
          examples:
          - ada72f8f-1643-e5c6-94db-f2a5636f1a64
      description: BLE radio and beacon statistics reported by the AP
    stats_ap_env_stat2:
      title: stats_ap_env_stat2
      type: object
      properties:
        accel_x:
          type:
          - number
          - 'null'
          description: X-axis accelerometer reading reported by the AP
          readOnly: true
          examples:
          - 0
        accel_y:
          type:
          - number
          - 'null'
          description: Y-axis accelerometer reading reported by the AP
          readOnly: true
          examples:
          - 0.032
        accel_z:
          type:
          - number
          - 'null'
          description: Z-axis accelerometer reading reported by the AP
          readOnly: true
          examples:
          - -1.088
        ambient_temp:
          type:
          - integer
          - 'null'
          description: Temperature reading from the AP ambient sensor
          contentEncoding: int32
          readOnly: true
          examples:
          - 43
        attitude:
          type:
          - integer
          - 'null'
          description: Device attitude or orientation reading reported by the AP
          contentEncoding: int32
          readOnly: true
          examples:
          - 0
        cpu_temp:
          type:
          - integer
          - 'null'
          description: Temperature reading from the AP CPU sensor
          contentEncoding: int32
          readOnly: true
          examples:
          - 61
        humidity:
          type:
          - integer
          - 'null'
          description: Relative humidity sensor reading reported by the AP
          contentEncoding: int32
          readOnly: true
          examples:
          - 9
        magne_x:
          type:
          - number
          - 'null'
          description: X-axis magnetometer reading reported by the AP
          readOnly: true
          examples:
          - 0
        magne_y:
          type:
          - number
          - 'null'
          description: Y-axis magnetometer reading reported by the AP
          readOnly: true
          examples:
          - 0
        magne_z:
          type:
          - number
          - 'null'
          description: Z-axis magnetometer reading reported by the AP
          readOnly: true
          examples:
          - 0
        pressure:
          type:
          - number
          - 'null'
          description: Barometric pressure sensor reading reported by the AP
          readOnly: true
          examples:
          - 968
        vcore_voltage:
          type:
          - integer
          - 'null'
          description: Core voltage sensor reading reported by the AP
          contentEncoding: int32
          readOnly: true
          examples:
          - 0
      description: Environmental sensor readings reported by the AP
    stats_ap_esl_stat2:
      title: stats_ap_esl_stat2
      type: object
      properties:
        channel:
          type:
          - integer
          - 'null'
          description: Radio channel used by the ESL dongle
          contentEncoding: int32
          readOnly: true
        connected:
          type:
          - boolean
          - 'null'
          description: Whether the ESL dongle is connected
          readOnly: true
        ip:
          type:
          - string
          - 'null'
          description: Network IP address of Hanshow and SoluM dongles
          readOnly: true
          examples:
          - 172.16.2.249
        mac:
          type:
          - string
          - 'null'
          description: Dongle MAC address for Hanshow and SoluM dongles
          readOnly: true
          examples:
          - 98-6d-35-79-76-3b
        product_id:
          type:
          - string
          - 'null'
          description: Product ID of Hanshow and SoluM dongles
          readOnly: true
          examples:
          - A4A2
        type:
          type:
          - string
          - 'null'
          description: ESL dongle type reported by the AP
          readOnly: true
          examples:
          - imagotag
        up:
          type:
          - boolean
          - 'null'
          description: Whether the ESL dongle is operational
          readOnly: true
        vendor_id:
          type:
          - string
          - 'null'
          description: Vendor ID of Hanshow and SoluM dongles
          readOnly: true
          examples:
          - '0525'
      description: Electronic shelf label dongle status reported by the AP
    stats_ap_gps_stat_src2:
      title: stats_ap_gps_stat_src2
      enum:
      - gps
      - other_ap
      - other_aps
      type: string
      description: 'Source of the GPS location data. enum: `gps`, `other_ap`, `other_aps`.'
    stats_ap_gps_stat2:
      title: stats_ap_gps_stat2
      type: object
      properties:
        accuracy:
          type: number
          description: The estimated accuracy or accuracy of the GPS coordinates, measured in meters.
          examples:
          - 12.5
        altitude:
          type: number
          description: The elevation of the AP above sea level, measured in meters.
          examples:
          - 99.939
        latitude:
          type: number
          description: The geographic latitude of the AP, measured in degrees.
          examples:
          - 37.29548
        longitude:
          type: number
          description: The geographic longitude of the AP, measured in degrees.
          examples:
          - -122.03304
        src:
          allOf:
          - $ref: '#/components/schemas/stats_ap_gps_stat_src2'
          - description: 'Source of the GPS location data. enum: `gps`, `other_ap`, `other_aps`.'
        timestamp:
          type: number
          description: Time when the GPS location data was observed, in epoch seconds
          readOnly: true
      description: GPS location data reported for the AP
    stats_ap_lldp_stat2:
      title: stats_ap_lldp_stat2
      type: object
      properties:
        chassis_id:
          type:
          - string
          - 'null'
          description: LLDP neighbor chassis identifier
          readOnly: true
        lldp_med_supported:
          type:
          - boolean
          - 'null'
          description: Whether it support LLDP-MED
          readOnly: true
        mgmt_addr:
          type:
          - string
          - 'null'
          description: Management IP address of the switch
          readOnly: true
        mgmt_addrs:
          type: array
          items:
            type: string
          description: Management IP addresses advertised by the LLDP neighbor
        port_desc:
          type:
          - string
          - 'null'
          description: Port description, e.g. “2/20”, “Port 2 on Switch0”
          readOnly: true
          examples:
          - 2/20
        port_id:
          type:
          - string
          - 'null'
          description: LLDP neighbor port identifier
          readOnly: true
          examples:
          - ge-0/0/4
        power_allocated:
          type:
          - number
          - 'null'
          description: In mW, power allocated by PSE
          readOnly: true
        power_avail:
          type: integer
          description: In mW, total Power Avail at AP from pwr source
          contentEncoding: int32
        power_budget:
          type: integer
          description: In mW, surplus if positive or deficit if negative
          contentEncoding: int32
        power_constrained:
          type: boolean
          description: Whether power is insufficient
        power_draw:
          type:
          - number
          - 'null'
          description: In mW, total power needed by PD
          readOnly: true
        power_needed:
          type: integer
          description: In mW, total Power needed incl Peripherals
          contentEncoding: int32
        power_opmode:
          type: string
          description: Power operating mode negotiated through LLDP
        power_request_count:
          type:
          - integer
          - 'null'
          description: Number of negotiations, if it keeps increasing, we don’ t have a stable power
          contentEncoding: int32
          readOnly: true
        power_requested:
          type:
          - number
          - 'null'
          description: In mW, power requested by PD
          readOnly: true
        power_src:
          type: string
          description: Primary AP power source reported through LLDP
        power_srcs:
          type: array
          items:
            type: string
          description: AP power sources reported through LLDP
        system_desc:
          type:
          - string
          - 'null'
          description: Description provided by switch
          readOnly: true
          examples:
          - 'uniper Networks, Inc. ex4300-48t internet router, kernel JUNOS 20.4R3-S7.2, Build date: 2023-04-21 19:47:18 UTC Copyright (c) 1996-2023 Juniper Networks, Inc.'
        system_name:
          type:
          - string
          - 'null'
          description: Name of the switch
          readOnly: true
          examples:
          - Core-AE23
      description: Primary LLDP neighbor and power negotiation details for the AP
    stats_ap_radio_config_band1:
      title: stats_ap_radio_config_band1
      type: object
      properties:
        allow_rrm_disable:
          type:
          - boolean
          - 'null'
          description: Whether RRM disablement is allowed for this radio band
          readOnly: true
        bandwidth:
          type:
          - number
          - 'null'
          description: Channel bandwidth configured for this radio band
          readOnly: true
          examples:
          - 20
        channel:
          type: integer
          description: Operating channel configured for this radio band
          contentEncoding: int32
          examples:
          - 1
        disabled:
          type:
          - boolean
          - 'null'
          description: Whether this radio band is disabled
          readOnly: true
        dynamic_chaining_enabled:
          type:
          - boolean
          - 'null'
          description: Whether dynamic chaining is enabled for this radio band
          readOnly: true
          examples:
          - false
        power:
          type:
          - number
          - 'null'
          description: Transmit power configured for this radio band
          readOnly: true
          examples:
          - 10
        power_max:
          type:
          - number
          - 'null'
          description: Maximum transmit power allowed for this radio band
          readOnly: true
          examples:
          - 10
        power_min:
          type:
          - number
          - 'null'
          description: Minimum transmit power allowed for this radio band
          readOnly: true
          examples:
          - 10
        rx_chain:
          type:
          - integer
          - 'null'
          description: Number of receive chains enabled for this radio band
          contentEncoding: int32
          readOnly: true
          examples:
          - 4
        tx_chain:
          type:
          - integer
          - 'null'
          description: Number of transmit chains enabled for this radio band
          contentEncoding: int32
          readOnly: true
          examples:
          - 4
      description: 5 GHz radio configuration reported by the AP
    stats_ap_radio_config_band2:
      title: stats_ap_radio_config_band2
      type: object
      properties:
        allow_rrm_disable:
          type:
          - boolean
          - 'null'
          description: Whether RRM disablement is allowed for this radio band
          readOnly: true
        bandwidth:
          type:
          - number
          - 'null'
          description: Channel bandwidth configured for this radio band
          readOnly: true
          examples:
          - 20
        channel:
          type: integer
          description: Operating channel configured for this radio band
          contentEncoding: int32
          examples:
          - 1
        disabled:
          type:
          - boolean
          - 'null'
          description: Whether this radio band is disabled
          readOnly: true
        dynamic_chaining_enabled:
          type:
          - boolean
          - 'null'
          description: Whether dynamic chaining is enabled for this radio band
          readOnly: true
          examples:
          - false
        power:
          type:
          - number
          - 'null'
          description: Transmit power configured for this radio band
          readOnly: true
          examples:
          - 10
        power_max:
          type:
          - number
          - 'null'
          description: Maximum transmit power allowed for this radio band
          readOnly: true
          examples:
          - 10
        power_min:
          type:
          - number
          - 'null'
          description: Minimum transmit power allowed for this radio band
          readOnly: true
          examples:
          - 10
        rx_chain:
          type:
          - integer
          - 'null'
          description: Number of receive chains enabled for this radio band
          contentEncoding: int32
          readOnly: true
          examples:
          - 4
        tx_chain:
          type:
          - integer
          - 'null'
          description: Number of transmit chains enabled for this radio band
          contentEncoding: int32
          readOnly: true
          examples:
          - 4
      description: 6 GHz radio configuration reported by the AP
    stats_ap_radio_config_band4:
      title: stats_ap_radio_config_band4
      type: object
      properties:
        allow_rrm_disable:
          type:
          - boolean
          - 'null'
          description: Whether RRM disablement is allowed for this radio band
          readOnly: true
        bandwidth:
          type:
          - number
          - 'null'
          description: Channel bandwidth configured for this radio band
          readOnly: true
          examples:
          - 20
        channel:
          type: integer
          description: Operating channel configured for this radio band
          contentEncoding: int32
          examples:
          - 1
        disabled:
          type:
          - boolean
          - 'null'
          description: Whether this radio band is disabled
          readOnly: true
        dynamic_chaining_enabled:
          type:
          - boolean
          - 'null'
          description: Whether dynamic chaining is enabled for this radio band
          readOnly: true
          examples:
          - false
        power:
          type:
          - number
          - 'null'
          description: Transmit power configured for this radio band
          readOnly: true
          examples:
          - 10
        power_max:
          type:
          - number
          - 'null'
          description: Maximum transmit power allowed for this radio band
          readOnly: true
          examples:
          - 10
        power_min:
          type:
          - number
          - 'null'
          description: Minimum transmit power allowed for this radio band
          readOnly: true
          examples:
          - 10
        rx_chain:
          type:
          - integer
          - 'null'
          description: Number of receive chains enabled for this radio band
          contentEncoding: int32
          readOnly: true
          examples:
          - 4
        tx_chain:
          type:
          - integer
          - 'null'
          description: Number of transmit chains enabled for this radio band
          contentEncoding: int32
          readOnly: true
          examples:
          - 4
      description: 2.4 GHz radio configuration reported by the AP
    stats_ap_radio_config2:
      title: stats_ap_radio_config2
      type: object
      properties:
        band_24:
          allOf:
          - $ref: '#/components/schemas/stats_ap_radio_config_band4'
          - description: 2.4 GHz radio configuration reported by the AP
        band_24_usage:
          type:
          - string
          - 'null'
          description: Current operating use for the 2.4 GHz radio
          readOnly: true
          examples:
          - '5'
        band_5:
          allOf:
          - $ref: '#/components/schemas/stats_ap_radio_config_band1'
          - description: 5 GHz radio configuration reported by the AP
        band_6:
          allOf:
          - $ref: '#/components/schemas/stats_ap_radio_config_band2'
          - description: 6 GHz radio configuration reported by the AP
        scanning_enabled:
          type: boolean
          description: Whether radio scanning is enabled on the AP
      description: Radio configuration currently applied to the AP
    stats_ap_radio_stat2:
      title: stats_ap_radio_stat2
      type: object
      properties:
        band_24:
          allOf:
          - $ref: '#/components/schemas/ap_radio_stat1'
          - description: 2.4 GHz radio statistics reported by the AP
        band_5:
          allOf:
          - $ref: '#/components/schemas/ap_radio_stat2'
          - description: 5 GHz radio statistics reported by the AP
        band_6:
          allOf:
          - $ref: '#/components/schemas/ap_radio_stat3'
          - description: 6 GHz radio statistics reported by the AP
      description: Radio statistics reported by AP bands
    stats_ap_switch_redundancy2:
      title: stats_ap_switch_redundancy2
      type: object
      properties:
        num_redundant_aps:
          type:
          - integer
          - 'null'
          description: Number of redundant APs available for switch redundancy
          contentEncoding: int32
          readOnly: true
          examples:
          - 1
      description: Switch redundancy status reported for the AP
    stats_ap_usb_stat2:
      title: stats_ap_usb_stat2
      type: object
      properties:
        channel:
          type:
          - integer
          - 'null'
          description: Radio channel used by the USB peripheral
          contentEncoding: int32
          readOnly: true
          examples:
          - 3
        connected:
          type:
          - boolean
          - 'null'
          description: Whether the USB peripheral is connected
          readOnly: true
          examples:
          - true
        last_activity:
          type:
          - integer
          - 'null'
          description: Time of the last USB peripheral activity, in epoch seconds
          contentEncoding: int32
          readOnly: true
          examples:
          - 1586873254
        type:
          type:
          - string
          - 'null'
          description: USB peripheral type reported by the AP
          readOnly: true
          examples:
          - imagotag
        up:
          type:
          - boolean
          - 'null'
          description: Whether the USB peripheral is operational
          readOnly: true
          examples:
          - true
      description: USB peripheral status reported by the AP
    stats_ap_zigbee_stat2:
      title: stats_ap_zigbee_stat2
      type: object
      properties:
        iotproxy_status:
          type:
          - string
          - 'null'
          description: Connection status of the IoT proxy
          readOnly: true
          examples:
          - connected
        num_iotendpoints:
          type:
          - integer
          - 'null'
          description: Number of IoT endpoints connected through the AP
          contentEncoding: int32
          readOnly: true
          examples:
          - 3
      description: ZigBee statistics reported by the AP, present only when ZigBee is enabled on the AP
    stats_cluster_config_control_link_info2:
      title: stats_cluster_config_control_link_info2
      type: object
      properties:
        name:
          type: string
          description: Control link interface name reported by the gateway cluster
        status:
          type: string
          description: Operational state reported for the control link
      description: Control link interface and operational state for the gateway cluster
    stats_cluster_config_fabric_link_info2:
      title: stats_cluster_config_fabric_link_info2
      type: object
      properties:
        DataPlaneNotifiedStatus:
          type: string
          description: Fabric link data-plane notification status reported by the gateway
        Interface:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Fabric link interfaces reported for the gateway cluster
        InternalStatus:
          type: string
          description: Gateway-reported internal status for the fabric link
        State:
          type: string
          description: Administrative state of the fabric link
        Status:
          type: string
          description: Operational status of the fabric link
      description: Fabric link state and data-plane notification details for the gateway cluster
    stats_cluster_config1:
      title: stats_cluster_config1
      type: object
      properties:
        configuration:
          type: string
          description: Configured high-availability mode for the gateway cluster, such as active-active
        control_link_info:
          allOf:
          - $ref: '#/components/schemas/stats_cluster_config_control_link_info2'
          - description: Control link interface and operational state for the gateway cluster
        ethernet_connection:
          type: array
          items:
            $ref: '#/components/schemas/stats_cluster_config_ethernet_connection_item'
          description: Ethernet interface connection states used by the gateway cluster
        fabric_link_info:
          allOf:
          - $ref: '#/components/schemas/stats_cluster_config_fabric_link_info2'
          - description: Fabric link state and data-plane notification details for the gateway cluster
        last_status_change_reason:
          type: string
          description: Reason reported for the most recent gateway cluster status change
        operational:
          type: string
          description: Current operational high-availability mode of the gateway cluster
        primary_node_health:
          type: string
          description: Health state reported for the primary gateway cluster node
        redundancy_group_information:
          type: array
          items:
            $ref: '#/components/schemas/stats_cluster_config_redundancy_group_info_item'
          description: Redundancy group monitoring state reported by the gateway cluster
        secondary_node_health:
          type: string
          description: Health state reported for the secondary gateway cluster node
        status:
          type: string
          description: Overall health status reported for the gateway cluster
      description: High-availability cluster configuration and health for the gateway
    stats_device_other_vendor_specific2:
      title: stats_device_other_vendor_specific2
      type: object
      properties:
        interfaces:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/stats_device_other_vendor_specific_port'
          description: Cradlepoint interface statistics keyed by vendor interface identifier
          examples:
          - mdm-4d0e073b:
              bytes_in: 5623096929
              bytes_out: 12372750366
              carrier: Orange
              imei: '866401234567893'
              imsi: '2080101234567893'
              ip: 10.134.237.57
              link: true
              mode: wan
              rsrp: -108
              rsrq: -14
              rssi: -74
              service_mode: 5G NSA
              sinr: -1.2
              state: READY
              type: mdm
              uptime: 2095779
        target_version:
          type: string
          description: Cradlepoint software version targeted for the device
          examples:
          - 7.23.40
      description: Additional statistics returned by the device vendor
    stats_gateway_cluster2:
      title: stats_gateway_cluster2
      type: object
      properties:
        state:
          type:
          - string
          - 'null'
          description: Current HA cluster state for the gateway
          readOnly: true
      description: High-availability cluster state summary for the gateway
    stats_gateway_mac_table_stats2:
      title: stats_gateway_mac_table_stats2
      type: object
      properties:
        mac_table_count:
          type: integer
          description: Number of MAC table entries currently learned by the gateway
          contentEncoding: int32
        max_mac_entries_supported:
          type: integer
          description: Maximum MAC table entries supported by the gateway
          contentEncoding: int32
      description: Layer 2 MAC table utilization statistics for the gateway
    stats_gateway_service_status2:
      title: stats_gateway_service_status2
      type: object
      properties:
        appid_install_result:
          type: string
          description: Installation result reported for the AppID package
        appid_install_timestamp:
          type: string
          description: Installation time reported for the AppID package
        appid_status:
          type: string
          description: Operational status of the AppID service on the gateway
        appid_version:
          type: integer
          description: Installed AppID package version number
          contentEncoding: int32
        ewf_status:
          type: string
          description: Enhanced Web Filtering service status reported by the gateway
        idp_install_result:
          type: string
          description: Installation result reported for the intrusion detection and prevention package
        idp_install_timestamp:
          type: string
          description: Installation time reported for the intrusion detection and prevention package
        idp_policy:
          type: string
          description: Intrusion detection and prevention policy applied to the gateway
        idp_status:
          type: string
          description: Intrusion detection and prevention service status reported by the gateway
        idp_update_timestamp:
          type: string
          description: Last update time reported for the intrusion detection and prevention package
      description: Security service status reported by the gateway
    stats_marvis_client_location1:
      title: stats_marvis_client_location1
      type: object
      properties:
        map_id:
          type: string
          description: UUID of the floor-plan map
          contentEncoding: uuid
        site_id:
          type: string
          description: UUID of the site the device was located in
          contentEncoding: uuid
        timestamp:
          type: integer
          description: Timestamp of the location fix, in epoch seconds
          contentEncoding: int32
        x:
          type: number
          description: X coordinate on the floor-plan map, in pixels
        y:
          type: number
          description: Y coordinate on the floor-plan map, in pixels
      description: Last known device location
    stats_mxedge_cpu_stat2:
      title: stats_mxedge_cpu_stat2
      type: object
      properties:
        cpus:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/cpu_stat'
          description: Per-core CPU utilization statistics keyed by CPU name
          examples:
          - cpu0:
              idle: 89
              interrupt: 0
              system: 8
              usage: 10
              user: 1
            cpu1:
              idle: 81
              interrupt: 0
              system: 4
              usage: 18
              user: 13
            cpu2:
              idle: 81
              interrupt: 0
              system: 4
              usage: 18
              user: 13
            cpu3:
              idle: 2
              interrupt: 0
              system: 50
              usage: 97
              user: 46
        idle:
          type: integer
          description: Percentage of Idle, Idle/(Idle + Busy) since last sampling
          contentEncoding: int32
          examples:
          - 62
        interrupt:
          type: integer
          description: Percentage of Interrupt, (Irq + SoftIrq)/(Idle + Busy) since last sampling
          contentEncoding: int32
          examples:
          - 0
        system:
          type: integer
          description: Percentage of System, System/(Idle + Busy) since last sampling
          contentEncoding: int32
          examples:
          - 17
        usage:
          type: integer
          description: Percentage of load, Busy/(Idle + Busy) since last sampling
          contentEncoding: int32
          examples:
          - 37
        user:
          type: integer
          description: Percentage of User, User/(Idle + Busy) since last sampling
          contentEncoding: int32
          examples:
          - 19
      description: CPU utilization statistics reported by the Mist Edge
    stats_mxedge_inactive_vlan_strs2:
      title: stats_mxedge_inactive_vlan_strs2
      type: object
      properties:
        l2tp:
          type: array
          items:
            type: string
          description: Inactive L2TP VLANs. Entries can be individual VLANs or ranges.
        wired:
          type: array
          items:
            type: string
          description: Inactive wired VLANs. Entries can be individual VLANs or ranges.
          examples:
          - - '100'
            - 102-106
      description: Inactive VLAN identifiers reported by the Mist Edge
    stats_mxedge_ip_stat2:
      title: stats_mxedge_ip_stat2
      type: object
      properties:
        ip:
          type: string
          description: Primary IPv4 address reported for the Mist Edge
          examples:
          - 192.168.1.244
        ip6:
          type: string
          description: Primary IPv6 address reported for the Mist Edge
          examples:
          - fd4e:c615:b27d:5555::45
        ips:
          type: object
          additionalProperties:
            type: string
          description: Interface IP addresses keyed by interface name
          examples:
          - ens18: 92.168.1.244/24,fd4e:c615:b27d:5555::45/128,fd4e:c615:b27d:5555:20c:29ff:fe44:af25/64,fe80::104c:ffff:fee0:caf8/64
        macs:
          type: object
          additionalProperties:
            type: string
          description: Interface MAC addresses keyed by interface name
          examples:
          - ens18: e4434b217044
        netmask:
          type: string
          description: IPv4 netmask reported for the primary Mist Edge address
          examples:
          - 255.255.255.0
        netmask6:
          type: string
          description: IPv6 prefix length reported for the primary Mist Edge address
          examples:
          - /128
      description: IP address statistics reported by the Mist Edge
    stats_mxedge_memory_stat2:
      title: stats_mxedge_memory_stat2
      type: object
      properties:
        active:
          type: integer
          description: The amount of memory, in kilobytes, that has been used more recently and is usually not reclaimed unless absolutely necessary.
          contentEncoding: int32
          examples:
          - 394936320
        available:
          type: integer
          description: An estimate of how much memory is available for starting new applications, without swapping.
          contentEncoding: int64
          examples:
          - 4699291648
        buffers:
          type: integer
          description: The amount, in kilobytes, of temporary storage for raw disk blocks.
          contentEncoding: int32
          examples:
          - 107646976
        cached:
          type: integer
          description: The amount of physical RAM, in kilobytes, used as cache memory.
          contentEncoding: int32
          examples:
          - 478060544
        free:
          type: integer
          description: The amount of physical RAM, in kilobytes, left unused by the system
          contentEncoding: int64
          examples:
          - 4330659840
        inactive:
          type: integer
          description: The amount of memory, in kilobytes, that has been used less recently and is more eligible to be reclaimed for other purposes.
          contentEncoding: int32
          examples:
          - 211980288
        swap_cached:
          type: integer
          description: The amount of memory, in kilobytes, that has once been moved into swap, then back into the main memory, but still also remains in the swapfile.
          contentEncoding: int32
          examples:
          - 0
        swap_free:
          type: integer
          description: The total amount of swap free, in kilobytes.
          contentEncoding: int32
          examples:
          - 1022357504
        swap_total:
          type: integer
          description: The total amount of swap available, in kilobytes.
          contentEncoding: int32
          examples:
          - 1022357504
        total:
          type: integer
          description: Usable RAM total, in kilobytes, which is physical RAM minus a number of reserved bits and the kernel binary code
          contentEncoding: int64
          examples:
          - 8365957120
        usage:
          type: integer
          description: Memory utilization percentage reported by the Mist Edge
          contentEncoding: int32
          examples:
          - 48
      description: Memory utilization statistics reported by the Mist Edge
    stats_mxedge_oob_ip_stat2:
      title: stats_mxedge_oob_ip_stat2
      type: object
      properties:
        dns:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Out-of-band management DNS servers
        gateway:
          type: string
          description: IPv4 default gateway for out-of-band management
        gateway6:
          type: string
          description: IPv6 default gateway for out-of-band management
        ip:
          type: string
          description: Out-of-band management IPv4 address
        ip6:
          type: string
          description: Out-of-band management IPv6 address
        netmask:
          type: string
          description: IPv4 netmask for the out-of-band management interface
        netmask6:
          type: string
          description: IPv6 prefix length for the out-of-band management interface
        type:
          allOf:
          - $ref: '#/components/schemas/mxedge_mgmt_oob_ip_type2'
          - description: 'IPv4 address assignment mode for out-of-band management. enum: `dhcp`, `disabled`, `static`.'
        type8:
          allOf:
          - $ref: '#/components/schemas/mxedge_mgmt_oob_ip_type62'
          - description: 'IPv6 address assignment mode for out-of-band management. enum: `autoconf`, `dhcp`, `disabled`, `static`.'
      description: Observed out-of-band management IP status for the Mist Edge
    stats_mxedge_port_stat_lacp2:
      title: stats_mxedge_port_stat_lacp2
      type: object
      properties:
        mux_state:
          type: string
          description: LACP multiplexer state reported for the port
        rx_lacpdu:
          type: integer
          description: Number of LACPDUs received on the port
          contentEncoding: int32
        rx_state:
          type: string
          description: LACP receive state reported for the port
        tx_lacpdu:
          type: integer
          description: Number of LACPDUs transmitted from the port
          contentEncoding: int32
      description: Link aggregation control protocol state and packet counters for the port
    stats_mxedge_port_stat_lldp_stats2:
      title: stats_mxedge_port_stat_lldp_stats2
      type: object
      properties:
        chassis_id:
          type: string
          description: LLDP chassis identifier advertised by the neighbor
        mgmt_addr:
          type: string
          description: Management address advertised by the LLDP neighbor
        port_desc:
          type: string
          description: Port description advertised by the LLDP neighbor
        port_id:
          type: string
          description: Port identifier advertised by the LLDP neighbor
        system_desc:
          type: string
          description: System description advertised by the LLDP neighbor
        system_name:
          type: string
          description: System name advertised by the LLDP neighbor
      description: LLDP neighbor information learned on the port
    stats_mxedge_port_stat_sfp2:
      title: stats_mxedge_port_stat_sfp2
      type: object
      properties:
        codes:
          type: string
          description: Transceiver capability codes reported by the SFP module
        mbps:
          type: integer
          description: Nominal transceiver speed, in Mbps
          contentEncoding: int32
        part_no:
          type: string
          description: Manufacturer part number reported by the SFP module
        serial_no:
          type: string
          description: Manufacturer serial number reported by the SFP module
        type:
          type: integer
          description: Transceiver type code reported by the SFP module
          contentEncoding: int32
        vendor:
          type: string
          description: Manufacturer name reported by the SFP module
      description: Transceiver details reported for the SFP module on the port
    stats_mxedge_tunterm_ip_config2:
      title: stats_mxedge_tunterm_ip_config2
      type: object
      properties:
        gateway:
          type: string
          description: IPv4 default gateway for tunnel termination traffic
          examples:
          - 192.168.11.1
        ip:
          type: string
          description: Tunnel termination IPv4 address used by the Mist Edge
          examples:
          - 192.168.11.91
        netmask:
          type: string
          description: IPv4 netmask for the tunnel termination address
          examples:
          - 255.255.255.0
      description: Configured tunnel termination IP settings for the Mist Edge
    stats_mxedge_tunterm_port_config2:
      title: stats_mxedge_tunterm_port_config2
      type: object
      properties:
        downstream_ports:
          type: array
          items:
            type: string
          description: Ports configured for downstream tunnel termination traffic
          examples:
          - - '0'
            - '1'
        separate_upstream_downstream:
          type: boolean
          description: Whether separate port sets are used for upstream and downstream tunnel termination traffic
          examples:
          - false
        upstream_ports:
          type: array
          items:
            type: string
          description: Ports configured for upstream tunnel termination traffic
          examples:
          - - '0'
            - '1'
      description: Tunnel termination port configuration reported for the Mist Edge
    stats_mxedge_tunterm_stat2:
      title: stats_mxedge_tunterm_stat2
      type: object
      properties:
        monitoring_failed:
          type: boolean
          description: Whether tunnel termination monitoring is currently failing
          examples:
          - false
      description: Tunnel termination monitoring status reported by the Mist Edge
    stats_mxtunnel_state2:
      title: stats_mxtunnel_state2
      enum:
      - established
      - established_with_sessions
      - idle
      - wait-ctrl-conn
      - wait-ctrl-reply
      type: string
      description: 'Current state of the WxLAN or Mist tunnel. enum: `established`, `established_with_sessions`, `idle`, `wait-ctrl-conn`, `wait-ctrl-reply`.'
    stats_org_sle_user_minutes2:
      title: stats_org_sle_user_minutes2
      required:
      - ok
      - total
      type: object
      properties:
        ok:
          type: number
          description: User minutes that met the SLE target
        total:
          type: number
          description: Observed total user minutes for the SLE path
      description: User-minute totals for this SLE path
    stats_sdkclient_network_connection1:
      title: stats_sdkclient_network_connection1
      required:
      - mac
      - rssi
      - signal_level
      - type
      type: object
      properties:
        mac:
          type: string
          description: Current network connection MAC address reported for the SDK client
        rssi:
          type: number
          description: Received signal strength indicator for the SDK client's current network connection, in dBm
        signal_level:
          type: number
          description: Numeric signal quality level reported with the SDK client's current network connection
        type:
          type: string
          description: Network connection type reported for the SDK client, such as WiFi
      description: Current network connection details for the SDK client
    stats_switch_ap_redundancy2:
      title: stats_switch_ap_redundancy2
      type: object
      properties:
        modules:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/stats_switch_ap_redundancy_module'
          description: Per-module AP redundancy counts for VC or stacked switches
        num_aps:
          type: integer
          description: Total number of APs considered for switch redundancy
          contentEncoding: int32
          examples:
          - 15
        num_aps_with_switch_redundancy:
          type: integer
          description: Number of APs that have switch redundancy coverage
          contentEncoding: int32
          examples:
          - 8
      description: AP redundancy statistics associated with the switch
    stats_switch_clients_stats_total2:
      title: stats_switch_clients_stats_total2
      type: object
      properties:
        num_aps:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: AP counts included in the aggregate switch client statistics
        num_wired_clients:
          type: integer
          description: Number of wired clients included in the aggregate switch client statistics
          contentEncoding: int32
      description: Aggregate client counts across the switch
    stats_switch_clients_stats2:
      title: stats_switch_clients_stats2
      type: object
      properties:
        total:
          allOf:
          - $ref: '#/components/schemas/stats_switch_clients_stats_total2'
          - description: Aggregate client counts across the switch
      description: Aggregate client counts reported for the switch
    stats_switch_port_poe_mode1:
      title: stats_switch_port_poe_mode1
      enum:
      - 802.3af
      - 802.3at
      - 802.3bt
      type: string
      description: 'PoE mode reported for the port. enum: `802.3af`, `802.3at`, `802.3bt`.'
    stats_switch_port_type1:
      title: stats_switch_port_type1
      enum:
      - ap
      - ble
      - gateway
      - mxedge
      - nac
      - switch
      type: string
      description: 'Detected device category connected to the port, when available. enum: `ap`, `ble`, `gateway`, `mxedge`, `nac`, `switch`.'
      examples:
      - gateway
    stats_switch_vc_setup_info2:
      title: stats_switch_vc_setup_info2
      type: object
      properties:
        config_type:
          type: string
          description: Provisioning mode used for the Virtual Chassis setup
          readOnly: true
          examples:
          - nonprovisioned
        current_stats:
          type: string
          description: Status currently reported for the Virtual Chassis setup workflow
          readOnly: true
          examples:
          - VCSETUP_WAITING
        err_missing_dev_id_fpc:
          type: boolean
          description: Whether the Virtual Chassis setup is missing a device ID for an FPC member
          readOnly: true
        last_update:
          type: number
          description: Most recent update time for the Virtual Chassis setup status
          readOnly: true
        request_time:
          type: number
          description: Time when the Virtual Chassis setup request was submitted
          readOnly: true
        request_type:
          type: string
          description: Virtual Chassis setup request type
          readOnly: true
          examples:
          - vc_create
      description: Virtual Chassis setup request and status details for the switch
    stats_wireless_client_airwatch2:
      title: stats_wireless_client_airwatch2
      required:
      - authorized
      type: object
      properties:
        authorized:
          type: boolean
          description: Whether the wireless client is authorized by AirWatch
      description: Mobile device management authorization information from AirWatch for the wireless client
    stats_wxrule_action2:
      title: stats_wxrule_action2
      enum:
      - allow
      - block
      type: string
      description: Allow or block behavior enforced by this WxLAN rule
      examples:
      - allow
    stats_zone_assets_waits1:
      title: stats_zone_assets_waits1
      type: object
      properties:
        avg:
          type: number
          description: Average wait time in seconds
          examples:
          - 0
        max:
          type: number
          description: Longest wait time in seconds
          examples:
          - 0
        min:
          type: number
          description: Shortest wait time in seconds
          examples:
          - 0
        p95:
          type: number
          description: 95th percentile of all the wait time(s)
          examples:
          - 0
      description: BLE asset wait-time summary for the zone
    stats_zone_assets_waits3:
      title: stats_zone_assets_waits3
      type: object
      properties:
        avg:
          type: number
          description: Average wait time in seconds
          examples:
          - 0
        max:
          type: number
          description: Longest wait time in seconds
          examples:
          - 0
        min:
          type: number
          description: Shortest wait time in seconds
          examples:
          - 0
        p95:
          type: number
          description: 95th percentile of all the wait time(s)
          examples:
          - 0
      description: BLE asset wait-time summary for the RSSI zone
    stats_zone_clients_waits1:
      title: stats_zone_clients_waits1
      type: object
      properties:
        avg:
          type: number
          description: Average wait time in seconds
          examples:
          - 1200
        max:
          type: number
          description: Longest wait time in seconds
          examples:
          - 3610
        min:
          type: number
          description: Shortest wait time in seconds
          examples:
          - 600
        p95:
          type: number
          description: 95th percentile of all the wait time(s)
          examples:
          - 2800
      description: Wi-Fi client wait-time summary for the zone
    stats_zone_clients_waits3:
      title: stats_zone_clients_waits3
      type: object
      properties:
        avg:
          type: number
          description: Average wait time in seconds
          examples:
          - 1200
        max:
          type: number
          description: Longest wait time in seconds
          examples:
          - 3610
        min:
          type: number
          description: Shortest wait time in seconds
          examples:
          - 600
        p95:
          type: number
          description: 95th percentile of all the wait time(s)
          examples:
          - 2800
      description: Wi-Fi client wait-time summary for the RSSI zone
    stats_zone_details_client_waits2:
      title: stats_zone_details_client_waits2
      required:
      - avg
      - max
      - min
      - p95
      type: object
      properties:
        avg:
          type: integer
          description: Average wait time in seconds
          contentEncoding: int32
          examples:
          - 1200
        max:
          type: integer
          description: Longest wait time in seconds
          contentEncoding: int32
          examples:
          - 3610
        min:
          type: integer
          description: Shortest wait time in seconds
          contentEncoding: int32
          examples:
          - 600
        p95:
          type: integer
          description: 95th percentile of all the wait time(s)
          contentEncoding: int32
          examples:
          - 2800
      description: Wi-Fi client wait-time summary for the zone
    stats_zone_discovered_assets_waits1:
      title: stats_zone_discovered_assets_waits1
      type: object
      properties:
        avg:
          type: number
          description: Average wait time in seconds
          examples:
          - 0
        max:
          type: number
          description: Longest wait time in seconds
          examples:
          - 0
        min:
          type: number
          description: Shortest wait time in seconds
          examples:
          - 0
        p95:
          type: number
          description: 95th percentile of all the wait time(s)
          examples:
          - 0
      description: Discovered BLE asset wait-time summary for the zone
    stats_zone_discovered_assets_waits3:
      title: stats_zone_discovered_assets_waits3
      type: object
      properties:
        avg:
          type: number
          description: Average wait time in seconds
          examples:
          - 0
        max:
          type: number
          description: Longest wait time in seconds
          examples:
          - 0
        min:
          type: number
          description: Shortest wait time in seconds
          examples:
          - 0
        p95:
          type: number
          description: 95th percentile of all the wait time(s)
          examples:
          - 0
      description: Discovered BLE asset wait-time summary for the RSSI zone
    stats_zone_sdkclients_waits1:
      title: stats_zone_sdkclients_waits1
      type: object
      properties:
        avg:
          type: number
          description: Average wait time in seconds
          examples:
          - 0
        max:
          type: number
          description: Longest wait time in seconds
          examples:
          - 0
        min:
          type: number
          description: Shortest wait time in seconds
          examples:
          - 0
        p95:
          type: number
          description: 95th percentile of all the wait time(s)
          examples:
          - 0
      description: SDK client wait-time summary for the zone
    stats_zone_sdkclients_waits3:
      title: stats_zone_sdkclients_waits3
      type: object
      properties:
        avg:
          type: number
          description: Average wait time in seconds
          examples:
          - 0
        max:
          type: number
          description: Longest wait time in seconds
          examples:
          - 0
        min:
          type: number
          description: Shortest wait time in seconds
          examples:
          - 0
        p95:
          type: number
          description: 95th percentile of all the wait time(s)
          examples:
          - 0
      description: SDK client wait-time summary for the RSSI zone
    stats_zone_unconnected_clients_waits1:
      title: stats_zone_unconnected_clients_waits1
      type: object
      properties:
        avg:
          type: number
          description: Average wait time in seconds
          examples:
          - 0
        max:
          type: number
          description: Longest wait time in seconds
          examples:
          - 0
        min:
          type: number
          description: Shortest wait time in seconds
          examples:
          - 0
        p95:
          type: number
          description: 95th percentile of all the wait time(s)
          examples:
          - 0
      description: Unconnected Wi-Fi client wait-time summary for the zone
    stats_zone_unconnected_clients_waits3:
      title: stats_zone_unconnected_clients_waits3
      type: object
      properties:
        avg:
          type: number
          description: Average wait time in seconds
          examples:
          - 0
        max:
          type: number
          description: Longest wait time in seconds
          examples:
          - 0
        min:
          type: number
          description: Shortest wait time in seconds
          examples:
          - 0
        p95:
          type: number
          description: 95th percentile of all the wait time(s)
          examples:
          - 0
      description: Unconnected Wi-Fi client wait-time summary for the RSSI zone
    support_contract_status2:
      title: support_contract_status2
      enum:
      - Active
      - Declined
      - EOL
      - Service Available
      type: string
      description: 'Service contract status; only returned for onboarded (claimed) devices. enum: `Active`, `Declined`, `EOL`, `Service Available`.'
    suppressed_alarm_applies2:
      title: suppressed_alarm_applies2
      type: object
      properties:
        org_id:
          type: string
          description: UUID of the current org (if provided, the alarms will be suppressed at org level)
          contentEncoding: uuid
        site_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Site identifiers included in the suppression scope. If provided, alarms are suppressed for the listed sites.
        sitegroup_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Site group identifiers included in the suppression scope. If provided, alarms are suppressed for all sites in the listed site groups.
      description: If `scope`==`site`. Site and site-group targets where alarms are suppressed
    suppressed_alarm_scope1:
      title: suppressed_alarm_scope1
      enum:
      - org
      - site
      type: string
      description: 'Alarm suppression target level. enum: `org`, `site`.'
    suppressed_alarm_scope3:
      title: suppressed_alarm_scope3
      enum:
      - org
      - site
      type: string
      description: 'Alarm suppression scope, either organization-wide or site-specific. enum: `org`, `site`.'
    sw_routing_policy_term_action2:
      title: sw_routing_policy_term_action2
      type: object
      properties:
        accept:
          type: boolean
          description: Whether to accept routes that match this term
        community:
          type: array
          items:
            type: string
          description: BGP communities to set when this term is used as an export policy
        local_preference:
          anyOf:
          - type: string
          - maximum: 4294967295
            minimum: 1
            type: integer
            contentEncoding: int32
          description: Preference value to set when this term is used as an import policy
        prepend_as_path:
          type: array
          items:
            type: string
          description: AS path values to prepend when this term is used as an export policy
      description: Policy actions applied when this routing policy term matches
    sw_routing_policy_term_matching2:
      title: sw_routing_policy_term_matching2
      type: object
      properties:
        as_path:
          type: array
          items:
            $ref: '#/components/schemas/bgp_as'
          description: AS path values that routes must match
        community:
          type: array
          items:
            type: string
          description: BGP communities that routes must match
        prefix:
          type: array
          items:
            type: string
          description: Route prefixes that routes must match
        protocol:
          type: array
          items:
            $ref: '#/components/schemas/sw_routing_policy_term_matching_protocol_enum'
          description: Routing protocols that routes must match
      description: Route match criteria that must be satisfied before actions are applied
    switch_auto_upgrade1:
      title: switch_auto_upgrade1
      type: object
      properties:
        custom_versions:
          type: object
          additionalProperties:
            type: string
          description: Per-model switch firmware versions to use for auto-upgrade
          examples:
          - QFX5120-32C: 23.4R2-S2.1
            QFX5130-32CD: 23.4R2-S2.3
        enabled:
          type: boolean
          description: Whether switch auto-upgrade is enabled
        snapshot:
          type: boolean
          description: Whether to create a recovery snapshot during the upgrade process
          default: false
      description: Switch firmware auto-upgrade configuration
    switch_auto_upgrade3:
      title: switch_auto_upgrade3
      type: object
      properties:
        custom_versions:
          type: object
          additionalProperties:
            type: string
          description: Per-model switch firmware versions to use for auto-upgrade
          examples:
          - QFX5120-32C: 23.4R2-S2.1
            QFX5130-32CD: 23.4R2-S2.3
        enabled:
          type: boolean
          description: Whether switch auto-upgrade is enabled
        snapshot:
          type: boolean
          description: Whether to create a recovery snapshot during the upgrade process
          default: false
      description: Auto-upgrade defaults for switches in this organization
    switch_bgp_config_type2:
      title: switch_bgp_config_type2
      enum:
      - external
      - internal
      type: string
      description: 'BGP session type for this switch BGP configuration. enum: `external`, `internal`.'
    switch_dhcpd_config_type2:
      title: switch_dhcpd_config_type2
      enum:
      - none
      - relay
      - server
      type: string
      description: 'IPv4 DHCP mode for this switch network. enum: `none`, `relay`, `server`.'
    switch_dhcpd_config_type62:
      title: switch_dhcpd_config_type62
      enum:
      - none
      - relay
      - server
      type: string
      description: 'IPv6 DHCP mode for this switch network. enum: `none`, `relay`, `server`.'
    switch_dhcpd_config1:
      title: switch_dhcpd_config1
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether switch DHCP server or relay configuration is enabled
          default: false
      additionalProperties:
        allOf:
        - $ref: '#/components/schemas/switch_dhcpd_config_property'
        - description: DHCP server or relay configuration for one switch network. The property key is the network name. In case of DHCP relay, it's common for many networks to use the same dhcp relay, comma-separated network names can be used here (e.g. "net1,net2")
      description: DHCP server defaults provided by this switch profile
    switch_dhcpd_config3:
      title: switch_dhcpd_config3
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether switch DHCP server or relay configuration is enabled
          default: false
      additionalProperties:
        allOf:
        - $ref: '#/components/schemas/switch_dhcpd_config_property'
        - description: DHCP server or relay configuration for one switch network. The property key is the network name. In case of DHCP relay, it's common for many networks to use the same dhcp relay, comma-separated network names can be used here (e.g. "net1,net2")
      description: DHCP server configuration served by this switch
    switch_iot_port_alarm_class2:
      title: switch_iot_port_alarm_class2
      enum:
      - minor
      - major
      type: string
      description: 'Alarm severity class raised for input-triggered switch IOT port events. enum: `minor`, `major`.'
    switch_iot_port_input_src2:
      title: switch_iot_port_input_src2
      enum:
      - IN0
      - IN1
      type: string
      description: 'Only for `OUT` ports. Input port that triggers this output port. enum: `IN0`, `IN1`.'
    switch_matching_rule_ip_config2:
      title: switch_matching_rule_ip_config2
      type: object
      properties:
        network:
          type: string
          description: VLAN Name for the management interface
        type:
          allOf:
          - $ref: '#/components/schemas/ip_type11'
          - description: 'IP assignment mode for in-band switch management. enum: `dhcp`, `static`.'
            examples:
            - static
      description: In-band management IP configuration applied when this matching rule matches
    switch_matching_rule_oob_ip_config2:
      title: switch_matching_rule_oob_ip_config2
      type: object
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/ip_type12'
          - description: 'IP assignment mode for out-of-band switch management. enum: `dhcp`, `static`.'
            examples:
            - static
        use_mgmt_vrf:
          type: boolean
          description: If supported on the platform. If enabled, DNS will be using this routing-instance, too
          default: false
        use_mgmt_vrf_for_host_out:
          type: boolean
          description: For host-out traffic (NTP/TACPLUS/RADIUS/SYSLOG/SNMP), if alternative source network/ip is desired
          default: false
      description: Out-of-band management IP configuration applied when this matching rule matches
    switch_matching1:
      title: switch_matching1
      type: object
      properties:
        enable:
          type: boolean
          description: Whether custom switch matching rules are enabled
        rules:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/switch_matching_rule'
          description: Switch matching rules evaluated to apply custom configuration
      description: Rules for matching switches to model-specific settings
    switch_matching3:
      title: switch_matching3
      type: object
      properties:
        enable:
          type: boolean
          description: Whether custom switch matching rules are enabled
        rules:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/switch_matching_rule'
          description: Switch matching rules evaluated to apply custom configuration
      description: Matching rules that select switches for this network template
    switch_metrics_active_ports_summary_details2:
      title: switch_metrics_active_ports_summary_details2
      type: object
      properties:
        active_port_count:
          type: integer
          description: Number of active ports observed across evaluated switches
          contentEncoding: int32
        total_port_count:
          type: integer
          description: Total number of ports evaluated for the active-port metric
          contentEncoding: int32
      description: Port counts used to calculate the active-port summary metric
    switch_mgmt1:
      title: switch_mgmt1
      type: object
      properties:
        ap_affinity_threshold:
          type: integer
          description: AP affinity threshold for switch management. If set in both site settings and organization settings, the site setting value is used.
          contentEncoding: int32
          default: 10
        cli_banner:
          type: string
          description: Set Banners for switches. Allows markup formatting
          examples:
          - '\t\tWELCOME!'
        cli_idle_timeout:
          maximum: 60
          minimum: 1
          type: integer
          description: Sets timeout for switches
          contentEncoding: int32
        config_revert_timer:
          maximum: 30
          minimum: 1
          type: integer
          description: Rollback timer for commit confirmed
          contentEncoding: int32
          default: 10
        dhcp_option_fqdn:
          type: boolean
          description: Enable to provide the FQDN with DHCP option 81
          default: false
        disable_oob_down_alarm:
          type: boolean
          description: Whether to suppress alarms when the switch out-of-band management interface is down
        fips_enabled:
          type: boolean
          description: Whether FIPS mode is enabled on the switch
          default: false
        local_accounts:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/config_switch_local_accounts_user'
          description: Local switch user accounts keyed by username
        mxedge_proxy_host:
          type: string
          description: IP address or FQDN of the Mist Edge used to proxy the switch management traffic to the Mist Cloud
        mxedge_proxy_port:
          anyOf:
          - maximum: 65535
            minimum: 1
            type: integer
            contentEncoding: int32
            default: 2222
          - type: string
          description: Mist Edge proxy port used for switch management traffic
        protect_re:
          allOf:
          - $ref: '#/components/schemas/protect_re3'
          - description: Control-plane protection settings for the switch
        radius:
          allOf:
          - $ref: '#/components/schemas/switch_radius2'
          - description: Management authentication settings using RADIUS
        remove_existing_configs:
          type: boolean
          description: By default, only the configuration generated by Mist is cleaned up during the configuration process. If `true`, all the existing configuration will be removed.
          default: false
        root_password:
          type: string
          description: Root password for local switch access
          contentEncoding: password
        tacacs:
          allOf:
          - $ref: '#/components/schemas/tacacs2'
          - description: Management authentication settings using TACACS+
        use_mxedge_proxy:
          type: boolean
          description: Whether to use Mist Edge as a proxy for switch management traffic
      description: Management-plane defaults provided by this switch profile
    switch_mgmt2:
      title: switch_mgmt2
      type: object
      properties:
        ap_affinity_threshold:
          type: integer
          description: AP affinity threshold for switch management. If set in both site settings and organization settings, the site setting value is used.
          contentEncoding: int32
          default: 10
        cli_banner:
          type: string
          description: Set Banners for switches. Allows markup formatting
          examples:
          - '\t\tWELCOME!'
        cli_idle_timeout:
          maximum: 60
          minimum: 1
          type: integer
          description: Sets timeout for switches
          contentEncoding: int32
        config_revert_timer:
          maximum: 30
          minimum: 1
          type: integer
          description: Rollback timer for commit confirmed
          contentEncoding: int32
          default: 10
        dhcp_option_fqdn:
          type: boolean
          description: Enable to provide the FQDN with DHCP option 81
          default: false
        disable_oob_down_alarm:
          type: boolean
          description: Whether to suppress alarms when the switch out-of-band management interface is down
        fips_enabled:
          type: boolean
          description: Whether FIPS mode is enabled on the switch
          default: false
        local_accounts:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/config_switch_local_accounts_user'
          description: Local switch user accounts keyed by username
        mxedge_proxy_host:
          type: string
          description: IP address or FQDN of the Mist Edge used to proxy the switch management traffic to the Mist Cloud
        mxedge_proxy_port:
          anyOf:
          - maximum: 65535
            minimum: 1
            type: integer
            contentEncoding: int32
            default: 2222
          - type: string
          description: Mist Edge proxy port used for switch management traffic
        protect_re:
          allOf:
          - $ref: '#/components/schemas/protect_re3'
          - description: Control-plane protection settings for the switch
        radius:
          allOf:
          - $ref: '#/components/schemas/switch_radius2'
          - description: Management authentication settings using RADIUS
        remove_existing_configs:
          type: boolean
          description: By default, only the configuration generated by Mist is cleaned up during the configuration process. If `true`, all the existing configuration will be removed.
          default: false
        root_password:
          type: string
          description: Root password for local switch access
          contentEncoding: password
        tacacs:
          allOf:
          - $ref: '#/components/schemas/tacacs2'
          - description: Management authentication settings using TACACS+
        use_mxedge_proxy:
          type: boolean
          description: Whether to use Mist Edge as a proxy for switch management traffic
      description: Management-plane settings applied when this matching rule matches
    switch_mgmt3:
      title: switch_mgmt3
      type: object
      properties:
        ap_affinity_threshold:
          type: integer
          description: AP affinity threshold for switch management. If set in both site settings and organization settings, the site setting value is used.
          contentEncoding: int32
          default: 10
        cli_banner:
          type: string
          description: Set Banners for switches. Allows markup formatting
          examples:
          - '\t\tWELCOME!'
        cli_idle_timeout:
          maximum: 60
          minimum: 1
          type: integer
          description: Sets timeout for switches
          contentEncoding: int32
        config_revert_timer:
          maximum: 30
          minimum: 1
          type: integer
          description: Rollback timer for commit confirmed
          contentEncoding: int32
          default: 10
        dhcp_option_fqdn:
          type: boolean
          description: Enable to provide the FQDN with DHCP option 81
          default: false
        disable_oob_down_alarm:
          type: boolean
          description: Whether to suppress alarms when the switch out-of-band management interface is down
        fips_enabled:
          type: boolean
          description: Whether FIPS mode is enabled on the switch
          default: false
        local_accounts:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/config_switch_local_accounts_user'
          description: Local switch user accounts keyed by username
        mxedge_proxy_host:
          type: string
          description: IP address or FQDN of the Mist Edge used to proxy the switch management traffic to the Mist Cloud
        mxedge_proxy_port:
          anyOf:
          - maximum: 65535
            minimum: 1
            type: integer
            contentEncoding: int32
            default: 2222
          - type: string
          description: Mist Edge proxy port used for switch management traffic
        protect_re:
          allOf:
          - $ref: '#/components/schemas/protect_re3'
          - description: Control-plane protection settings for the switch
        radius:
          allOf:
          - $ref: '#/components/schemas/switch_radius2'
          - description: Management authentication settings using RADIUS
        remove_existing_configs:
          type: boolean
          description: By default, only the configuration generated by Mist is cleaned up during the configuration process. If `true`, all the existing configuration will be removed.
          default: false
        root_password:
          type: string
          description: Root password for local switch access
          contentEncoding: password
        tacacs:
          allOf:
          - $ref: '#/components/schemas/tacacs2'
          - description: Management authentication settings using TACACS+
        use_mxedge_proxy:
          type: boolean
          description: Whether to use Mist Edge as a proxy for switch management traffic
      description: Management-plane defaults provided by this network template
    switch_mgmt4:
      title: switch_mgmt4
      type: object
      properties:
        ap_affinity_threshold:
          type: integer
          description: AP affinity threshold for switch management. If set in both site settings and organization settings, the site setting value is used.
          contentEncoding: int32
          default: 10
        cli_banner:
          type: string
          description: Set Banners for switches. Allows markup formatting
          examples:
          - '\t\tWELCOME!'
        cli_idle_timeout:
          maximum: 60
          minimum: 1
          type: integer
          description: Sets timeout for switches
          contentEncoding: int32
        config_revert_timer:
          maximum: 30
          minimum: 1
          type: integer
          description: Rollback timer for commit confirmed
          contentEncoding: int32
          default: 10
        dhcp_option_fqdn:
          type: boolean
          description: Enable to provide the FQDN with DHCP option 81
          default: false
        disable_oob_down_alarm:
          type: boolean
          description: Whether to suppress alarms when the switch out-of-band management interface is down
        fips_enabled:
          type: boolean
          description: Whether FIPS mode is enabled on the switch
          default: false
        local_accounts:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/config_switch_local_accounts_user'
          description: Local switch user accounts keyed by username
        mxedge_proxy_host:
          type: string
          description: IP address or FQDN of the Mist Edge used to proxy the switch management traffic to the Mist Cloud
        mxedge_proxy_port:
          anyOf:
          - maximum: 65535
            minimum: 1
            type: integer
            contentEncoding: int32
            default: 2222
          - type: string
          description: Mist Edge proxy port used for switch management traffic
        protect_re:
          allOf:
          - $ref: '#/components/schemas/protect_re3'
          - description: Control-plane protection settings for the switch
        radius:
          allOf:
          - $ref: '#/components/schemas/switch_radius2'
          - description: Management authentication settings using RADIUS
        remove_existing_configs:
          type: boolean
          description: By default, only the configuration generated by Mist is cleaned up during the configuration process. If `true`, all the existing configuration will be removed.
          default: false
        root_password:
          type: string
          description: Root password for local switch access
          contentEncoding: password
        tacacs:
          allOf:
          - $ref: '#/components/schemas/tacacs2'
          - description: Management authentication settings using TACACS+
        use_mxedge_proxy:
          type: boolean
          description: Whether to use Mist Edge as a proxy for switch management traffic
      description: Management access settings for switches at the site
    switch_mgmt6:
      title: switch_mgmt6
      type: object
      properties:
        ap_affinity_threshold:
          type: integer
          description: AP affinity threshold for switch management. If set in both site settings and organization settings, the site setting value is used.
          contentEncoding: int32
          default: 10
        cli_banner:
          type: string
          description: Set Banners for switches. Allows markup formatting
          examples:
          - '\t\tWELCOME!'
        cli_idle_timeout:
          maximum: 60
          minimum: 1
          type: integer
          description: Sets timeout for switches
          contentEncoding: int32
        config_revert_timer:
          maximum: 30
          minimum: 1
          type: integer
          description: Rollback timer for commit confirmed
          contentEncoding: int32
          default: 10
        dhcp_option_fqdn:
          type: boolean
          description: Enable to provide the FQDN with DHCP option 81
          default: false
        disable_oob_down_alarm:
          type: boolean
          description: Whether to suppress alarms when the switch out-of-band management interface is down
        fips_enabled:
          type: boolean
          description: Whether FIPS mode is enabled on the switch
          default: false
        local_accounts:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/config_switch_local_accounts_user'
          description: Local switch user accounts keyed by username
        mxedge_proxy_host:
          type: string
          description: IP address or FQDN of the Mist Edge used to proxy the switch management traffic to the Mist Cloud
        mxedge_proxy_port:
          anyOf:
          - maximum: 65535
            minimum: 1
            type: integer
            contentEncoding: int32
            default: 2222
          - type: string
          description: Mist Edge proxy port used for switch management traffic
        protect_re:
          allOf:
          - $ref: '#/components/schemas/protect_re3'
          - description: Control-plane protection settings for the switch
        radius:
          allOf:
          - $ref: '#/components/schemas/switch_radius2'
          - description: Management authentication settings using RADIUS
        remove_existing_configs:
          type: boolean
          description: By default, only the configuration generated by Mist is cleaned up during the configuration process. If `true`, all the existing configuration will be removed.
          default: false
        root_password:
          type: string
          description: Root password for local switch access
          contentEncoding: password
        tacacs:
          allOf:
          - $ref: '#/components/schemas/tacacs2'
          - description: Management authentication settings using TACACS+
        use_mxedge_proxy:
          type: boolean
          description: Whether to use Mist Edge as a proxy for switch management traffic
      description: Management-plane settings for this switch
    switch_mist_nac1:
      title: switch_mist_nac1
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether Mist NAC RadSec is enabled for the switch
        network:
          type: string
          description: Switch network used for Mist NAC RadSec connectivity
      description: Mist NAC defaults applied by this switch profile
    switch_mist_nac2:
      title: switch_mist_nac2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether Mist NAC RadSec is enabled for the switch
        network:
          type: string
          description: Switch network used for Mist NAC RadSec connectivity
      description: Mist NAC defaults applied by this network template
    switch_mist_nac3:
      title: switch_mist_nac3
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether Mist NAC RadSec is enabled for the switch
        network:
          type: string
          description: Switch network used for Mist NAC RadSec connectivity
      description: Network access control settings for switches at the site
    switch_mist_nac5:
      title: switch_mist_nac5
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether Mist NAC RadSec is enabled for the switch
        network:
          type: string
          description: Switch network used for Mist NAC RadSec connectivity
      description: Mist NAC settings applied to this switch
    switch_multicast_config1:
      title: switch_multicast_config1
      type: object
      properties:
        anycast_rp:
          type: boolean
          description: When `true`, auto-generates a shared RP on `is_l3_border` devices (ERB/IPClos topologies only)
          default: false
        rp_ip:
          type: string
          description: RP address used when `anycast_rp`==`false`. If the address matches a device SVI, it is configured as a local RP; otherwise a static RP is configured
          examples:
          - 10.2.1.10
        sbd_subnet:
          type: string
          description: SBD IRB subnet; Mist auto-assigns per-device IPs from this range (EVPN eOISM only)
          examples:
          - 10.99.0.0/24
        sbd_vlan_id:
          type: integer
          description: Supplemental Bridge Domain VLAN ID (EVPN topology / eOISM only)
          contentEncoding: int32
          examples:
          - 3900
      description: Multicast settings for networks in the master VRF (not assigned to any vrf_instances); PIM is automatically enabled when any master-VRF network has `multicast.enabled`==`true`
    switch_multicast_config3:
      title: switch_multicast_config3
      type: object
      properties:
        anycast_rp:
          type: boolean
          description: When `true`, auto-generates a shared RP on `is_l3_border` devices (ERB/IPClos topologies only)
          default: false
        rp_ip:
          type: string
          description: RP address used when `anycast_rp`==`false`. If the address matches a device SVI, it is configured as a local RP; otherwise a static RP is configured
          examples:
          - 10.2.1.10
        sbd_subnet:
          type: string
          description: SBD IRB subnet; Mist auto-assigns per-device IPs from this range (EVPN eOISM only)
          examples:
          - 10.99.0.0/24
        sbd_vlan_id:
          type: integer
          description: Supplemental Bridge Domain VLAN ID (EVPN topology / eOISM only)
          contentEncoding: int32
          examples:
          - 3900
      description: Multicast configuration for this VRF instance. PIM is automatically enabled when any network in this VRF has `multicast.enabled`==`true`
    switch_network_multicast2:
      title: switch_network_multicast2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether to enable IGMP snooping on this VLAN
          default: false
        igmp_version:
          allOf:
          - $ref: '#/components/schemas/switch_network_multicast_igmp_version'
          - description: IGMP version. '2' (default, ASM/IGMPv2) / '3' (SSM/IGMPv3)
      description: Multicast (IGMP snooping) settings for this VLAN
    switch_oob_ip_config1:
      title: switch_oob_ip_config1
      type: object
      properties:
        gateway:
          type: string
          description: Default gateway for the out-of-band management interface when `type`==`static`
        ip:
          type: string
          description: Static IPv4 address for the out-of-band management interface when `type`==`static`
        netmask:
          type: string
          description: Used only if `subnet` is not specified in `networks`
        network:
          type: string
          description: Optional, the network to be used for mgmt
        type:
          allOf:
          - $ref: '#/components/schemas/ip_type2'
          - description: 'IP assignment mode for the out-of-band management interface. enum: `dhcp`, `static`.'
            examples:
            - static
        use_mgmt_vrf:
          type: boolean
          description: If supported on the platform. If enabled, DNS will be using this routing-instance, too
          default: false
        use_mgmt_vrf_for_host_out:
          type: boolean
          description: For host-out traffic (NTP/TACPLUS/RADIUS/SYSLOG/SNMP), if alternative source network/ip is desired
          default: false
      description: Out-of-band management IP defaults in this switch profile
    switch_oob_ip_config3:
      title: switch_oob_ip_config3
      type: object
      properties:
        gateway:
          type: string
          description: Default gateway for the out-of-band management interface when `type`==`static`
        ip:
          type: string
          description: Static IPv4 address for the out-of-band management interface when `type`==`static`
        netmask:
          type: string
          description: Used only if `subnet` is not specified in `networks`
        network:
          type: string
          description: Optional, the network to be used for mgmt
        type:
          allOf:
          - $ref: '#/components/schemas/ip_type2'
          - description: 'IP assignment mode for the out-of-band management interface. enum: `dhcp`, `static`.'
            examples:
            - static
        use_mgmt_vrf:
          type: boolean
          description: If supported on the platform. If enabled, DNS will be using this routing-instance, too
          default: false
        use_mgmt_vrf_for_host_out:
          type: boolean
          description: For host-out traffic (NTP/TACPLUS/RADIUS/SYSLOG/SNMP), if alternative source network/ip is desired
          default: false
      description: Out-of-band management IP configuration for this switch
    switch_ospf_config2:
      title: switch_ospf_config2
      type: object
      properties:
        areas:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/switch_ospf_config_area'
          description: OSPF areas configured on the switch
        enabled:
          type: boolean
          description: Enable OSPF on the switch
          default: false
        export_policy:
          type: string
          description: optional, for basic scenario, `import_policy` can be specified and can be applied to all networks in all areas if not explicitly specified
        import_policy:
          type: string
          description: optional, for basic scenario, `import_policy` can be specified and can be applied to all networks in all areas if not explicitly specified
        reference_bandwidth:
          anyOf:
          - type: integer
            contentEncoding: int32
          - type: string
          description: Reference bandwidth used for OSPF cost calculation
          examples:
          - '100000'
      description: OSPF routing configuration for this switch
    switch_port_local_usage_dot1x2:
      title: switch_port_local_usage_dot1x2
      const: dot1x
      type: string
      description: '802.1X authentication mode for this local port configuration. enum: `dot1x`.'
    switch_port_local_usage_duplex2:
      title: switch_port_local_usage_duplex2
      enum:
      - auto
      - full
      - half
      type: string
      description: 'Link duplex mode for this local port configuration. enum: `auto`, `full`, `half`.'
    switch_port_local_usage_mac_auth_protocol2:
      title: switch_port_local_usage_mac_auth_protocol2
      enum:
      - eap-md5
      - eap-peap
      - pap
      type: string
      description: 'Only if `enable_mac_auth`==`true`, MAC authentication protocol to use. enum: `eap-md5`, `eap-peap`, `pap`.'
    switch_port_local_usage_mode2:
      title: switch_port_local_usage_mode2
      enum:
      - access
      - inet
      - trunk
      type: string
      description: 'Switching mode for this local port configuration. enum: `access`, `inet`, `trunk`.'
    switch_port_usage_dot1x2:
      title: switch_port_usage_dot1x2
      const: dot1x
      type: string
      description: 'Only if `mode`!=`dynamic`. 802.1X authentication mode for this port usage. enum: `dot1x`.'
    switch_port_usage_duplex_overwrite2:
      title: switch_port_usage_duplex_overwrite2
      enum:
      - auto
      - full
      - half
      type: string
      description: 'Link duplex mode override for the switch port. enum: `auto`, `full`, `half`.'
    switch_port_usage_duplex2:
      title: switch_port_usage_duplex2
      enum:
      - auto
      - full
      - half
      type: string
      description: 'Only if `mode`!=`dynamic`. Link duplex mode for this port usage. enum: `auto`, `full`, `half`.'
    switch_port_usage_dynamic_reset_default_when2:
      title: switch_port_usage_dynamic_reset_default_when2
      enum:
      - link_down
      - none
      type: string
      description: 'Only if `mode`==`dynamic`. Condition that resets a dynamic port to the default port usage. enum: `link_down`, `none`.'
      examples:
      - link_down
    switch_port_usage_dynamic_rule_src2:
      title: switch_port_usage_dynamic_rule_src2
      enum:
      - link_peermac
      - lldp_chassis_id
      - lldp_hardware_revision
      - lldp_manufacturer_name
      - lldp_oui
      - lldp_serial_number
      - lldp_system_description
      - lldp_system_name
      - radius_dynamicfilter
      - radius_usermac
      - radius_username
      type: string
      description: 'Source attribute evaluated by this dynamic rule. enum: `link_peermac`, `lldp_chassis_id`, `lldp_hardware_revision`, `lldp_manufacturer_name`, `lldp_oui`, `lldp_serial_number`, `lldp_system_description`, `lldp_system_name`, `radius_dynamicfilter`, `radius_usermac`, `radius_username`.'
    switch_port_usage_mac_auth_protocol2:
      title: switch_port_usage_mac_auth_protocol2
      enum:
      - eap-md5
      - eap-peap
      - pap
      type: string
      description: 'Only if `mode`!=`dynamic` and `enable_mac_auth`==`true`. MAC authentication protocol to use; ignored if Mist NAC is enabled. enum: `eap-md5`, `eap-peap`, `pap`.'
    switch_port_usage_mode2:
      title: switch_port_usage_mode2
      enum:
      - access
      - dynamic
      - inet
      - trunk
      type: string
      description: 'Switching mode for this port usage. enum: `access`, `dynamic`, `inet`, `trunk`.'
    switch_port_usage_speed_overwrite2:
      title: switch_port_usage_speed_overwrite2
      enum:
      - 10m
      - 100m
      - 1g
      - 2.5g
      - 5g
      - 10g
      - 25g
      - 40g
      - 100g
      - auto
      type: string
      description: 'Link speed override for the switch port. enum: `10m`, `100m`, `1g`, `2.5g`, `5g`, `10g`, `25g`, `40g`, `100g`, `auto`.'
    switch_port_usage_speed2:
      title: switch_port_usage_speed2
      enum:
      - 10m
      - 100m
      - 1g
      - 2.5g
      - 5g
      - 10g
      - 25g
      - 40g
      - 100g
      - auto
      type: string
      description: 'Only if `mode`!=`dynamic`. Link speed for this port usage. enum: `10m`, `100m`, `1g`, `2.5g`, `5g`, `10g`, `25g`, `40g`, `100g`, `auto`.'
    switch_port_usage_storm_control2:
      title: switch_port_usage_storm_control2
      type: object
      properties:
        disable_port:
          type: boolean
          description: Whether to disable the port when storm control is triggered
          default: false
        no_broadcast:
          type: boolean
          description: Whether to disable storm control on broadcast traffic
          default: false
        no_multicast:
          type: boolean
          description: Whether to disable storm control on multicast traffic
          default: false
        no_registered_multicast:
          type: boolean
          description: Whether to disable storm control on registered multicast traffic
          default: false
        no_unknown_unicast:
          type: boolean
          description: Whether to disable storm control on unknown unicast traffic
          default: false
        percentage:
          maximum: 100
          minimum: 0
          type: integer
          description: Bandwidth-percentage, configures the storm control level as a percentage of the available bandwidth
          contentEncoding: int32
          default: 80
      description: Only if `mode`!=`dynamic`. Storm-control settings for this port usage
    switch_radius_config_auth_server_selection2:
      title: switch_radius_config_auth_server_selection2
      enum:
      - ordered
      - unordered
      type: string
      description: 'Selection strategy for RADIUS authentication servers. enum: `ordered`, `unordered`.'
    switch_radius_config1:
      title: switch_radius_config1
      type: object
      properties:
        acct_immediate_update:
          type: boolean
          description: Whether immediate RADIUS accounting updates are sent
        acct_interim_interval:
          maximum: 65535
          minimum: 0
          type: integer
          description: How frequently should interim accounting be reported, 60-65535. default is 0 (use one specified in Access-Accept request from RADIUS Server). Very frequent messages can affect the performance of the RADIUS server, 600 and up is recommended when enabled
          contentEncoding: int32
          default: 0
        acct_servers:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/radius_acct_server'
          description: RADIUS accounting servers used by this switch configuration
        auth_server_selection:
          allOf:
          - $ref: '#/components/schemas/switch_radius_config_auth_server_selection2'
          - description: 'Selection strategy for RADIUS authentication servers. enum: `ordered`, `unordered`.'
        auth_servers:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/radius_auth_server'
          description: RADIUS authentication servers used by this switch configuration
        auth_servers_retries:
          type: integer
          description: RADIUS auth session retries
          contentEncoding: int32
          default: 3
        auth_servers_timeout:
          type: integer
          description: RADIUS auth session timeout
          contentEncoding: int32
          default: 5
        coa_enabled:
          type: boolean
          description: Whether RADIUS Change of Authorization (CoA) is enabled
          default: false
        coa_port:
          anyOf:
          - maximum: 65545
            minimum: 1
            type: integer
            contentEncoding: int32
          - type: string
          description: UDP port used for RADIUS Change of Authorization (CoA)
        fast_dot1x_timers:
          type: boolean
          description: Whether fast 802.1X timers are enabled for RADIUS authentication
          default: false
        network:
          type: string
          description: Use `network`or `source_ip`. Which network the RADIUS server resides, if there's static IP for this network, we'd use it as source-ip
        source_ip:
          type: string
          description: Use `network` or `source_ip`. Explicit source IP address for RADIUS traffic
      description: RADIUS configuration used when alternate RADIUS settings are required
    switch_radius_config2:
      title: switch_radius_config2
      type: object
      properties:
        acct_immediate_update:
          type: boolean
          description: Whether immediate RADIUS accounting updates are sent
        acct_interim_interval:
          maximum: 65535
          minimum: 0
          type: integer
          description: How frequently should interim accounting be reported, 60-65535. default is 0 (use one specified in Access-Accept request from RADIUS Server). Very frequent messages can affect the performance of the RADIUS server, 600 and up is recommended when enabled
          contentEncoding: int32
          default: 0
        acct_servers:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/radius_acct_server'
          description: RADIUS accounting servers used by this switch configuration
        auth_server_selection:
          allOf:
          - $ref: '#/components/schemas/switch_radius_config_auth_server_selection2'
          - description: 'Selection strategy for RADIUS authentication servers. enum: `ordered`, `unordered`.'
        auth_servers:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/radius_auth_server'
          description: RADIUS authentication servers used by this switch configuration
        auth_servers_retries:
          type: integer
          description: RADIUS auth session retries
          contentEncoding: int32
          default: 3
        auth_servers_timeout:
          type: integer
          description: RADIUS auth session timeout
          contentEncoding: int32
          default: 5
        coa_enabled:
          type: boolean
          description: Whether RADIUS Change of Authorization (CoA) is enabled
          default: false
        coa_port:
          anyOf:
          - maximum: 65545
            minimum: 1
            type: integer
            contentEncoding: int32
          - type: string
          description: UDP port used for RADIUS Change of Authorization (CoA)
        fast_dot1x_timers:
          type: boolean
          description: Whether fast 802.1X timers are enabled for RADIUS authentication
          default: false
        network:
          type: string
          description: Use `network`or `source_ip`. Which network the RADIUS server resides, if there's static IP for this network, we'd use it as source-ip
        source_ip:
          type: string
          description: Use `network` or `source_ip`. Explicit source IP address for RADIUS traffic
      description: RADIUS authentication and accounting defaults in this switch profile
    switch_radius_config3:
      title: switch_radius_config3
      type: object
      properties:
        acct_immediate_update:
          type: boolean
          description: Whether immediate RADIUS accounting updates are sent
        acct_interim_interval:
          maximum: 65535
          minimum: 0
          type: integer
          description: How frequently should interim accounting be reported, 60-65535. default is 0 (use one specified in Access-Accept request from RADIUS Server). Very frequent messages can affect the performance of the RADIUS server, 600 and up is recommended when enabled
          contentEncoding: int32
          default: 0
        acct_servers:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/radius_acct_server'
          description: RADIUS accounting servers used by this switch configuration
        auth_server_selection:
          allOf:
          - $ref: '#/components/schemas/switch_radius_config_auth_server_selection2'
          - description: 'Selection strategy for RADIUS authentication servers. enum: `ordered`, `unordered`.'
        auth_servers:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/radius_auth_server'
          description: RADIUS authentication servers used by this switch configuration
        auth_servers_retries:
          type: integer
          description: RADIUS auth session retries
          contentEncoding: int32
          default: 3
        auth_servers_timeout:
          type: integer
          description: RADIUS auth session timeout
          contentEncoding: int32
          default: 5
        coa_enabled:
          type: boolean
          description: Whether RADIUS Change of Authorization (CoA) is enabled
          default: false
        coa_port:
          anyOf:
          - maximum: 65545
            minimum: 1
            type: integer
            contentEncoding: int32
          - type: string
          description: UDP port used for RADIUS Change of Authorization (CoA)
        fast_dot1x_timers:
          type: boolean
          description: Whether fast 802.1X timers are enabled for RADIUS authentication
          default: false
        network:
          type: string
          description: Use `network`or `source_ip`. Which network the RADIUS server resides, if there's static IP for this network, we'd use it as source-ip
        source_ip:
          type: string
          description: Use `network` or `source_ip`. Explicit source IP address for RADIUS traffic
      description: RADIUS authentication and accounting defaults in this network template
    switch_radius_config4:
      title: switch_radius_config4
      type: object
      properties:
        acct_immediate_update:
          type: boolean
          description: Whether immediate RADIUS accounting updates are sent
        acct_interim_interval:
          maximum: 65535
          minimum: 0
          type: integer
          description: How frequently should interim accounting be reported, 60-65535. default is 0 (use one specified in Access-Accept request from RADIUS Server). Very frequent messages can affect the performance of the RADIUS server, 600 and up is recommended when enabled
          contentEncoding: int32
          default: 0
        acct_servers:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/radius_acct_server'
          description: RADIUS accounting servers used by this switch configuration
        auth_server_selection:
          allOf:
          - $ref: '#/components/schemas/switch_radius_config_auth_server_selection2'
          - description: 'Selection strategy for RADIUS authentication servers. enum: `ordered`, `unordered`.'
        auth_servers:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/radius_auth_server'
          description: RADIUS authentication servers used by this switch configuration
        auth_servers_retries:
          type: integer
          description: RADIUS auth session retries
          contentEncoding: int32
          default: 3
        auth_servers_timeout:
          type: integer
          description: RADIUS auth session timeout
          contentEncoding: int32
          default: 5
        coa_enabled:
          type: boolean
          description: Whether RADIUS Change of Authorization (CoA) is enabled
          default: false
        coa_port:
          anyOf:
          - maximum: 65545
            minimum: 1
            type: integer
            contentEncoding: int32
          - type: string
          description: UDP port used for RADIUS Change of Authorization (CoA)
        fast_dot1x_timers:
          type: boolean
          description: Whether fast 802.1X timers are enabled for RADIUS authentication
          default: false
        network:
          type: string
          description: Use `network`or `source_ip`. Which network the RADIUS server resides, if there's static IP for this network, we'd use it as source-ip
        source_ip:
          type: string
          description: Use `network` or `source_ip`. Explicit source IP address for RADIUS traffic
      description: Switch RADIUS configuration for the site
    switch_radius_config6:
      title: switch_radius_config6
      type: object
      properties:
        acct_immediate_update:
          type: boolean
          description: Whether immediate RADIUS accounting updates are sent
        acct_interim_interval:
          maximum: 65535
          minimum: 0
          type: integer
          description: How frequently should interim accounting be reported, 60-65535. default is 0 (use one specified in Access-Accept request from RADIUS Server). Very frequent messages can affect the performance of the RADIUS server, 600 and up is recommended when enabled
          contentEncoding: int32
          default: 0
        acct_servers:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/radius_acct_server'
          description: RADIUS accounting servers used by this switch configuration
        auth_server_selection:
          allOf:
          - $ref: '#/components/schemas/switch_radius_config_auth_server_selection2'
          - description: 'Selection strategy for RADIUS authentication servers. enum: `ordered`, `unordered`.'
        auth_servers:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/radius_auth_server'
          description: RADIUS authentication servers used by this switch configuration
        auth_servers_retries:
          type: integer
          description: RADIUS auth session retries
          contentEncoding: int32
          default: 3
        auth_servers_timeout:
          type: integer
          description: RADIUS auth session timeout
          contentEncoding: int32
          default: 5
        coa_enabled:
          type: boolean
          description: Whether RADIUS Change of Authorization (CoA) is enabled
          default: false
        coa_port:
          anyOf:
          - maximum: 65545
            minimum: 1
            type: integer
            contentEncoding: int32
          - type: string
          description: UDP port used for RADIUS Change of Authorization (CoA)
        fast_dot1x_timers:
          type: boolean
          description: Whether fast 802.1X timers are enabled for RADIUS authentication
          default: false
        network:
          type: string
          description: Use `network`or `source_ip`. Which network the RADIUS server resides, if there's static IP for this network, we'd use it as source-ip
        source_ip:
          type: string
          description: Use `network` or `source_ip`. Explicit source IP address for RADIUS traffic
      description: RADIUS authentication and accounting settings for this switch
    switch_radius2:
      title: switch_radius2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether RADIUS is enabled for switch management authentication
        radius_config:
          allOf:
          - $ref: '#/components/schemas/switch_radius_config1'
          - description: RADIUS configuration used when alternate RADIUS settings are required
        use_different_radius:
          type: string
          description: Selector for alternate RADIUS settings instead of the default switch `radius_config`
      description: Management authentication settings using RADIUS
    switch_stp_config1:
      title: switch_stp_config1
      type: object
      properties:
        bridge_priority:
          type: string
          description: Switch STP priority. Range [0, 4k, 8k.. 60k] in steps of 4k. Bridge priority applies to both VSTP and RSTP.
          default: 32k
          examples:
          - 40k
      description: Spanning Tree Protocol defaults provided by this switch profile
    switch_stp_config2:
      title: switch_stp_config2
      type: object
      properties:
        bridge_priority:
          type: string
          description: Switch STP priority. Range [0, 4k, 8k.. 60k] in steps of 4k. Bridge priority applies to both VSTP and RSTP.
          default: 32k
          examples:
          - 40k
      description: Spanning Tree Protocol configuration applied when this matching rule matches
    switch_stp_config4:
      title: switch_stp_config4
      type: object
      properties:
        bridge_priority:
          type: string
          description: Switch STP priority. Range [0, 4k, 8k.. 60k] in steps of 4k. Bridge priority applies to both VSTP and RSTP.
          default: 32k
          examples:
          - 40k
      description: Spanning Tree Protocol configuration for this switch
    switch_virtual_chassis_member_vc_role2:
      title: switch_virtual_chassis_member_vc_role2
      enum:
      - backup
      - linecard
      - master
      type: string
      description: 'Role of this member in the Virtual Chassis. enum: `backup`, `linecard`, `master`.'
    switch_virtual_chassis2:
      title: switch_virtual_chassis2
      type: object
      properties:
        members:
          type: array
          items:
            $ref: '#/components/schemas/switch_virtual_chassis_member'
          description: Virtual Chassis members and their expected roles
        preprovisioned:
          type: boolean
          description: To configure whether the VC is preprovisioned or nonprovisioned
          default: false
      description: Virtual Chassis membership and provisioning settings for this switch
    synthetictest_config_aggressiveness1:
      title: synthetictest_config_aggressiveness1
      enum:
      - auto
      - high
      - med
      - low
      type: string
      description: 'Probe aggressiveness level for this custom synthetic probe. enum: `auto`, `high`, `med`, `low`.'
    synthetictest_config_aggressiveness3:
      title: synthetictest_config_aggressiveness3
      enum:
      - auto
      - high
      - med
      - low
      type: string
      description: 'Overall aggressiveness level for synthetic test probes. enum: `auto`, `high`, `med`, `low`.'
    synthetictest_config_custom_probe_type2:
      title: synthetictest_config_custom_probe_type2
      enum:
      - application
      - curl
      - icmp
      - reachability
      - tcp
      type: string
      description: 'Synthetic test type used for the Minis application result. enum: `application`, `curl`, `icmp`, `reachability`, `tcp`.'
    synthetictest_config_custom_probe_type3:
      title: synthetictest_config_custom_probe_type3
      enum:
      - application
      - curl
      - icmp
      - reachability
      - tcp
      type: string
      description: 'Probe type used by this custom synthetic probe. enum: `application`, `curl`, `icmp`, `reachability`, `tcp`.'
    synthetictest_config_wan_speedtest2:
      title: synthetictest_config_wan_speedtest2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether scheduled WAN speedtests are enabled
        time_of_day:
          type: string
          description: Scheduled time of day for WAN speedtests
          default: any
          examples:
          - 12:00
      description: WAN speedtest settings for synthetic tests
    synthetictest_config1:
      title: synthetictest_config1
      type: object
      properties:
        aggressiveness:
          allOf:
          - $ref: '#/components/schemas/synthetictest_config_aggressiveness3'
          - description: 'Overall aggressiveness level for synthetic test probes. enum: `auto`, `high`, `med`, `low`.'
        custom_probes:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/synthetictest_config_custom_probe'
          description: Custom synthetic probe definitions keyed by probe name
        disabled:
          type: boolean
          description: Whether synthetic tests are disabled
          default: false
        lan_networks:
          type: array
          items:
            $ref: '#/components/schemas/synthetictest_config_lan_network'
          description: LAN network probe groups used by synthetic tests
        vlans:
          type: array
          items:
            $ref: '#/components/schemas/synthetictest_config_vlan'
          description: Deprecated VLAN-based synthetic test settings
          deprecated: true
        wan_speedtest:
          allOf:
          - $ref: '#/components/schemas/synthetictest_config_wan_speedtest2'
          - description: WAN speedtest settings for synthetic tests
      description: Active monitoring test configuration for the site
    synthetictest_config3:
      title: synthetictest_config3
      type: object
      properties:
        aggressiveness:
          allOf:
          - $ref: '#/components/schemas/synthetictest_config_aggressiveness3'
          - description: 'Overall aggressiveness level for synthetic test probes. enum: `auto`, `high`, `med`, `low`.'
        custom_probes:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/synthetictest_config_custom_probe'
          description: Custom synthetic probe definitions keyed by probe name
        disabled:
          type: boolean
          description: Whether synthetic tests are disabled
          default: false
        lan_networks:
          type: array
          items:
            $ref: '#/components/schemas/synthetictest_config_lan_network'
          description: LAN network probe groups used by synthetic tests
        vlans:
          type: array
          items:
            $ref: '#/components/schemas/synthetictest_config_vlan'
          description: Deprecated VLAN-based synthetic test settings
          deprecated: true
        wan_speedtest:
          allOf:
          - $ref: '#/components/schemas/synthetictest_config_wan_speedtest2'
          - description: WAN speedtest settings for synthetic tests
      description: Configuration for organization synthetic tests
    synthetictest_device_protocol2:
      title: synthetictest_device_protocol2
      enum:
      - ping
      - ping+traceroute
      - traceroute
      type: string
      description: 'If `type`==`lan_connectivity`. Protocol or protocol combination used for the connectivity test. enum: `ping`, `ping+traceroute`, `traceroute`.'
    synthetictest_type1:
      title: synthetictest_type1
      enum:
      - arp
      - curl
      - dhcp
      - dhcp6
      - dns
      - lan_connectivity
      - radius
      - speedtest
      type: string
      description: 'Synthetic test type to run against the target. enum: `arp`, `curl`, `dhcp`, `dhcp6`, `dns`, `lan_connectivity`, `radius`, `speedtest`.'
    synthetictest_type3:
      title: synthetictest_type3
      enum:
      - arp
      - curl
      - dhcp
      - dhcp6
      - dns
      - lan_connectivity
      - radius
      - speedtest
      type: string
      description: 'Synthetic test type for this result. enum: `arp`, `curl`, `dhcp`, `dhcp6`, `dns`, `lan_connectivity`, `radius`, `speedtest`.'
    tacacs_default_role2:
      title: tacacs_default_role2
      enum:
      - admin
      - helpdesk
      - none
      - read
      type: string
      description: 'Default switch-management role to use for TACACS+ logins. enum: `admin`, `helpdesk`, `none`, `read`.'
    tacacs2:
      title: tacacs2
      type: object
      properties:
        acct_servers:
          type: array
          items:
            $ref: '#/components/schemas/tacacs_acct_server'
          description: TACACS+ accounting servers used for switch management sessions
        default_role:
          allOf:
          - $ref: '#/components/schemas/tacacs_default_role2'
          - description: 'Default switch-management role to use for TACACS+ logins. enum: `admin`, `helpdesk`, `none`, `read`.'
        enabled:
          type: boolean
          description: Whether TACACS+ is enabled for switch management authentication
        network:
          type: string
          description: Source network used for connectivity to the TACACS+ servers
        tacplus_servers:
          type: array
          items:
            $ref: '#/components/schemas/tacacs_auth_server'
          description: TACACS+ authentication servers used for switch management logins
      description: Management authentication settings using TACACS+
    template_applies2:
      title: template_applies2
      type: object
      properties:
        org_id:
          type: string
          description: Organization included in the WLAN template application scope
          contentEncoding: uuid
        site_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Sites included in the WLAN template application scope
        sitegroup_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Site groups included in the WLAN template application scope
      description: Organizations, sites, or site groups targeted by this WLAN template
    template_exceptions2:
      title: template_exceptions2
      type: object
      properties:
        site_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Sites excluded from the WLAN template application scope
        sitegroup_ids:
          type: array
          items:
            type: string
            contentEncoding: uuid
          description: Site groups excluded from the WLAN template application scope
      description: Sites or site groups excluded from this WLAN template even when included by the application scope
    test_cradlepoint_last_status2:
      title: test_cradlepoint_last_status2
      enum:
      - active
      - inactive
      type: string
      description: 'Integration status detected during the most recent Cradlepoint sync. enum: `active`, `inactive`.'
      examples:
      - inactive
    ticket_status2:
      title: ticket_status2
      enum:
      - closed
      - open
      - pending
      - solved
      type: string
      description: 'Current lifecycle status of this support ticket. enum: `closed`, `open`, `pending`, `solved`.'
    tunnel_config_auth_algo1:
      title: tunnel_config_auth_algo1
      enum:
      - md5
      - sha1
      - sha2
      type: string
      description: 'Integrity algorithm used by this IPsec proposal. enum: `md5`, `sha1`, `sha2`.'
    tunnel_config_auth_algo3:
      title: tunnel_config_auth_algo3
      enum:
      - md5
      - sha1
      - sha2
      type: string
      description: 'Integrity algorithm used by this IKE proposal. enum: `md5`, `sha1`, `sha2`.'
    tunnel_config_auto_provision_lat_lng2:
      title: tunnel_config_auto_provision_lat_lng2
      required:
      - lat
      - lng
      type: object
      properties:
        lat:
          type: number
          description: Geographic latitude used for POP selection override
          examples:
          - 37.295833
        lng:
          type: number
          description: Geographic longitude used for POP selection override
          examples:
          - -122.032946
      description: Geographic coordinate override used for tunnel POP selection
    tunnel_config_auto_provision_node1:
      title: tunnel_config_auto_provision_node1
      type: object
      properties:
        probe_ips:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Probe IP addresses used to monitor auto-provisioned tunnel reachability
        wan_names:
          type: array
          items:
            type: string
          description: WAN interface names used by the auto-provisioned tunnel endpoint
      description: Backup auto-provisioned tunnel endpoint settings
    tunnel_config_auto_provision_node3:
      title: tunnel_config_auto_provision_node3
      type: object
      properties:
        probe_ips:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Probe IP addresses used to monitor auto-provisioned tunnel reachability
        wan_names:
          type: array
          items:
            type: string
          description: WAN interface names used by the auto-provisioned tunnel endpoint
      description: Main auto-provisioned tunnel endpoint settings
    tunnel_config_auto_provision_provider2:
      title: tunnel_config_auto_provision_provider2
      enum:
      - jse-ipsec
      - zscaler-ipsec
      type: string
      description: 'Tunnel provider used for automatic endpoint provisioning. enum: `jse-ipsec`, `zscaler-ipsec`.'
    tunnel_config_auto_provision2:
      title: tunnel_config_auto_provision2
      required:
      - provider
      type: object
      properties:
        enabled:
          type: boolean
          description: Enable auto provisioning for the tunnel. If enabled, the `primary` and `secondary` nodes will be ignored.
        latlng:
          allOf:
          - $ref: '#/components/schemas/tunnel_config_auto_provision_lat_lng2'
          - description: Geographic coordinate override used for tunnel POP selection
        primary:
          allOf:
          - $ref: '#/components/schemas/tunnel_config_auto_provision_node3'
          - description: Main auto-provisioned tunnel endpoint settings
        provider:
          allOf:
          - $ref: '#/components/schemas/tunnel_config_auto_provision_provider2'
          - description: 'Tunnel provider used for automatic endpoint provisioning. enum: `jse-ipsec`, `zscaler-ipsec`.'
        region:
          type: string
          description: API override for POP selection in the case user wants to override the auto discovery of remote network location and force the tunnel to use the specified peer location.
        secondary:
          allOf:
          - $ref: '#/components/schemas/tunnel_config_auto_provision_node1'
          - description: Backup auto-provisioned tunnel endpoint settings
        service_connection:
          type: string
          description: if `provider`==`prisma-ipsec`. By default, we'll use the location of the site to determine the optimal Remote Network location, optionally, service_connection can be considered, then we'll also consider this along with the site location. Define service_connection if the traffic is to be routed to a specific service connection. This field takes a service connection name that is configured in the Prisma cloud, Prisma Access Setup -> Service Connections.
          examples:
          - Juniper-Lab-SC-1
      description: Provider auto-provisioning settings for tunnel endpoints
    tunnel_config_dh_group2:
      title: tunnel_config_dh_group2
      enum:
      - '1'
      - '14'
      - '15'
      - '16'
      - '19'
      - '2'
      - '20'
      - '21'
      - '24'
      - '5'
      type: string
      description: 'Diffie-Hellman group used by this IPsec proposal. enum: `1`, `14`, `15`, `16`, `19`, `2`, `20`, `21`, `24`, `5`.'
    tunnel_config_enc_algo1:
      title: tunnel_config_enc_algo1
      enum:
      - 3des
      - aes128
      - aes256
      - aes_gcm128
      - aes_gcm256
      type: string
      description: 'Cipher algorithm used by this IPsec proposal. enum: `3des`, `aes128`, `aes256`, `aes_gcm128`, `aes_gcm256`.'
    tunnel_config_enc_algo3:
      title: tunnel_config_enc_algo3
      enum:
      - 3des
      - aes128
      - aes256
      - aes_gcm128
      - aes_gcm256
      type: string
      description: 'Cipher algorithm used by this IKE proposal. enum: `3des`, `aes128`, `aes256`, `aes_gcm128`, `aes_gcm256`.'
    tunnel_config_ike_dh_group2:
      title: tunnel_config_ike_dh_group2
      enum:
      - '1'
      - '14'
      - '15'
      - '16'
      - '19'
      - '2'
      - '20'
      - '21'
      - '24'
      - '5'
      type: string
      description: 'Diffie-Hellman group used by this IKE proposal. enum: `1`, `14`, `15`, `16`, `19`, `2`, `20`, `21`, `24`, `5`.'
    tunnel_config_ike_mode2:
      title: tunnel_config_ike_mode2
      enum:
      - aggressive
      - main
      type: string
      description: 'Only if `provider`==`custom-ipsec`. IKE negotiation mode for the tunnel. enum: `aggressive`, `main`.'
    tunnel_config_node_probe_http2:
      title: tunnel_config_node_probe_http2
      type: object
      properties:
        accepted_status_codes:
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: HTTP response status codes that indicate a successful probe. Defaults to 200 if not specified.
          examples:
          - - 204
        urls:
          type: array
          items:
            type: string
          description: HTTP or HTTPS URLs to probe
          examples:
          - - http://www.google.com/generate_204
            - https://www.google.com/generate_204
      description: HTTP probe settings for this tunnel node; success from any ICMP or HTTP probe indicates the tunnel is up
    tunnel_config_node1:
      title: tunnel_config_node1
      required:
      - hosts
      - wan_names
      type: object
      properties:
        hosts:
          type: array
          items:
            type: string
          description: Remote gateway host addresses for this tunnel node
        internal_ip6s:
          uniqueItems: true
          type: array
          items:
            type: string
          description: IPv6 addresses configured on this tunnel node
        internal_ips:
          type: array
          items:
            type: string
          description: Internal IP addresses configured on this tunnel node
        probe_hostnames:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Hostnames used as ICMP probe destinations for this tunnel node; applicable for both IPv4 and IPv6
        probe_http:
          allOf:
          - $ref: '#/components/schemas/tunnel_config_node_probe_http2'
          - description: HTTP probe settings for this tunnel node; success from any ICMP or HTTP probe indicates the tunnel is up
        probe_ip6s:
          uniqueItems: true
          type: array
          items:
            type: string
          description: IPv6 ICMP probe addresses used to monitor this tunnel node
        probe_ips:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Health-check IP addresses used to monitor this tunnel node
        remote_ids:
          type: array
          items:
            type: string
          description: IKE identities expected from this tunnel node
        wan_names:
          type: array
          items:
            type: string
          description: Interface names that source tunnel traffic for this node
      description: Backup remote tunnel endpoint settings
    tunnel_config_node3:
      title: tunnel_config_node3
      required:
      - hosts
      - wan_names
      type: object
      properties:
        hosts:
          type: array
          items:
            type: string
          description: Remote gateway host addresses for this tunnel node
        internal_ip6s:
          uniqueItems: true
          type: array
          items:
            type: string
          description: IPv6 addresses configured on this tunnel node
        internal_ips:
          type: array
          items:
            type: string
          description: Internal IP addresses configured on this tunnel node
        probe_hostnames:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Hostnames used as ICMP probe destinations for this tunnel node; applicable for both IPv4 and IPv6
        probe_http:
          allOf:
          - $ref: '#/components/schemas/tunnel_config_node_probe_http2'
          - description: HTTP probe settings for this tunnel node; success from any ICMP or HTTP probe indicates the tunnel is up
        probe_ip6s:
          uniqueItems: true
          type: array
          items:
            type: string
          description: IPv6 ICMP probe addresses used to monitor this tunnel node
        probe_ips:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Health-check IP addresses used to monitor this tunnel node
        remote_ids:
          type: array
          items:
            type: string
          description: IKE identities expected from this tunnel node
        wan_names:
          type: array
          items:
            type: string
          description: Interface names that source tunnel traffic for this node
      description: Main remote tunnel endpoint settings
    tunnel_config_probe_type2:
      title: tunnel_config_probe_type2
      enum:
      - http
      - icmp
      type: string
      description: 'Protocol used by the custom IPsec tunnel health probe. enum: `http`, `icmp`.'
    tunnel_config_protocol2:
      title: tunnel_config_protocol2
      enum:
      - gre
      - ipsec
      type: string
      description: 'Only if `provider`==`custom-ipsec`. Tunnel protocol for custom tunnel negotiation. enum: `gre`, `ipsec`.'
    tunnel_config_provider2:
      title: tunnel_config_provider2
      enum:
      - custom-ipsec
      - custom-gre
      - jse-ipsec
      - prisma-ipsec
      - zscaler-gre
      - zscaler-ipsec
      type: string
      description: 'Tunnel provider used when auto provisioning is disabled. enum: `custom-ipsec`, `custom-gre`, `jse-ipsec`, `prisma-ipsec`, `zscaler-gre`, `zscaler-ipsec`.'
    tunnel_config_tunnel_mode2:
      title: tunnel_config_tunnel_mode2
      enum:
      - active-active
      - active-standby
      type: string
      description: 'Tunnel failover mode used for primary and secondary endpoints. enum: `active-active`, `active-standby`.'
    tunnel_config_version2:
      title: tunnel_config_version2
      enum:
      - '1'
      - '2'
      type: string
      description: 'Only if `provider`==`custom-gre` or `provider`==`custom-ipsec`. Tunnel version value for custom tunnel configuration. enum: `1`, `2`.'
    tunnel_priority1:
      title: tunnel_priority1
      enum:
      - primary
      - secondary
      type: string
      description: 'Relative preference assigned to the tunnel. enum: `primary`, `secondary`.'
    tunnel_provider_options_jse2:
      title: tunnel_provider_options_jse2
      type: object
      properties:
        num_users:
          type: integer
          description: User capacity to provision on Juniper Secure Edge
          contentEncoding: int32
          examples:
          - 5
        org_name:
          type: string
          description: JSE Organization name. The list of available organizations can be retrieved with the [Get Org JSE Info]($e/Orgs%20Integration%20JSE/getOrgJseInfo) API Call
          examples:
          - JSE_ORG1
      description: Juniper Secure Edge provisioning options for tunnel endpoints
    tunnel_provider_options_prisma2:
      title: tunnel_provider_options_prisma2
      type: object
      properties:
        service_account_name:
          type: string
          description: For prisma-ipsec, service account name to used for tunnel auto provisioning
          examples:
          - sa1@1823425211
      description: Palo Alto Prisma Access provisioning options for tunnel endpoints
    tunnel_provider_options_zscaler2:
      title: tunnel_provider_options_zscaler2
      type: object
      properties:
        aup_block_internet_until_accepted:
          type: boolean
          description: Whether Zscaler blocks internet access until the Acceptable Use Policy is accepted
          default: false
        aup_enabled:
          type: boolean
          description: Can only be `true` when `auth_required`==`false`, display Acceptable Use Policy (AUP)
          default: false
        aup_force_ssl_inspection:
          type: boolean
          description: Proxy HTTPs traffic, requiring Zscaler cert to be installed in browser
          default: false
        aup_timeout_in_days:
          maximum: 180
          minimum: 1
          type: integer
          description: Required if `aup_enabled`==`true`. Days before AUP is requested again
          contentEncoding: int32
        auth_required:
          type: boolean
          description: Enable this option to enforce user authentication
          default: false
        caution_enabled:
          type: boolean
          description: Can only be `true` when `auth_required`==`false`, display caution notification for non-authenticated users
          default: false
        dn_bandwidth:
          maximum: 99999
          minimum: 0.1
          type:
          - number
          - 'null'
          description: Download bandwidth cap of the link, in Mbps. Disabled if not set
          examples:
          - 200
        idle_time_in_minutes:
          maximum: 43200
          minimum: 0
          type: integer
          description: Required if `surrogate_IP`==`true`, idle Time to Disassociation
          contentEncoding: int32
        ofw_enabled:
          type: boolean
          description: If `true`, enable the firewall control option
          default: false
        sub_locations:
          type: array
          items:
            $ref: '#/components/schemas/tunnel_provider_options_zscaler_sub_location'
          description: Per-network Zscaler sub-location settings
        surrogate_IP:
          type: boolean
          description: Can only be `true` when `auth_required`==`true`. Map a user to a private IP address so it applies the user's policies, instead of the location's policies
          default: false
        surrogate_IP_enforced_for_known_browsers:
          type: boolean
          description: Can only be `true` when `surrogate_IP`==`true`, enforce surrogate IP for known browsers
        surrogate_refresh_time_in_minutes:
          maximum: 43200
          minimum: 1
          type: integer
          description: Required if `surrogate_IP_enforced_for_known_browsers`==`true`, must be lower or equal than `idle_time_in_minutes`, refresh Time for re-validation of Surrogacy
          contentEncoding: int32
        up_bandwidth:
          maximum: 99999
          minimum: 0.1
          type:
          - number
          - 'null'
          description: Download bandwidth cap of the link, in Mbps. Disabled if not set
          examples:
          - 200
        xff_forward_enabled:
          type: boolean
          description: Location uses proxy chaining to forward traffic
          default: false
      description: Provider settings for Zscaler tunnel endpoints
    tunnel_provider_options1:
      title: tunnel_provider_options1
      type: object
      properties:
        jse:
          allOf:
          - $ref: '#/components/schemas/tunnel_provider_options_jse2'
          - description: Juniper Secure Edge provisioning options for tunnel endpoints
        prisma:
          allOf:
          - $ref: '#/components/schemas/tunnel_provider_options_prisma2'
          - description: Palo Alto Prisma Access provisioning options for tunnel endpoints
        zscaler:
          allOf:
          - $ref: '#/components/schemas/tunnel_provider_options_zscaler2'
          - description: Provider settings for Zscaler tunnel endpoints
      description: Provider-specific tunnel options defined by this gateway profile
    tunnel_provider_options2:
      title: tunnel_provider_options2
      type: object
      properties:
        jse:
          allOf:
          - $ref: '#/components/schemas/tunnel_provider_options_jse2'
          - description: Juniper Secure Edge provisioning options for tunnel endpoints
        prisma:
          allOf:
          - $ref: '#/components/schemas/tunnel_provider_options_prisma2'
          - description: Palo Alto Prisma Access provisioning options for tunnel endpoints
        zscaler:
          allOf:
          - $ref: '#/components/schemas/tunnel_provider_options_zscaler2'
          - description: Provider settings for Zscaler tunnel endpoints
      description: Provider-specific tunnel options defined by this gateway template
    tunnel_provider_options4:
      title: tunnel_provider_options4
      type: object
      properties:
        jse:
          allOf:
          - $ref: '#/components/schemas/tunnel_provider_options_jse2'
          - description: Juniper Secure Edge provisioning options for tunnel endpoints
        prisma:
          allOf:
          - $ref: '#/components/schemas/tunnel_provider_options_prisma2'
          - description: Palo Alto Prisma Access provisioning options for tunnel endpoints
        zscaler:
          allOf:
          - $ref: '#/components/schemas/tunnel_provider_options_zscaler2'
          - description: Provider settings for Zscaler tunnel endpoints
      description: Provider-specific options for tunnels terminated by this gateway
    tunnel_via2:
      title: tunnel_via2
      enum:
      - primary
      - secondary
      type: string
      description: If `via`==`tunnel`, primary or secondary tunnel associated with this BGP neighbor
    tunterm_dhcpd_config2:
      title: tunterm_dhcpd_config2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether DHCP relay is enabled for tunnel termination VLANs
          default: false
        servers:
          uniqueItems: true
          type: array
          items:
            type: string
          description: DHCP server IP addresses used as relay targets
        type:
          allOf:
          - $ref: '#/components/schemas/tunterm_dhcpd_type3'
          - description: 'DHCP forwarding mode for tunnel termination VLANs. enum: `relay`.'
      additionalProperties:
        allOf:
        - $ref: '#/components/schemas/tunterm_dhcpd_config_property'
        - description: Per-VLAN DHCP relay configuration for tunnel termination
      description: DHCP relay or server settings for tunneled VLANs
    tunterm_dhcpd_type1:
      title: tunterm_dhcpd_type1
      const: relay
      type: string
      description: 'DHCP forwarding mode for this tunneled VLAN. enum: `relay`.'
    tunterm_dhcpd_type3:
      title: tunterm_dhcpd_type3
      const: relay
      type: string
      description: 'DHCP forwarding mode for tunnel termination VLANs. enum: `relay`.'
    tunterm_monitoring_protocol2:
      title: tunterm_monitoring_protocol2
      enum:
      - arp
      - ping
      - tcp
      type: string
      description: 'Monitoring method used for this tunnel termination check. enum: `arp`, `ping`, `tcp`.'
      examples:
      - tcp
    tunterm_port_config1:
      title: tunterm_port_config1
      type: object
      properties:
        downstream_ports:
          type: array
          items:
            type: string
          description: Ports connected downstream toward APs for tunnel termination
          examples:
          - - '2'
            - '3'
        separate_upstream_downstream:
          type: boolean
          description: Whether to separate upstream / downstream ports. default is false where all ports will be used.
          default: false
        upstream_port_vlan_id:
          oneOf:
          - type: string
          - maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
          description: Native VLAN ID applied to upstream tunnel termination ports
        upstream_ports:
          type: array
          items:
            type: string
          description: Ports connected upstream toward the LAN for tunnel termination
          examples:
          - - '0'
            - '1'
      description: Tunnel termination Ethernet port configuration for a Mist Edge replacement
    tunterm_port_config3:
      title: tunterm_port_config3
      type: object
      properties:
        downstream_ports:
          type: array
          items:
            type: string
          description: Ports connected downstream toward APs for tunnel termination
          examples:
          - - '2'
            - '3'
        separate_upstream_downstream:
          type: boolean
          description: Whether to separate upstream / downstream ports. default is false where all ports will be used.
          default: false
        upstream_port_vlan_id:
          oneOf:
          - type: string
          - maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
          description: Native VLAN ID applied to upstream tunnel termination ports
        upstream_ports:
          type: array
          items:
            type: string
          description: Ports connected upstream toward the LAN for tunnel termination
          examples:
          - - '0'
            - '1'
      description: Port configuration for tunnel termination traffic
    ui_settings_default_time_range2:
      title: ui_settings_default_time_range2
      type: object
      properties:
        end:
          type: integer
          description: Upper bound of the default databoard time range, in epoch seconds
          contentEncoding: int32
          examples:
          - 1508828400
        endDate:
          type: string
          description: Display date for the end of the default databoard time range
          examples:
          - 10/23/2017
        interval:
          type: string
          description: Bucket interval used for the default databoard time range
          examples:
          - 1d
        name:
          type: string
          description: Display name for the default databoard time range
          examples:
          - This Week
        shortName:
          type: string
          description: Compact display label for the default databoard time range
          examples:
          - thisWeek
        start:
          type: integer
          description: Lower bound of the default databoard time range, in epoch seconds
          contentEncoding: int32
          examples:
          - 1508655600
        usePreset:
          type: boolean
          description: Whether the default databoard time range uses a named preset
          examples:
          - true
      description: Time range used by default for this databoard
    ui_settings_tile_metric2:
      title: ui_settings_tile_metric2
      type: object
      properties:
        apiName:
          type: string
          description: Metric API name requested by this tile
          examples:
          - client_dhcp_latency
      description: Selected measurement configuration displayed by this tile
    ui_settings_tile_time_range2:
      title: ui_settings_tile_time_range2
      type: object
      properties:
        end:
          type: number
          description: Upper bound of the tile time range, in epoch seconds
          examples:
          - 1508823743
        endDate:
          type: string
          description: Display date for the end of the tile time range
          examples:
          - 10/23/2017
        interval:
          type: string
          description: Bucket interval used for the tile time range
          examples:
          - 1d
        name:
          type: string
          description: Display name for the tile time range
          examples:
          - Past 7 Days
        shortName:
          type: string
          description: Compact display label for the tile time range
          examples:
          - 7d
        start:
          type: integer
          description: Lower bound of the tile time range, in epoch seconds
          contentEncoding: int32
          examples:
          - 1508223600
        usePreset:
          type: boolean
          description: Whether the tile time range uses a named preset
          examples:
          - true
      description: Time range override for this tile
    upgrade_device_rrm_mesh_upgrade1:
      title: upgrade_device_rrm_mesh_upgrade1
      enum:
      - parallel
      - sequential
      type: string
      description: 'For APs only and if `strategy`==`rrm`. Mesh AP upgrade order for the organization upgrade. enum: `parallel`, `sequential`.'
    upgrade_device_rrm_mesh_upgrade2:
      title: upgrade_device_rrm_mesh_upgrade2
      enum:
      - parallel
      - sequential
      type: string
      description: 'For APs only and if `strategy`==`rrm`. Mesh AP upgrade order for the site upgrade. enum: `parallel`, `sequential`.'
    upgrade_device_rrm_node_order1:
      title: upgrade_device_rrm_node_order1
      enum:
      - center_to_fringe
      - fringe_to_center
      type: string
      description: 'For APs only and if `strategy`==`rrm`. AP ordering direction for RRM upgrade batches. enum: `center_to_fringe`, `fringe_to_center`.'
    upgrade_device_status1:
      title: upgrade_device_status1
      enum:
      - cancelled
      - completed
      - created
      - downloaded
      - downloading
      - failed
      - queued
      - upgrading
      type: string
      description: 'Current status of the site device upgrade job. enum: `cancelled`, `completed`, `created`, `downloaded`, `downloading`, `failed`, `queued`, `upgrading`.'
    upgrade_device_status2:
      title: upgrade_device_status2
      enum:
      - cancelled
      - completed
      - created
      - downloaded
      - downloading
      - failed
      - queued
      - upgrading
      type: string
      description: 'Current status of the site-level upgrade job. enum: `cancelled`, `completed`, `created`, `downloaded`, `downloading`, `failed`, `queued`, `upgrading`.'
    upgrade_device_strategy1:
      title: upgrade_device_strategy1
      enum:
      - big_bang
      - canary
      - rrm
      - serial
      type: string
      description: 'Device upgrade strategy used by this job. enum: `big_bang`, `canary`, `rrm`, `serial`.'
    upgrade_device_strategy2:
      title: upgrade_device_strategy2
      enum:
      - big_bang
      - canary
      - rrm
      - serial
      type: string
      description: 'Execution strategy used for the organization upgrade job. enum: `big_bang`, `canary`, `rrm`, `serial`.'
    upgrade_device_strategy4:
      title: upgrade_device_strategy4
      enum:
      - big_bang
      - canary
      - rrm
      - serial
      type: string
      description: 'Device reboot orchestration strategy for selected devices. enum: `big_bang`, `canary`, `rrm`, `serial`.'
    upgrade_device_strategy5:
      title: upgrade_device_strategy5
      enum:
      - big_bang
      - canary
      - rrm
      - serial
      type: string
      description: 'Upgrade orchestration strategy for selected devices. enum: `big_bang`, `canary`, `rrm`, `serial`.'
    upgrade_devices_targets1:
      title: upgrade_devices_targets1
      type: object
      properties:
        download_requested:
          type: array
          items:
            type: string
          description: Device MAC addresses for devices requested to download firmware
        downloaded:
          type: array
          items:
            type: string
          description: Device MAC addresses for devices that have downloaded firmware
        downloading:
          type: array
          items:
            type: string
          description: Device MAC addresses for devices currently downloading firmware
        failed:
          type: array
          items:
            type: string
          description: Device MAC addresses for devices that failed to upgrade
        reboot_in_progress:
          type: array
          items:
            type: string
          description: Device MAC addresses for devices currently rebooting
        rebooted:
          type: array
          items:
            type: string
          description: Device MAC addresses for devices that rebooted successfully
        scheduled:
          type: array
          items:
            type: string
          description: Device MAC addresses for devices scheduled for upgrade by the cloud
        skipped:
          type: array
          items:
            type: string
          description: Device MAC addresses for devices skipped because the requested version matched the running version
        total:
          type: integer
          description: Count of devices part of this upgrade
          contentEncoding: int32
        upgraded:
          type: array
          items:
            type: string
          description: Device MAC addresses for devices that upgraded successfully
      description: Device targets grouped by upgrade state
    upgrade_devices_targets3:
      title: upgrade_devices_targets3
      type: object
      properties:
        download_requested:
          type: array
          items:
            type: string
          description: Device MAC addresses for devices requested to download firmware
        downloaded:
          type: array
          items:
            type: string
          description: Device MAC addresses for devices that have downloaded firmware
        downloading:
          type: array
          items:
            type: string
          description: Device MAC addresses for devices currently downloading firmware
        failed:
          type: array
          items:
            type: string
          description: Device MAC addresses for devices that failed to upgrade
        reboot_in_progress:
          type: array
          items:
            type: string
          description: Device MAC addresses for devices currently rebooting
        rebooted:
          type: array
          items:
            type: string
          description: Device MAC addresses for devices that rebooted successfully
        scheduled:
          type: array
          items:
            type: string
          description: Device MAC addresses for devices scheduled for upgrade by the cloud
        skipped:
          type: array
          items:
            type: string
          description: Device MAC addresses for devices skipped because the requested version matched the running version
        total:
          type: integer
          description: Count of devices part of this upgrade
          contentEncoding: int32
        upgraded:
          type: array
          items:
            type: string
          description: Device MAC addresses for devices that upgraded successfully
      description: Device targets grouped by upgrade and download status
    upgrade_info_status2:
      title: upgrade_info_status2
      enum:
      - error
      - inprogress
      - scheduled
      - starting
      - success
      type: string
      description: 'Current status of the requested device upgrade. enum: `error`, `inprogress`, `scheduled`, `starting`, `success`.'
    upgrade_org_devices_download_strategy2:
      title: upgrade_org_devices_download_strategy2
      enum:
      - canary
      - big_bang
      - serial
      type: string
      description: 'Firmware download orchestration strategy for the organization upgrade. enum: `canary`, `big_bang`, `serial`.'
    upgrade_org_devices_upgrade_info2:
      title: upgrade_org_devices_upgrade_info2
      type: object
      properties:
        id:
          type: string
          description: Unique value identifying the site-level upgrade job
          contentEncoding: uuid
          readOnly: true
          examples:
          - 53f10664-3ce8-4c27-b382-0ef66432349f
        start_time:
          type: integer
          description: Epoch timestamp, in seconds, when the site-level upgrade starts
          contentEncoding: int32
          examples:
          - 1717658765
        status:
          allOf:
          - $ref: '#/components/schemas/upgrade_device_status2'
          - description: 'Current status of the site-level upgrade job. enum: `cancelled`, `completed`, `created`, `downloaded`, `downloading`, `failed`, `queued`, `upgrading`.'
        targets:
          allOf:
          - $ref: '#/components/schemas/upgrade_devices_targets1'
          - description: Device targets grouped by upgrade state
          readOnly: true
      description: Site-level job details for this upgrade entry
    upgrade_org_devices_version_firmware_type2:
      title: upgrade_org_devices_version_firmware_type2
      enum:
      - ap
      - junos
      - ssr
      type: string
      description: 'Firmware family this version entry applies to. enum: `ap`, `junos`, `ssr`.'
    upgrade_site_devices_counts2:
      title: upgrade_site_devices_counts2
      type: object
      properties:
        download_requested:
          type: integer
          description: Count of devices which cloud has requested to download firmware
          contentEncoding: int32
        downloaded:
          type: integer
          description: Count of ap's which have the firmware downloaded
          contentEncoding: int32
        failed:
          type: integer
          description: Count of devices which have failed to upgrade
          contentEncoding: int32
        reboot_in_progress:
          type: integer
          description: Count of devices which are rebooting
          contentEncoding: int32
        rebooted:
          type: integer
          description: Count of devices which have rebooted successfully
          contentEncoding: int32
        scheduled:
          type: integer
          description: Count of devices which cloud has scheduled an upgrade for
          contentEncoding: int32
        skipped:
          type: integer
          description: Count of devices which skipped upgrade since requested version was same as running version. Use force to always upgrade
          contentEncoding: int32
        total:
          type: integer
          description: Count of devices part of this upgrade
          contentEncoding: int32
        upgraded:
          type: integer
          description: Count of devices which have upgraded successfully
          contentEncoding: int32
      description: Device counts grouped by upgrade status for this job
    use_auto_ap_values_for2:
      title: use_auto_ap_values_for2
      enum:
      - orientation
      - placement
      type: string
      description: 'Localization value type to accept or reject. enum: `orientation`, `placement`.'
    utils_clear_bgp_type2:
      title: utils_clear_bgp_type2
      enum:
      - hard
      - in
      - out
      - soft
      type: string
      description: 'BGP clear operation type to run. enum: `hard`, `in`, `out`, `soft`.'
    utils_devices_restart_node2:
      title: utils_devices_restart_node2
      enum:
      - node0
      - node1
      type: string
      description: 'SRX or SSR node to restart. enum: `node0`, `node1`.'
    utils_send_support_logs_info2:
      title: utils_send_support_logs_info2
      enum:
      - code-dumps
      - full
      - messages
      - outbound-ssh
      - process
      - var-logs
      type: string
      description: 'Support file bundle type to upload. enum: `code-dumps`, `full`, `messages`, `outbound-ssh`, `process`, `var-logs`.'
    utils_show_route_protocol2:
      title: utils_show_route_protocol2
      enum:
      - any
      - bgp
      - direct
      - evpn
      - ospf
      - static
      type: string
      description: 'Routing protocol filter for route entries. enum: `any`, `bgp`, `direct`, `evpn`, `ospf`, `static`.'
    utils_traceroute_protocol2:
      title: utils_traceroute_protocol2
      enum:
      - icmp
      - udp
      type: string
      description: 'Transport protocol to use for traceroute. enum: `icmp`, `udp`.'
    vc_port_mode2:
      title: vc_port_mode2
      enum:
      - network
      - vcp-higig
      - vcp-hgoe
      type: string
      description: 'Virtual Chassis port mode to apply. enum: `network`, `vcp-higig`, `vcp-hgoe`.'
    virtual_chassis_config_member_vc_role2:
      title: virtual_chassis_config_member_vc_role2
      enum:
      - backup
      - linecard
      - master
      type: string
      description: 'Role of this member in the Virtual Chassis. enum: `backup`, `linecard`, `master`.'
    virtual_chassis_member_update_vc_role2:
      title: virtual_chassis_member_update_vc_role2
      enum:
      - backup
      - linecard
      - master
      type: string
      description: 'Required if `op`==`add` or `op`==`preprovision`; role of the member in the Virtual Chassis. enum: `backup`, `linecard`, `master`.'
    virtual_chassis_port_operation2:
      title: virtual_chassis_port_operation2
      enum:
      - delete
      - set
      type: string
      description: 'Action to perform on the specified Virtual Chassis ports. enum: `delete`, `set`.'
    virtual_chassis_update_op2:
      title: virtual_chassis_update_op2
      enum:
      - add
      - preprovision
      - remove
      - renumber
      type: string
      description: 'Action to perform on the Virtual Chassis. enum: `add`, `preprovision`, `remove`, `renumber`.'
    vpn_mode2:
      title: vpn_mode2
      enum:
      - hub_spoke
      - mesh
      type: string
      description: 'VPN topology mode for this configuration. enum: `hub_spoke`, `mesh`.'
    vpn_path_bfd_profile2:
      title: vpn_path_bfd_profile2
      enum:
      - broadband
      - lte
      type: string
      description: 'BFD profile used for this VPN path. enum: `broadband`, `lte`.'
    vpn_path_selection_strategy2:
      title: vpn_path_selection_strategy2
      enum:
      - disabled
      - simple
      - manual
      type: string
      description: 'Path selection strategy for a hub-and-spoke VPN. enum: `disabled`, `simple`, `manual`.'
    vpn_path_selection2:
      title: vpn_path_selection2
      type: object
      properties:
        strategy:
          allOf:
          - $ref: '#/components/schemas/vpn_path_selection_strategy2'
          - description: 'Path selection strategy for a hub-and-spoke VPN. enum: `disabled`, `simple`, `manual`.'
      description: Path selection settings used when `type`==`hub_spoke`
    vpn_path_traffic_shaping2:
      title: vpn_path_traffic_shaping2
      type: object
      properties:
        class_percentage:
          maxItems: 4
          minItems: 4
          type: array
          items:
            type: integer
            contentEncoding: int32
          description: Bandwidth percentages for high, medium, low, and best-effort traffic classes
          default:
          - 80
          - 10
          - 9
          - 1
        enabled:
          type: boolean
          description: Whether traffic shaping is enabled for this VPN path
        max_tx_kbps:
          type:
          - integer
          - 'null'
          description: Maximum transmit rate for this VPN path, in Kbps; `null` means no explicit limit
          contentEncoding: int32
      description: Traffic shaping settings applied to this VPN path
    vrf_config1:
      title: vrf_config1
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether to enable VRF (when supported on the device)
      description: VRF configuration applied to this gateway
    vrf_config2:
      title: vrf_config2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether to enable VRF (when supported on the device)
      description: VRF defaults applied by this gateway profile
    vrf_config3:
      title: vrf_config3
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether to enable VRF (when supported on the device)
      description: VRF defaults applied by this switch profile
    vrf_config4:
      title: vrf_config4
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether to enable VRF (when supported on the device)
      description: VRF defaults applied by this gateway template
    vrf_config5:
      title: vrf_config5
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether to enable VRF (when supported on the device)
      description: VRF defaults applied by this network template
    vrf_config6:
      title: vrf_config6
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether to enable VRF (when supported on the device)
      description: Routing instance configuration for the site
    vrf_config8:
      title: vrf_config8
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether to enable VRF (when supported on the device)
      description: VRF configuration applied to this switch
    vrrp_config1:
      title: vrrp_config1
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether VRRP configuration is enabled
        groups:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/vrrp_config_group'
          description: VRRP groups keyed by group name
      description: VRRP defaults applied by this switch profile
    vrrp_config3:
      title: vrrp_config3
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether VRRP configuration is enabled
        groups:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/vrrp_config_group'
          description: VRRP groups keyed by group name
      description: VRRP configuration applied to this switch
    vrrp_group_auth_type2:
      title: vrrp_group_auth_type2
      enum:
      - md5
      - simple
      type: string
      description: 'Authentication method used by the VRRP group. enum: `md5`, `simple`.'
      examples:
      - md5
    wan_tunnel_protocol1:
      title: wan_tunnel_protocol1
      enum:
      - gre
      - ipsec
      type: string
      description: 'Tunnel protocol used for the connection. enum: `gre`, `ipsec`.'
    webhook_action1:
      title: webhook_action1
      enum:
      - permit
      - block
      type: string
      description: 'Action applied when the rule matches the incoming event. enum: `permit`, `block`.'
    webhook_action3:
      title: webhook_action3
      enum:
      - permit
      - block
      type: string
      description: 'Default action applied when none of the `rules` match the incoming event. enum: `permit`, `block`.'
    webhook_client_info_topic2:
      title: webhook_client_info_topic2
      const: client-info
      type: string
      description: 'Webhook topic name for client information deliveries. enum: `client-info`.'
    webhook_client_latency_topic2:
      title: webhook_client_latency_topic2
      const: client-latency
      type: string
      description: 'Webhook topic name for client latency deliveries. enum: `client-latency`.'
    webhook_delivery_status2:
      title: webhook_delivery_status2
      enum:
      - failure
      - success
      type: string
      description: 'Delivery result for the webhook request. enum: `failure`, `success`.'
      examples:
      - failure
    webhook_delivery_topic2:
      title: webhook_delivery_topic2
      enum:
      - alarms
      - audits
      - device-updowns
      - occupancy-alerts
      - ping
      type: string
      description: 'Webhook topic delivered in this request. enum: `alarms`, `audits`, `device-updowns`, `occupancy-alerts`, `ping`.'
      examples:
      - audits
    webhook_device_events_event_ev_type2:
      title: webhook_device_events_event_ev_type2
      enum:
      - notice
      - warn
      type: string
      description: 'Advisory severity for the device event. enum: `notice`, `warn`.'
    webhook_guest_authorizations_topic2:
      title: webhook_guest_authorizations_topic2
      const: guest-authorizations
      type: string
      description: 'Webhook topic name for guest authorization deliveries. enum: `guest-authorizations`.'
    webhook_location_centrak_event_type2:
      title: webhook_location_centrak_event_type2
      const: wifi
      type: string
      description: 'Location object type for the CenTrak event. enum: `wifi`.'
    webhook_nac_accounting_topic2:
      title: webhook_nac_accounting_topic2
      const: nac-accounting
      type: string
      description: 'Webhook topic name for NAC accounting deliveries. enum: `nac-accounting`.'
    webhook_nac_events_topic2:
      title: webhook_nac_events_topic2
      const: nac-events
      type: string
      description: 'Webhook topic name for NAC event deliveries. enum: `nac-events`.'
    webhook_oauth2_grant_type2:
      title: webhook_oauth2_grant_type2
      enum:
      - client_credentials
      - password
      type: string
      description: 'OAuth2 grant type used when `type`==`oauth2`. enum: `client_credentials`, `password`.'
    webhook_occupancy_alert_type1:
      title: webhook_occupancy_alert_type1
      enum:
      - COMPLIANCE-OK
      - COMPLIANCE-VIOLATION
      type: string
      description: 'Occupancy compliance state reported for the zone. enum: `COMPLIANCE-OK`, `COMPLIANCE-VIOLATION`.'
    webhook_site_sle_event_sle2:
      title: webhook_site_sle_event_sle2
      type: object
      properties:
        ap-availability:
          type: number
          description: Wireless AP availability SLE score for the site
          examples:
          - 0.6
        successful-connect:
          type: number
          description: Connection success SLE score for the site
          examples:
          - 0.7
        time-to-connect:
          type: number
          description: Client connection-time SLE score for the site
          examples:
          - 0.9
      description: Service-level experience scores reported for the site
    webhook_type2:
      title: webhook_type2
      enum:
      - aws-sns
      - google-pubsub
      - http-post
      - oauth2
      - splunk
      type: string
      description: 'Delivery mechanism used by this webhook. enum: `aws-sns`, `google-pubsub`, `http-post`, `oauth2`, `splunk`.'
    webhook_zone_event_trigger1:
      title: webhook_zone_event_trigger1
      enum:
      - enter
      - exit
      type: string
      description: 'Whether the client or asset entered or exited the zone. enum: `enter`, `exit`.'
    webhook_zone_event_trigger3:
      title: webhook_zone_event_trigger3
      enum:
      - enter
      - exit
      type: string
      description: 'Whether the client entered or exited the RSSI zone. enum: `enter`, `exit`.'
    webhook_zone_event_type1:
      title: webhook_zone_event_type1
      enum:
      - asset
      - sdk
      - wifi
      type: string
      description: 'Client or asset type reported for the zone event. enum: `asset`, `sdk`, `wifi`.'
    webhook_zone_event_type3:
      title: webhook_zone_event_type3
      enum:
      - asset
      - sdk
      - wifi
      type: string
      description: 'Client type reported for the RSSI zone event. enum: `asset`, `sdk`, `wifi`.'
    wlan_airwatch2:
      title: wlan_airwatch2
      type: object
      properties:
        api_key:
          type: string
          description: API key used to authenticate to the AirWatch service
          examples:
          - aHhlbGxvYXNkZmFzZGZhc2Rmc2RmCg=="
        console_url:
          type: string
          description: Base console URL of the AirWatch deployment
          examples:
          - https://hs1.airwatchportals.com
        enabled:
          type: boolean
          description: Whether AirWatch integration is enabled for the WLAN
          default: false
        password:
          type: string
          description: AirWatch integration account password for this WLAN
          contentEncoding: password
          examples:
          - user1
        username:
          type: string
          description: AirWatch integration account username for this WLAN
          examples:
          - test123
      description: Integration settings for AirWatch device compliance on this WLAN
    wlan_app_limit2:
      title: wlan_app_limit2
      type: object
      properties:
        apps:
          type: object
          additionalProperties:
            type: integer
            format: int32
          description: "Map from app key to bandwidth in kbps. \nProperty key is the app key, defined in Get Application List"
          default: {}
          examples:
          - dropbox: 300
            netflix: 60
        enabled:
          type: boolean
          description: Whether application bandwidth limits are enabled for this WLAN
          default: false
        wxtag_ids:
          type: object
          additionalProperties:
            type: integer
            format: int32
          description: Map from wxtag_id of Hostname Wxlan Tags to bandwidth in kbps. Property key is the `wxtag_id`
          default: {}
          examples:
          - f99862d9-2726-931f-7559-3dfdf5d070d3: 30
      description: Bandwidth limits for applications on this WLAN
    wlan_app_qos2:
      title: wlan_app_qos2
      type: object
      properties:
        apps:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/wlan_app_qos_apps_properties'
          description: Map of application keys to QoS rewrite settings
          examples:
          - skype-business-video:
              dscp: 32
              dst_subnet: 10.2.0.0/16
              src_subnet: 10.2.0.0/16
        enabled:
          type: boolean
          description: Whether application QoS rewrite rules are enabled for this WLAN
          default: false
        others:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/wlan_app_qos_others_item'
          description: Custom traffic QoS rules that are not tied to named applications
      description: QoS rules for application traffic on this WLAN
    wlan_apply_to2:
      title: wlan_apply_to2
      enum:
      - aps
      - site
      - wxtags
      type: string
      description: 'Scope that determines where this WLAN is applied. enum: `aps`, `site`, `wxtags`.'
    wlan_auth_owe2:
      title: wlan_auth_owe2
      enum:
      - disabled
      - enabled
      - required
      type: string
      description: 'When `type`==`open`, Opportunistic Wireless Encryption mode for this WLAN. enum: `disabled`, `enabled`, `required`.'
    wlan_auth_server_selection2:
      title: wlan_auth_server_selection2
      enum:
      - ordered
      - unordered
      type: string
      description: 'RADIUS authentication server selection behavior for this WLAN. enum: `ordered`, `unordered`.'
      examples:
      - ordered
    wlan_auth_type2:
      title: wlan_auth_type2
      enum:
      - eap
      - eap192
      - open
      - psk
      - psk-tkip
      - psk-wpa2-tkip
      - wep
      type: string
      description: 'Authentication mode used by this WLAN. enum: `eap`, `eap192`, `open`, `psk`, `psk-tkip`, `psk-wpa2-tkip`, `wep`.'
      examples:
      - psk
    wlan_auth2:
      title: wlan_auth2
      required:
      - type
      type: object
      properties:
        anticlog_threshold:
          maximum: 32
          minimum: 16
          type: integer
          description: SAE anti-clogging token threshold
          contentEncoding: int32
          default: 16
          examples:
          - 16
        eap_reauth:
          type: boolean
          description: Whether to trigger EAP reauth when the session ends
          default: false
        enable_beacon_protection:
          type: boolean
          description: Enable Beacon Protection; default is false for better compatibility
          default: false
        enable_gcmp256:
          type: boolean
          description: Enable GCMP-256 encryption suite; default is false for better compatibility
          default: false
        enable_mac_auth:
          type: boolean
          description: Whether to enable MAC Auth, uses the same auth_servers
          default: false
        key_idx:
          maximum: 4
          minimum: 1
          type: integer
          description: When `type`==`wep`, index of the WEP key used as the default transmit key
          contentEncoding: int32
          default: 1
        keys:
          type: array
          items:
            type:
            - string
            - 'null'
          description: When `type`==`wep`, WEP keys configured for this WLAN
          default: []
        multi_psk_only:
          type: boolean
          description: When `type`==`psk`, whether to only use multi_psk
          default: false
        owe:
          allOf:
          - $ref: '#/components/schemas/wlan_auth_owe2'
          - description: 'When `type`==`open`, Opportunistic Wireless Encryption mode for this WLAN. enum: `disabled`, `enabled`, `required`.'
        pairwise:
          type: array
          items:
            oneOf:
            - {}
            - $ref: '#/components/schemas/wlan_auth_pairwise_item'
          description: When `type`==`psk` or `type`==`eap`, pairwise cipher suites allowed for this WLAN
        private_wlan:
          type: boolean
          description: When `multi_psk_only`==`true`, whether private wlan is enabled
          default: false
        psk:
          maxLength: 64
          minLength: 8
          type:
          - string
          - 'null'
          description: When `type`==`psk`, 8-64 characters, or 64 hex characters
          examples:
          - foryoureyesonly
        type:
          allOf:
          - $ref: '#/components/schemas/wlan_auth_type2'
          - description: 'Authentication mode used by this WLAN. enum: `eap`, `eap192`, `open`, `psk`, `psk-tkip`, `psk-wpa2-tkip`, `wep`.'
            examples:
            - psk
        wep_as_secondary_auth:
          type: boolean
          description: Enable WEP as secondary auth
          default: false
      description: Settings that control client authentication for this WLAN
    wlan_bonjour_service_properties_scope2:
      title: wlan_bonjour_service_properties_scope2
      enum:
      - same_ap
      - same_map
      - same_site
      type: string
      description: 'Discovery scope for this Bonjour service on the WLAN. enum: `same_ap`, `same_map`, `same_site`.'
    wlan_bonjour2:
      title: wlan_bonjour2
      type: object
      properties:
        additional_vlan_ids:
          anyOf:
          - type: string
          - type: array
            items:
              $ref: '#/components/schemas/vlan_id_with_variable'
          description: VLAN IDs, beyond the client VLAN, where Bonjour queries and responses are forwarded
        enabled:
          type: boolean
          description: Whether to enable bonjour for this WLAN. Once enabled, limit_bcast is assumed true, allow_mdns is assumed false
          default: false
        services:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/wlan_bonjour_service_properties'
          description: "What services are allowed. \nProperty key is the service name"
          examples:
          - airplay:
              radius_groups:
              - teachers
              scope: same_ap
      description: Service discovery gateway settings for Bonjour traffic on this WLAN
    wlan_cisco_cwa2:
      title: wlan_cisco_cwa2
      type: object
      properties:
        allowed_hostnames:
          type: array
          items:
            type: string
          description: Hostnames allowed for Cisco CWA client access before authorization
        allowed_subnets:
          type: array
          items:
            type: string
          description: CIDR subnets allowed for Cisco CWA client access before authorization
        blocked_subnets:
          type: array
          items:
            type: string
          description: CIDR subnets blocked for Cisco CWA client access
        enabled:
          type: boolean
          description: Whether Cisco CWA is enabled for this WLAN
          default: false
      description: Central web authentication settings for Cisco CWA on this WLAN
    wlan_datarates_template2:
      title: wlan_datarates_template2
      enum:
      - compatible
      - legacy-only
      - custom
      - no-legacy
      - high-density
      type: string
      description: 'Data rate template used to derive WLAN rate settings. enum: `compatible`, `legacy-only`, `custom`, `no-legacy`, `high-density`.'
    wlan_dns_server_rewrite2:
      title: wlan_dns_server_rewrite2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether DNS server rewrite by RADIUS group is enabled for this WLAN
          default: false
        radius_groups:
          type: object
          additionalProperties:
            type: string
          description: Map between radius_group and the desired DNS server (IPv4 only). Property key is the RADIUS group, property value is the desired DNS Server
          examples:
          - contractor: 172.1.1.1
            guest: 8.8.8.8
      description: RADIUS group based DNS server rewrite settings for this WLAN
    wlan_dynamic_psk2:
      title: wlan_dynamic_psk2
      type: object
      properties:
        default_psk:
          maxLength: 63
          minLength: 8
          type: string
          description: Default PSK to use if cloud WLC is not available, 8-63 characters
          examples:
          - foryoureyesonly
        default_vlan_id:
          oneOf:
          - type: string
          - maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
          description: Default VLAN ID used when dynamic PSK lookup does not return a VLAN
        enabled:
          type: boolean
          description: Whether dynamic PSK is enabled for this WLAN
          default: false
        force_lookup:
          type: boolean
          description: When 11r is enabled, we'll try to use the cached PMK, this can be disabled. `false` means auto
          default: false
        local_vlan_ids:
          type: array
          items:
            $ref: '#/components/schemas/vlan_id_with_variable'
          description: VLANs to be bridged locally when forwarding to mxtunnel or site mxedge
        source:
          allOf:
          - $ref: '#/components/schemas/dynamic_psk_source1'
          - description: 'Origin used to retrieve per-user PSKs. enum: `cloud_psks`, `radius`.'
            examples:
            - cloud_psks
      description: Per-user PSK selection settings for this WLAN
    wlan_dynamic_vlan_type2:
      title: wlan_dynamic_vlan_type2
      enum:
      - airespace-interface-name
      - standard
      type: string
      description: 'Dynamic VLAN mapping method used for RADIUS-provided VLAN attributes. enum: `airespace-interface-name`, `standard`.'
      examples:
      - airespace-interface-name
    wlan_dynamic_vlan2:
      title: wlan_dynamic_vlan2
      type: object
      properties:
        default_vlan_id:
          oneOf:
          - type: string
          - maximum: 4094
            minimum: 1
            type: integer
            contentEncoding: int32
            default: 999
          description: Deprecated default VLAN ID used when no RADIUS VLAN match is returned. Please use `default_vlan_ids` instead, which can support VLAN pools.
          deprecated: true
        default_vlan_ids:
          type: array
          items:
            $ref: '#/components/schemas/wlan_dynamic_vlan_default_vlan_id'
          description: Fallback VLAN IDs, ranges, or variables used when no RADIUS VLAN match is returned
        enabled:
          type: boolean
          description: Requires `vlan_enabled`==`true` to be set to `true`. Whether to enable dynamic vlan
          default: false
        local_vlan_ids:
          type: array
          items:
            $ref: '#/components/schemas/vlan_id_with_variable'
          description: VLAN IDs that should be locally bridged for dynamic VLAN assignment
        type:
          allOf:
          - $ref: '#/components/schemas/wlan_dynamic_vlan_type2'
          - description: 'Dynamic VLAN mapping method used for RADIUS-provided VLAN attributes. enum: `airespace-interface-name`, `standard`.'
            examples:
            - airespace-interface-name
        vlans:
          type: object
          additionalProperties:
            type: string
          description: >-
            Map between vlan_id (as string) to airespace interface names (comma-separated) or null for standard mapping
              * if `dynamic_vlan.type`==`standard`, property key is the VLAN ID and property value is \"\"
              * if `dynamic_vlan.type`==`airespace-interface-name`, property key is the VLAN ID and property value is the Airespace Interface Name
          examples:
          - '131': default
            '322': fast,video
      description: VLAN assignment settings for 802.1X dynamic VLANs
    wlan_hotspot_202:
      title: wlan_hotspot_202
      type: object
      properties:
        domain_name:
          type: array
          items:
            type: string
          description: Advertised domain names for Hotspot 2.0 clients
          examples:
          - - mist.com
        enabled:
          type: boolean
          description: Whether to enable hotspot 2.0 config
        nai_realms:
          uniqueItems: true
          type: array
          items:
            type: string
          description: NAI realms advertised for Hotspot 2.0 authentication
        operators:
          type: array
          items:
            $ref: '#/components/schemas/wlan_hotspot20_operators_item'
          description: Operator profiles supported by this Hotspot 2.0 configuration
          examples:
          - - google
            - att
        rcoi:
          type: array
          items:
            type: string
          description: Roaming Consortium Organization Identifiers advertised for Hotspot 2.0
          examples:
          - - 5A03BA0000
        venue_name:
          type: string
          description: Venue name, default is site name
          examples:
          - some_name
      description: Passpoint and Hotspot 2.0 settings for this WLAN
    wlan_inject_dhcp_option_822:
      title: wlan_inject_dhcp_option_822
      type: object
      properties:
        circuit_id:
          type: string
          description: >-
            Information to set in the `circuit_id` field of the DHCP Option 82. It is possible to use static string or the following variables (e.g. `{{SSID}}:{{AP_MAC}}`):
              * {{AP_MAC}}
              * {{AP_MAC_DASHED}}
              * {{AP_MODEL}}
              * {{AP_NAME}}
              * {{SITE_NAME}}
              * {{SSID}}
          examples:
          - '{{SSID}}:{{AP_MAC}}'
        enabled:
          type: boolean
          description: Whether to inject option 82 when forwarding DHCP packets
          default: false
      description: DHCP Option 82 insertion settings for this WLAN
    wlan_interface2:
      title: wlan_interface2
      enum:
      - all
      - eth0
      - eth1
      - eth2
      - eth3
      - mxtunnel
      - site_mxedge
      - wxtunnel
      type: string
      description: 'Network interface or tunnel where this WLAN bridges client traffic. enum: `all`, `eth0`, `eth1`, `eth2`, `eth3`, `mxtunnel`, `site_mxedge`, `wxtunnel`.'
      examples:
      - all
    wlan_mist_nac1:
      title: wlan_mist_nac1
      type: object
      properties:
        acct_interim_interval:
          maximum: 65535
          minimum: 0
          type: integer
          description: How frequently should interim accounting be reported, 60-65535. default is 0 (use one specified in Access-Accept request from Server). Very frequent messages can affect the performance of the RADIUS server, 600 and up is recommended when enabled.
          contentEncoding: int32
          default: 0
          examples:
          - 60
        auth_servers_retries:
          maximum: 10
          minimum: 1
          type: integer
          description: RADIUS auth session retries. Following fast timers are set if `fast_dot1x_timers` knob is enabled. "retries" are set to value of `auth_servers_timeout`. "max-requests" is also set when setting `auth_servers_retries` is set to default value to 3.
          contentEncoding: int32
          default: 2
          examples:
          - 3
        auth_servers_timeout:
          maximum: 30
          minimum: 1
          type: integer
          description: RADIUS auth session timeout. Following fast timers are set if `fast_dot1x_timers` knob is enabled. "quite-period" and "transmit-period" are set to half the value of `auth_servers_timeout`. "supplicant-timeout" is also set when setting `auth_servers_timeout` is set to default value of 10.
          contentEncoding: int32
          default: 5
          examples:
          - 5
        coa_enabled:
          type: boolean
          description: Allows a RADIUS server to dynamically modify the authorization status of a user session.
          default: false
        coa_port:
          maximum: 65535
          minimum: 1
          type: integer
          description: the communication port used for “Change of Authorization” (CoA) messages
          contentEncoding: int32
          examples:
          - 3799
        enabled:
          type: boolean
          description: >-
            When enabled:
              * `auth_servers` is ignored
              * `acct_servers` is ignored
              * `auth_servers_*` are ignored
              * `coa_servers` is ignored
              * `radsec` is ignored
              * `coa_enabled` is assumed
          default: false
        fast_dot1x_timers:
          type: boolean
          description: If set to true, sets default fast-timers with values calculated from `auth_servers_timeout` and `auth_server_retries`.
          default: false
        network:
          type:
          - string
          - 'null'
          description: Which network the mist nac server resides in
          examples:
          - default
        source_ip:
          type:
          - string
          - 'null'
          description: In case there is a static IP for this network, we can specify it using source ip
          examples:
          - 1.2.3.4
      description: Juniper Mist NAC settings used by this WLAN
    wlan_mist_nac3:
      title: wlan_mist_nac3
      type: object
      properties:
        acct_interim_interval:
          maximum: 65535
          minimum: 0
          type: integer
          description: How frequently should interim accounting be reported, 60-65535. default is 0 (use one specified in Access-Accept request from Server). Very frequent messages can affect the performance of the RADIUS server, 600 and up is recommended when enabled.
          contentEncoding: int32
          default: 0
          examples:
          - 60
        auth_servers_retries:
          maximum: 10
          minimum: 1
          type: integer
          description: RADIUS auth session retries. Following fast timers are set if `fast_dot1x_timers` knob is enabled. "retries" are set to value of `auth_servers_timeout`. "max-requests" is also set when setting `auth_servers_retries` is set to default value to 3.
          contentEncoding: int32
          default: 2
          examples:
          - 3
        auth_servers_timeout:
          maximum: 30
          minimum: 1
          type: integer
          description: RADIUS auth session timeout. Following fast timers are set if `fast_dot1x_timers` knob is enabled. "quite-period" and "transmit-period" are set to half the value of `auth_servers_timeout`. "supplicant-timeout" is also set when setting `auth_servers_timeout` is set to default value of 10.
          contentEncoding: int32
          default: 5
          examples:
          - 5
        coa_enabled:
          type: boolean
          description: Allows a RADIUS server to dynamically modify the authorization status of a user session.
          default: false
        coa_port:
          maximum: 65535
          minimum: 1
          type: integer
          description: the communication port used for “Change of Authorization” (CoA) messages
          contentEncoding: int32
          examples:
          - 3799
        enabled:
          type: boolean
          description: >-
            When enabled:
              * `auth_servers` is ignored
              * `acct_servers` is ignored
              * `auth_servers_*` are ignored
              * `coa_servers` is ignored
              * `radsec` is ignored
              * `coa_enabled` is assumed
          default: false
        fast_dot1x_timers:
          type: boolean
          description: If set to true, sets default fast-timers with values calculated from `auth_servers_timeout` and `auth_server_retries`.
          default: false
        network:
          type:
          - string
          - 'null'
          description: Which network the mist nac server resides in
          examples:
          - default
        source_ip:
          type:
          - string
          - 'null'
          description: In case there is a static IP for this network, we can specify it using source ip
          examples:
          - 1.2.3.4
      description: Juniper Mist NAC settings used by AP port authentication
    wlan_portal_auth2:
      title: wlan_portal_auth2
      enum:
      - amazon
      - azure
      - email
      - external
      - facebook
      - google
      - microsoft
      - multi
      - none
      - password
      - sms
      - sponsor
      - sso
      type: string
      description: 'Guest portal login scheme used by the WLAN. enum: `amazon`, `azure`, `email`, `external`, `facebook`, `google`, `microsoft`, `multi`, `none`, `password`, `sms`, `sponsor`, `sso`.'
      examples:
      - none
    wlan_portal_idp_sign_algo2:
      title: wlan_portal_idp_sign_algo2
      enum:
      - sha1
      - sha256
      - sha384
      - sha512
      type: string
      description: 'Optional if `wlan_portal_auth`==`sso`. Signing algorithm used for SAML assertions from the identity provider. enum: `sha1`, `sha256`, `sha384`, `sha512`.'
    wlan_portal_sms_provider2:
      title: wlan_portal_sms_provider2
      enum:
      - broadnet
      - clickatell
      - gupshup
      - manual
      - puzzel
      - telstra
      - twilio
      - smsglobal
      type: string
      description: 'Optional if `sms_enabled`==`true`. SMS provider used to deliver guest portal access codes. enum: `broadnet`, `clickatell`, `gupshup`, `manual`, `puzzel`, `telstra`, `twilio`, `smsglobal`.'
      examples:
      - twilio
    wlan_portal_sso_nameid_format2:
      title: wlan_portal_sso_nameid_format2
      enum:
      - email
      - unspecified
      type: string
      description: 'Optional if `wlan_portal_auth`==`sso`. SAML NameID format expected from the identity provider. enum: `email`, `unspecified`.'
    wlan_portal_template_setting_locale1:
      title: wlan_portal_template_setting_locale1
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for Catalan in Spain
    wlan_portal_template_setting_locale2:
      title: wlan_portal_template_setting_locale2
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for Czech in Czechia
    wlan_portal_template_setting_locale3:
      title: wlan_portal_template_setting_locale3
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for Danish in Denmark
    wlan_portal_template_setting_locale4:
      title: wlan_portal_template_setting_locale4
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for German in Germany
    wlan_portal_template_setting_locale5:
      title: wlan_portal_template_setting_locale5
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for Greek in Greece
    wlan_portal_template_setting_locale6:
      title: wlan_portal_template_setting_locale6
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for English in the United Kingdom
    wlan_portal_template_setting_locale7:
      title: wlan_portal_template_setting_locale7
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for English in the United States
    wlan_portal_template_setting_locale8:
      title: wlan_portal_template_setting_locale8
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for Spanish in Spain
    wlan_portal_template_setting_locale9:
      title: wlan_portal_template_setting_locale9
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for Finnish in Finland
    wlan_portal_template_setting_locale10:
      title: wlan_portal_template_setting_locale10
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for French in France
    wlan_portal_template_setting_locale11:
      title: wlan_portal_template_setting_locale11
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for Hebrew in Israel
    wlan_portal_template_setting_locale12:
      title: wlan_portal_template_setting_locale12
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for Hindi in India
    wlan_portal_template_setting_locale13:
      title: wlan_portal_template_setting_locale13
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for Croatian in Croatia
    wlan_portal_template_setting_locale14:
      title: wlan_portal_template_setting_locale14
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for Hungarian in Hungary
    wlan_portal_template_setting_locale15:
      title: wlan_portal_template_setting_locale15
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for Indonesian in Indonesia
    wlan_portal_template_setting_locale16:
      title: wlan_portal_template_setting_locale16
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for Italian in Italy
    wlan_portal_template_setting_locale17:
      title: wlan_portal_template_setting_locale17
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for Japanese in Japan
    wlan_portal_template_setting_locale18:
      title: wlan_portal_template_setting_locale18
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for Korean in Korea
    wlan_portal_template_setting_locale19:
      title: wlan_portal_template_setting_locale19
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for Malay in Malaysia
    wlan_portal_template_setting_locale20:
      title: wlan_portal_template_setting_locale20
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for Norwegian Bokmal in Norway
    wlan_portal_template_setting_locale21:
      title: wlan_portal_template_setting_locale21
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for Dutch in the Netherlands
    wlan_portal_template_setting_locale22:
      title: wlan_portal_template_setting_locale22
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for Polish in Poland
    wlan_portal_template_setting_locale23:
      title: wlan_portal_template_setting_locale23
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for Portuguese in Brazil
    wlan_portal_template_setting_locale24:
      title: wlan_portal_template_setting_locale24
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for Portuguese in Portugal
    wlan_portal_template_setting_locale25:
      title: wlan_portal_template_setting_locale25
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for Romanian in Romania
    wlan_portal_template_setting_locale26:
      title: wlan_portal_template_setting_locale26
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for Russian in Russia
    wlan_portal_template_setting_locale27:
      title: wlan_portal_template_setting_locale27
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for Slovak in Slovakia
    wlan_portal_template_setting_locale28:
      title: wlan_portal_template_setting_locale28
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for Swedish in Sweden
    wlan_portal_template_setting_locale29:
      title: wlan_portal_template_setting_locale29
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for Thai in Thailand
    wlan_portal_template_setting_locale30:
      title: wlan_portal_template_setting_locale30
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for Turkish in Turkey
    wlan_portal_template_setting_locale31:
      title: wlan_portal_template_setting_locale31
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for Ukrainian in Ukraine
    wlan_portal_template_setting_locale32:
      title: wlan_portal_template_setting_locale32
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for Vietnamese in Vietnam
    wlan_portal_template_setting_locale33:
      title: wlan_portal_template_setting_locale33
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for Simplified Chinese
    wlan_portal_template_setting_locale34:
      title: wlan_portal_template_setting_locale34
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for Traditional Chinese
    wlan_portal_template_setting_locale36:
      title: wlan_portal_template_setting_locale36
      type: object
      properties:
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
        authButtonAzure:
          type: string
          description: Label for Azure auth button
        authButtonEmail:
          type: string
          description: Label for Email auth button
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
        authButtonGoogle:
          type: string
          description: Label for Google auth button
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
        authButtonSms:
          type: string
          description: Label for SMS auth button
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
        authLabel:
          type: string
          description: Localized heading text displayed above portal authentication options
        backLink:
          type: string
          description: Label of the link to go back to /logon
        companyError:
          type: string
          description: Error message when company not provided
        companyLabel:
          type: string
          description: Localized label displayed for the company input field
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
        emailCodeCancel:
          type: string
          description: Localized link text for requesting help when the email access code was not received
        emailCodeError:
          type: string
          description: Localized error message shown when the alternate email address for access-code delivery is invalid
        emailCodeFieldLabel:
          type: string
          description: Localized label for the email access-code input field
        emailCodeMessage:
          type: string
          description: Localized instructional text shown before entering the email access code
        emailCodeSubmit:
          type: string
          description: Localized button label for submitting the email access code
        emailCodeTitle:
          type: string
          description: Localized title shown on the email access-code entry page
        emailError:
          type: string
          description: Error message when email not provided
        emailFieldLabel:
          type: string
          description: Localized label for the email address input field
        emailLabel:
          type: string
          description: Localized label displayed for the email input field
        emailMessage:
          type: string
          description: Localized instructional text explaining email access-code delivery
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
        emailTitle:
          type: string
          description: Title for the Email registration
        field1Error:
          type: string
          description: Error message when field1 not provided
        field1Label:
          type: string
          description: Localized label for custom field 1 input
        field2Error:
          type: string
          description: Error message when field2 not provided
        field2Label:
          type: string
          description: Localized label for custom field 2 input
        field3Error:
          type: string
          description: Error message when field3 not provided
        field3Label:
          type: string
          description: Localized label for custom field 3 input
        field4Error:
          type: string
          description: Error message when field4 not provided
        field4Label:
          type: string
          description: Localized label for custom field 4 input
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
        marketingPolicyOptInText:
          type: string
          description: Localized text of the marketing policy opt-in content
        message:
          type: string
          description: Localized main message displayed on the guest portal sign-in page
        nameError:
          type: string
          description: Error message when name not provided
        nameLabel:
          type: string
          description: Localized label displayed for the name input field
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
        pageTitle:
          type: string
          description: Localized browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
        passphraseLabel:
          type: string
          description: Localized label for the passphrase input field
        passphraseMessage:
          type: string
          description: Localized instructional text shown on the passphrase sign-in page
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
        passphraseTitle:
          type: string
          description: Title for passphrase details page
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
        requiredFieldLabel:
          type: string
          description: Localized text used to mark a form field as required
        signInLabel:
          type: string
          description: Label of the button to signin
        smsCarrierDefault:
          type: string
          description: Localized default option text shown in the SMS carrier selector
        smsCarrierError:
          type: string
          description: Localized error message shown when no mobile carrier is selected
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
        smsCodeFieldLabel:
          type: string
          description: Localized label for the SMS confirmation-code input field
        smsCodeMessage:
          type: string
          description: Localized instructional text shown before entering the SMS access code
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
        smsCodeTitle:
          type: string
          description: Localized title shown on the SMS access-code entry page
        smsCountryFieldLabel:
          type: string
          description: Localized label for the SMS country-code input field
        smsCountryFormat:
          type: string
          description: Localized example country code format shown for SMS authentication
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
        smsNumberError:
          type: string
          description: Localized error message shown when the mobile number is invalid
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
        smsNumberFormat:
          type: string
          description: Localized example mobile number format shown for SMS authentication
        smsNumberMessage:
          type: string
          description: Localized instructional text explaining SMS access-code delivery
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
        smsNumberTitle:
          type: string
          description: Title for phone number details
        smsUsernameFormat:
          type: string
          description: Localized example username format shown for SMS authentication
        sponsorBackLink:
          type: string
          description: Localized link text for returning to edit the sponsor request form
        sponsorCancel:
          type: string
          description: Localized button label for canceling sponsor authentication
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
        sponsorEmailError:
          type: string
          description: Localized error message shown when the sponsor email address is invalid
        sponsorInfoApproved:
          type: string
          description: Localized status message prefix shown when a sponsor approves the request
        sponsorInfoDenied:
          type: string
          description: Localized status message prefix shown when a sponsor denies the request
        sponsorInfoPending:
          type: string
          description: Localized status message prefix shown after a sponsor notification is sent
        sponsorName:
          type: string
          description: Label for Sponsor Name
        sponsorNameError:
          type: string
          description: Localized error message shown when the sponsor name is missing
        sponsorNotePending:
          type: string
          description: Localized additional status text shown while sponsor approval is pending
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
        sponsorsError:
          type: string
          description: Localized error message shown when no sponsor is selected
        sponsorsFieldLabel:
          type: string
          description: Localized label for the sponsor selection field
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
        tosError:
          type: string
          description: Error message when tos not accepted
        tosLink:
          type: string
          description: Label of the link to go to tos
        tosText:
          type: string
          description: Text of the Terms of Service
      description: Localized portal template strings for Arabic
    wlan_portal_template_setting2:
      title: wlan_portal_template_setting2
      required:
      - pageTitle
      type: object
      properties:
        accessCodeAlternateEmail:
          type: string
          description: Link text for using an alternate email address during access-code login
          default: Use alternate email address
        alignment:
          allOf:
          - $ref: '#/components/schemas/portal_template_alignment3'
          - description: 'Text and content alignment used by the guest portal template. enum: `center`, `left`, `right`.'
        ar:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale36'
          - description: Localized portal template strings for Arabic
        authButtonAmazon:
          type: string
          description: Label for Amazon auth button
          default: Sign in with Amazon
        authButtonAzure:
          type: string
          description: Label for Azure auth button
          default: Sign in with Azure
        authButtonEmail:
          type: string
          description: Label for Email auth button
          default: Sign in with Email
        authButtonFacebook:
          type: string
          description: Label for Facebook auth button
          default: Sign in with Facebook
        authButtonGoogle:
          type: string
          description: Label for Google auth button
          default: Sign in with Google
        authButtonMicrosoft:
          type: string
          description: Label for Microsoft auth button
          default: Sign in with Microsoft
        authButtonPassphrase:
          type: string
          description: Label for passphrase auth button
          default: Sign in with Passphrase
        authButtonSms:
          type: string
          description: Label for SMS auth button
          default: Sign in with Text Message
        authButtonSponsor:
          type: string
          description: Label for Sponsor auth button
          default: Sign in as Guest
        authLabel:
          type: string
          description: Heading text displayed above portal authentication options
          default: Connect to Wi-Fi with
        backLink:
          type: string
          description: Label of the link to go back to /logon
        ca-ES:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale1'
          - description: Localized portal template strings for Catalan in Spain
        color:
          type: string
          description: Primary color used by the portal template
          default: '#1074bc'
        colorDark:
          type: string
          description: Darker accent color used by the portal template
          default: '#0b5183'
        colorLight:
          type: string
          description: Lighter accent color used by the portal template
          default: '#3589c6'
        company:
          type: boolean
          description: Whether company field is required
          default: false
        companyError:
          type: string
          description: Error message when company not provided
          default: Please provide your company name
        companyLabel:
          type: string
          description: Label displayed for the company input field
          default: Company
        cs-CZ:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale2'
          - description: Localized portal template strings for Czech in Czechia
        da-DK:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale3'
          - description: Localized portal template strings for Danish in Denmark
        de-DE:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale4'
          - description: Localized portal template strings for German in Germany
        el-GR:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale5'
          - description: Localized portal template strings for Greek in Greece
        email:
          type: boolean
          description: Whether email field is required
          default: false
        emailAccessDomainError:
          type: string
          description: Error message when a user has valid social login but doesn't match specified email domains.
          default: Email Access Domain Error
        emailCancel:
          type: string
          description: Label for cancel confirmation code submission using email auth
          default: Cancel
        emailCodeCancel:
          type: string
          description: Link text for requesting help when the email access code was not received
          default: I did not receive the code
        emailCodeError:
          type: string
          description: Error message shown when the alternate email address for access-code delivery is invalid
          default: Please provide valid alternate email
        emailCodeFieldLabel:
          type: string
          description: Label for the email access-code input field
          default: Access Code
        emailCodeMessage:
          type: string
          description: Instructional text shown before entering the email access code
          default: Enter the access number that was sent to your email address.
        emailCodeSubmit:
          type: string
          description: Button label for submitting the email access code
          default: Sign In
        emailCodeTitle:
          type: string
          description: Title shown on the email access-code entry page
          default: Access Code
        emailError:
          type: string
          description: Error message when email not provided
          default: Please provide valid email
        emailFieldLabel:
          type: string
          description: Label for the email address input field
          default: Enter your email address
        emailLabel:
          type: string
          description: Label displayed for the email input field
          default: Email
        emailMessage:
          type: string
          description: Instructional text explaining email access-code delivery
          default: We will email you an authentication code which you can use to connect to the Wi-Fi network.
        emailSubmit:
          type: string
          description: Label for confirmation code submit button using email auth
          default: Send Access Code
        emailTitle:
          type: string
          description: Title for the Email registration
          default: Sign in with Email
        en-GB:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale6'
          - description: Localized portal template strings for English in the United Kingdom
        en-US:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale7'
          - description: Localized portal template strings for English in the United States
        es-ES:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale8'
          - description: Localized portal template strings for Spanish in Spain
        fi-FI:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale9'
          - description: Localized portal template strings for Finnish in Finland
        field1:
          type: boolean
          description: Whether to ask field1
          default: false
        field1Error:
          type: string
          description: Error message when field1 not provided
          default: Please provide Custom Field 1
        field1Label:
          type: string
          description: Label for custom field 1 input
          default: Custom Field 1
        field1Required:
          type: boolean
          description: Whether custom field 1 must be provided when the field is shown
        field2:
          type: boolean
          description: Whether to ask field2
          default: false
        field2Error:
          type: string
          description: Error message when field2 not provided
          default: Please provide Custom Field 2
        field2Label:
          type: string
          description: Label for custom field 2 input
          default: Custom Field 2
        field2Required:
          type: boolean
          description: Whether custom field 2 must be provided when the field is shown
        field3:
          type: boolean
          description: Whether to ask field3
          default: false
        field3Error:
          type: string
          description: Error message when field3 not provided
          default: Please provide Custom Field 3
        field3Label:
          type: string
          description: Label for custom field 3 input
          default: Custom Field 3
        field3Required:
          type: boolean
          description: Whether custom field 3 must be provided when the field is shown
        field4:
          type: boolean
          description: Whether to ask field4
          default: false
        field4Error:
          type: string
          description: Error message when field4 not provided
          default: Please provide Custom Field 4
        field4Label:
          type: string
          description: Label for custom field 4 input
          default: Custom Field 4
        field4Required:
          type: boolean
          description: Whether custom field 4 must be provided when the field is shown
        fr-FR:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale10'
          - description: Localized portal template strings for French in France
        he-IL:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale11'
          - description: Localized portal template strings for Hebrew in Israel
        hi-IN:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale12'
          - description: Localized portal template strings for Hindi in India
        hr-HR:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale13'
          - description: Localized portal template strings for Croatian in Croatia
        hu-HU:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale14'
          - description: Localized portal template strings for Hungarian in Hungary
        id-ID:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale15'
          - description: Localized portal template strings for Indonesian in Indonesia
        it-IT:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale16'
          - description: Localized portal template strings for Italian in Italy
        ja-JP:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale17'
          - description: Localized portal template strings for Japanese in Japan
        ko-KR:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale18'
          - description: Localized portal template strings for Korean in Korea
        logo:
          type:
          - string
          - 'null'
          description: Custom logo with `data:image/png;base64,` format, default null, uses Juniper Mist Logo. File size must be less than 100kB and image dimensions must be less than 500px x 200px (width x height).
          examples:
          - data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAZg…
        logoHeight:
          maximum: 200
          minimum: 0
          type: integer
          description: Height of the logo, in px
          contentEncoding: int32
          examples:
          - 123
        logoWidth:
          maximum: 500
          minimum: 0
          type: integer
          description: Width of the logo, in px
          contentEncoding: int32
          examples:
          - 408
        marketingPolicyLink:
          type: string
          description: label of the link to go to /marketing_policy
          default: Marketing Policy
        marketingPolicyOptIn:
          type: boolean
          description: Whether marketing policy optin is enabled
          default: false
        marketingPolicyOptInLabel:
          type: string
          description: label for marketing optin
          default: I wish to receive Marketing notifications
        marketingPolicyOptInText:
          type: string
          description: Text of the marketing policy opt-in content
          default: Marketing policy content
        message:
          type: string
          description: Main message displayed on the guest portal sign-in page
          default: Sign in to get online
        ms-MY:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale19'
          - description: Localized portal template strings for Malay in Malaysia
        multiAuth:
          type: boolean
          description: Whether the portal presents multiple authentication methods
          default: false
        name:
          type: boolean
          description: Whether name field is required
          default: false
        nameError:
          type: string
          description: Error message when name not provided
          default: Please provide your name
        nameLabel:
          type: string
          description: Label displayed for the name input field
          default: Name
        nb-NO:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale20'
          - description: Localized portal template strings for Norwegian Bokmal in Norway
        nl-NL:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale21'
          - description: Localized portal template strings for Dutch in the Netherlands
        optOutDefault:
          type: boolean
          description: Default value for the `Do not store` checkbox
          default: true
        optout:
          type: boolean
          description: Whether to display Do Not Store My Personal Information
          default: false
        optoutLabel:
          type: string
          description: Label for Do Not Store My Personal Information
          default: Do not store
        pageTitle:
          type: string
          description: Browser or page title shown for the guest portal
        passphraseCancel:
          type: string
          description: Label for the Passphrase cancel button
          default: Cancel
        passphraseError:
          type: string
          description: Error message when invalid passphrase is provided
          default: Invalid Passphrase
        passphraseLabel:
          type: string
          description: Label for the passphrase input field
          default: Passphrase
        passphraseMessage:
          type: string
          description: Instructional text shown on the passphrase sign-in page
          default: Enter the secret passphrase to access the Wi-Fi network.
        passphraseSubmit:
          type: string
          description: Label for the Passphrase submit button
          default: Sign in
        passphraseTitle:
          type: string
          description: Title for passphrase details page
          default: Sign in with Passphrase
        pl-PL:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale22'
          - description: Localized portal template strings for Polish in Poland
        poweredBy:
          type: boolean
          description: Whether to show \"Powered by Mist\"
          default: true
        privacy:
          type: boolean
          description: Whether to require the Privacy Term acceptance
          default: false
        privacyPolicyAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to Privacy Policy
          default: I accept the Privacy Terms
        privacyPolicyError:
          type: string
          description: Error message when Privacy Policy not accepted
          default: Please review and accept the Privacy Terms
        privacyPolicyLink:
          type: string
          description: Label of the link to go to Privacy Policy
          default: Privacy Terms
        privacyPolicyText:
          type: string
          description: Text of the Privacy Policy
          default: << provide your Privacy Terms here >>
        pt-BR:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale23'
          - description: Localized portal template strings for Portuguese in Brazil
        pt-PT:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale24'
          - description: Localized portal template strings for Portuguese in Portugal
        requiredFieldLabel:
          type: string
          description: Text used to mark a form field as required
          default: required
        responsiveLayout:
          type: boolean
          description: Whether the portal template uses a responsive layout
          default: true
        ro-RO:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale25'
          - description: Localized portal template strings for Romanian in Romania
        ru-RU:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale26'
          - description: Localized portal template strings for Russian in Russia
        signInLabel:
          type: string
          description: Label of the button to signin
          default: Sign In
        sk-SK:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale27'
          - description: Localized portal template strings for Slovak in Slovakia
        smsCarrierDefault:
          type: string
          description: Default option text shown in the SMS carrier selector
          default: Please Select
        smsCarrierError:
          type: string
          description: Error message shown when no mobile carrier is selected
          default: Please select a mobile carrier
        smsCarrierFieldLabel:
          type: string
          description: Label for mobile carrier drop-down list
          default: Mobile Carrier
        smsCodeCancel:
          type: string
          description: Label for cancel confirmation code submission
          default: I did not receive the code
        smsCodeError:
          type: string
          description: Error message when confirmation code is invalid
          default: Invalid Access Code
        smsCodeFieldLabel:
          type: string
          description: Label for the SMS confirmation-code input field
          default: Confirmation Code
        smsCodeMessage:
          type: string
          description: Instructional text shown before entering the SMS access code
          default: Enter the access number that was sent to your mobile number.
        smsCodeSubmit:
          type: string
          description: Label for confirmation code submit button
          default: Sign In
        smsCodeTitle:
          type: string
          description: Title shown on the SMS access-code entry page
          default: Access Code
        smsCountryFieldLabel:
          type: string
          description: Label for the SMS country-code input field
          default: Country Code
        smsCountryFormat:
          type: string
          description: Example country code format shown for SMS authentication
          default: '+1'
        smsHaveAccessCode:
          type: string
          description: Label for checkbox to specify that the user has access code
          default: I have an access code
        smsIsTwilio:
          type: boolean
          description: Whether the SMS portal flow uses Twilio-specific behavior
          default: false
        smsMessageFormat:
          type: string
          description: Format of access code sms message. {{code}} and {{duration}} are placeholders and should be retained as is.
        smsNumberCancel:
          type: string
          description: Label for canceling mobile details for SMS auth
          default: Cancel
        smsNumberError:
          type: string
          description: Error message shown when the mobile number is invalid
          default: Invalid Mobile Number
        smsNumberFieldLabel:
          type: string
          description: Label for field to provide mobile number
          default: Mobile Number
        smsNumberFormat:
          type: string
          description: Example mobile number format shown for SMS authentication
          default: 2125551212 (digits only)
        smsNumberMessage:
          type: string
          description: Instructional text explaining SMS access-code delivery
          default: We will send an access code to your mobile number which you can use to connect to the Wi-Fi network. Message and data rates may apply.
        smsNumberSubmit:
          type: string
          description: Label for submit button for code generation
          default: Send Access Code
        smsNumberTitle:
          type: string
          description: Title for phone number details
          default: Sign in with Text Message
        smsUsernameFormat:
          type: string
          description: Example username format shown for SMS authentication
          default: username
        smsValidityDuration:
          maximum: 30
          minimum: 1
          type: integer
          description: How long confirmation code should be considered valid (in minutes)
          contentEncoding: int32
        sponsorBackLink:
          type: string
          description: Link text for returning to edit the sponsor request form
          default: Go back and edit request form
        sponsorCancel:
          type: string
          description: Button label for canceling sponsor authentication
          default: Cancel
        sponsorEmail:
          type: string
          description: Label for Sponsor Email
          default: Sponsor Email
        sponsorEmailError:
          type: string
          description: Error message shown when the sponsor email address is invalid
          default: Please provide valid sponsor email
        sponsorEmailTemplate:
          type: string
          description: "HTML template to replace/override default sponsor email template \nSponsor Email Template supports following template variables:\n  * `approve_url`: Renders URL to approve the request; optionally &minutes=N query param can be appended to change the Authorization period of the guest, where N is a valid integer denoting number of minutes a guest remains authorized\n  * `deny_url`: Renders URL to reject the request\n  * `guest_email`: Renders Email ID of the guest\n  * `guest_name`: Renders Name of the guest\n  * `field1`: Renders value of the Custom Field 1\n  * `field2`: Renders value of the Custom Field 2\n  * `sponsor_link_validity_duration`: Renders validity time of the request (i.e. Approve/Deny URL)\n  * `auth_expire_minutes`: Renders Wlan-level configured Guest Authorization Expiration time period (in minutes), If not configured then default (1 day in minutes)"
        sponsorInfoApproved:
          type: string
          description: Status message prefix shown when a sponsor approves the request
          default: Your request was approved by
        sponsorInfoDenied:
          type: string
          description: Status message prefix shown when a sponsor denies the request
          default: Your request was denied by
        sponsorInfoPending:
          type: string
          description: Status message prefix shown after a sponsor notification is sent
          default: Your notification has been sent to
        sponsorName:
          type: string
          description: Label for Sponsor Name
          default: Sponsor Name
        sponsorNameError:
          type: string
          description: Error message shown when the sponsor name is missing
          default: Please provide sponsor name
        sponsorNotePending:
          type: string
          description: Additional status text shown while sponsor approval is pending
          default: Please wait for them to acknowledge.
        sponsorRequestAccess:
          type: string
          description: Submit button label request Wifi Access and notify sponsor about guest request
          default: Request Wi-Fi Access
        sponsorStatusApproved:
          type: string
          description: Text to display if sponsor approves request
          default: Your request was approved
        sponsorStatusDenied:
          type: string
          description: Text to display when sponsor denies request
          default: Your request was denied
        sponsorStatusPending:
          type: string
          description: Text to display if request is still pending
          default: Notification Sent
        sponsorSubmit:
          type: string
          description: Submit button label to notify sponsor about guest request
          default: Request Wi-Fi Access
        sponsorsError:
          type: string
          description: Error message shown when no sponsor is selected
          default: Please select a sponsor
        sponsorsFieldLabel:
          type: string
          description: Label for the sponsor selection field
          default: Sponsors
        sv-SE:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale28'
          - description: Localized portal template strings for Swedish in Sweden
        th-TH:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale29'
          - description: Localized portal template strings for Thai in Thailand
        tos:
          type: boolean
          description: Whether the portal requires Terms of Service acceptance
          default: true
        tosAcceptLabel:
          type: string
          description: Prefix of the label of the link to go to tos
          default: I accept the Terms of Service
        tosError:
          type: string
          description: Error message when tos not accepted
          default: Please review and accept the Terms of Service
        tosLink:
          type: string
          description: Label of the link to go to tos
          default: Terms of Service
        tosText:
          type: string
          description: Text of the Terms of Service
          default: << provide your Terms of Service here >>
        tr-TR:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale30'
          - description: Localized portal template strings for Turkish in Turkey
        uk-UA:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale31'
          - description: Localized portal template strings for Ukrainian in Ukraine
        vi-VN:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale32'
          - description: Localized portal template strings for Vietnamese in Vietnam
        zh-Hans:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale33'
          - description: Localized portal template strings for Simplified Chinese
        zh-Hant:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_template_setting_locale34'
          - description: Localized portal template strings for Traditional Chinese
      description: Template settings that define guest portal text, layout, and localization
    wlan_portal2:
      title: wlan_portal2
      type: object
      properties:
        allow_wlan_id_roam:
          type: boolean
          description: Optional if `amazon_enabled`==`true`. Whether to allow guest to connect to other Guest WLANs (with different `WLAN.ssid`) of same org without reauthentication (disable random_mac for seamless roaming)
          default: false
        amazon_client_id:
          type:
          - string
          - 'null'
          description: Optional if `amazon_enabled`==`true`. Amazon OAuth2 client id. This is optional. If not provided, it will use a default one.
        amazon_client_secret:
          type:
          - string
          - 'null'
          description: Optional if `amazon_enabled`==`true`. Amazon OAuth2 client secret. If amazon_client_id was provided, provide a corresponding value. Else leave blank.
          contentEncoding: password
        amazon_email_domains:
          type: array
          items:
            type: string
          description: Optional if `amazon_enabled`==`true`. Email domains allowed for Amazon-authenticated guest users. If null or empty, any authenticated Amazon email domain is allowed.
          default: []
        amazon_enabled:
          type: boolean
          description: Whether amazon is enabled as a login method
          default: false
        amazon_expire:
          type:
          - integer
          - 'null'
          description: Optional if `amazon_enabled`==`true`. Interval for which guest remains authorized using amazon auth (in minutes), if not provided, uses expire`
          contentEncoding: int32
        auth:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_auth2'
          - description: 'Guest portal login scheme used by the WLAN. enum: `amazon`, `azure`, `email`, `external`, `facebook`, `google`, `microsoft`, `multi`, `none`, `password`, `sms`, `sponsor`, `sso`.'
            examples:
            - none
        azure_client_id:
          type:
          - string
          - 'null'
          description: Required if `azure_enabled`==`true`. Azure active directory app client id
        azure_client_secret:
          type:
          - string
          - 'null'
          description: Required if `azure_enabled`==`true`. Azure active directory app client secret
          contentEncoding: password
        azure_enabled:
          type: boolean
          description: Whether Azure Active Directory is enabled as a login method
          default: false
        azure_expire:
          type:
          - integer
          - 'null'
          description: Interval for which guest remains authorized using azure auth (in minutes), if not provided, uses expire`
          contentEncoding: int32
        azure_tenant_id:
          type:
          - string
          - 'null'
          description: Required if `azure_enabled`==`true`. Azure active directory tenant id.
        broadnet_password:
          type: string
          description: Required if `sms_provider`==`broadnet`. Password for the Broadnet SMS provider account
          contentEncoding: password
          examples:
          - password
        broadnet_sid:
          type: string
          description: Required if `sms_provider`==`broadnet`. SID for the Broadnet SMS provider account
          examples:
          - MIST
        broadnet_user_id:
          type: string
          description: Required if `sms_provider`==`broadnet`. User ID for the Broadnet SMS provider account
          examples:
          - juniper
        bypass_when_cloud_down:
          type: boolean
          description: Whether to bypass the guest portal when cloud not reachable (and apply the default policies)
          default: false
        clickatell_api_key:
          type: string
          description: Required if `sms_provider`==`clickatell`. API key for the Clickatell SMS provider account
        cross_site:
          type: boolean
          description: Whether to allow guest to roam between WLANs (with same `WLAN.ssid`, regardless of variables) of different sites of same org without reauthentication (disable random_mac for seamless roaming)
          default: false
        email_enabled:
          type: boolean
          description: Whether email (access code verification) is enabled as a login method
          default: false
        enabled:
          type: boolean
          description: Whether guest portal is enabled
          default: false
        expire:
          type: integer
          description: How long to remain authorized, in minutes
          contentEncoding: int32
          default: 1440
          examples:
          - 1440
        external_portal_url:
          type: string
          description: Required if `wlan_portal_auth`==`external`. External portal URL (e.g. https://host/url) where we can append our query parameters to
        facebook_client_id:
          type:
          - string
          - 'null'
          description: Required if `facebook_enabled`==`true`. Facebook OAuth2 app id. This is optional. If not provided, it will use a default one.
        facebook_client_secret:
          type:
          - string
          - 'null'
          description: Required if `facebook_enabled`==`true`. Facebook OAuth2 app secret. If facebook_client_id was provided, provide a corresponding value. Else leave blank.
          contentEncoding: password
        facebook_email_domains:
          type: array
          items:
            type: string
          description: Optional if `facebook_enabled`==`true`. Email domains allowed for Facebook-authenticated guest users. If null or empty, any authenticated Facebook email domain is allowed.
          default: []
        facebook_enabled:
          type: boolean
          description: Whether facebook is enabled as a login method
          default: false
        facebook_expire:
          type:
          - integer
          - 'null'
          description: Optional if `facebook_enabled`==`true`. Interval for which guest remains authorized using facebook auth (in minutes), if not provided, uses expire`
          contentEncoding: int32
        forward:
          type: boolean
          description: Whether to forward the user to another URL after authorized
          default: false
        forward_url:
          type:
          - string
          - 'null'
          description: URL to forward the user to
          examples:
          - https://abc.com/promotions
        google_client_id:
          type:
          - string
          - 'null'
          description: Google OAuth2 app id. This is optional. If not provided, it will use a default one.
        google_client_secret:
          type:
          - string
          - 'null'
          description: Optional if `google_enabled`==`true`. Google OAuth2 app secret. If google_client_id was provided, provide a corresponding value. Else leave blank.
          contentEncoding: password
        google_email_domains:
          type: array
          items:
            type: string
          description: Optional if `google_enabled`==`true`. Email domains allowed for Google-authenticated guest users. If null or empty, any authenticated Google email domain is allowed.
          default: []
          examples:
          - - mydomain.edu
            - mydomain.org
        google_enabled:
          type: boolean
          description: Whether Google is enabled as login method
          default: false
        google_expire:
          type:
          - integer
          - 'null'
          description: Optional if `google_enabled`==`true`. Interval for which guest remains authorized using Google Auth (in minutes), if not provided, uses expire`
          contentEncoding: int32
        gupshup_password:
          type: string
          description: Required if `sms_provider`==`gupshup`. Password for the Gupshup SMS provider account
          contentEncoding: password
        gupshup_userid:
          type: string
          description: Required if `sms_provider`==`gupshup`. User ID for the Gupshup SMS provider account
        microsoft_client_id:
          type:
          - string
          - 'null'
          description: Optional if `microsoft_enabled`==`true`. Microsoft 365 OAuth2 client id. This is optional. If not provided, it will use a default one.
        microsoft_client_secret:
          type:
          - string
          - 'null'
          description: Optional if `microsoft_enabled`==`true`. Microsoft 365 OAuth2 client secret. If microsoft_client_id was provided, provide a corresponding value. Else leave blank.
          contentEncoding: password
        microsoft_email_domains:
          type: array
          items:
            type: string
          description: Optional if `microsoft_enabled`==`true`. Email domains allowed for Microsoft 365-authenticated guest users. If null or empty, any authenticated Microsoft 365 email domain is allowed.
          default: []
        microsoft_enabled:
          type: boolean
          description: Whether microsoft 365 is enabled as a login method
          default: false
        microsoft_expire:
          type:
          - integer
          - 'null'
          description: Optional if `microsoft_enabled`==`true`. Interval for which guest remains authorized using microsoft auth (in minutes), if not provided, uses expire`
          contentEncoding: int32
        passphrase_enabled:
          type: boolean
          description: Whether password is enabled
          default: false
        passphrase_expire:
          type:
          - integer
          - 'null'
          description: Optional if `passphrase_enabled`==`true`. Interval for which guest remains authorized using passphrase auth (in minutes), if not provided, uses `expire`
          contentEncoding: int32
        password:
          type:
          - string
          - 'null'
          description: Required if `passphrase_enabled`==`true`. Passphrase guests must enter when passphrase authentication is enabled
          examples:
          - let me in
        predefined_sponsors_enabled:
          type: boolean
          description: Whether to show list of sponsor emails mentioned in `sponsors` object as a dropdown. If both `sponsor_notify_all` and `predefined_sponsors_enabled` are false, behavior is acc to `sponsor_email_domains`
          default: true
        predefined_sponsors_hide_email:
          type: boolean
          description: Whether to hide sponsor’s email from list of sponsors
          default: false
        privacy:
          type: boolean
          description: Whether to show the privacy policy in the WLAN guest portal
          default: false
        puzzel_password:
          type: string
          description: Required if `sms_provider`==`puzzel`. Password for the Puzzel SMS provider account
          contentEncoding: password
        puzzel_service_id:
          type: string
          description: Required if `sms_provider`==`puzzel`. Service ID for the Puzzel SMS provider account
        puzzel_username:
          type: string
          description: Required if `sms_provider`==`puzzel`. Username for the Puzzel SMS provider account
        smsMessageFormat:
          type: string
          description: Optional if `sms_enabled`==`true`. SMS Message format
          default: Code {{code}} expires in {{duration}} minutes.
        sms_enabled:
          type: boolean
          description: Whether sms is enabled as a login method
          default: false
        sms_expire:
          type:
          - integer
          - 'null'
          description: Optional if `sms_enabled`==`true`. Interval for which guest remains authorized using sms auth (in minutes), if not provided, uses expire`
          contentEncoding: int32
        sms_provider:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_sms_provider2'
          - description: 'Optional if `sms_enabled`==`true`. SMS provider used to deliver guest portal access codes. enum: `broadnet`, `clickatell`, `gupshup`, `manual`, `puzzel`, `telstra`, `twilio`, `smsglobal`.'
            examples:
            - twilio
        smsglobal_api_key:
          type: string
          description: Required if `sms_provider`==`smsglobal`, Client API Key
        smsglobal_api_secret:
          type: string
          description: Required if `sms_provider`==`smsglobal`, Client secret
          contentEncoding: password
        smsglobal_sender:
          type: string
          description: Optional sender's number or sender ID for SMSGlobal. If not provided, uses the default number associated with the account
        sponsor_auto_approve:
          type: boolean
          description: Optional if `sponsor_enabled`==`true`. Whether to automatically approve guest and allow sponsor to revoke guest access, needs predefined_sponsors_enabled enabled and sponsor_notify_all disabled
          default: false
        sponsor_email_domains:
          type: array
          items:
            type: string
          description: Email domains allowed for sponsor email addresses. Required if `sponsor_enabled` is `true` and `sponsors` is empty.
          examples:
          - - reserved.net
            - reserved.org
        sponsor_enabled:
          type: boolean
          description: Whether sponsor is enabled
          default: false
        sponsor_expire:
          type:
          - integer
          - 'null'
          description: Optional if `sponsor_enabled`==`true`. Interval for which guest remains authorized using sponsor auth (in minutes), if not provided, uses expire`
          contentEncoding: int32
        sponsor_link_validity_duration:
          anyOf:
          - maximum: 60
            minimum: 5
            type: integer
            contentEncoding: int32
            default: 60
          - type: string
          description: Optional if `sponsor_enabled`==`true`. Validity duration, in minutes, for approve or deny links in sponsor emails. Valid values are 5 to 60.
        sponsor_notify_all:
          type: boolean
          description: Optional if `sponsor_enabled`==`true`. whether to notify all sponsors that are mentioned in `sponsors` object. Both `sponsor_notify_all` and `predefined_sponsors_enabled` should be true in order to notify sponsors. If true, email sent to 10 sponsors in no particular order.
          default: false
        sponsor_status_notify:
          type: boolean
          description: Optional if `sponsor_enabled`==`true`. If enabled, guest will get email about sponsor's action (approve/deny)
          default: false
        sponsors:
          oneOf:
          - type: array
            items:
              type: string
          - type: object
            additionalProperties:
              type: string
            examples:
            - sponsor1@company.com: FirstName1 LastName1
              sponsor2@company.com: FirstName2 LastName2
          description: Allowed sponsor email addresses and display names. Required if `sponsor_enabled` is `true` and `sponsor_email_domains` is empty.
        sso_default_role:
          type: string
          description: Optional if `wlan_portal_auth`==`sso`, default role to assign if there’s no match. By default, an assertion is treated as invalid when there’s no role matched
        sso_forced_role:
          type: string
          description: Optional if `wlan_portal_auth`==`sso`. Role assigned to authenticated users when guest SSO is used
        sso_idp_cert:
          type: string
          description: Required if `wlan_portal_auth`==`sso`. IDP Cert (used to verify the signed response)
        sso_idp_sign_algo:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_idp_sign_algo2'
          - description: 'Optional if `wlan_portal_auth`==`sso`. Signing algorithm used for SAML assertions from the identity provider. enum: `sha1`, `sha256`, `sha384`, `sha512`.'
        sso_idp_sso_url:
          type: string
          description: Required if `wlan_portal_auth`==`sso`, IDP Single-Sign-On URL
        sso_issuer:
          type: string
          description: Required if `wlan_portal_auth`==`sso`, IDP issuer URL
        sso_nameid_format:
          allOf:
          - $ref: '#/components/schemas/wlan_portal_sso_nameid_format2'
          - description: 'Optional if `wlan_portal_auth`==`sso`. SAML NameID format expected from the identity provider. enum: `email`, `unspecified`.'
        telstra_client_id:
          type: string
          description: Required if `sms_provider`==`telstra`, Client ID provided by Telstra
        telstra_client_secret:
          type: string
          description: Required if `sms_provider`==`telstra`, Client secret provided by Telstra
          contentEncoding: password
        twilio_auth_token:
          type:
          - string
          - 'null'
          description: Required if `sms_provider`==`twilio`, Auth token account with twilio account
          contentEncoding: password
          examples:
          - af9dac44c344a875ab5d31cb7abcdefg
        twilio_phone_number:
          type:
          - string
          - 'null'
          description: Required if `sms_provider`==`twilio`, Twilio phone number associated with the account. See example for accepted format.
          examples:
          - '+18548888888'
        twilio_sid:
          type:
          - string
          - 'null'
          description: Required if `sms_provider`==`twilio`, Account SID provided by Twilio
          examples:
          - af9dac44c344a875ab5d31cb7abcdefg
      description: Guest portal settings for this WLAN
    wlan_qos_class2:
      title: wlan_qos_class2
      enum:
      - background
      - best_effort
      - video
      - voice
      type: string
      description: 'QoS traffic class applied when WLAN QoS override is enabled. enum: `background`, `best_effort`, `video`, `voice`.'
      examples:
      - best_effort
    wlan_qos2:
      title: wlan_qos2
      type: object
      properties:
        class:
          allOf:
          - $ref: '#/components/schemas/wlan_qos_class2'
          - description: 'QoS traffic class applied when WLAN QoS override is enabled. enum: `background`, `best_effort`, `video`, `voice`.'
            examples:
            - best_effort
        overwrite:
          type: boolean
          description: Whether to overwrite QoS
          default: false
      description: Quality-of-service settings for WLAN client traffic
    wlan_roam_mode2:
      title: wlan_roam_mode2
      enum:
      - 11r
      - NONE
      - OKC
      type: string
      description: 'Fast roaming mode configured for this WLAN. enum: `11r`, `NONE`, `OKC`.'
      examples:
      - NONE
    wlan_schedule2:
      title: wlan_schedule2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether the WLAN operating schedule is enabled
          default: false
        hours:
          allOf:
          - $ref: '#/components/schemas/hours2'
          - description: Time ranges when the WLAN is scheduled to operate
      description: Operating schedule controlling when this WLAN is active
    wxlan_rule_action2:
      title: wxlan_rule_action2
      enum:
      - allow
      - block
      type: string
      description: Allow or block behavior applied by this WxLAN rule
      examples:
      - allow
    wxlan_tag_match2:
      title: wxlan_tag_match2
      enum:
      - ap_id
      - app
      - asset_mac
      - client_mac
      - hostname
      - ip_range_subnet
      - port
      - psk_name
      - psk_role
      - radius_attr
      - radius_class
      - radius_group
      - radius_username
      - sdkclient_uuid
      - wlan_id
      type: string
      description: 'Required if `type`==`match`; attribute compared against `values`. enum: `ap_id`, `app`, `asset_mac`, `client_mac`, `hostname`, `ip_range_subnet`, `port`, `psk_name`, `psk_role`, `radius_attr`, `radius_class`, `radius_group`, `radius_username`, `sdkclient_uuid`, `wlan_id`.'
    wxlan_tag_operation2:
      title: wxlan_tag_operation2
      enum:
      - in
      - not_in
      type: string
      description: 'Required if `type`==`match`; whether `values` are inclusive or exclusive matches. enum: `in`, `not_in`.'
    wxlan_tag_type2:
      title: wxlan_tag_type2
      enum:
      - client
      - match
      - resource
      - spec
      - subnet
      - vlan
      type: string
      description: 'Kind of WxLAN tag and how it is populated. enum: `client`, `match`, `resource`, `spec`, `subnet`, `vlan`.'
    wxlan_tunnel_dmvpn2:
      title: wxlan_tunnel_dmvpn2
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether DMVPN is enabled
          default: false
        holding_time:
          type: integer
          description: Optional; the holding time for NHRP ‘registration requests’  and ‘resolution replies’ sent from the Mist AP (in seconds); default 600
          contentEncoding: int32
        host_routes:
          type: array
          items:
            type: string
          description: IPv4 DMVPN peer host routes to which traffic is forwarded
      description: Settings for Dynamic Multipoint VPN on this WxLAN tunnel
    wxlan_tunnel_ipsec2:
      title: wxlan_tunnel_ipsec2
      required:
      - psk
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether ipsec is enabled, requires DMVPN be enabled
          default: false
        psk:
          type: string
          description: Pre-shared key used for IPsec on this WxLAN tunnel
      description: Security settings for IPsec on this WxLAN tunnel; requires DMVPN to be enabled
    wxlan_tunnel_session_ethertype2:
      title: wxlan_tunnel_session_ethertype2
      enum:
      - ethernet
      - vlan
      type: string
      description: 'Frame type carried by this tunnel session. enum: `ethernet`, `vlan`.'
    account_oauth_add:
      oneOf:
      - $ref: '#/components/schemas/account_jamf_config'
      - $ref: '#/components/schemas/account_vmware_config'
      - $ref: '#/components/schemas/account_mobicontrol_config'
      - $ref: '#/components/schemas/account_zdx_config'
      - $ref: '#/components/schemas/account_crowdstrike_config'
      - $ref: '#/components/schemas/account_prisma_config'
      - $ref: '#/components/schemas/account_sentinelone_config'
      description: Account configuration payload for adding a supported OAuth-linked application
    additional_vlan_ids:
      anyOf:
      - type: string
      - type: array
        items:
          $ref: '#/components/schemas/vlan_id_with_variable'
      description: List or Comma separated list of additional VLAN IDs (on the LAN side or from other WLANs) should we be forwarding bonjour queries/responses
    additional_vlan_ids_array:
      allOf:
      - $ref: '#/components/schemas/vlan_id_with_variable'
      - description: Additional VLAN IDs represented as an array
    ap_switch_setting_port_vlan_id:
      anyOf:
      - maximum: 4094
        minimum: 1
        type: integer
        contentEncoding: int32
      - type: string
      description: Native VLAN ID, optional
    bgp_as:
      anyOf:
      - type: string
      - maximum: 4294967294
        minimum: 1
        type: integer
        contentEncoding: int32
      description: BGP AS, value in range 1-4294967294. Can be a Variable (e.g. `{{bgp_as}}` )
      examples:
      - '65000'
    bgp_local_as:
      anyOf:
      - type: string
      - maximum: 4294967295
        minimum: 1
        type: integer
        contentEncoding: int32
      description: Required if `via`==`lan`, `via`==`tunnel` or `via`==`wan`. BGP AS, value in range 1-4294967295
      examples:
      - '65000'
    capture_org:
      oneOf:
      - $ref: '#/components/schemas/capture_mxedge'
      description: Packet capture request payload for organization-level captures
    capture_site:
      oneOf:
      - $ref: '#/components/schemas/capture_client'
      - $ref: '#/components/schemas/capture_gateway'
      - $ref: '#/components/schemas/capture_new_assoc'
      - $ref: '#/components/schemas/capture_radiotap'
      - $ref: '#/components/schemas/capture_radiotapwired'
      - $ref: '#/components/schemas/capture_scan'
      - $ref: '#/components/schemas/capture_switch'
      - $ref: '#/components/schemas/capture_wired'
      - $ref: '#/components/schemas/capture_wireless'
      description: Packet capture request payload for site-level captures
      discriminator:
        propertyName: type
        mapping:
          client: capture_client
          gateway: capture_gateway
          new_assoc: capture_new_assoc
          radiotap: capture_radiotap
          radiotap,wired: capture_radiotapwired
          scan: capture_scan
          switch: capture_switch
          wired: capture_wired
          wireless: capture_wireless
    config_device:
      oneOf:
      - $ref: '#/components/schemas/device_ap'
      - $ref: '#/components/schemas/device_switch'
      - $ref: '#/components/schemas/device_gateway'
      description: Device configuration object for an AP, switch, or gateway
      discriminator:
        propertyName: type
        mapping:
          ap: device_ap
          gateway: device_gateway
          switch: device_switch
    config_devices:
      allOf:
      - $ref: '#/components/schemas/config_device'
      - description: List of device configuration objects
    const_device_model:
      oneOf:
      - $ref: '#/components/schemas/const_device_ap'
      - $ref: '#/components/schemas/const_device_switch'
      - $ref: '#/components/schemas/const_device_gateway'
      description: Device model definition returned by the constants API
      discriminator:
        propertyName: type
        mapping:
          ap: const_device_ap
          gateway: const_device_switch
          switch: const_device_gateway
    const_device_models:
      allOf:
      - $ref: '#/components/schemas/const_device_model'
      - description: Device model definitions returned by the constants API
    const_insight_metrics_property_example:
      anyOf:
      - type: integer
        contentEncoding: int32
      - type: number
      - type: string
      - type: boolean
      - type: object
      description: Example value for an insight metric property
    const_insight_metrics_property_example_any_of1:
      anyOf:
      - type: array
        items:
          $ref: '#/components/schemas/const_insight_metrics_property_example'
      - type: object
        additionalProperties:
          type: array
          items:
            $ref: '#/components/schemas/const_insight_metrics_property_example'
      description: Example values for an insight metric property, as an array or keyed object
    const_insight_metrics_property_examples:
      allOf:
      - $ref: '#/components/schemas/const_insight_metrics_property_example'
      - description: List of example values for an insight metric property
    const_insight_metrics_property_examples_object:
      allOf:
      - $ref: '#/components/schemas/const_insight_metrics_property_example'
      - description: Object containing named fields, each with array of example values
    deviceprofile:
      oneOf:
      - $ref: '#/components/schemas/deviceprofile_ap'
      - $ref: '#/components/schemas/deviceprofile_gateway'
      - $ref: '#/components/schemas/deviceprofile_switch'
      description: Device profile configuration for an AP, switch, or gateway
      discriminator:
        propertyName: type
        mapping:
          ap: deviceprofile_ap
          gateway: deviceprofile_gateway
          switch: deviceprofile_switch
    deviceprofiles:
      allOf:
      - $ref: '#/components/schemas/deviceprofile'
      - description: List of device profile configurations
    dscp:
      anyOf:
      - type: string
      - maximum: 63
        minimum: 0
        type: integer
        contentEncoding: int32
      description: DSCP value range between 0 and 63
    gateway_port_config_reth_idx:
      anyOf:
      - type: integer
        contentEncoding: int32
      - type: string
      description: For SRX only and if HA Mode. `-1` means it will be managed by the device. Use `>= 0` values to manage it manually. Ensure no conflicting values are assigned across all ports.
    gateway_port_vlan_id_with_variable:
      oneOf:
      - type: string
      - maximum: 4094
        minimum: 1
        type: integer
        contentEncoding: int32
      description: If WAN interface is on a VLAN. Can be the VLAN ID (i.e. "10") or a Variable (i.e. "{{myvar}}")
    insight_metrics_results:
      allOf:
      - $ref: '#/components/schemas/insight_metrics_results_item'
      - description: Results depends on the `metric` - some return numbers (e.g. bytes, ap-count), others return objects
    insight_metrics_results_item:
      anyOf:
      - type: number
      - type: object
      description: Insight metric result item, returned either as a number or an object depending on the requested metric
    mist_device:
      oneOf:
      - $ref: '#/components/schemas/device_ap'
      - $ref: '#/components/schemas/device_switch'
      - $ref: '#/components/schemas/device_gateway'
      description: Mist-managed device object for an AP, switch, or gateway
      discriminator:
        propertyName: type
        mapping:
          ap: device_ap
          gateway: device_gateway
          switch: device_switch
    mxedge_tunterm_igmp_snooping_config_vlan_ids:
      anyOf:
      - type: array
        items:
          maximum: 4096
          minimum: 0
          type: integer
          contentEncoding: int32
      - type: string
      description: List of VLAN IDs where tunnel termination performs IGMP snooping
    mxedge_tunterm_switch_config_vlan_ids:
      allOf:
      - $ref: '#/components/schemas/vlan_id_with_variable'
      - description: Tagged VLAN IDs allowed on a tunnel termination switch port
    nac_tag_gbp_tag:
      anyOf:
      - maximum: 65535
        minimum: 1
        type: integer
        contentEncoding: int32
      - type: string
      description: If `type`==`gbp_tag`, GBP tag value returned by the NAC rule
    next_hop_via:
      oneOf:
      - type: string
      - type: array
        items:
          type: string
      description: Next-hop IP address. Can be a single IP address or an array of IP addresses for ECMP (Equal-Cost Multi-Path) load balancing across multiple next-hops.
      examples:
      - 10.2.1.1
      - >-
        [
          "10.2.1.1",
          "10.2.1.2"
        ]
    number_or_null:
      oneOf:
      - type: number
      description: Numeric value or null
    psk_vlan_id:
      oneOf:
      - type: string
      - maximum: 4094
        minimum: 1
        type: integer
        contentEncoding: int32
      description: VLAN for this PSK key
    radius_acct_port:
      anyOf:
      - maximum: 65545
        minimum: 1
        type: integer
        contentEncoding: int32
      - type: string
      description: RADIUS Auth Port, value from 1 to 65535, default is 1813
    radius_auth_port:
      anyOf:
      - maximum: 65545
        minimum: 1
        type: integer
        contentEncoding: int32
      - type: string
      description: RADIUS Auth Port, value from 1 to 65535, default is 1812
    radius_coa_port:
      anyOf:
      - maximum: 65545
        minimum: 1
        type: integer
        contentEncoding: int32
      - type: string
      description: RADIUS CoA Port, value from 1 to 65535, default is 3799
    radsec_idle_timeout:
      anyOf:
      - type: integer
        contentEncoding: int32
        default: 60
      - type: string
      description: RadSec idle timeout in seconds. Default is 60
    remote_syslog_archive_files:
      anyOf:
      - type: string
      - type: integer
        contentEncoding: int32
      description: Number of archived syslog files to retain
      examples:
      - '20'
    remote_syslog_server_port:
      anyOf:
      - maximum: 65545
        minimum: 1
        type: integer
        contentEncoding: int32
        default: 514
      - type: string
      description: Syslog Service Port, value from 1 to 65535
    response_device_metrics_results:
      allOf:
      - $ref: '#/components/schemas/response_device_metrics_results_items'
      - description: Device metric result values aligned with the response timestamps
    response_device_metrics_results_items:
      oneOf:
      - type: string
      - type: integer
        contentEncoding: int32
      description: Device metric result value, returned as a string or integer
    response_device_search_results:
      allOf:
      - $ref: '#/components/schemas/response_device_search_results_items'
      - description: Device search records for APs, switches, or gateways
    response_device_search_results_items:
      oneOf:
      - $ref: '#/components/schemas/ap_search'
      - $ref: '#/components/schemas/switch_search'
      - $ref: '#/components/schemas/gateway_search'
      description: Device search record for an AP, switch, or gateway
    response_org_site_sle:
      oneOf:
      - $ref: '#/components/schemas/org_site_sle_wifi'
      - $ref: '#/components/schemas/org_site_wired_wifi'
      - $ref: '#/components/schemas/org_site_wan_wifi'
      description: Organization site SLE response for Wi-Fi, wired, or WAN
    response_tunnel_search_item:
      oneOf:
      - $ref: '#/components/schemas/stats_mxtunnel'
      - $ref: '#/components/schemas/stats_wan_tunnel'
      description: Tunnel statistics record; shape depends on the requested tunnel type
    response_tunnel_search_results:
      allOf:
      - $ref: '#/components/schemas/response_tunnel_search_item'
      - description: Tunnel statistics records returned by search
    routing_policy_local_preference:
      anyOf:
      - type: string
      - maximum: 4294967295
        minimum: 1
        type: integer
        contentEncoding: int32
      description: Optional, for an import policy, local_preference can be changed, value in range 1-4294967294. Can be a Variable (e.g. `{{bgp_as}}`)
    routing_policy_term_matching_as_path:
      allOf:
      - $ref: '#/components/schemas/bgp_as'
      - description: BGP AS path values used as routing-policy match criteria
    service_dscp:
      oneOf:
      - type: string
      - maximum: 63
        minimum: 0
        type: integer
        contentEncoding: int32
      description: For SSR only, when `traffic_type`==`custom`. 0-63 or variable
    service_max_jitter:
      oneOf:
      - type: string
      - maximum: 2147483647
        minimum: 0
        type: integer
        contentEncoding: int32
      description: For SSR only, when `traffic_type`==`custom`, for uplink selection. 0-2147483647 or variable
    service_max_latency:
      oneOf:
      - type: string
      - maximum: 2147483647
        minimum: 0
        type: integer
        contentEncoding: int32
      description: For SSR only, when `traffic_type`==`custom`, for uplink selection. 0-2147483647 or variable
    service_max_loss:
      oneOf:
      - type: string
      - maximum: 100
        minimum: 0
        type: integer
        contentEncoding: int32
      description: For SSR only, when `traffic_type`==`custom`, for uplink selection. 0-100 or variable
    sle_classifier_samples_degraded:
      allOf:
      - $ref: '#/components/schemas/number_or_null'
      - description: Per-interval degraded SLE values for a classifier
    sle_classifier_samples_total:
      allOf:
      - $ref: '#/components/schemas/number_or_null'
      - description: Per-interval total SLE values for a classifier
    sle_summary_sle_samples_degraded:
      allOf:
      - $ref: '#/components/schemas/number_or_null'
      - description: Per-interval degraded SLE values for a summary
    sle_summary_sle_samples_total:
      allOf:
      - $ref: '#/components/schemas/number_or_null'
      - description: Per-interval total SLE values for a summary
    sle_summary_sle_samples_value:
      allOf:
      - $ref: '#/components/schemas/number_or_null'
      - description: Per-interval SLE score values for a summary
    sponsor_link_validity_duration:
      anyOf:
      - maximum: 60
        minimum: 5
        type: integer
        contentEncoding: int32
        default: 60
      - type: string
      description: Optional if `sponsor_enabled`==`true`. How long to remain valid sponsored guest request approve/deny link received in email, in minutes. Value is between 5 and 60.
    stats_client:
      oneOf:
      - $ref: '#/components/schemas/stats_wireless_client'
      - $ref: '#/components/schemas/stats_wired_client'
      description: Client statistics record for a wireless or wired client
    stats_client_any_of:
      allOf:
      - $ref: '#/components/schemas/stats_client'
      - description: Client statistics records returned by a stats response
    stats_device:
      oneOf:
      - $ref: '#/components/schemas/stats_ap'
      - $ref: '#/components/schemas/stats_switch'
      - $ref: '#/components/schemas/stats_gateway'
      description: Device statistics record for an AP, switch, or gateway
      discriminator:
        propertyName: type
        mapping:
          ap: stats_ap
          gateway: stats_gateway
          switch: stats_switch
    stats_devices:
      allOf:
      - $ref: '#/components/schemas/stats_device'
      - description: Device statistics records returned by a stats response
    switch_bgp_config_hold_time:
      oneOf:
      - $ref: '#/components/schemas/switch_bgp_config_hold_time_zero'
      - maximum: 65535
        minimum: 3
        type: integer
        contentEncoding: int32
      description: Hold time is three times the interval at which keepalive messages are sent. It indicates to the peer the length of time that it should consider the sender valid. Must be 0 or a number in the range 3-65535.
    switch_mgmt_mxedge_proxy_port:
      anyOf:
      - maximum: 65535
        minimum: 1
        type: integer
        contentEncoding: int32
        default: 2222
      - type: string
      description: Mist Edge port used to proxy the switch management traffic to the Mist Cloud. Value in range 1-65535
    switch_ospf_config_reference_bandwidth:
      anyOf:
      - type: integer
        contentEncoding: int32
      - type: string
      description: Reference bandwidth. Integer(100000) or String (10g)
      examples:
      - '100000'
    switch_port_usage_mac_limit:
      anyOf:
      - maximum: 16383
        minimum: 0
        type: integer
        contentEncoding: int32
        default: 0
      - type: string
      description: Only if `mode`!=`dynamic`, max number of MAC addresses, default is 0 for unlimited, otherwise range is 1 to 16383 (upper bound constrained by platform)
    switch_port_usage_mac_limit_overwrite:
      anyOf:
      - maximum: 16383
        minimum: 0
        type: integer
        contentEncoding: int32
        default: 0
      - type: string
      description: Max number of MAC addresses, default is 0 for unlimited, otherwise range is 1 to 16383 (upper bound constrained by platform)
    switch_port_usage_mtu:
      anyOf:
      - maximum: 9216
        minimum: 256
        type: integer
        contentEncoding: int32
      - type: string
      description: Only if `mode`!=`dynamic` media maximum transmission unit (MTU) is the largest data unit that can be forwarded without fragmentation. The default value is 1514.
    switch_port_usage_reauth_interval:
      anyOf:
      - maximum: 65535
        minimum: 10
        type: integer
        contentEncoding: int32
        default: 3600
      - type: string
      description: 'Only if `mode`!=`dynamic` and `port_auth`=`dot1x` reauthentication interval range (min: 10, max: 65535, default: 3600). Set to 0 to disable reauthentication (no-reauthentication).'
    synthetictest_config_vlan_vlan_ids:
      allOf:
      - $ref: '#/components/schemas/vlan_id_with_variable'
      - description: VLAN identifiers where deprecated VLAN-based synthetic probes run
    synthetictest_device_vlan_id:
      oneOf:
      - type: string
      - maximum: 4094
        minimum: 1
        type: integer
        contentEncoding: int32
      description: Required for AP. VLAN ID used by the synthetic test when the target device is an AP
    tunterm_port_config_upstream_port_vlan_id:
      oneOf:
      - type: string
      - maximum: 4094
        minimum: 1
        type: integer
        contentEncoding: int32
      description: Native VLAN ID for upstream ports
    vlan_id_with_variable:
      oneOf:
      - type: string
      - maximum: 4094
        minimum: 1
        type: integer
        contentEncoding: int32
      description: VLAN ID, either numeric or expressed as a template variable string
    wayfinding_import_json:
      oneOf:
      - $ref: '#/components/schemas/map_jibestream'
      - $ref: '#/components/schemas/map_micello'
      description: Vendor wayfinding map metadata imported from Jibestream or Micello
    wlan_dynamic_vlan_default_vlan_id:
      oneOf:
      - type: string
      - maximum: 4094
        minimum: 1
        type: integer
        contentEncoding: int32
        default: 999
      description: VLAN ID, VLAN range or variable to use when there’s no match from RADIUS
    wlan_dynamic_vlan_default_vlan_id_deprecated:
      oneOf:
      - type: string
      - maximum: 4094
        minimum: 1
        type: integer
        contentEncoding: int32
        default: 999
      description: vlan_id to use when there’s no match from RADIUS
    wlan_dynamic_vlan_default_vlan_ids:
      allOf:
      - $ref: '#/components/schemas/wlan_dynamic_vlan_default_vlan_id'
      - description: Default VLAN ID(s) can be a number, a range of VLAN IDs, a variable or multiple numbers, ranges or variables as a VLAN pool. Default VLAN as a pool of VLANS requires 0.14.x or newer firmware
    wlan_dynamic_vlan_local_vlan_ids:
      allOf:
      - $ref: '#/components/schemas/vlan_id_with_variable'
      - description: VLAN_ids to be locally bridged
    wlan_limit:
      anyOf:
      - maximum: 999000
        minimum: 1
        type: integer
        contentEncoding: int32
      - type: string
      description: In kbps, value from 1 to 999000
    wlan_portal_sponsors:
      oneOf:
      - type: array
        items:
          type: string
      - type: object
        additionalProperties:
          type: string
        examples:
        - sponsor1@company.com: FirstName1 LastName1
          sponsor2@company.com: FirstName2 LastName2
      description: Object of allowed sponsors email with name. Required if `sponsor_enabled` is `true` and `sponsor_email_domains` is empty. Property key is the sponsor email, Property value is the sponsor name. List of email allowed for backward compatibility
    wlan_vlan_id_with_variable:
      oneOf:
      - type: string
      - maximum: 4094
        minimum: 1
        type: integer
        contentEncoding: int32
      description: WLAN VLAN ID, either numeric, a variable string, or null
    wlan_vlan_ids:
      oneOf:
      - type: string
        examples:
        - 1,2
      - type: array
        items:
          $ref: '#/components/schemas/vlan_id_with_variable'
        examples:
        - - 3
          - 4
          - 5
      description: WLAN VLAN pool IDs represented as either a comma-separated string or a list
    wlan_vlan_ids_list:
      allOf:
      - $ref: '#/components/schemas/vlan_id_with_variable'
      - description: If `vlan_enabled`==`true` and `vlan_pooling`==`true`. List of VLAN IDs (comma separated) to be used in the VLAN Pool
    wxlan_tag_vlan_id:
      oneOf:
      - type: string
      - maximum: 4094
        minimum: 1
        type: integer
        contentEncoding: int32
      description: If `type`==`vlan_id`, VLAN ID or variable
      examples:
      - '1055'
  securitySchemes:
    apiToken:
      type: apiKey
      description: >-
        Preferred authentication method for automation and integrations. Send the API token in the HTTP `Authorization` header.


        **Format**:
          `Authorization: Token {apitoken}`

        **Notes**:

        * An API token generated for a specific admin has the same privileges as that admin

        * An API token is automatically removed if it is not used for more than 90 days

        * SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.
      name: Authorization
      in: header
    csrfToken:
      type: apiKey
      description: >-
        Session-based authentication for browser or login/password flows. After a successful [Login]($e/Admins%20Login/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.
      name: X-CSRFToken
      in: header
security:
- apiToken: []
- csrfToken: []
tags:
- name: Admins
  description: >-
    Admin API calls can be used to create, manage or authenticate Mist administrators.


    To register administrators into an existing MSP account or Organization, please check: * [Invite Msp Admin]($e/MSPs%20Admins/inviteMspAdmin) * [Invite Org Admin]($e/Orgs%20Admins/inviteOrgAdmin)
- name: Admins Login
  description: >-
    Login Endpoints when using Login/Password authentication, with or without 2FA.


    If the Login/Password authentication is successful, Mist will add a `csrftoken` cookie that must be added into the later API Requests (please see [csrfToken (Custom Header Signature)]($h/__auth_CsrfToken))
- name: Admins Logout
  description: Logout Endpoints when using Login/Password authentication, with or without 2FA.
- name: Admins Recover Password
  description: Endpoints used to trigger a password recovery and validate the token sent by email.
- name: Admins Lookup
  description: Admin Lookup API Call is mainly used by Web UIs to know if a user must be redirected to an SSO URL for login.
- name: Admins Login - OAuth2
  description: "A Mist account can be linked to OAuth2 providers:\n1. First, login with your Mist account\n2. Obtain the Authorization URL for Linking with [Get Oauth 2 Authorization Url for Login]($e/Admins%20Login%20-%20OAuth2/getOauth2AuthorizationUrlForLogin).\nAs OAuth2 flow goes through provider's UI and back with the authorization code, there are two ways to get it:\n  * in JSON response, more usable for developers. Simply don\\'t specify the `forward` parameter when obtaining the authorization URL\n  * as GET parameter, for UI where the user flow can be continued. Specify the landing page/url of your choice \n3. Obtain the authorization code by clicking / going through Authorization URL Link Mist Account against OAuth2 Provider by using the authorization code"
- name: Installer
  description: "In a typical enterprise, a separate group of people, Installers, are responsible for install new devices. May it be a new installation (e.g. new stores), a replacement installation (e.g. replacing Cisco APs with Mist APs), or addition (e.g. adding new APs for better coverage). Instead of granting them Admin/Write privilege, it's more desirable to grant them minimum privileges to do the initial provisioning so they cannot read sensible information (e.g. PSK of a WLAN), or change configs of running APs.\nAt a high level, Installer APs try to achieve the following:\n1. identifying a device by MAC (that\\u2019\\ \ns what they see)\n2. they can only touch configurations of the devices they\\u2019\\\nre installing\n3. allow the following configurations: \n  * name * site assignment \n  * device profile assignment \n  * map and location (x/y) assignment \n  * claim (if not already in the inventory) \n  * replace existing device with the device being installed\n\n**Grace Period**\n\nGrace period provides a dynamic way to limit what devices / sites installer can work on. Generally installers work on recent deployments - bringing up new sites, add newly claimed devices to new / existing sites. They make mistakes, too, and may need to further tweak some of the parameters. Default grace period is 7 days and can be set from 1 day to 365 days."
- name: MSPs
  description: MSP (Managed Service Provider) contains multiple Organizations.
- name: MSPs Admins
  description: An MSP Admin refers to a user who has access to the Juniper Mist managed service provider (MSP) portal and is responsible for managing and administering the network operations of multiple customer organizations and sites.
- name: Orgs SecIntel Profiles
  description: Sky ATP Secintel Profile
- name: Sites SecIntel Profiles
  description: Sky ATP Secintel Profile
- name: MSPs Inventory
  description: API Calls to locate a device across all the Organizations attached to the MSP account.
- name: MSPs Logo
  description: Manage the Mist portal logo at the MSP level. This logo will be displayed instead of the Juniper Mist Logo for all the Organizations attached to this MSP account.
- name: MSPs Logs
  description: >-
    Audit Logs are records of activities initiated by users, providing a history of actions such as accessing, creating, updating, or deleting resources or components at the MSP level.


    These logs allow superusers and network administrators to track and maintain a record of user actions, including who performed specific actions and when.


    Audit logs are useful for monitoring user activity, investigating security breaches, ensuring compliance with regulations, and tracing configuration changes in a network.


    They can be filtered and analyzed to view specific information and granular-level details of each event.
- name: MSPs Licenses
  description: >-
    Licenses are a type of service or access that customers can purchase for various features or services offered by a company.


    Subscriptions can have different statuses, such as active, expired, exceeded, or trial, depending on their validity and usage. The status of a subscription determines whether it is currently active and valid, has expired, has exceeded the allowed usage limit, or is in a trial period.


    Licenses can be activated using an activation code, and the activation process confirms the inputted code and activates the subscription.


    Licenses can be managed at the MSP level for organization attached to an MSP account, or directly at the [Organization level]($h/Orgs%20Licenses/_overview)
- name: MSPs Marvis
  description: >-
    Marvis is an AI-driven, interactive virtual network assistant that streamlines network operations, simplifies troubleshooting, and provides an enhanced user experience.

    It offers real-time network visibility, comprehensive insights, and automation customized for your network.

    Marvis can proactively identify issues, interpret their impact, determine root causes, and recommend fixes.

    It consists of components such as Marvis Actions, Marvis Minis, Conversational Assistant, Marvis Client, and Marvis Query Language.


    Marvis API Calls at the MSP level can be used to quickly detect network issues on all the Organizations attached to the MSP account.
- name: MSPs Org Groups
  description: >-
    Org Groups a way to group Organizations together based on certain criteria.


    They can be used for easier management and organization of multiple organizations within the MSP portal.
- name: MSPs Orgs
  description: >-
    An organization usually represents a customer - which has inventories, licenses.


    An Organization can contain multiple sites. A site usually represents a deployment at the same location (a campus, an office).
- name: MSPs SLEs
  description: >-
    SLEs, or Service-Level Expectations, are metrics used to monitor and report on the user experience of a Wireless, Wired or Wan network.


    They are generated through data science and machine learning algorithms and provide insights into various aspects of the network, such as coverage, capacity, connectivity, and performance.


    Mist SLEs help identify when users do not have sufficient network quality, when they face issues with connecting or roaming between access points, and when there are problems on the wired network.


    SLEs API Calls at the MSP level can be used to retrieve the SLEs summary for each Organization attached to the MSP account.
- name: MSPs SSO Roles
  description: >-
    MSP SSO roles refer to the different functions assigned to users within a Single Sign-On (SSO) system.


    These roles determine the tasks and actions that users can perform within the SSO system. There are typically predefined roles and custom roles in an SSO system.


    Roles in SSO provide a well-defined separation of responsibility and visibility, allowing for granular-level access control on SSO objects.
- name: MSPs SSO
  description: >-
    MSP SSO, or Single Sign-On, is a method of authentication that allows users to securely log in to multiple applications and websites with a single set of login credentials.


    It involves integrating the MSP portal with an Identity Provider (IdP) using the Security Assertion Markup Language (SAML) framework.


    This enables users to authenticate themselves through their corporate IdP, eliminating the need to remember separate passwords or enter credentials each time they access the MSP portal.
- name: MSPs Tickets
  description: >-
    Support tickets are a means for users to seek assistance and resolve issues they encounter with a product or service.

    They allow users to communicate their problems or questions to the Juniper Mist support team, who can then provide guidance, troubleshooting, or solutions.

    Support tickets typically include information such as the type of issue, relevant details, and any necessary attachments.


    Support Tickets API Calls at the MSP level can be used to retrieve the tickets for each Organization attached to the MSP account.
- name: Orgs
  description: An organization usually represents a customer - which has inventories, licenses. An Organization can contain multiple sites. A site usually represents a deployment at the same location (a campus, an office).
- name: Orgs Admins
  description: >-
    An org admin, or organization administrator, is a user with administrative privileges within a specific organization. They have the authority to manage and oversee the operations and settings of that organization's portal.

     The different types of access levels for an org admin include:
     * Super User: This role has full access to the MSP portal and all tenant organizations. A super user can manage other administrators and has the highest level of privileges.
     * Network Admin: A network admin has limited access to the MSP portal. They can be granted access to all organizations or specific organizations, with access to limited features in the organizations' portals. They are responsible for monitoring, verifying, and troubleshooting the network within their assigned organizations.
     * Observer: An observer has view-only access to limited features in the MSP portal. They can be granted access to all organizations or specific organizations, with view-only access to limited features in the organizations' portals. Observers monitor events in the network and bring any issues to the attention of the network administrator for resolution.
     * Installer: An installer can be granted access to all organizations or specific organizations, with only the ability to install access points for these organizations. They are responsible for setting up and installing access points in the network.
     * Helpdesk: A helpdesk user can be granted access to all organizations or specific organizations, with only helpdesk monitoring and workflow capabilities for these organizations. They assist with monitoring and resolving issues reported by users within the organization.

     These different access levels allow org admins to perform their specific roles and responsibilities within the MSP portal while ensuring appropriate access and security measures are in place.
- name: Orgs Alarms
  description: Alarms are triggered based on certain events. Alarms could be configured using an Alarm Template.
- name: Orgs Alarm Templates
  description: >-
    An Alarm Template is a set of Alarm Rules that could be applied to

    one or more sites (while each site can only pick one Alarm Template), or to the

    whole org.



    Once created, the Alarm template must be assigned with the `alarmtemplate_id` attribute to one of the following

    * the whole org with the [Update Org]($e/Orgs/updateOrg) API Call

    * one or multiple sites with the [Update Site Info]($e/Sites/updateSiteInfo) API Call
- name: Orgs AP Templates
  description: >-
    AP Templates are defining Wi-Fi and AP settings that can be assigned to Access Points based on different types of rules.


    AP Templates must be assigned to one or multiple sites to be used.
- name: Orgs API Tokens
  description: >-
    Org API token is a unique identifier used by an application to authenticate and access a service's API.

    These tokens are used to authenticate requests made to the API server and ensure secure access to the API.


    They are not bound to any specific user and provide access to the organization as a whole.


    Organization tokens support different privileges and can only be used for the specific organization they are generated for.


    Rate limiting is done on an individual token basis, so if one token reaches its rate limit, it does not impact other tokens.
- name: Orgs Assets
  description: >-
    An Asset refers to any equipment or item that is being tracked and monitored using Bluetooth Low Energy (BLE) beacon tags.


    This requires the Asset Visibility subscription.
- name: Orgs Asset Filters
  description: >-
    An Asset Filter is a feature that allows users to define specific criteria or conditions to filter and display only certain assets based on their attributes or properties.


    This requires the Asset Visibility subscription.
- name: Orgs Cert
  description: >-
    API Calls to manage Organization Certificates.


    The certificates can be used bu Access Assurance, during the SSO/SAML Authentication, ...
- name: Orgs Antivirus Profiles
  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 Clients - Marvis
  description: >-
    Marvis Invites can be generated for (and belongs to) an Org. They can be generated by an Admin of an Org and can be revoked at anytime.


    Marvis Clients are devices that have the Marvis Android Client installed on them and are connected to a Juniper Mist AP.


    They provide detailed data and telemetry about the client's wireless connection, including information about roaming behavior, connection type, and wireless properties.
- name: Orgs Marvis Invites
  description: >-
    Marvis Clients are devices that have the Marvis Android Client installed on them and are connected to a Juniper Mist AP.


    They provide detailed data and telemetry about the client's wireless connection, including information about roaming behavior, connection type, and wireless properties.
- name: Orgs Clients - NAC
  description: NAC Clients are devices connected to the network and authenticated by Juniper Mist Access Assurance.
- name: Orgs Clients - Wan
  description: WAN Clients are devices connected to a Juniper SRX or SSX gateway monitor or managed by Mist
- name: Orgs Clients - Wired
  description: Wired Clients are Wired devices connected to a Juniper switch monitored or managed by Mist.
- name: Orgs Clients - Wireless
  description: Wireless Clients are Wi-Fi devices connected to a Juniper Mist Access Point.
- name: Orgs Clients - SDK
  description: >-
    SDK Clients are devices that have installed an application using the Mist Software Development Kit (SDK).


    These clients can provide specific data and information that is not available without the installation of the SDK application.
- name: Orgs Integration Cradlepoint
  description: >-
    The integration between Mist and Cradlepoint allows users to utilize Cradlepoint 5G cellular adapters with Juniper's wired, wireless, and SD-WAN solutions driven by Mist AI.


    With this integration, users can manage Cradlepoint devices from the Mist portal, including onboarding, assigning devices to a site, and viewing device inventory details. It also provides visibility into the health, SLE, and insights of Cradlepoint devices.


    Additionally, the integration enables users to leverage Marvis, Juniper's virtual network assistant, to receive proactive recommendations and self-driving network actions. This integration enhances the client-to-cloud user experience by providing insights into branch WAN adapters, helping network admins reduce Mean Time to Identify (MTTI).
- name: Orgs CRL
  description: >-
    CRLs, or Certificate Revocation Lists, are time-stamped lists that identify digital certificates that have been invalidated before their expiration date. They include information about the reasons for revocation and the entities that issued the certificates.


    CRLs are used to prevent the usage of compromised digital certificates and signatures.
- name: Orgs Device Profiles
  description: >-
    While Templates / RF Templates / Network Templates / Gateway Templates provides powerful ways to control how a Device\'s configuration is derived for a Site. There are cases where you\'d like another level of control at the Org Level.

    A Device Profile contains a subset of Device\'s configurations you\'d like a device to have. It will be merged at runtime when we\'re provisioning an AP.
- name: Orgs Devices
  description: Devices are any Network device managed or monitored by Juniper Mist. It can be * Wireless Access Points * Juniper Switch (EX, QFX) * Juniper WAN Gateway (SRX, SSR) * Mist Edges * Other or 3rd party devices, like Cradlepoint Devices
- name: Orgs Devices - SSR
  description: API Calls specific to SSR devices
- name: Orgs Devices - AOSCX
  description: API Calls specific to AOS-CX (Aruba Operating System - CX) devices
- name: Orgs Devices - EdgeConnect
  description: API Calls specific to EdgeConnect devices
- name: Orgs EVPN Topologies
  description: >-
    EVPN allows an alternative but more efficient LAN architecture utilizing VxLAN / MP-BGP - separating control plane (MAC / IP Learning) from forwarding plane.

    In our implementation, following the steps to deploy EVPN topologies in a Site
- name: Orgs Integration Juniper
  description: The Juniper Integration can be used to synchronize Juniper Support Insights (JSI) information.
- name: Orgs Devices - Others
  description: API Call for 3rd party devices
- name: Orgs Integration Zscaler
  description: >-
    In Zscaler UI:

    1. add Partner Integration at https://admin.zscalerbeta.net/#administration/partner-integration

    2. Add Partner Administrator Role at https://admin.zscalerbeta.net/#administration/role-management - Name: Mist - Access: Full

    3. add Partner Admin at https://admin.zscalerbeta.net/#administration/admin-management with - Login ID: john - email: john@abc.com

    4. Find the cloud name for ZIA https://help.zscaler.com/zia/what-my-cloud-name-zia
- name: Orgs SCEP
- name: Orgs Gateway Templates
  description: >-
    Gateway Template is applied to a site for gateway(s) in a site.


    When Templates are not used, Site Setting holds settings for multiple device types and they can differ to set device_type specific configs, use this whatever is defined under `gateway` will overwrite/shadow the one at root-level
- name: Orgs Guests
  description: Guests are users who are accessing the wi-fi network as a temporary or non-permanent visitor.
- name: Orgs IDP Profiles
  description: >-
    An IDP profile is a set of predefined rules and actions that determine how the Intrusion Detection and Prevention (IDP) system handles network traffic.


    It allows you to selectively enforce attack detection and prevention techniques on your network. The profile includes a set of IDP signatures and rules recommended by Juniper Networks, and each attack type and severity has a specific action associated with it, such as closing the TCP connection, dropping the packet, or sending an alert.


    The IDP profile can be applied to an application policy to monitor and analyze network events for signs of incidents, violations, or threats to security policies.
- name: Orgs Inventory
  description: The Org Inventory allows administrators to view and manage all devices registered (claimed) to the Organization.
- name: Orgs Integration JSE
  description: >-
    JSE stands for Juniper Secure Edge and it is a feature within the Mist UI that allows customers to configure Secure Cloud Connectors.


    With JSE, users can establish a tunnel via IPSec  protocol and use application policy and traffic steering to send traffic from a WAN edge device to JSE. Mist also provides insights and telemetry for the secure edge connection, which is helpful for troubleshooting and monitoring data.
- name: Orgs Advanced Anti Malware Profiles
  description: >-
    The "Advanced Anti-Malware" feature in Sky ATP is a comprehensive security solution that leverages multiple techniques to detect and prevent malware attacks. Here are the key components of this feature:

    * **Flow-Based Antivirus Policy**: The policy checks inbound and outbound traffic to stop malware, quarantine infected systems, prevent data exfiltration, and disrupt lateral movement.

    * **Machine Learning-Based Threat Detection**: Sky ATP uses machine learning to identify zero-day threats and detect malware that traditional antivirus software might miss.

    * **Integration with SRX Series Firewalls**: The SRX Series firewalls integrate with Sky ATP to block known malicious file downloads and outbound Command and Control (C&C) traffic. This integration ensures that malware is quickly identified and dropped before it can infect a host.

    * **Real-Time Threat Intelligence**: Sky ATP distributes third-party threat intelligence feeds to all ATP-subscribed SRX firewalls for immediate action, reducing the attack surface.


    These components collectively provide a robust and automated threat detection and remediation solution, simplifying cybersecurity infrastructure and processes for organizations.


    For more details, you can refer to the Juniper documentation on advanced anti-malware policy configuration.
- name: Orgs Integration SkyATP
  description: "Sky Advanced Threat Prevention (Sky ATP) is a cloud-based security designed to detect and mitigate advanced threats in real-time, ensuring the security and integrity of your network.  \nThe integration of Sky ATP with Mist is a strategic move to enhance the security posture of wireless networks by leveraging the capabilities of both solutions.\n\n\nThe integration of Sky ATP with Mist enhances the security of wireless networks by providing real-time threat alerts and mitigation capabilities. Here are the key benefits of this integration:\n\n* Enhanced Security: Adds another layer of security to the robust mechanisms already in place within the Mist WLAN platform. It leverages artificial intelligence (AI) for tighter security, lower operational costs, and optimized user experience.\n* Real-Time Threat Detection: Quickly identifies devices on the network that are infected with malware and takes appropriate actions. This ensures that security risks are assessed and mitigated promptly when users and devices are connected to wireless networks.\n* Improved Device Tracking: Allows for better tracking of client hosts as Mist supplies client MAC addresses to Juniper ATP Cloud. This information is crucial for identifying and mitigating threats.\n* Streamlined Security Events: Threat alerts detected by Juniper SRX Series Firewalls and ATP Cloud are automatically streamed to Mist, enabling administrators to quickly assess security risks and take appropriate actions such as quarantine or enforce security policies."
- name: Orgs JSI
  description: "Juniper Support Insight is a free service provided to all Mist customers.\nYou can adopt your devices via a few lines CLI commands. Allowing you to \n* get some basic information about the adopted devices \n* web shell into device (write privilege required) \\n* upgrade (write privilege required)"
- name: Orgs Licenses
  description: >-
    Licenses are a type of service or access that customers can purchase for various features or services offered by a company.


    Subscriptions can have different statuses, such as active, expired, exceeded, or trial, depending on their validity and usage. The status of a subscription determines whether it is currently active and valid, has expired, has exceeded the allowed usage limit, or is in a trial period.


    Licenses can be activated using an activation code, and the activation process confirms the inputted code and activates the subscription.
- name: Orgs Linked Applications
  description: "Linked Application are Third party applications linked to the Mist Organization. \nThis is usually using OAuth2.0 or API integrations for a Cloud-to-Cloud Communication."
- name: Orgs Logs
  description: >-
    Audit Logs are records of activities initiated by users, providing a history of actions such as accessing, creating, updating, or deleting resources or components at the Org level.


    These logs allow superusers and network administrators to track and maintain a record of user actions, including who performed specific actions and when.


    Audit logs are useful for monitoring user activity, investigating security breaches, ensuring compliance with regulations, and tracing configuration changes in a network.


    They can be filtered and analyzed to view specific information and granular-level details of each event.
- name: Orgs Marvis
  description: >-
    Marvis is an AI-driven, interactive virtual network assistant that streamlines network operations, simplifies troubleshooting, and provides an enhanced user experience.

    It offers real-time network visibility, comprehensive insights, and automation customized for your network.

    Marvis can proactively identify issues, interpret their impact, determine root causes, and recommend fixes.

    It consists of components such as Marvis Actions, Marvis Minis, Conversational Assistant, Marvis Client, and Marvis Query Language.
- name: Orgs Maps
  description: These API Calls to import Site Maps at the Org level
- name: Orgs MxClusters
  description: A Mist Edge Cluster (MxCluster) is a group of Juniper Mist Edge devices that are configured to work together in order to provide high availability and load balancing for the tunneling of traffic from access points (APs). The cluster can consist of a single edge device or multiple edge devices.
- name: Orgs MxEdges
  description: A Mist Edge (MxEdge) is a physical or virtual appliance that is deployed in a network to provide centralized data path for user traffic or as a RADIUS Proxy, which was traditionally performed by legacy wireless controllers. It keeps all the control and management functions in the Mist Cloud, offering a microservices architecture to the campus.
- name: Orgs MxTunnels
  description: >-
    A Mist Tunnel (MxTunnel) is a configuration object that allows for the tunneling of user VLANs from the Access Points (APs) to a central point on the network.


    It specifies the VLAN IDs that need to be tunneled and assigns the tunnel to a primary or secondary mist edge cluster. The mist tunnel also includes settings for tunnel fail over, auto-preemption, and other parameters related to tunnel termination services.
- name: Orgs NAC IDP
  description: The NAC IDP allows users to integrate with various Identity Providers (IDPs) to enhance authentication and access control. Admins can configure identity providers such as microsoft EntraID, okta workforce identity cloud, and google workspace idp.
- name: Sites NAC Fingerprints
  description: The NAC IDP allows users to integrate with various Identity Providers (IDPs) to enhance authentication and access control. Admins can configure identity providers such as microsoft EntraID, okta workforce identity cloud, and google workspace idp.
- name: Orgs NAC Tags
  description: >-
    NAC Tags are the building blocks to compose nacrules.

    They can either appear in the "matching" / "not_matching" sections of a nacrule, in which case they play the role of classifiers, or they could appear in the "apply_tags" section of the of a nacrule, in which case they influence the result.

    When the "type" field of nactag is "match", it can be used as the classifier of a nacrule.

    - "match" field specifies the attribute name and "values" field specifies the list of attribute values to match on.

    - When multiple values are specified, its treated as an OR condition between those values. This behavior can be changed by setting "match_all" field to "true", in which case it is treated as an AND condition between those values.

    - By default, exact match is performed.


    This behavior can be changed as follows:

    - Adding `-` at the beginning will perform suffix match (ex: -staff will match foo-staff and bar-staff)

    - Adding `-` at the end will perform prefix match (ex: foo- will match foo-staff and foo-interns)

    - Adding `!` at both ends will perform substring match (ex: printer will match hp-printer-bldg1, brother-printer-lab)

    - Adding `!` at the beginning will perform negation of the match (ex: !ssid-guest will match any string that is not ssid-guest)

    - Note: when negation should be used along with suffix/substring operation, ! should always precede \* (ex: !guest will match any string that is not ending with guest)


    When the "type" field of nactag is NOT "match", it can be used as the result of a nacrule. "type" field identifies the action to take and the corresponding field would provide any associated parameters to that action. When the "type" field of nactag is NOT "match" and is any of the result type also supported by usermac table(`vlan`), "allow_usermac_override" field can be set to true to allow the override by usermac result
- name: Orgs NAC Portals
  description: "NAC Portals are for onboard Wireless and Wired client with 802.1X\n\nThe NAC Portal is a web-based interface that allows users to authenticate and\ngain access to the network. It is typically used for guest access or for devices\nthat do not have a pre-configured certificate for 802.1X authentication.\n\nIt can also be used to provision certificates for devices that require them with the Mist Application.\n\n\n### NAC-Based External Guest Portal Authorization / How to implement a External Guest Portal\n\n#### Context\n\nIn the guest portal flow, context such as SSID, guest MAC, AP MAC is required to unique identify the guest, if it's already authorized (e.g. roam to another AP), and used to instruct the AP to stop redirecting/blocking the user traffic\n\n#### Redirect\n\nGuest Device (or CNA in MacOS/iOS term) will be redirected to, e.g. “?ap_mac=5c5b35001234&ssid=Guest&…”\n\n| Name | Type | Description |\n |------|------|-------------|\n | ap_mac | string | AP's MAC address |\n | site_id | string | Site ID |\n | device_mac | string | Device's MAC address (the device that blocks the traffic) |\n | ssid | string | for wireless |\n | port_name | string | for wired (e.g. eth0, ge-0/0/13) |\n | client_mac | string | Client's MAC address |\n \n\n#### Authorize\n\nOnce the guest has gone through your portal flow, authorize them by redirect the user to\n\n```\nGET https://url_generated_by_portal_authorize_url?jwt=<signature>\n```\n\nThis can be generated by\n\n```python\nimport jwt\n\nsecret = \"EIfPMOykI3lMlDdNPub2WcbqT6dNOtWwmYHAd6bY\"  # from portal_authorize_jwt_secret above \npayload = {\n    # for wireless\n    \"ap_mac\": \"5c5b35001234\",\n    \"wlan_id\": \"be22bba7-8e22-e1cf-5185-b880816fe2cf\",  # only for _wireless_ captive portal\n    \"client_mac\": \"d58f6bb4c9d8\",\n\n    # for wired\n    \"device_mac\": \"5c5b35001234\",\n    \"port_name\": \"eth0\",  # only for _wired_ captive portal\"\n    \"client_mac\": \"d58f6bb4c9d8\",\n\n    # common\n    # how long should we authorize this session\n    \"minutes\": 480,  \n    \"expires\": 1768587994,  # alternatively\n    # instead of the original URL the user is trying to go to, redirect the user to this URL    \n    \"forward\": \"http://www.mist.com\",\n    # for testing: if authorize_only=true and authorization is successful, 200 OK will be returned instead of 302 Redirect the user to the `forward` URL\n    \"authorize_only\": False\n}\n\nencoded_jwt = jwt.encode(payload, secret, algorithm='HS256')\n```\n"
- name: Orgs NAC CRL
  description: "By default, Mist is automatically retrieving the PKI CRL by using the CRL Distribution Point provided by Certification Authority.\n\n\nIn case this information is not provided, or the CRL is not publicly available (i.e. Mist cannot get access to it), these API Calls can \nbe used to manually upload and manage the PKI CRL into the Mist Organization."
- name: Orgs Stats
  description: API Calls to retrieve statistics about the Mist Org and related items
- name: Orgs Stats - Assets
  description: API Calls to retrieve statistics about the Assets at the Org level
- name: Orgs Stats - BGP Peers
  description: API Calls to retrieve statistics about the BGP Peers (WAN Assurance)
- name: Orgs Stats - Devices
  description: >-
    API Calls to retrieve statistics about the Mist Managed and Monitored Devices at the Org level



    By default, the API call only returns a subset of the available fields. Additional fields can be requested by adding the query parameter `fields=` and the list of fields, or `fields=*` to retrieve all the available fields.
- name: Orgs Stats - Marvis Clients
  description: API Calls to retrieve statistics about Marvis Clients at the Org level
- name: Orgs Stats - MxEdges
  description: API Calls to retrieve statistics about the Mist Edges at the Org level
- name: Orgs Stats - Ospf
  description: API Calls to retrieve statistics about OSPF peers at the Org level
- name: Orgs Stats - Other Devices
  description: API Calls to retrieve statistics about the Other/3rd party devices at the Org level
- name: Orgs Stats - Ports
  description: API Calls to retrieve statistics about the Wired Ports at the Org level
- name: Orgs Stats - Sites
  description: API Calls to retrieve statistics about the Organization Sites
- name: Orgs Stats - Tunnels
  description: API Calls to retrieve statistics about the Mist Tunnels at the Org level
- name: Orgs Stats - VPN Peers
  description: API Calls to retrieve statistics about the VPN Peers (WAN Assurance)
- name: Orgs NAC Rules
  description: >-
    The NAC Rules (or Auth Policies) are a set of rules that devices and users must fulfill in order to gain access to the network and use network resources.


    Juniper Mist Access Assurance evaluates authentication requests based on the specified policy conditions. If a user or device satisfies the conditions, Mist Access Assurance applies actions that either allow or deny access to the user or device.


    These actions can also apply attributes such as VLAN and role to the allowed users. Mist Access Assurance uses "NAC Tags" (or Auth Policy Labels) as the policy matching criteria and as a policy action for allowed users. NAC Tags can be managed with the [Orgs NAC Tags API Calls]($h/Orgs%20NAC%20Tags/_overview)
- name: Orgs Network Templates
  description: >-
    A Network Template is a configuration template that allows for the consistent and standardized configuration of switches across an organization's network infrastructure.


    It includes settings such as RADIUS and ntp servers, shared elements like iot or corporate networks, and port profiles for specific devices.


    Switch templates can be applied at the site level, and they make the initial setup of switches easy and adaptable to specific site or switch settings.
- name: Orgs Networks
  description: A Network refers to a group or segment of users that are defined for use across the entire organization.
- name: Orgs Premium Analytics
  description: >-
    Premium Analytics is an advanced, cloud-based analytics service offered by Juniper Mist. It provides end-to-end network observability and allows users to gain unique insights into networking and location based on Juniper Mist data sets and optional third-party data sets.


    Premium Analytics stores data for up to 13 months, extending the observability of historical data beyond the 30 days available with the standard Juniper Mist analytics service. It supports features such as network, engagement, and occupancy analytics, and offers the ability to customize reports and filter data based on various parameters.
- name: Orgs Psks
  description: >-
    A multi PSK (Pre-Shared Key) is a feature that allows the use of multiple PSKs for securing network connections.


    It provides a simple and comprehensive way to onboard client devices without relying on client MAC addresses.


    Each psk has its own key name, which can be used for user-level accountability, key rotation, and visibility in the management platform. It supports the creation, rotation, and auto-expiration of PSKs, and allows vlan assignment and role assignment for dynamic per-user policies.


    Multi PSKs create virtual broadcast domains and can be used for end-user onboarding via authenticated sso login.


    Mist supports three methods of Org PSKs lookup: * local * RADIUS * cloud
- name: Orgs Psk Portals
  description: >-
    PSK Self-Service Portals are for

    1. **Wi-Fi users** who want to connect to a WLAN with personal PSK, they're told to connect to a URL where they can login (likely through company\u2019s SSO) and get the Wi-Fi Name / Passphrase - required input fields name, email so we can generate PSK

    2. **PSK Admins** (they don't have access to normal Network Admin Portal)


    When a PSK portal is created, an unique URL will be generated (e.g. https://psk.mist.com/xxxxxx)
- name: Orgs Reports
  description: API Calls to manage organization-level reports, such as E911 AP BSSID report exports.
- name: Orgs RF Templates
  description: >-
    Rf Templates are a feature in Juniper Mist wireless assurance that allow for uniform radio configurations to be applied across all sites in an organization.


    These templates can be customized to include model-specific exceptions and settings for different use cases.


    RF Templates enable the management of radio bands, channel width, transmission power, and ap antenna gain.


    They provide a centralized way to configure and apply these settings to all access points within an organization.
- name: Orgs SDK Invites
  description: SDK Invites can be generated for (and belongs to) an Org. They can be generated by an Admin of an Org and can be revoked at anytime.
- name: Orgs SDK Templates
- name: Orgs Security Policies
  description: "Security Policy is designed to audit / catch discrepancies between\n\"what's intended to be running\" versus \"what's actually running\" in a network. \n\nMany big organizations have separated Security and IT team (for good reasons). Each site can be assigned a security policy.\n Whenever an AP is provisioned, the configuration will be checked against the security policy.\n Any violations will be flagged in [Device Config History]($e/Sites%20Devices/searchSiteDeviceConfigHistory) where you can search for the when and where the violation occurs."
- name: Orgs Services
  description: >-
    A Service refers to the applications that network users will connect to. These applications represent traffic destinations and are essential for defining network policies and security configurations.


    Applications can be defined manually in the Juniper Mist cloud portal. They can be categorized as: * Custom Applications: Defined using IP prefixes, protocols, and port ranges. * Predefined Applications: Selected from a list of common applications (e.g., Social Media, Microsoft Teams). * URL Categories: Used to define applications based on specific URLs.
- name: Orgs Service Policies
  description: >-
    Services Policies are a security policy that defines who can access applications, they are used to control access to applications and ensure proper traffic management within a network.


    It determines the source network or users that are allowed or denied access to specific applications or destinations.


    The policy also includes options such as traffic steering profiles, which define the paths that the traffic should follow.


    Service policies can be defined at the organization level or within a wan edge template or hub profile.
- name: Orgs Setting
  description: API Calls to manage the Mist Organization Settings
- name: Orgs Sitegroups
  description: Site groups are a group of sites under the same Org. It's many-to-many mapping to sites
- name: Orgs Sites
  description: >-
    API Calls to Create or Get the Organization Sites.



    Use the [Site Settings](https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/setting/overview) to configure or update the Site information.
- name: Orgs Site Templates
  description: >-
    Site templates are pre-configured sets of attributes and settings that can be applied to one or more sites in a Mist Organization.


    These templates allow for quick and consistent configuration of sites by grouping common attributes together.


    They can include settings such as Auto-Upgrade features, wan edge configurations, switch configurations and other network parameters.


    By applying a site template, the same configuration can be easily replicated across multiple sites, simplifying network management and ensuring consistency.
- name: Orgs SLEs
  description: >-
    Org SLEs, or Service-Level Expectations, are metrics used to monitor and report on the user experience of a Wireless, Wired or Wan network.


    They are generated through data science and machine learning algorithms and provide insights into various aspects of the network, such as coverage, capacity, connectivity, and performance.


    Mist SLEs help identify when users do not have sufficient network quality, when they face issues with connecting or roaming between access points, and when there are problems on the wired network.
- name: Orgs SSO Roles
  description: >-
    SSO roles refer to the different functions assigned to users within a Single Sign-On (SSO) system.


    These roles determine the tasks and actions that users can perform within the SSO system. There are typically predefined roles and custom roles in an SSO system.


    Roles in SSO provide a well-defined separation of responsibility and visibility, allowing for granular-level access control on SSO objects.
- name: Orgs SSO
  description: >-
    Org SSO, or Single Sign-On, is a method of authentication that allows users to securely log in to multiple applications and websites with a single set of login credentials.


    It involves integrating the Org portal with an Identity Provider (IdP) using the Security Assertion Markup Language (SAML) framework.


    This enables users to authenticate themselves through their corporate IdP, eliminating the need to remember separate passwords or enter credentials each time they access the Org portal.
- name: Orgs WLAN Templates
  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 Tickets
  description: >-
    Support tickets are a means for users to seek assistance and resolve issues they encounter with a product or service.

    They allow users to communicate their problems or questions to the Juniper Mist support team, who can then provide guidance, troubleshooting, or solutions.

    Support tickets typically include information such as the type of issue, relevant details, and any necessary attachments.
- name: Orgs User MACs
  description: >-
    NAC User MACs (Endpoints) provide a database of endpoints identified by their MAC addresses. They can be used assign each endpoint with various attributes, such as name, VLAN, role and client label. Once an endpoint is labeled, the label name can be used to create [NAC Tags]($h/Orgs%20NAC%20Tags/_overview) as match criteria.


    [NAC Tags]($h/Orgs%20NAC%20Tags/_overview) can be used to create Tags regrouping one or multiple endpoint MAC addresses, but the use of the User MACs provides additional features:

    * possibility to assign specific attributes, like a Name, a RADIUS Group, a VLAN ID, ...

    * possibility to assign one or multiple Tags (Labels) to a User MAC

    * improved management for large list of MAC addresses
- name: Orgs Vars
  description: Vars endpoints are used to retrieve the list of Site Variables across all the Sites.
- name: Orgs VPNs
  description: "VPNs endpoints are used to create the WAN Assurance Overlay configuration between a Hub and one\nor multiple WAN Edge Gateways.\n\n\nWhen configuring the Hub and Spokes from the Mist UI, the UI is automatically creating or updating\nthe VPNs objects based on the configuration. \nWhen the configuration is directly done with the APIs, the VPN object must be manually managed."
- name: Orgs Webhooks
  description: >-
    An Org Webhook is a configuration that allows real-time events and data from the Org to be pushed to a provided url.


    It enables the collection of information about various topics such as device events, alarms, and audits updates at the org level.


    The Webhook can be set up and customized using the Mist API, allowing users to receive and analyze specific data from a particular site.
- name: Orgs Wlans
  description: >-
    An Org Wlan is a wireless local area network that is configured at the Org level and applied to a WLAN template.


    It allows for the creation and management of wireless network settings, such as SSIDs (service set identifiers), authentication settings, VLAN configurations, etc...


    Org WLANs are created and managed at the org level and can only be referenced and used within the WLAN Templates.
- name: Orgs WxRules
  description: >-
    ORg WxRules are a set of rules, restrictions, and settings that can be applied to WLANs within a specific WLAN Template.


    These policies determine how the devices and traffic are treated by the network and can be used to control access, define VLANs, and apply labels to users and resources.
- name: Orgs WxTags
  description: >-
    Wxtags are tags or groups that can be created and used within the Org.


    They are used to classify users and resources and can be applied to Access Points, WLAN configurations or WxRules within that site.


    Org WxTags are created and managed at the org level and can only be referenced and used within the org level configuration.
- name: Orgs WxTunnels
  description: >-
    A WxLan Tunnel (WxTunnel) are used to create a secure connection between Juniper Mist Access Points and third-party VPN concentrators using protocols such as L2TPv3 or dmvpn.


    These tunnels allow for the aggregation of ethernet interfaces on access points, support dynamic or static tunnels, and provide options for IPSec encryption.
- name: Sites Spectrum Analysis
  description: The Spectrum Analysis feature provides insights into the radio frequency environment, helping to identify interference and optimize wireless network performance. It allows users to monitor and analyze the spectrum usage in their vicinity.
- name: Sites
  description: A site represents a project, a deployment. For MSP, it can be as small as a coffee shop or a five-star 600-room hotel. A site contains a set of Maps, Wlans, Policies, Zones.
- name: Sites Alarms
  description: Alarms are triggered based on certain events. Alarms could be configured using an [Orgs Alarm Template]($h/Orgs%20Alarm%20Templates/_overview).
- name: Sites AP Templates
  description: >-
    AP Templates are defining Wi-Fi and AP settings that can be assigned to Access Points based on different types of rules.


    Site AP Templates are created and managed at the site level and can only be referenced and used within that particular site.
- name: Sites Applications
  description: Applications contains a list of applications users are interested in monitoring / routing / policing
- name: Sites Anomaly
- name: Sites Auto Map Assignment
  description: Auto Map Assignment allows devices to be automatically assigned to maps based on their location data. These API calls can be used to manage, apply, and clear auto map assignments for devices at the site level.
- name: Sites Asset Filters
  description: >-
    An Asset Filter is a feature that allows users to define specific criteria or conditions to filter and display only certain assets based on their attributes or properties.


    Site Asset Filters are created and managed at the site level and can only be referenced and used within that particular site.


    This requires the Asset Visibility subscription.
- name: Sites Assets
  description: >-
    An Asset refers to any equipment or item that is being tracked and monitored using Bluetooth Low Energy (BLE) beacon tags.


    This requires the Asset Visibility subscription.
- name: Sites Beacons
- name: Sites Clients - NAC
  description: NAC Clients are devices connected to the network and authenticated by Juniper Mist Access Assurance.
- name: Sites Clients - Wan
  description: WAN Clients are devices connected to a Juniper SRX or SSX gateway monitor or managed by Mist
- name: Sites Clients - Wired
  description: Wired Clients are Wired devices connected to a Juniper switch monitored or managed by Mist.
- name: Sites Clients - Wireless
  description: Wireless Clients are Wi-Fi devices connected to a Juniper Mist Access Point.
- name: Sites Devices
  description: >-
    Mist provides many ways (device_type specific template, site template, device profile, per-device) to configure devices for different kind of scenarios.


    The precedence goes from most specific to least specific


    Device > Device Profile > RFTemplate (for AP only) > DeviceType-specific Template > Site Template > Site Setting
- name: Sites Devices - Wireless
  description: API Calls specific to the Mist Access Points
- name: Sites Devices - Others
  description: API Call for 3rd party devices
- name: Sites Devices - Wired
  description: API Calls specific to the Juniper Switches managed by Mist
- name: Sites Devices - Wired - Virtual Chassis
  description: API Calls specific to the Juniper Switches Virtual Chassis managed by Mist
- name: Sites Devices - WAN Cluster
  description: API Calls specific to manage (form/delete) the SRX/SSR Clusters
- name: Sites Device Profiles
  description: The API Endpoints for the Device Profiles at the site level can be used to get the site derived networks, meaning the org level configuration with the site variables resolved..
- name: Orgs Events
  description: Orgs Events are all the system level changes at the org level
- name: Sites Events
  description: >-
    Site events are issues or incidents that affect site-assigned access points (aps) and radius, dhcp, and dns servers.


    They can be investigated and monitored using the insights dashboard in the juniper mist portal. the dashboard provides a summary of site events, including information about the impacted devices and contributing events.


    Site events can be categorized as resolved or acknowledged, and additional details can be accessed by clicking on the event.
- name: Sites EVPN Topologies
  description: >-
    EVPN allows an alternative but more efficient LAN architecture utilizing VxLAN / MP-BGP - separating control plane (MAC / IP Learning) from forwarding plane.


    In our implementation, following the steps to deploy EVPN topologies in a Site
- name: Sites Gateway Templates
  description: The API Endpoints for the Gateway Templates at the site level can be used to get the site derived networks, meaning the org level configuration with the site variables resolved..
- name: Sites IDP Profiles
  description: The API Endpoints for the IDP Profiles at the site level can be used to get the site derived profiles, meaning the org level configuration with the site variables resolved..
- name: Sites Advanced Anti Malware Profiles
  description: The API Endpoints for the Advanced Anti Malware Profiles at the site level can be used to get the site derived profiles, meaning the org level configuration with the site variables resolved..
- name: Sites Antivirus Profiles
  description: The API Endpoints for the Antivirus Profiles at the site level can be used to get the site derived profiles, meaning the org level configuration with the site variables resolved..
- name: Sites Guests
  description: Guests are users who are accessing the wi-fi network as a temporary or non-permanent visitor.
- name: Sites Insights
  description: >-
    Insights is a feature that provides an overview of network experience across the entire site, access points, or clients.


    It offers useful information about current conditions, such as telemetry data from wired switches, edge devices, wireless clients, access points, network applications, and bluetooth low energy (ble) tags.


    These insights can be used to correct issues, make changes, and ensure a good network experience for users.
- name: Sites JSE
  description: >-
    JSE stands for Juniper Secure Edge and it is a feature within the Mist UI that allows customers to configure Secure Cloud Connectors.


    With JSE, users can establish a tunnel via IPSec  protocol and use application policy and traffic steering to send traffic from a WAN edge device to JSE. Mist also provides insights and telemetry for the secure edge connection, which is helpful for troubleshooting and monitoring data.
- name: Sites Licenses
  description: The API Endpoints for the Licenses at the site level can be used to get license usages for a specific site.
- name: Sites Location
  description: The Location Diagnostics allows users to retrieve and analyze coverage and performance data for mist access points (aps) and devices.
- name: Sites Maps
  description: >-
    A Site Map is a visual representation of the layout and structure of a location, such as a building or campus.


    It includes accurate information about the placement, positions, heights, and orientations of Juniper Mist Access Points (APs) and other devices in the deployment.


    The floorplan is an essential component of location services as it enables the location engine to generate accurate location estimates for client devices, assets, and users at the site.
- name: Sites Maps - Auto-placement
  description: "### AP Auto-Placement\nAP Auto-Placement is a feature in Juniper Mist wireless assurance that automatically determines and sets the positions of Access Points (APs) on a floorplan.\n\nIt saves time and simplifies the deployment process by eliminating the need for manual placement. \n\nThe autoplacement algorithm calculates the most probable location for each AP based on factors such as signal strength and coverage requirements. \n\nThe confidence level of the autoplacement is indicated by colors, with green representing high certainty, orange indicating medium certainty, and red suggesting low certainty. \nIn cases where aps are isolated or cannot communicate with nearby aps, they cannot be placed automatically and must be [manually positioned on the floorplan]($e/Sites%20Devices/updateSiteDevice). \n\nAfter the autoplacement process is complete, the results can be evaluated and accepted of rejected with the API Call [Confirm Site AP Localization Data]($e/Sites%20Maps%20-%20Auto-placement/confirmSiteApLocalizationData)\n\n\n### AP Auto-Orientation\nAp Auto-Orientation is a feature in juniper mist wireless assurance that allows users to check and correct the orientation of Access Points (APs) on a floorplan. \n\nThis feature is supported by specific ap models and requires a firmware dependency of version 0.14.28310 or higher and does not require a maintenance window and can be used after performing autoplacement. \n\nTo use auto-orientation, physically install the APs, claim or adopt them into the Juniper Mist organization, place them on the floorplan, and perform auto-placement, then trigger the [Start Site Ap Auto Orientation API call]($e/Sites%20Maps%20-%20Auto-placement/startSiteApAutoOrientation)\n\nAfter 24 hours, the rotation in degrees of the AP(s) will be updated. users can accept or deny the changes made by the auto-orientation feature with the API Call [Confirm Site AP Localization Data]($e/Sites%20Maps%20-%20Auto-placement/confirmSiteApLocalizationData)."
- name: Sites Maps - Auto-Zone
  description: The auto zones service is a map parsing service that uses map image data to suggest spaces to designate as location zones.
- name: Sites Map Stacks
  description: Map Stacks are a way to group multiple maps together within a site, typically representing different floors or levels in a building. Map Stacks help organize and manage floorplans for multi-story buildings or complex deployments.
- name: Sites Marvis Configs
  description: Marvis Config Actions are config changes injected by Marvis into network devices. These actions can be searched, counted, deleted, and given feedback.
- name: Sites MxEdges
  description: >-
    MxEdges (Mist Edges) at the site level are deployed to tunnel traffic at each site due to network constraints or security concerns.


    They can be assigned to a specific site and configured to provide tunneling and RADIUS proxy services for the access points (APs) in that site.


    These Mist Edges allow for the extension of user vlans from the corporate network to the aps, and they support features such as auto preemption for failover, dual tunneling to different mist edge clusters, and anchor tunnels for traffic routing to dmz areas.
- name: Sites Network Templates
  description: The API Endpoints for the Network Templates at the site level can be used to get the site derived networks, meaning the org level configuration with the site variables resolved.
- name: Sites Networks
  description: The API Endpoints for the Networks at the site level can be used to get the site derived networks, meaning the org level configuration with the site variables resolved.
- name: Sites Psks
  description: >-
    A multi PSK (Pre-Shared Key) is a feature that allows the use of multiple PSKs for securing network connections.


    It provides a simple and comprehensive way to onboard client devices without relying on client MAC addresses.


    Each psk has its own key name, which can be used for user-level accountability, key rotation, and visibility in the management platform. It supports the creation, rotation, and auto-expiration of psks, and allows vlan assignment and role assignment for dynamic per-user policies.


    Multi PSKs create virtual broadcast domains and can be used for end-user onboarding via authenticated sso login.


    Mist supports two methods of Site PSKs lookup: * local * radius
- name: Sites RF Templates
  description: The API Endpoints for the RF Templates at the site level can be used to get the site derived configuration, meaning the org level configuration with the site variables resolved..
- name: Sites Rfdiags
  description: >-
    Rf Diags is a feature in Juniper Mist location services that allows users to replay recorded sessions of the RF (radio frequency) environment.


    It enables users to gain an understanding of current issues, troubleshoot problems, and review recordings for further analysis or to share with customer support.
- name: Sites Rogues
  description: >-
    Rogues are unauthorized wireless access points that are installed on a network without authorization.


    They can be connected to the LAN via an ethernet cable, similar to a pc, and are typically set up by individuals with malicious intent or by employees trying to cover a dead spot with their own wi-fi hotspot.
- name: Sites RRM
  description: >-
    RRM, or Radio Resource Management, is a tool used by large multi-site organizations to efficiently manage their RF spectrum.


    It involves making decisions on channel and power settings for access points (APs) based on factors such as user experience, client count, client usage, and interference.


    Mist RRM uses a reinforcement learning-based feedback model to monitor the impact of changes in channel and power settings on the capacity and performance of the wireless network. It adapts dynamically to changing conditions throughout the day and aims to optimize wireless coverage and capacity across a site.
- name: Sites RSSI Zones
  description: RSSI Zones are zones based on the RSSI (Received Signal Strength Indicator, i.e. the power of the signal received by the Access Points from the Wireless Clients).
- name: Sites Services
  description: >-
    A Service represents an a traffic destination or an application that network users connect to. They are associated with users and networks and are used in application policies to permit or deny access.


    Services are defined at the [Org level]($e/Orgs%20Services/createOrgService).


    The Site level endpoints can be used to get the site services statistics or the derived services, meaning the merge between the site level configuration and the org level configuration.
- name: Sites Service Policies
  description: The API Endpoints for the Service Policies at the site level can be used to get the site derived configuration, meaning the merge between the site level configuration and the org level configuration.
- name: Sites Setting
  description: >-
    Site settings refer to the configuration and management of of site within a Mist Organization.


    These settings include access point settings, firmware upgrade schedules, and various features such as location services, occupancy analytics, and engagement analytics.
- name: Sites Site Templates
  description: The API Endpoints for the Site Templates at the site level can be used to get the site derived configuration, meaning the org level configuration with the site variables resolved..
- name: Sites Skyatp
  description: >-
    SkyATP is a cloud-based solution that provides advanced threat protection for network security.


    It allows security analysts to update their defense against new attack techniques in real-time and distribute threat intelligence quickly.


    SkyATP inspects network traffic and blocks devices that have downloaded malware or accessed command and control servers. It also offers configuration and troubleshooting capabilities for administrators.
- name: Sites SLEs
  description: >-
    Site SLEs, or Service-Level Expectations, are metrics used to monitor and report on the user experience of a Wireless, Wired or Wan network.


    They are generated through data science and machine learning algorithms and provide insights into various aspects of the network, such as coverage, capacity, connectivity, and performance.


    Mist SLEs help identify when users do not have sufficient network quality, when they face issues with connecting or roaming between access points, and when there are problems on the wired network.
- name: Sites Synthetic Tests
  description: >-
    Synthetic Tests (Marvis Minis) are a feature of Juniper Networks' Mist platform, designed to proactively identify and resolve network issues before they impact users by simulating user connections and validating network configurations.



    Here are the key points about Marvis Minis:


    * Proactive Testing: Marvis Minis perform user connection tests to validate connectivity and application reachability issues on your network. These tests run automatically every hour and can also be initiated manually by an admin user.

    * Scope and Stress Management: By default, Marvis Minis run on a few APs based on the scope it automatically learns, and it can expand the scope to other APs and switches if necessary, without causing additional stress on network services.

    * Integration with Mist AI: Data from Marvis Minis is continuously fed back into the Mist AI engine, providing additional insights for AIOps responses. This data is also integrated into Marvis Actions for proactive resolution and validation.

    * Subscription and Accessibility: Marvis Minis are available at no extra charge with a Marvis VNA subscription and do not require additional hardware or software.
- name: Sites UI Settings
  description: The Site UI Settings are used to configure the site Network and Analytics reports
- name: Orgs UI Settings
  description: The Org UI Settings are used to configure the MArvis dashboards
- name: Sites vBeacons
  description: >-
    A vBeacon is a virtual beacon that is created and configured on a floorplan and are configured with a name and message


    It is a Mist patented technology that provides proximity-related notifications to users on a mobile app using the Mist SDK.


    vBeacons allow users to receive notifications when their device is within the proximity of the beacon, based on the power transmitted. When a user goes near the location of a vbeacon, a notification is sent to the application with the configured message.
- name: Sites VPNs
  description: API Calls to retrieve the list of Org VPNs configuration available for the Site
- name: Sites WAN Usages
  description: API Calls to retrieve WAN Assurance statistics about the WAN Usage
- name: Sites Webhooks
  description: >-
    A Site Webhook is a configuration that allows real-time events and data from a specific site to be pushed to a provided url.


    It enables the collection of information about various topics such as device events, alarms, audits, client sessions and location updates at the site level.


    The Webhook can be set up and customized using the Mist API, allowing users to receive and analyze specific data from a particular site.
- name: Sites Wlans
  description: >-
    A Site Wlan is a wireless local area network that is configured and applied to a specific site within an organization.


    It allows for the creation and management of wireless network settings, such as SSIDs (service set identifiers), authentication settings, VLAN configurations, etc... for a particular site.


    Site Wlans are created and managed at the site level and can only be referenced and used within that particular site.
- name: Sites WxRules
  description: >-
    Site WxRules are a set of rules, restrictions, and settings that can be applied to WLANs within a specific site.


    These policies determine how the devices and traffic are treated by the network and can be used to control access, define VLANs, and apply labels to users and resources.


    Site WxRules are created and managed at the site level and are applied after the site-level WxRules.
- name: Sites WxTags
  description: >-
    Wxtags are tags or groups that can be created and used within a specific site.


    They are used to classify users and resources and can be applied to Access Points, WLAN configurations or WxRules within that site.


    Site WxTags are created and managed at the site level and can only be referenced and used within that particular site.
- name: Sites WxTunnels
  description: >-
    A WxLan Tunnel (WxTunnel) are used to create a secure connection between Juniper Mist Access Points and third-party VPN concentrators using protocols such as L2TPv3 or dmvpn.


    These tunnels allow for the aggregation of ethernet interfaces on access points, support dynamic or static tunnels, and provide options for IPSec encryption.
- name: Sites Zones
  description: >-
    A Zone is a custom area defined by a user on a floor plan.


    Zones can be used for capturing entry and exit events of clients, assets, and sdk clients, providing insights such as wait time and the number of devices in a particular zone.


    Zone notifications can be accessed using sdk notification callbacks.


    Zones are useful for data collection specific to areas on the floor plan.
- name: Sites Stats
  description: The stats are providing access to raw data about a specific type of entities.
- name: Sites Stats - Apps
  description: API Calls to retrieve the stats of the Applications used on side
- name: Sites Stats - Assets
- name: Sites Stats - Beacons
- name: Sites Stats - BGP Peers
  description: API Calls to retrieve BGP Peers statistics of the Site Wen Edge Gateways at the Site level
- name: Sites Stats - Calls
  description: API Calls to retrieve the stats of the calls (Zoom/Teams) detected by Mist
- name: Sites Stats - Clients Wireless
  description: API Calls to retrieve the stats of the wireless clients detected (connected or not connected) on this site.
- name: Sites Stats - Clients SDK
  description: >-
    SDK Clients are devices that have installed an application using the Mist Software Development Kit (SDK).


    These clients can provide specific data and information that is not available without the installation of the SDK application.
- name: Sites Stats - Devices
  description: API Calls to retrieve statistics about the Mist Managed and Monitored Devices at the Site level
- name: Sites Stats - MxEdges
  description: API Calls to retrieve statistics about the Mist Edges at the Site level
- name: Sites Stats - Ospf
  description: API Calls to retrieve statistics about OSPF peers at the Site level
- name: Sites Stats - Ports
  description: API Calls to retrieve statistics about the Wired Ports at the Site level
- name: Sites Stats - WxRules
  description: API Calls to retrieve WxRules statistics for the current Site
- name: Sites Stats - Zones
  description: API Calls to retrieve Zones statistics for the current Site
- name: Sites Stats - Discovered Switches
  description: API Calls to retrieve statistics about the Discovered Switches at the Site level
- name: Sites Stats - IoT Endpoints
  description: API Calls to retrieve IoT Endpoint statistics for the current Site
- name: Constants Definitions
  description: API Calls to retrieve constant values that can be used in different parts of the configuration
- name: Constants Events
  description: API Calls to retrieve the definitions of the Mist events. These definitions are providing example of the Webhook payloads
- name: Constants Models
  description: API Calls to retrieve the list of Hardware Models and their features
- name: Self Account
  description: API calls related to the currently connected user account.
- name: Self API Token
  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.

    **Notes:**


    * an API token generated for a specific admin has the same privilege as the user

    * an API token will be automatically removed if not used for > 90 days

    * SSO admins cannot generate these API tokens. Refer [Org level API tokens]($e/Orgs%20API%20Tokens/createOrgApiToken) which can have privileges of a specific Org/Site for more information.
- name: Self OAuth2
  description: >-
    A Mist account can be linked to OAuth2 providers:
      1. First, login with your Mist account
      2. Obtain the Authorization URL for Linking
      3. Obtain the authorization code by clicking / going through Authorization URL
      4. Link Mist Account against OAuth2 Provider by using the authorization code
- name: Self MFA
  description: API calls related to Two Factor Authentication for the currently connected user account.
- name: Self Alarms
  description: API calls related to the alarm subscriptions for the currently connected user account.
- name: Self Audit Logs
  description: API calls related to the audit logs subscriptions for the currently connected user account.
- name: Utilities Common
  description: >-
    API Calls to use Devices Troubleshooting tools.



    Some API Calls can be used with any type of devices (Access Points, Switches and Gateways), and some others may be limited to some types of devices (e.g. "Junos Only")
- name: Utilities WAN
  description: API Calls to use Devices Troubleshooting tools specific to WAN Assurance
- name: Utilities LAN
  description: API Calls to use Devices Troubleshooting tools specific to Wired Assurance
- name: Utilities Wi-Fi
  description: API Calls to use Devices Troubleshooting tools specific to Wireless Assurance
- name: Utilities PCAPs
  description: API Calls to start, stop or managed Packet Captures at the device level
- name: Utilities Location
  description: API Calls to use Devices Troubleshooting tools specific to Asset Tracking and User Management
- name: Utilities MxEdge
  description: API Calls to use Devices Troubleshooting tools specific to Mx Edges
- name: Utilities Upgrade
  description: API Calls used to manage device upgrades for a single device, at the site level or at the organization level.